Search passages or files by words and meaning
Combines word and vector passage rankings. An explicit mode selects passages or distinct files with full live text. Omit mode during the grace period to receive full files in the legacy format, including file.fileId and file.url. Mode will be required after the grace period. Expansion defaults to on. Disabling it searches the original query with both methods, without rewrites. With explicit mode, each result includes kind, text, and its readable file in file.id. The sources field lists connected external records when requested. Order shows rank, best match first, rather than confidence. Numerical scores are not returned. New or changed files may take a moment to become searchable.
Authorizations
Workspace-scoped API key, sent as a bearer token. The recommended header. The workspace is implicit in the key and never appears in a URL.
Body
- Option 1
- Legacy full-file search
Return ranked passages or distinct files with full text.
passages, files What you are looking for. A few words or a whole question both work.
"What is the refund policy?"
Maximum passages in passages mode, or distinct files in files mode. Defaults to 10.
1 <= x <= 500Include external records connected to each matched file as sources. The file reference is always present. Defaults to true.
Also search query rewrites. Defaults to true.
Response
Matching passages or full files, best match first. One page; there is no next.
- Option 1
- Option 2
Type discriminator. Always list.
list The search this page came from.
"/v1/search/hybrid"
Always false. A search answers the best matches in one page and has no next page.
false
Always null. A search has no position to resume from, so there is no cursor to pass back.
null
Matching passages or full files, best match first.