Search resources of a specific collection in the data partition

Search resources of a specific collection in the data partition.

Path Parameters

partitionKey*string

The partition from which to execute the query.

collectionKey*string

The collection from which to execute the query.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Use dot-notation paths (e.g., name, meta.updatedAt, address.city). To include properties from relationships or adjacent records, request them via traversedProperties and reference with @ (e.g., @worksAt.*, @worksAt.@clinic.name). Some endpoints require federated paths such as resources.<collectionKey>.<propertyKey> or relationships.<collectionKey>.<propertyKey>.

semanticQuery?

A semantic query is a high-level representation of the user's intent. When specified, it will trigger our query understanding capabilities and generate a query and filter operator that will be applied to the search parameters.

query?|||||||||||

An operator that will be used to search the targeted collections. The matching operator will count as part of the ranking.

filter?|||||||||||

An operator that will be used to search the targeted collections. The matching operator will count as part of the ranking.

properties?

Limits the semantic paths the LLM can consider. Accepts collection-scoped paths or federated paths depending on the endpoint.

highlighting?array<string>

page?integer

Formatint32

perPage?integer

Formatint32

Default20

sort?

aggregations?array<>

traversedProperties?array<string>

The properties from the relationships or adjacent records that will be returned in the search response. The wildcard '*' can be used in itself or in combination with a prefix

* will return all traversed properties.
@worksAt.* will return all traversed properties from the relationship 'worksAt'.
@worksAt.@clinic.* will return all traversed properties from an adjacent 'clinic' connected with a 'worksAt' relationship.

Response Body

`application/json`

curl -X POST "https://example.com/partitions/string/v1/collections/string/query" \  -H "Content-Type: application/json" \  -d '{}'

{  "semanticQueryInfo": {    "reasoning": "string",    "originalQuery": "string",    "query": {      "id": "string",      "and": [        null      ]    },    "filter": {      "id": "string",      "and": [        null      ]    }  },  "hits": [    {      "hitType": "RESOURCE",      "score": 0.1,      "resource": {},      "traversedProperties": {        "property1": [          {            "type": "address",            "value": {},            "relationshipId": "string",            "relationshipType": "string",            "recordId": "string",            "recordType": "string"          }        ],        "property2": [          {            "type": "address",            "value": {},            "relationshipId": "string",            "relationshipType": "string",            "recordId": "string",            "recordType": "string"          }        ]      },      "highlighting": {        "property1": [          {            "type": "textual",            "highlight": "string"          }        ],        "property2": [          {            "type": "textual",            "highlight": "string"          }        ]      }    }  ],  "meta": {    "numPages": 0,    "page": 0,    "perPage": 0,    "total": 0,    "filter": {      "id": "string",      "and": [        null      ]    }  },  "aggregates": [    {      "type": "LEXICAL",      "path": "string",      "aggregate": [        {          "value": "string",          "count": 0        }      ]    }  ]}

Search resources of a specific collection in the data partition

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

404application/json

413application/json

429application/json

504application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`