Document Retrieval
query
Generate completion using relevant chunks as context
query
Generate completion using relevant chunks as context.
Parameters
query
(str): Query textfilters
(Dict[str, Any], optional): Optional metadata filtersk
(int, optional): Number of chunks to use as context. Defaults to 4.min_score
(float, optional): Minimum similarity threshold. Defaults to 0.0.max_tokens
(int, optional): Maximum tokens in completiontemperature
(float, optional): Model temperatureuse_colpali
(bool, optional): Whether to use ColPali-style embedding model to generate the completion (only works for documents ingested withuse_colpali=True
). Defaults to True.
Returns
CompletionResponse
: Response containing the completion and source information
Example
CompletionResponse Properties
The CompletionResponse
object returned by this method has the following properties:
completion
(str): The generated completion textusage
(Dict[str, int]): Token usage informationsources
(List[ChunkSource]): Sources of chunks used in the completion