Search
Searches the documents in a namespace.
Set multiturn: true to enable multi-turn mode, which returns a session_id and may return clarification_needed status when the system needs more information.
Set stream: true to receive results as server-sent events; see SearchStreamEvent for the event shape. The stream closes after either a session_result or error event.
Request body
Response
Successful response. When stream is false (default), returns JSON. When stream is true, returns text/event-stream.
Changes
Changed in 5 of the 8 revisions of this API.8319
- ▲
added
SearchStatusEventSearchSessionResultEventSearchErrorEventto the response bodyoneOflist for the response status200response-body-one-of-added
- ○
added response discriminator for the response status
200response-body-discriminator-added
- ▲
- ○
the response property
session_idbecame required for the status200response-property-became-required
- ○
- ▲
added the new required request property
contextnew-required-request-property
- ▲
added the new required request property
objectivenew-required-request-property
- ▲
removed
SearchNewSessionRequestSearchContinuationRequestfrom the request bodyoneOflistrequest-body-one-of-removed
- ▲
the request's body type/format changed from
/toobject/request-body-type-changed
- ▲
the response property
session_idbecame optional for the status200response-property-became-optional
- ○
added the new optional request property
filtersnew-optional-request-property
- ○
added the new optional request property
include_attributesnew-optional-request-property
- ○
added the new optional request property
multiturnnew-optional-request-property
- ○
added the new optional request property
streamnew-optional-request-property
This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog
- ▲
- ○
added the new optional request property
oneOf[subschema #1: New Session]/include_attributesnew-optional-request-property
- ○
added the new optional request property
oneOf[subschema #2: Continue Session]/include_attributesnew-optional-request-property
- ○
added
subschema #12: Globsubschema #13: Case-Insensitive Globto theoneOf[subschema #1: New Session]/filters/oneOf[subschema #3: Field Condition]/additionalProperties/request propertyoneOflistrequest-property-one-of-added
- ○
added the media type
text/event-streamfor the response with the status200response-media-type-added
- ○
added the non-success response with the status
400response-non-success-status-added
- ○
added the non-success response with the status
401response-non-success-status-added
- ○
added the non-success response with the status
404response-non-success-status-added
- ○
added the optional property
documents_scannedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
queries_executedto the response with the200statusresponse-optional-property-added
- ○
added the optional property
results/items/attributesto the response with the200statusresponse-optional-property-added
- ○
removed the
expiredenum value from thestatusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
pendingenum value from thestatusresponse property for the response status200response-property-enum-value-removed
- ○
removed the
runningenum value from thestatusresponse property for the response status200response-property-enum-value-removed
- ○
- ▲
added the new required request property
oneOf[subschema #1: New Session]/contextnew-required-request-property
- ▲
added the new required request property
oneOf[subschema #1: New Session]/objectivenew-required-request-property
- ●
removed the request property
oneOf[subschema #1: New Session]/high_level_goalrequest-property-removed
- ●
removed the request property
oneOf[subschema #1: New Session]/max_resultsrequest-property-removed
- ●
removed the request property
oneOf[subschema #1: New Session]/search_queryrequest-property-removed
- ▲