Index on nested payload field?

[mymindwentblvnk]

Hi, do you know if it is possible to create an index on a nested payload field?

As written here (https://qdrant.tech/documentation/concepts/indexing/#payload-index), one can easily create an index on a top level field. Our payload looks like this:

{
    'id': 1,
    'vector': ...,
    'payload': {
        'top_level_attribute': [
            { 'nested_attribute': ['s1', 's2', 's3', 's4', ...], 'other_nested_attribute': 'some_string' },
            { 'nested_attribute': ['s3', 's4', ...], 'other_nested_attribute': 'some_other_string' },
        ]
    }
}

I want to filter on a certain string in nested_attribute. How could I create an index on it?

[mymindwentblvnk]

So the following index definition seems to work:

client.create_payload_index('collection_1', field_name='top_level_attribute[].nested_attribute', field_schema='keyword')

When checking the collection information, it confirms to have created an index for all points in the collection.

collection_info = client.get_collection('collection_1')
assert collection_info.payload_schema['top_level_attribut[].nested_attribute'].points == number_of_points_in_collection  # This is True

But I cannot measure any performance improvement.
May be field_schema='keyword' is not the correct type, since it is a list of keywords?

[gururaser]

Hi, @mymindwentblvnk have you been able to verify practically that this method works? I feel like If I don't see "filter" logo in Qdrant Cloud UI (you can see it in platform_brand_name), it doesn't have index even though I see on collection information:

self.qm.create_payload_index("platform_brand_name", models.TextIndexParams(type=models.TextIndexType.TEXT, tokenizer= models.TokenizerType.WORD, min_token_len=2, max_token_len=20, lowercase=True, on_disk=True))
self.qm.create_payload_index("scores.rating", models.FloatIndexParams(type="float", is_principal=True))
self.qm.create_payload_index("scores.merchant", models.FloatIndexParams(type="float", is_principal=True))

def create_payload_index(self, field_name: str, field_schema: Any) -> bool:
        try:
            target_collection = self.get_target_collection()
            collection_info = self.client.get_collection(target_collection)
            existing_indices = collection_info.payload_schema

            if field_name not in existing_indices:
                self.client.create_payload_index(
                    collection_name=target_collection,
                    field_name=field_name,
                    field_schema=field_schema
                )
                logger.info(f"Index created for field '{field_name}' in collection '{target_collection}'.")
            else:
                logger.info(f"Index already exists for field '{field_name}' in collection '{target_collection}'. Skipping creation.")
            return True
        except Exception as e:
            logger.error(f"Error occurred while checking/creating index for field '{field_name}': {e}")
            return False