Search sessions for the specified query.

Deprecated

Deprecated API: Search sessions for the specified query.

Headers

AuthorizationstringRequired

Header authentication of the form Api-Key <token>

Query parameters

limitintegerOptional

The maximum number of search results to return. Defaults to None (no limit).

Request

This endpoint expects an object.
textstringRequired<=256 characters
The search text.
min_fact_ratingdoubleOptional
The minimum fact rating to filter on.
min_scoredoubleOptional
The minimum score for search results.
mmr_lambdadoubleOptional
The lambda parameter for the MMR Reranking Algorithm.
record_filtermap from strings to anyOptional
Record filter on the metadata.
search_scopeenumOptional
Search scope.
Allowed values:
search_typeenumOptional
Search type.
Allowed values:
session_idslist of stringsOptional
the session ids to search
user_idstringOptional
User ID used to determine which sessions to search.

Response

A SessionSearchResponse object representing the search results.
resultslist of objectsOptional

Errors