API ReferenceSearch

Search dataset

Perform a visual and audio search of a dataset using a natural language (text) query

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

querystringOptional

The search query

queriesstringOptional

The list of text query strings to include in the natural_language_query

coactive_image_idsstringOptional

The list of coactive image ids to include in the natural_language_query

dataset_idstringRequired

The id of the dataset to search

encoderenumOptional

The encoder to use to search within this dataset.Only applicable if dataset has multiple embeddings.Will use default dataset embedding if None.

Allowed values:
concept_idsstringOptional

The ids of the concepts to include in the natural_language_query

offsetintegerOptional>=0Defaults to 0

Starting index to return

limitintegerOptional>=1Defaults to 100

Max number of items to return

metadata_filtersstringOptional

JSON string containing a list of metadata filters

asset_typeenumOptional

Asset type to filter by

search_typeenumOptional

Search type to use

Allowed values:

Response

Search results

metaobject

Metadata for the set of data returned

datalist of objects

The paginated results

Errors