Watson Discovery

% pip install novastack-retrievers-watson-discovery

WatsonDiscoveryRetriever

Bases: BaseRetriever

Provides functionality to interact with IBM Watson Discovery for querying documents.

For more information, see IBM Watson Discovery Getting Started

Attributes:

Name	Type	Description
url	str	Watson Discovery instance URL.
api_key	str	Watson Discovery API key.
project_id	str	Watson Discovery project ID.
version	str	Watson Discovery API version. Defaults to 2023-03-31.
disable_passages	bool	Return the full document instead of passages. Only enable this if all documents are short. Defaults to False.

Example

from novastack.retrievers.watson_discovery import WatsonDiscoveryRetriever

doc_retriever = WatsonDiscoveryRetriever(
    url="your_url", api_key="your_api_key", project_id="your_project_id"
)

docs = doc_retriever.query_documents("What's novastack Framework?")

query_documents

query_documents(query: str, **kwargs: Any) -> list[DocumentWithScore]

Query and retrieve relevant documents.

Parameters:

Name	Type	Description	Default
query	str	Query text.	required
**kwargs	Any	Additional keyword arguments to customize the LLM completion request.	{}