This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.
Changes in GA:
Name:Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Use default_branch as the branch ID, to list documents under the default branch.
If the caller does not have permission to list Documents under this branch, regardless of whether or not this branch exists, a PERMISSION_DENIED error is returned.
Query parameters
Parameters
pageSize
integer
Maximum number of Documents 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.
When paginating, all other parameters provided to DocumentService.ListDocuments must match the call that provided the page token. Otherwise, an INVALID_ARGUMENT error is returned.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2024-02-13 UTC."],[[["This webpage outlines how to retrieve a list of `Document` resources using a `GET` request in the Google Cloud Discovery Engine API."],["The request URL requires a `parent` path parameter specifying the branch under which the documents are listed, using the format `projects/*/locations/*/collections/*/dataStores/*/branches/*`."],["The `pageSize` and `pageToken` query parameters are used for pagination, allowing control over the number of documents returned and enabling retrieval of subsequent pages."],["The request body must be empty, and a successful request returns a `ListDocumentsResponse` instance."],["To successfully perform the request you need the `discoveryengine.documents.list` IAM permission on the `parent` resource and the `https://www.googleapis.com/auth/cloud-platform` authorization scope."]]],[]]
