- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- Try it!
Bulk import of multiple Document
s. Request processing may be synchronous. Non-existing items will be created.
Note: It is possible for a subset of the Document
s to be successfully updated.
HTTP request
POST https://discoveryengine.googleapis.com/v1beta/{parent=projects/*/locations/*/collections/*/dataStores/*/branches/*}/documents:import
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. The parent branch resource name, such as |
Request body
The request body contains data with the following structure:
JSON representation |
---|
{ "errorConfig": { object ( |
Fields | |
---|---|
errorConfig |
The desired location of errors incurred during the Import. |
reconciliationMode |
The mode of reconciliation between existing documents and the documents to be imported. Defaults to |
autoGenerateIds |
Whether to automatically generate IDs for the documents if absent. If set to Only set this field when using |
idField |
The field in the Cloud Storage and BigQuery sources that indicates the unique IDs of the documents. For The values of the JSON field or the BigQuery column are used as the Only set this field when using If it is unset, a default value |
Union field source . Required. The source of the input. source can be only one of the following: |
|
inlineSource |
The Inline source for the input content for documents. |
gcsSource |
Cloud Storage location for the input content. |
bigquerySource |
BigQuery input source. |
Response body
If successful, the response body contains an instance of Operation
.
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.import
For more information, see the IAM documentation.