API Reference

Search resources of a specific collection in the data partition

post
https://{workspaceId}.clinia.cloud/partitions//v1/collections//query

Search resources of a specific collection in the data partition.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The partition from which to execute the query.

string
required

The collection from which to execute the query.

Body Params
semanticQuery
object

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 filter the targeted collections. The filtering operator excludes results that do not match the specified criteria.

highlighting
array of strings
highlighting
int32
int32
Defaults to 20
sort
object
ranking
aggregations
array of objects
aggregations
traversedProperties
array of strings

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.
traversedProperties
Responses

Updated about 1 year ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 year ago