This preview documentation is deprecated.

Discovery for Media has been renamed to media recommendations. It is now part of Vertex AI Search, and you can manage it using the Search and Conversation console. We recommend that you use the Search and Conversation console. After March 31, 2024, the Discovery Engine console will no longer be available.

For information about what's changing, see Switch from Discovery for Media to media recommendations. For more information about recommendations in Vertex AI Search, see About recommendations.

Method: projects.locations.dataStores.branches.documents.create

HTTP request
Path parameters
Query parameters
Request body
Response body
Authorization scopes
IAM Permissions
Try it!

Creates a Document.

HTTP request

POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters

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

parent

string

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

Query parameters

Parameters

Parameters
`documentId`	`string` Required. The ID to use for the `Document`, which will become 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 `Document`s with the same `parent`. Otherwise, an `ALREADY_EXISTS` error is returned. This field must conform to RFC-1034 standard with a length limit of 63 characters. Otherwise, an `INVALID_ARGUMENT` error is returned.

documentId

string

Required. The ID to use for the Document, which will become 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 63 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.