Method: projects.locations.ragCorpora.ragFiles.get

Gets a RagFile.

Endpoint

get https://aiplatform.googleapis.com/v1beta1/{name}

Path parameters

name string

Required. The name of the RagFile resource. Format: projects/{project}/locations/{location}/ragCorpora/{ragCorpus}/ragFiles/{ragFile}

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"
# file_name = "projects/{PROJECT_ID}/locations/us-central1/ragCorpora/{rag_corpus_id}/ragFiles/{rag_file_id}"

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

rag_file = rag.get_file(name=file_name)
print(rag_file)
# Example response:
# RagFile(name='projects/1234567890/locations/us-central1/ragCorpora/11111111111/ragFiles/22222222222',
# display_name='file_display_name', description='file description')

get_file_example.py

Response body

If successful, the response body contains an instance of RagFile.