Note: Vertex AI Search is being renamed to Agent Search. We are in the process of updating content to reflect the new branding.

Method: projects.locations.collections.dataStores.branches.documents.chunks.list

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes

Gets a list of Chunks.

HTTP request

GET https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}/chunks

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

Parameters
`parent`	`string` Required. The parent document resource name, such as `projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}`. If the caller does not have permission to list `Chunk`s under this document, regardless of whether or not this document exists, a `PERMISSION_DENIED` error is returned.

parent

string

Required. The parent document resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{document}.

If the caller does not have permission to list Chunks under this document, regardless of whether or not this document exists, a PERMISSION_DENIED error is returned.

Query parameters

Parameters

Parameters
`pageSize`	`integer` Maximum number of `Chunk`s to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000. If this field is negative, an `INVALID_ARGUMENT` error is returned.
`pageToken`	`string` A page token `ListChunksResponse.next_page_token`, received from a previous `ChunkService.ListChunks` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ChunkService.ListChunks` must match the call that provided the page token. Otherwise, an `INVALID_ARGUMENT` error is returned.

pageSize

integer

Maximum number of Chunks to return. If unspecified, defaults to 100. The maximum allowed value is 1000. Values above 1000 will be coerced to 1000.

If this field is negative, an INVALID_ARGUMENT error is returned.

pageToken

string

A page token ListChunksResponse.next_page_token, received from a previous ChunkService.ListChunks call. Provide this to retrieve the subsequent page.

When paginating, all other parameters provided to ChunkService.ListChunks must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.

Request body

The request body must be empty.

Response body

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

Authorization scopes

Requires one of the following OAuth scopes:

https://www.googleapis.com/auth/cloud-platform
https://www.googleapis.com/auth/discoveryengine.readwrite
https://www.googleapis.com/auth/discoveryengine.serving.readwrite

For more information, see the Authentication Overview.

Method: projects.locations.collections.dataStores.branches.documents.chunks.list Stay organized with collections Save and categorize content based on your preferences.