gen_ai_hub.document_grounding.clients.retrieval_api_client module¶

Retrieval API client for Document Grounding.

This module provides the RetrievalAPIClient class for querying and retrieving relevant content from configured data repositories. The Retrieval API combines semantic search with repository metadata filtering and supports custom retrieval configurations for chunk/document granularity.

Supported repository types:

Vector stores
External document sources (e.g., help.sap.com)

API Reference: https://api.sap.com/api/DOCUMENT_GROUNDING_API/resource/Retrieval

class gen_ai_hub.document_grounding.clients.retrieval_api_client.RetrievalAPIClient(proxy_client: GenAIHubProxyClient | None = None)¶

Bases: object

The Retrieval API enables querying and retrieving relevant content from configured data repositories, such as vector or external document sources (e.g., help.sap.com).

Retrieval combines semantic search with repository metadata filtering and supports custom retrieval configurations for chunk/document granularity.

Reference: https://api.sap.com/api/DOCUMENT_GROUNDING_API/resource/Retrieval

__init__(proxy_client: GenAIHubProxyClient | None = None)¶

Initialize the RetrievalAPIClient.

Parameters:: proxy_client (Optional[GenAIHubProxyClient], optional) – Optional proxy client for making API requests.

get_data_repositories(top: int | None = None, skip: int | None = None, count: bool | None = None) → DataRepositories¶

List all data repositories available to the tenant.

Parameters:

top (Optional[int], optional) – the number of items to return, defaults to None
skip (Optional[int], optional) – the number of items to skip, defaults to None
count (Optional[bool], optional) – whether to include a count of total items, defaults to None

Returns:

DataRepositories model containing the list of data repositories

Return type:

DataRepositories

get_data_repository_by_id(repository_id: str) → DataRepository¶

Get a single data repository by its unique ID.

Parameters:: repository_id (str) – the unique identifier of the data repository
Returns:: DataRepository model representing the data repository
Return type:: DataRepository

search(search_input: RetrievalSearchInput) → RetrievalSearchResults¶

Perform a retrieval search for relevant content.

Parameters:: search_input (RetrievalSearchInput) – RetrievalSearchInput model defining the query and filters.
Returns:: RetrievalSearchResults model containing repositories, documents, and chunks.
Return type:: RetrievalSearchResults