This preview documentation is deprecated as of October 27, 2023. For GA documentation, go to the Vertex AI Search documentation.
Changes in GA:
Name:Discovery for Media is renamed to Vertex AI Search for media. Vertex AI Search includes media recommendations and media search.
Google Cloud Console page: Use the Agent Builder page in the console. The Discovery Engine console page is deprecated.
API reference: Continue to use the discoveryengine.googleapis.com service. The API remains the same but the documentation has moved. Go to the up-to-date, GA version of the Discovery Engine API reference in the Vertex AI Search documentation.
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),"autoGenerateIds": boolean,"idField": string,// Union field source can be only one of the following:"inlineSource": {object (InlineSource)},"gcsSource": {object (GcsSource)},"bigquerySource": {object (BigQuerySource)}// End of list of possible types for union field source.}
The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
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 in the Cloud Storage and BigQuery sources that indicates the 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 BigQuerySource it is the column name of the BigQuery table where the unique ids are stored.
The values of the JSON field or the BigQuery column are used as the Document.ids. The JSON field or the BigQuery 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.
[[["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 2024-02-13 UTC."],[[["This API facilitates the bulk import of multiple documents into a specified branch, with the ability to create non-existent items."],["The HTTP request uses `POST` with a URL that follows gRPC Transcoding syntax, targeting a specific branch within a data store."],["The request body requires specifying the source of the data to import, which can be an inline source, a Google Cloud Storage (GCS) location, or a BigQuery source, with settings to manage errors and reconciliation mode."],["The import process can handle generating document IDs automatically, or use IDs provided in the source data, while specifying the field containing the ID in the `idField` parameter."],["Successful import requests will yield a response body that contains an instance of an `Operation`, and it is required that the request have the `discoveryengine.documents.import` IAM permission on the parent resource, as well as the OAuth `https://www.googleapis.com/auth/cloud-platform` scope."]]],[]]
