aito.v1.api.search

aito.v1.api.search(client: AitoClient, query: Dict, raise_for_status: bool | None = None, use_job: bool = False) → SearchResponse | RequestError

send a query to the Search API

Parameters:

• client (AitoClient) – the AitoClient instance

• query (Dict) – the search query

• raise_for_status (Optional[bool]) – raise RequestError if the request fails instead of returning the error If set to None, value from Client will be used. Defaults to None

• use_job (bool) – use job fo request that takes longer than 30 seconds, defaults to False

Returns:

SearchResponse or RequestError if an error occurred and not raise_for_status

Return type:

SearchResponse