View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaImportDocumentsRequest (google_api_discovery_engine v0.3.0)
Request message for Import methods.
Attributes
-
autoGenerateIds
(type:boolean()
, default:nil
) - Whether to automatically generate IDs for the documents if absent. If set totrue
, 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 tofalse
, Document.ids have to be specified using id_field, otherwise, documents without IDs fail to be imported. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema iscustom
orcsv
. Otherwise, an INVALID_ARGUMENT error is thrown. -
bigquerySource
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaBigQuerySource.t
, default:nil
) - BigQuery input source. -
errorConfig
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaImportErrorConfig.t
, default:nil
) - The desired location of errors incurred during the Import. -
gcsSource
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaGcsSource.t
, default:nil
) - Cloud Storage location for the input content. -
idField
(type:String.t
, default:nil
) - 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. Only set this field when using GcsSource or BigQuerySource, and when GcsSource.data_schema or BigQuerySource.data_schema iscustom
. And only set this field when auto_generate_ids is unset or set asfalse
. Otherwise, an INVALID_ARGUMENT error is thrown. If it is unset, a default value_id
is used when importing from the allowed data sources. -
inlineSource
(type:GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource.t
, default:nil
) - The Inline source for the input content for documents. -
reconciliationMode
(type:String.t
, default:nil
) - The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL.
Summary
Functions
Unwrap a decoded JSON object into its complex fields.
Types
@type t() :: %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaImportDocumentsRequest{ autoGenerateIds: boolean() | nil, bigquerySource: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaBigQuerySource.t() | nil, errorConfig: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaImportErrorConfig.t() | nil, gcsSource: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaGcsSource.t() | nil, idField: String.t() | nil, inlineSource: GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaImportDocumentsRequestInlineSource.t() | nil, reconciliationMode: String.t() | nil }
Functions
Unwrap a decoded JSON object into its complex fields.