Method
lookupMatches POST
Copy POST

Lookup document retrievers and return the matching documents from the document retriever deployed with given query.

Arguments:

REQUIRED KEY TYPE DESCRIPTION
Yes deploymentToken str The deployment token used to authenticate access to created deployments. This token is only authorized to predict on deployments within this project, making it safe to embed this model in an application or website.
Yes deploymentId str A unique string identifier for the deployment created under the project.
No data str The query to search for.
No filters dict A dictionary mapping column names to a list of values to restrict the retrieved search results.
No num int If provided, will limit the number of results to the value specified.
No resultColumns List[str] If provided, will limit the column properties present in each result to those specified in this list.
No maxWords int If provided, will limit the total number of words in the results to the value specified.
No numRetrievalMarginWords int If provided, will add this number of words from left and right of the returned chunks.
No maxWordsPerChunk int If provided, will limit the number of words in each chunk to the value specified. If the value provided is smaller than the actual size of chunk on disk, which is determined during document retriever creation, the actual size of chunk will be used. I.e, chunks looked up from document retrievers will not be split into smaller chunks during lookup due to this setting.
No scoreMultiplierColumn str If provided, will use the values in this column to modify the relevance score of the returned chunks. Values in this column must be numeric.
No minScore float If provided, will filter out the results with score less than the value specified.
No requiredPhrases List[str] If provided, each result will contain at least one of the phrases in the given list. The matching is whitespace and case insensitive.
No filterClause str If provided, filter the results of the query using this sql where clause.
No crowdingLimits dict A dictionary mapping metadata columns to the maximum number of results per unique value of the column. This is used to ensure diversity of metadata attribute values in the results. If a particular attribute value has already reached its maximum count, further results with that same attribute value will be excluded from the final result set. An entry in the map can also be a map specifying the limit per attribute value rather than a single limit for all values. This allows a per value limit for attributes. If an attribute value is not present in the map its limit defaults to zero.
No includeTextSearch bool If true, combine the ranking of results from a BM25 text search over the documents with the vector search using reciprocal rank fusion. It leverages both lexical and semantic matching for better overall results. It's particularly valuable in professional, technical, or specialized fields where both precision in terminology and understanding of context are important.
Note: The arguments for the API methods follow camelCase but for Python SDK underscore_case is followed.

Response:

KEY TYPE DESCRIPTION
success Boolean true if the call succeeded, false if there was an error
result list[DocumentRetrieverLookupResult]

Exceptions:

TYPE WHEN
DataNotFoundError

deploymentId is not found.
Language:

© Copyright