Skip to content

docs: GenAI client - Add example usage to RAG docstrings #6999

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

Open
copybara-service wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: GenAI client - Add example usage to RAG docstrings #6999

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
157 changes: 146 additions & 11 deletions agentplatform/_genai/rag.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2926,6 +2926,17 @@ def create_corpus(

Returns:
The created RagCorpus.

Example usage:

```
corpus = client.rag.create_corpus(
rag_corpus=types.RagCorpus(
display_name="test-corpus",
name="projects/test-project/locations/us-central1/ragCorpora/123456789",
),
)
```
"""
operation = self._create_corpus(rag_corpus=rag_corpus, config=config)

Expand Down Expand Up @@ -2954,6 +2965,14 @@ def delete_corpus(
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.

Example usage:

```
client.rag.delete_corpus(
name="projects/test-project/locations/us-central1/ragCorpora/123456789",
)
```
"""

operation = self._delete_corpus(name=name, config=config)
Expand Down Expand Up @@ -2983,6 +3002,14 @@ def delete_file(
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.

Example usage:

```
client.rag.delete_file(
name="projects/test-project/locations/us-central1/ragCorpora/123456789/ragFiles/987654321",
)
```
"""
operation = self._delete_file(name=name, config=config)

Expand Down Expand Up @@ -3016,7 +3043,19 @@ def update_corpus(

Returns:
The updated RagCorpus.

Example usage:

```
client.rag.update_corpus(
name="projects/test-project/locations/us-central1/ragCorpora/123456789",
rag_corpus=types.RagCorpus(
display_name="Updated corpus name",
),
)
```
"""

operation = self._update_corpus(name=name, rag_corpus=rag_corpus, config=config)

operation = _operations_utils.await_operation(
Expand Down Expand Up @@ -3046,6 +3085,19 @@ def update_config(

Returns:
The updated RagEngineConfig.

Example usage:

```
client.rag.update_config(
updated_config=types.RagEngineConfig(
name="projects/test-project/locations/us-central1/ragCorpora/123456789/ragEngineConfig/123456789",
rag_managed_db_config=types.RagManagedDbConfig(
basic=types.RagManagedDbConfigBasic()
),
),
)
```
"""
operation = self._update_config(
updated_config=updated_config, config=request_config
Expand Down Expand Up @@ -3073,25 +3125,25 @@ def import_files(
"""
Imports files into a Rag Corpus. To get a list of all files on the corpus after calling import_files, call list_files.

Args:
name: The name of the Rag Corpus to import files into, format:
`projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`
import_config: The configuration for importing files, including source files and processing options.
config: The configuration to use for the import request.

Returns:
The ImportRagFilesResponse from the import files operation.

Example usage:

```
client.rag.import_files(
import_files_response = client.rag.import_files(
name="projects/test-project/locations/us-central1/ragCorpora/123456789",
import_config=types.ImportRagFilesConfig(
gcs_source=types.GcsSource(uris=["gs://test-bucket/test-file.pdf"]),
),
)
```

Args:
name: The name of the Rag Corpus to import files into, format:
`projects/{project}/locations/{location}/ragCorpora/{rag_corpus_id}`
import_config: The configuration for importing files, including source files and processing options.
config: The configuration to use for the import request.

Returns:
The ImportRagFilesResponse from the import files operation.
"""
if isinstance(import_config, dict):
import_config = types.ImportRagFilesConfig.model_validate(import_config)
Expand Down Expand Up @@ -3148,6 +3200,22 @@ def upload_file(

Returns:
The uploaded RagFile.

Example usage:

```
rag_file = client.rag.upload_file(
corpus_name="projects/test-project/locations/us-central1/ragCorpora/123456789",
path="/path/to/file.pdf",
display_name="test-file",
upload_rag_file_config=types.UploadRagFileConfig(
chunk_config=types.ChunkConfig(
chunk_size=1024,
chunk_overlap=128,
),
),
)
```
"""

if not display_name:
Expand Down Expand Up @@ -4534,6 +4602,17 @@ async def create_corpus(

Returns:
The created RagCorpus.

Example usage:

```
corpus = await client.aio.rag.create_corpus(
rag_corpus=types.RagCorpus(
display_name="test-corpus",
name="projects/test-project/locations/us-central1/ragCorpora/123456789",
),
)
```
"""
operation = await self._create_corpus(rag_corpus=rag_corpus, config=config)

Expand Down Expand Up @@ -4562,6 +4641,14 @@ async def delete_corpus(
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.

Example usage:

```
await client.aio.rag.delete_corpus(
name="projects/test-project/locations/us-central1/ragCorpora/123456789",
)
```
"""
operation = await self._delete_corpus(name=name, config=config)

Expand Down Expand Up @@ -4590,6 +4677,14 @@ async def delete_file(
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.

Example usage:

```
await client.aio.rag.delete_file(
name="projects/test-project/locations/us-central1/ragCorpora/123456789/ragFiles/987654321",
)
```
"""
operation = await self._delete_file(name=name, config=config)

Expand Down Expand Up @@ -4623,6 +4718,17 @@ async def update_corpus(

Returns:
The updated RagCorpus.

Example usage:

```
await client.aio.rag.update_corpus(
name="projects/test-project/locations/us-central1/ragCorpora/123456789",
rag_corpus=types.RagCorpus(
display_name="Updated corpus name",
),
)
```
"""
operation = await self._update_corpus(
name=name, rag_corpus=rag_corpus, config=config
Expand Down Expand Up @@ -4655,6 +4761,19 @@ async def update_config(

Returns:
The updated RagEngineConfig.

Example usage:

```
await client.aio.rag.update_config(
updated_config=types.RagEngineConfig(
name="projects/test-project/locations/us-central1/ragCorpora/123456789/ragEngineConfig/123456789",
rag_managed_db_config=types.RagManagedDbConfig(
basic=types.RagManagedDbConfigBasic()
)
),
)
```
"""
operation = await self._update_config(
updated_config=updated_config, config=request_config
Expand Down Expand Up @@ -4685,7 +4804,7 @@ async def import_files(
Example usage:

```
client.rag.import_files(
import_files_response = await client.aio.rag.import_files(
name="projects/test-project/locations/us-central1/ragCorpora/123456789",
import_config=types.ImportRagFilesConfig(
gcs_source=types.GcsSource(uris=["gs://test-bucket/test-file.pdf"]),
Expand Down Expand Up @@ -4758,6 +4877,22 @@ async def upload_file(

Returns:
The uploaded RagFile.

Example usage:

```
rag_file = await client.aio.rag.upload_file(
corpus_name="projects/test-project/locations/us-central1/ragCorpora/123456789",
path="/path/to/file.pdf",
display_name="test-file",
upload_rag_file_config=types.UploadRagFileConfig(
chunk_config=types.ChunkConfig(
chunk_size=1024,
chunk_overlap=128,
),
),
)
```
"""

if not display_name:
Expand Down
Loading