ImportDocumentsRequest(mapping=None, *, ignore_unknown_fields=False, **kwargs)Request message for Import methods.
This message has oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
members.
.. _oneof: https://proto-plus-python.readthedocs.io/en/stable/fields.html#oneofs-mutually-exclusive-fields
Attributes | |
|---|---|
| Name | Description |
inline_source |
google.cloud.discoveryengine_v1alpha.types.ImportDocumentsRequest.InlineSource
The Inline source for the input content for documents. This field is a member of oneof_ source.
|
gcs_source |
google.cloud.discoveryengine_v1alpha.types.GcsSource
Cloud Storage location for the input content. This field is a member of oneof_ source.
|
bigquery_source |
google.cloud.discoveryengine_v1alpha.types.BigQuerySource
BigQuery input source. This field is a member of oneof_ source.
|
parent |
str
Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}.
Requires create/update permission.
|
error_config |
google.cloud.discoveryengine_v1alpha.types.ImportErrorConfig
The desired location of errors incurred during the Import. |
reconciliation_mode |
google.cloud.discoveryengine_v1alpha.types.ImportDocumentsRequest.ReconciliationMode
The mode of reconciliation between existing documents and the documents to be imported. Defaults to ReconciliationMode.INCREMENTAL. |
auto_generate_ids |
bool
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
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
is custom or csv. Otherwise, an INVALID_ARGUMENT
error is thrown.
|
id_field |
str
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
is custom. And only set this field when
auto_generate_ids
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.
|
Classes
InlineSource
InlineSource(mapping=None, *, ignore_unknown_fields=False, **kwargs)The inline source for the input config for ImportDocuments method.
ReconciliationMode
ReconciliationMode(value)Indicates how imported documents are reconciled with the existing documents created or imported before.
Values:
RECONCILIATION_MODE_UNSPECIFIED (0):
Defaults to INCREMENTAL.
INCREMENTAL (1):
Inserts new documents or updates existing
documents.
FULL (2):
Calculates diff and replaces the entire
document dataset. Existing documents may be
deleted if they are not present in the source
location.