Search sessions for the specified query.

POST

Search sessions for the specified query.

Query parameters

limitintegerOptional

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

Request

This endpoint expects an object.
textstringRequired

The search text.

min_fact_ratingdoubleOptional

The minimum fact rating to filter on. Only supported on cloud. Will be ignored on Community Edition.

min_scoredoubleOptional

The minimum score for search results. Only supported on cloud. Will be ignored on Community Edition.

mmr_lambdadoubleOptional

The lambda parameter for the MMR Reranking Algorithm. Only supported on cloud. Will be ignored on Community Edition.

record_filtermap from strings to anyOptional

Record filter on the metadata. Only supported on cloud. Will be ignored on Community Edition.

search_scopeenumOptional
Allowed values: messagessummaryfacts

Search scope. Only supported on cloud. On Community Edition the search scope is always “facts”.

search_type"similarity" or "mmr"Optional
Allowed values: similaritymmr

Search type. Only supported on cloud. Will be ignored on Community Edition.

session_idslist of stringsOptional

the session ids to search

user_idstringOptional

User ID used to determine which sessions to search. Required on Community Edition.

Response

This endpoint returns an object.
resultslist of objectsOptional

Errors

Built with