Method: projects.locations.ragCorpora.list

Lists RagCorpora in a Location.

Endpoint

get https://aiplatform.googleapis.com/v1beta1/{parent}/ragCorpora

Path parameters

parent string

Required. The resource name of the Location from which to list the RagCorpora. Format: projects/{project}/locations/{location}

Query parameters

pageSize integer

Optional. The standard list page size.

pageToken string

Optional. The standard list page token. Typically obtained via ListRagCorporaResponse.next_page_token of the previous VertexRagDataService.ListRagCorpora call.

Request body

The request body must be empty.

Example request

Python


from vertexai.preview import rag
import vertexai

# TODO(developer): Update and un-comment below lines
# PROJECT_ID = "your-project-id"

# Initialize Vertex AI API once per session
vertexai.init(project=PROJECT_ID, location="us-central1")

corpora = rag.list_corpora()
print(corpora)
# Example response:
# ListRagCorporaPager<rag_corpora {
#   name: "projects/[PROJECT_ID]/locations/us-central1/ragCorpora/2305843009213693952"
#   display_name: "test_corpus"
#   create_time {
# ...
list_corpora_example.py

Response body

Response message for VertexRagDataService.ListRagCorpora.

If successful, the response body contains data with the following structure:

Fields

ragCorpora[] object (RagCorpus)

List of RagCorpora in the requested page.

nextPageToken string

A token to retrieve the next page of results. Pass to ListRagCorporaRequest.page_token to obtain that page.

JSON representation
{ "ragCorpora": [ { object (`RagCorpus`) } ], "nextPageToken": string }