Method: projects.locations.ragCorpora.ragFiles.list

Lists RagFiles in a RagCorpus.

HTTP request

GET https://{service-endpoint}/v1beta1/{parent}/ragFiles

Where {service-endpoint} is one of the supported service endpoints.

Path parameters

Parameters
parent

string

Required. The resource name of the RagCorpus from which to list the RagFiles. Format: projects/{project}/locations/{location}/ragCorpora/{ragCorpus}

Query parameters

Parameters
pageSize

integer

Optional. The standard list page size.
pageToken

string

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

Request body

The request body must be empty.

Response body

Response message for VertexRagDataService.ListRagFiles.

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

JSON representation 
{
  "ragFiles": [
    {
      object (RagFile)
    }
  ],
  "nextPageToken": string
}
Fields
ragFiles[]

object (RagFile)

List of RagFiles in the requested page.
nextPageToken

string

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

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.