aito.api.similarity

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

send a query to the Similarity API

Parameters:

  • client (AitoClient) – the AitoClient instance

  • query (Dict) – the similarity 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:

SimilarityResponse or RequestError if an error occurred and not raise_for_status

Return type:

Union[SimilarityResponse, RequestError]