Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}. Requires create/update permission.
Request body
The request body contains data with the following structure:
JSON representation
{"errorConfig": {object (ImportErrorConfig)},"reconciliationMode": enum (ReconciliationMode),"updateMask": string,"autoGenerateIds": boolean,"idField": string,"forceRefreshContent": boolean,// Union field source can be only one of the following:"inlineSource": {object (InlineSource)},"gcsSource": {object (GcsSource)},"bigquerySource": {object (BigQuerySource)},"fhirStoreSource": {object (FhirStoreSource)},"spannerSource": {object (SpannerSource)},"cloudSqlSource": {object (CloudSqlSource)},"firestoreSource": {object (FirestoreSource)},"alloyDbSource": {object (AlloyDbSource)},"bigtableSource": {object (BigtableSource)}// End of list of possible types for union field source.}
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: "user.displayName,photo".
autoGenerateIds
boolean
Whether to automatically generate IDs for the documents if absent.
If set to true, Document.ids are automatically generated based on the hash of the payload, where IDs may not be consistent during multiple imports. In which case ReconciliationMode.FULL is highly recommended to avoid duplicate contents. If unset or set to false, Document.ids have to be specified using idField, otherwise, documents without IDs fail to be imported.
The field indicates the ID field or column to be used as unique IDs of the documents.
For GcsSource it is the key of the JSON field. For instance, my_id for JSON {"my_id": "some_uuid"}. For others, it may be the column name of the table where the unique ids are stored.
The values of the JSON field or the table column are used as the Document.ids. The JSON field or the table column must be of string type, and the values must be set as valid strings conform to RFC-1034 with 1-63 characters. Otherwise, documents without valid IDs fail to be imported.
Only set this field when autoGenerateIds is unset or set as false. Otherwise, an INVALID_ARGUMENT error is thrown.
If it is unset, a default value Id is used when importing from the allowed data sources.
[[["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-07-30 UTC."],[[["\u003cp\u003eThis endpoint supports bulk importing of multiple documents, allowing for the creation of new documents and updates to existing ones, with the possibility of synchronous request processing.\u003c/p\u003e\n"],["\u003cp\u003eThe request is made using a \u003ccode\u003ePOST\u003c/code\u003e HTTP request to a specific URL structure, which includes path parameters like the parent branch resource.\u003c/p\u003e\n"],["\u003cp\u003eThe request body allows configuration for error handling, reconciliation mode, field updates, automatic ID generation, and specification of an ID field, and also contains the data from a source.\u003c/p\u003e\n"],["\u003cp\u003eThe document import supports various data sources, such as GcsSource, BigQuerySource, SpannerSource, CloudSqlSource, FirestoreSource, AlloyDbSource, and BigtableSource, each with specific data schema requirements.\u003c/p\u003e\n"],["\u003cp\u003eSuccessful import operations return an \u003ccode\u003eOperation\u003c/code\u003e instance in the response body, and the request requires \u003ccode\u003ediscoveryengine.documents.import\u003c/code\u003e IAM permission, along with the \u003ccode\u003ehttps://www.googleapis.com/auth/cloud-platform\u003c/code\u003e OAuth scope.\u003c/p\u003e\n"]]],[],null,[]]
