API ReferenceSearch

Fast content search.

Returns fast results by performing hybrid, semantic, or lexical search based on content already indexed in the database.

Headers

authorizationstringRequired

Request

Body
querystringRequired>=1 character
Your search query. **Notes on Lexical Search** - You may perform exact phrase matching by enclosing your query in double quotes and using lexical search and the websearch_to_tsquery parser. - Queries with binary operators (e.g. `<->`, `&`) using the ts_query parser will work best with pure lexical search. - To perform exact phrase matching along with other boolean operators, use the `<->` operator with the to_tsquery parser instead of double quotes. - If searching a language other than English, you may see better results with hybrid or semantic search than lexical search.
paginationobjectOptional
collectionIdslist of stringsOptional
similarityThresholddoubleOptional0-1Defaults to 0.3
The similarity threshold to use for semantic search. If using hybrid search, content will be included whether it passes the semantic threshold OR contains a lexical match. **Note:** Semantic scores are normalized for hybrid search: - Normalized score of 0.64 = Unnormalized score of 0.28. - Threshold is applied to unnormalized scores for faster indexing. - For the given example, a threshold of 0.3 would exclude it from results.
searchTypeenumOptionalDefaults to hybrid
The type of search to use.
Allowed values:
parserenumOptionalDefaults to websearch_to_tsquery
The parser to use for hybrid or lexical search. Refer to Postgres' [parser docs](https://www.postgresql.org/docs/current/textsearch-controls.html#TEXTSEARCH-PARSING-QUERIES) for more information.
Allowed values:

Response

200
dataobject

Errors