Skip to content

docs: GenAI client - Update docstrings for RAG GenAI Module #6952

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
copybara-service merged 1 commit into from
Jun 29, 2026
+140 −9
Merged

docs: GenAI client - Update docstrings for RAG GenAI Module #6952

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
149 changes: 140 additions & 9 deletions agentplatform/_genai/rag.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1650,7 +1650,15 @@ def ask_contexts(
config: Optional[types.AskContextsConfigOrDict] = None,
) -> types.AskContextsResponse:
"""
Asks a RAG Contexts.
Agentic Retrieval Ask API for RAG.

Args:
query: The query to ask.
config: Optional configuration for the request.

Returns:
The AskContextsResponse.

"""

parameter_model = types._AskContextsRequestParameters(
Expand Down Expand Up @@ -1863,6 +1871,14 @@ def get_corpus(
) -> types.RagCorpus:
"""
Gets a RAG Corpus.

Args:
name: The name of the RagCorpus to retrieve.
config: Optional configuration for the request.

Returns:
The requested RagCorpus.

"""

parameter_model = types._GetRagCorpusRequestParameters(
Expand Down Expand Up @@ -1934,7 +1950,14 @@ def list_corpora(
self, *, config: Optional[types.ListRagCorporaConfigOrDict] = None
) -> types.ListRagCorporaResponse:
"""
Lists RagCorpora.
Lists RagCorpora for a project.

Args:
config: Optional configuration for listing corpora.

Returns:
A ListRagCorporaResponse containing the corpora.

"""

parameter_model = types._ListRagCorporaRequestParameters(
Expand Down Expand Up @@ -2006,6 +2029,14 @@ def get_file(
) -> types.RagFile:
"""
Gets a RagFile.

Args:
name: The name of the RagFile to retrieve.
config: Optional configuration for the request.

Returns:
The requested RagFile.

"""

parameter_model = types._GetRagFileRequestParameters(
Expand Down Expand Up @@ -2075,6 +2106,14 @@ def list_files(
) -> types.ListRagFilesResponse:
"""
Lists RagFile instances within a RagCorpus.

Args:
name: The name of the RagCorpus to list files from.
config: Optional configuration for the request (e.g., pagination details).

Returns:
A ListRagFilesResponse containing the files.

"""

parameter_model = types._ListRagFilesRequestParameters(
Expand Down Expand Up @@ -2143,7 +2182,14 @@ def get_config(
self, *, config: Optional[types.GetRagConfigOrDict] = None
) -> types.RagEngineConfig:
"""
Gets a RAG Engine Config.
Gets the project-level RAG Engine Config.

Args:
config: Optional configuration for the request.

Returns:
The requested RagEngineConfig.

"""

parameter_model = types._GetRagConfigRequestParameters(
Expand Down Expand Up @@ -2505,7 +2551,16 @@ def retrieve_contexts(
config: Optional[types.RetrieveContextsConfigOrDict] = None,
) -> types.RetrieveContextsResponse:
"""
Retrieves a RAG Contexts.
Retrieves contexts from a Vertex RAG store based on a query.

Args:
vertex_rag_store: The Vertex RAG store to retrieve contexts from.
query: The query to retrieve contexts for.
config: Optional configuration for the request.

Returns:
The RetrieveContextsResponse containing the relevant contexts.

"""

parameter_model = types._RetrieveRagContextsRequestParameters(
Expand Down Expand Up @@ -2893,7 +2948,13 @@ def delete_corpus(
) -> None:
"""
Deletes a RAG Corpus and waits for the delete operation to complete.

Args:
name: The name of the RagCorpus to delete, formatted as
`projects/{project}/locations/{location}/ragCorpora/{corpus_id}`.
config: The configuration to use for the RagCorpus delete request.
"""

operation = self._delete_corpus(name=name, config=config)

operation = _operations_utils.await_operation(
Expand All @@ -2916,6 +2977,11 @@ def delete_file(
) -> None:
"""
Deletes a file from a RAG Corpus and waits for the delete operation to complete.

Args:
name: The name of the RagFile to delete, formatted as
`projects/{project}/locations/{location}/ragCorpora/{corpus_id}/ragFiles/{file_id}`.
config: The configuration to use for the RagFile delete request.
"""
operation = self._delete_file(name=name, config=config)

Expand Down Expand Up @@ -3158,7 +3224,15 @@ async def ask_contexts(
config: Optional[types.AskContextsConfigOrDict] = None,
) -> types.AskContextsResponse:
"""
Asks a RAG Contexts.
Agentic Retrieval Ask API for RAG.

Args:
query: The query to ask.
config: Optional configuration for the request.

Returns:
The AskContextsResponse.

"""

parameter_model = types._AskContextsRequestParameters(
Expand Down Expand Up @@ -3377,6 +3451,14 @@ async def get_corpus(
) -> types.RagCorpus:
"""
Gets a RAG Corpus.

Args:
name: The name of the RagCorpus to retrieve.
config: Optional configuration for the request.

Returns:
The requested RagCorpus.

"""

parameter_model = types._GetRagCorpusRequestParameters(
Expand Down Expand Up @@ -3450,7 +3532,14 @@ async def list_corpora(
self, *, config: Optional[types.ListRagCorporaConfigOrDict] = None
) -> types.ListRagCorporaResponse:
"""
Lists RagCorpora.
Lists RagCorpora for a project.

Args:
config: Optional configuration for listing corpora.

Returns:
A ListRagCorporaResponse containing the corpora.

"""

parameter_model = types._ListRagCorporaRequestParameters(
Expand Down Expand Up @@ -3524,6 +3613,14 @@ async def get_file(
) -> types.RagFile:
"""
Gets a RagFile.

Args:
name: The name of the RagFile to retrieve.
config: Optional configuration for the request.

Returns:
The requested RagFile.

"""

parameter_model = types._GetRagFileRequestParameters(
Expand Down Expand Up @@ -3595,6 +3692,14 @@ async def list_files(
) -> types.ListRagFilesResponse:
"""
Lists RagFile instances within a RagCorpus.

Args:
name: The name of the RagCorpus to list files from.
config: Optional configuration for the request (e.g., pagination details).

Returns:
A ListRagFilesResponse containing the files.

"""

parameter_model = types._ListRagFilesRequestParameters(
Expand Down Expand Up @@ -3665,7 +3770,14 @@ async def get_config(
self, *, config: Optional[types.GetRagConfigOrDict] = None
) -> types.RagEngineConfig:
"""
Gets a RAG Engine Config.
Gets the project-level RAG Engine Config.

Args:
config: Optional configuration for the request.

Returns:
The requested RagEngineConfig.

"""

parameter_model = types._GetRagConfigRequestParameters(
Expand Down Expand Up @@ -4037,7 +4149,16 @@ async def retrieve_contexts(
config: Optional[types.RetrieveContextsConfigOrDict] = None,
) -> types.RetrieveContextsResponse:
"""
Retrieves a RAG Contexts.
Retrieves contexts from a Vertex RAG store based on a query.

Args:
vertex_rag_store: The Vertex RAG store to retrieve contexts from.
query: The query to retrieve contexts for.
config: Optional configuration for the request.

Returns:
The RetrieveContextsResponse containing the relevant contexts.

"""

parameter_model = types._RetrieveRagContextsRequestParameters(
Expand Down Expand Up @@ -4435,6 +4556,11 @@ async def delete_corpus(
) -> None:
"""
Deletes a RAG Corpus and waits for the delete operation to complete asynchronously.

Args:
name: The name of the RagCorpus to delete, formatted as
`projects/{project}/locations/{location}/ragCorpora/{corpus_id}`.
config: The configuration to use for the RagCorpus delete request.
"""
operation = await self._delete_corpus(name=name, config=config)

Expand All @@ -4457,7 +4583,12 @@ async def delete_file(
config: Optional[types.DeleteRagFileConfigOrDict] = None,
) -> None:
"""
Deletes a file from a RAG Corpus and waits for the delete operation to complete asynchronously.
Deletes a file from a RAG Corpus and waits for the delete operation to complete.

Args:
name: The name of the RagFile to delete, formatted as
`projects/{project}/locations/{location}/ragCorpora/{corpus_id}/ragFiles/{file_id}`.
config: The configuration to use for the RagFile delete request.
"""
operation = await self._delete_file(name=name, config=config)

Expand Down
Loading