Sign in

v5

latestOpenAPI 3.1.02026-08-04166362486.5 KB
stores

Get metadata facets

post/v1/stores/metadata-facets

Request body

top_kinteger

Number of results to return

file_idsstring[] nullable

Optional list of file IDs to filter chunks by (inclusion filter)

querystring nullable

Search query text

facetsstring[] nullable

Optional list of facets to return. Use dot for nested fields.

max_fieldsinteger

Maximum number of distinct metadata fields (keys) to return.

max_values_per_fieldinteger

Maximum number of distinct values returned per field, ranked by count.

max_filesinteger

Maximum number of store files scanned to compute facets.

Example request

{
  "filters": {
    "all": [
      {
        "key": "price",
        "operator": "gt",
        "value": "100"
      },
      {
        "key": "color",
        "operator": "eq",
        "value": "red"
      }
    ],
    "any": [
      {
        "key": "price",
        "operator": "gt",
        "value": "100"
      },
      {
        "key": "color",
        "operator": "eq",
        "value": "red"
      }
    ],
    "none": [
      {
        "key": "price",
        "operator": "gt",
        "value": "100"
      },
      {
        "key": "color",
        "operator": "eq",
        "value": "red"
      }
    ]
  },
  "file_ids": [
    "123e4567-e89b-12d3-a456-426614174000",
    "123e4567-e89b-12d3-a456-426614174001"
  ],
  "query": "how to configure SSL",
  "search_options": {
    "rerank": {
      "model": "rerank_model",
      "top_k": 10
    }
  }
}

Response

The metadata facets

facetsobject required

Metadata facets

Example response

{
  "facets": {
    "author": {
      "count": 1,
      "value": "John Doe"
    },
    "year": {
      "count": 2,
      "value": "2024"
    }
  }
}