Method: projects.locations.dataStores.branches.documents.create
Stay organized with collections
Save and categorize content based on your preferences.
HTTP request
POST https://discoveryengine.googleapis.com/v1alpha/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents
The URL uses gRPC Transcoding syntax.
Path parameters
| Parameters |
parent |
string
Required. The parent resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}.
|
Query parameters
| Parameters |
documentId |
string
Required. The ID to use for the Document, which becomes the final component of the Document.name. If the caller does not have permission to create the Document, regardless of whether or not it exists, a PERMISSION_DENIED error is returned. This field must be unique among all Documents with the same parent. Otherwise, an ALREADY_EXISTS error is returned. This field must conform to RFC-1034 standard with a length limit of 128 characters. Otherwise, an INVALID_ARGUMENT error is returned.
|
Request body
The request body contains an instance of Document.
Response body
If successful, the response body contains a newly created instance of Document.
Authorization scopes
Requires the following OAuth scope:
https://www.googleapis.com/auth/cloud-platform
For more information, see the Authentication Overview.
IAM Permissions
Requires the following IAM permission on the parent resource:
discoveryengine.documents.create
For more information, see the IAM documentation.
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-03-03 UTC.
[[["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 2025-03-03 UTC."],[[["This API call creates a new Document resource within a specified branch of a data store, as indicated by the `parent` path parameter."],["The HTTP request uses `POST` method to the specified URL and requires `parent` as a path parameter, following gRPC Transcoding syntax."],["The `documentId` is required as a query parameter to uniquely identify the Document being created and must adhere to RFC-1034 with a maximum length of 128 characters."],["The request body must contain an instance of a Document, and a successful call will return the newly created Document in the response body."],["This operation requires the OAuth scope `https://www.googleapis.com/auth/cloud-platform` and the IAM permission `discoveryengine.documents.create` on the parent resource."]]],[]]
