Bulk import of multiple Document
s. Request processing may be synchronous. Non-existing items are created.
Note: It is possible for a subset of the Document
s to be successfully updated.
HTTP request
POST https://discoveryengine.googleapis.com/v1/{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 | |
---|---|
error |
The desired location of errors incurred during the Import. |
reconciliation |
The mode of reconciliation between existing documents and the documents to be imported. Defaults to |
update |
Indicates which fields in the provided imported documents to update. If not set, the default is to update all fields. This is a comma-separated list of fully qualified names of fields. Example: |
auto |
Whether to automatically generate IDs for the documents if absent. If set to Supported data sources:
|
id |
The field indicates the ID field or column to be used as unique IDs of the documents. For The values of the JSON field or the table column are used as the Only set this field when If it is unset, a default value Supported data sources:
|
Union field source . Required. The source of the input. source can be only one of the following: |
|
inline |
The Inline source for the input content for documents. |
gcs |
Cloud Storage location for the input content. |
bigquery |
BigQuery input source. |
fhir |
FhirStore input source. |
spanner |
Spanner input source. |
cloud |
Cloud SQL input source. |
firestore |
Firestore input source. |
alloy |
AlloyDB input source. |
bigtable |
Cloud Bigtable 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.