Discovery Engine V1 API - Class Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest (v0.4.2)

Reference documentation and code samples for the Discovery Engine V1 API class Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest.

Request message for Import methods.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#auto_generate_ids

def auto_generate_ids() -> ::Boolean
Returns
  • (::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 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.

#auto_generate_ids=

def auto_generate_ids=(value) -> ::Boolean
Parameter
  • value (::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 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.

Returns
  • (::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 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.

#bigquery_source

def bigquery_source() -> ::Google::Cloud::DiscoveryEngine::V1::BigQuerySource
Returns

#bigquery_source=

def bigquery_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::BigQuerySource
Parameter
Returns

#error_config

def error_config() -> ::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig
Returns

#error_config=

def error_config=(value) -> ::Google::Cloud::DiscoveryEngine::V1::ImportErrorConfig
Parameter
Returns

#gcs_source

def gcs_source() -> ::Google::Cloud::DiscoveryEngine::V1::GcsSource
Returns

#gcs_source=

def gcs_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::GcsSource
Parameter
Returns

#id_field

def id_field() -> ::String
Returns
  • (::String) — 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.

#id_field=

def id_field=(value) -> ::String
Parameter
  • value (::String) — 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.

Returns
  • (::String) — 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.

#inline_source

def inline_source() -> ::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::InlineSource
Returns

#inline_source=

def inline_source=(value) -> ::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::InlineSource
Parameter
Returns

#parent

def parent() -> ::String
Returns
  • (::String) — Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.

#parent=

def parent=(value) -> ::String
Parameter
  • value (::String) — Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.
Returns
  • (::String) — Required. The parent branch resource name, such as projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}. Requires create/update permission.

#reconciliation_mode

def reconciliation_mode() -> ::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode
Returns

#reconciliation_mode=

def reconciliation_mode=(value) -> ::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode
Parameter
Returns