- API
- Python SDK
We will create a sample API request and describe the main request parameters. The best way to try it out is the Developer Platform > Search PlaygroundThe Output:The response contains an array of documents with the text chunks that matched the query criteria.
query request object contains the following main parameters:text: Natural-language search string equivalent to the Similarity filter in the SDK. It is not mandatory when filtering by entities, keywords or other filters.filters: It supports equivalent filters as the SDK described in Query Filters. For instance:timestamp,entity,keyword,source,topic,sentiment,reporting_entity, etcranking_params: Allow customers to control the search ranking algorithm. The Re-ranker is set by default with a threshold between 0.2 and 0.3 depending of the applied filters.max_chunksMaximum number of chunks to retrieve. It must be lower than or equal to 1000. The response might contain a lower number of chunks due to discarding duplicated chunks after the matching phase.

