google-cloud-discovery_engine-v1 0.6.0 → 0.7.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +5 -1
- data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +5 -1
- data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +49 -0
- data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +49 -21
- data/lib/google/cloud/discovery_engine/v1/document_service/paths.rb +21 -0
- data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +49 -21
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/client.rb +553 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/credentials.rb +47 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/paths.rb +154 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/client.rb +520 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest/service_stub.rb +145 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service/rest.rb +52 -0
- data/lib/google/cloud/discovery_engine/v1/recommendation_service.rb +55 -0
- data/lib/google/cloud/discovery_engine/v1/rest.rb +1 -0
- data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +12 -6
- data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +45 -0
- data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +12 -6
- data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
- data/lib/google/cloud/discovery_engine/v1.rb +1 -0
- data/lib/google/cloud/discoveryengine/v1/common_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/document_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +3 -1
- data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +13 -1
- data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +1 -1
- data/lib/google/cloud/discoveryengine/v1/recommendation_service_pb.rb +55 -0
- data/lib/google/cloud/discoveryengine/v1/recommendation_service_services_pb.rb +45 -0
- data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +4 -1
- data/proto_docs/google/api/client.rb +4 -0
- data/proto_docs/google/cloud/discoveryengine/v1/common.rb +9 -1
- data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +5 -0
- data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +16 -0
- data/proto_docs/google/cloud/discoveryengine/v1/document.rb +7 -0
- data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +4 -0
- data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +2 -2
- data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +311 -22
- data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +3 -0
- data/proto_docs/google/cloud/discoveryengine/v1/recommendation_service.rb +228 -0
- data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +129 -21
- data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +16 -11
- metadata +12 -2
checksums.yaml
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
---
|
2
2
|
SHA256:
|
3
|
-
metadata.gz:
|
4
|
-
data.tar.gz:
|
3
|
+
metadata.gz: 738e9fee5d0953eb87a1a9fa39b9e1b23e20ffb85010bb616b83896e5d3c30cd
|
4
|
+
data.tar.gz: 72d222f9beac6dd6558e1c7e7e451646aefe607c8f09e1f7ea94d8937a427c15
|
5
5
|
SHA512:
|
6
|
-
metadata.gz:
|
7
|
-
data.tar.gz:
|
6
|
+
metadata.gz: c1163c3027d26aadfcbfb7bf38d0d82944c1b3351dfea309dd878ed27e7a587decc7dc77ea544b7232de69686378fd622823f2e73685ad07bd99a84150c6a63a
|
7
|
+
data.tar.gz: e11224db4a0342ff2d30b14232cba1f0f336b6e0c8ba2fd2137ef9ac4dc0a6619eb6e56c2f59943abd1f2b50c40c95ae626193f8cc9d4e92559c58df52733de5
|
@@ -193,7 +193,7 @@ module Google
|
|
193
193
|
# @param options [::Gapic::CallOptions, ::Hash]
|
194
194
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
195
195
|
#
|
196
|
-
# @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil)
|
196
|
+
# @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil, boost_spec: nil)
|
197
197
|
# Pass arguments to `converse_conversation` via keyword arguments. Note that at
|
198
198
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
199
199
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -254,6 +254,10 @@ module Google
|
|
254
254
|
# For more information about filtering including syntax and filter
|
255
255
|
# operators, see
|
256
256
|
# [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
257
|
+
# @param boost_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec, ::Hash]
|
258
|
+
# Boost specification to boost certain documents in search results which may
|
259
|
+
# affect the converse response. For more information on boosting, see
|
260
|
+
# [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
257
261
|
#
|
258
262
|
# @yield [response, operation] Access the result along with the RPC operation
|
259
263
|
# @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse]
|
@@ -186,7 +186,7 @@ module Google
|
|
186
186
|
# @param options [::Gapic::CallOptions, ::Hash]
|
187
187
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
188
188
|
#
|
189
|
-
# @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil)
|
189
|
+
# @overload converse_conversation(name: nil, query: nil, serving_config: nil, conversation: nil, safe_search: nil, user_labels: nil, summary_spec: nil, filter: nil, boost_spec: nil)
|
190
190
|
# Pass arguments to `converse_conversation` via keyword arguments. Note that at
|
191
191
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
192
192
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -247,6 +247,10 @@ module Google
|
|
247
247
|
# For more information about filtering including syntax and filter
|
248
248
|
# operators, see
|
249
249
|
# [Filter](https://cloud.google.com/generative-ai-app-builder/docs/filter-search-metadata)
|
250
|
+
# @param boost_spec [::Google::Cloud::DiscoveryEngine::V1::SearchRequest::BoostSpec, ::Hash]
|
251
|
+
# Boost specification to boost certain documents in search results which may
|
252
|
+
# affect the converse response. For more information on boosting, see
|
253
|
+
# [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
|
250
254
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
251
255
|
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::ConverseConversationResponse]
|
252
256
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -88,6 +88,55 @@ module Google
|
|
88
88
|
resource.call(**args)
|
89
89
|
end
|
90
90
|
|
91
|
+
##
|
92
|
+
# Create a fully-qualified Schema resource string.
|
93
|
+
#
|
94
|
+
# @overload schema_path(project:, location:, data_store:, schema:)
|
95
|
+
# The resource will be in the following format:
|
96
|
+
#
|
97
|
+
# `projects/{project}/locations/{location}/dataStores/{data_store}/schemas/{schema}`
|
98
|
+
#
|
99
|
+
# @param project [String]
|
100
|
+
# @param location [String]
|
101
|
+
# @param data_store [String]
|
102
|
+
# @param schema [String]
|
103
|
+
#
|
104
|
+
# @overload schema_path(project:, location:, collection:, data_store:, schema:)
|
105
|
+
# The resource will be in the following format:
|
106
|
+
#
|
107
|
+
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/schemas/{schema}`
|
108
|
+
#
|
109
|
+
# @param project [String]
|
110
|
+
# @param location [String]
|
111
|
+
# @param collection [String]
|
112
|
+
# @param data_store [String]
|
113
|
+
# @param schema [String]
|
114
|
+
#
|
115
|
+
# @return [::String]
|
116
|
+
def schema_path **args
|
117
|
+
resources = {
|
118
|
+
"data_store:location:project:schema" => (proc do |project:, location:, data_store:, schema:|
|
119
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
120
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
121
|
+
raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
|
122
|
+
|
123
|
+
"projects/#{project}/locations/#{location}/dataStores/#{data_store}/schemas/#{schema}"
|
124
|
+
end),
|
125
|
+
"collection:data_store:location:project:schema" => (proc do |project:, location:, collection:, data_store:, schema:|
|
126
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
127
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
128
|
+
raise ::ArgumentError, "collection cannot contain /" if collection.to_s.include? "/"
|
129
|
+
raise ::ArgumentError, "data_store cannot contain /" if data_store.to_s.include? "/"
|
130
|
+
|
131
|
+
"projects/#{project}/locations/#{location}/collections/#{collection}/dataStores/#{data_store}/schemas/#{schema}"
|
132
|
+
end)
|
133
|
+
}
|
134
|
+
|
135
|
+
resource = resources[args.keys.sort.join(":")]
|
136
|
+
raise ::ArgumentError, "no resource found for values #{args.keys}" if resource.nil?
|
137
|
+
resource.call(**args)
|
138
|
+
end
|
139
|
+
|
91
140
|
extend self
|
92
141
|
end
|
93
142
|
end
|
@@ -529,7 +529,7 @@ module Google
|
|
529
529
|
# @param options [::Gapic::CallOptions, ::Hash]
|
530
530
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
531
531
|
#
|
532
|
-
# @overload update_document(document: nil, allow_missing: nil)
|
532
|
+
# @overload update_document(document: nil, allow_missing: nil, update_mask: nil)
|
533
533
|
# Pass arguments to `update_document` via keyword arguments. Note that at
|
534
534
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
535
535
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -549,6 +549,9 @@ module Google
|
|
549
549
|
# If set to true, and the
|
550
550
|
# {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not found, a new
|
551
551
|
# {::Google::Cloud::DiscoveryEngine::V1::Document Document} will be created.
|
552
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
553
|
+
# Indicates which fields in the provided imported 'document' to update. If
|
554
|
+
# not set, will by default update all fields.
|
552
555
|
#
|
553
556
|
# @yield [response, operation] Access the result along with the RPC operation
|
554
557
|
# @yieldparam response [::Google::Cloud::DiscoveryEngine::V1::Document]
|
@@ -727,7 +730,7 @@ module Google
|
|
727
730
|
# @param options [::Gapic::CallOptions, ::Hash]
|
728
731
|
# Overrides the default settings for this call, e.g, timeout, retries, etc. Optional.
|
729
732
|
#
|
730
|
-
# @overload import_documents(inline_source: nil, gcs_source: nil, bigquery_source: nil, parent: nil, error_config: nil, reconciliation_mode: nil, auto_generate_ids: nil, id_field: nil)
|
733
|
+
# @overload import_documents(inline_source: nil, gcs_source: nil, bigquery_source: nil, fhir_store_source: nil, spanner_source: nil, cloud_sql_source: nil, firestore_source: nil, bigtable_source: nil, parent: nil, error_config: nil, reconciliation_mode: nil, update_mask: nil, auto_generate_ids: nil, id_field: nil)
|
731
734
|
# Pass arguments to `import_documents` via keyword arguments. Note that at
|
732
735
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
733
736
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -738,6 +741,16 @@ module Google
|
|
738
741
|
# Cloud Storage location for the input content.
|
739
742
|
# @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource, ::Hash]
|
740
743
|
# BigQuery input source.
|
744
|
+
# @param fhir_store_source [::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource, ::Hash]
|
745
|
+
# FhirStore input source.
|
746
|
+
# @param spanner_source [::Google::Cloud::DiscoveryEngine::V1::SpannerSource, ::Hash]
|
747
|
+
# Spanner input source.
|
748
|
+
# @param cloud_sql_source [::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource, ::Hash]
|
749
|
+
# Cloud SQL input source.
|
750
|
+
# @param firestore_source [::Google::Cloud::DiscoveryEngine::V1::FirestoreSource, ::Hash]
|
751
|
+
# Firestore input source.
|
752
|
+
# @param bigtable_source [::Google::Cloud::DiscoveryEngine::V1::BigtableSource, ::Hash]
|
753
|
+
# Cloud Bigtable input source.
|
741
754
|
# @param parent [::String]
|
742
755
|
# Required. The parent branch resource name, such as
|
743
756
|
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
@@ -748,6 +761,9 @@ module Google
|
|
748
761
|
# The mode of reconciliation between existing documents and the documents to
|
749
762
|
# be imported. Defaults to
|
750
763
|
# {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
|
764
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
765
|
+
# Indicates which fields in the provided imported documents to update. If
|
766
|
+
# not set, the default is to update all fields.
|
751
767
|
# @param auto_generate_ids [::Boolean]
|
752
768
|
# Whether to automatically generate IDs for the documents if absent.
|
753
769
|
#
|
@@ -762,42 +778,54 @@ module Google
|
|
762
778
|
# {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#id_field id_field},
|
763
779
|
# otherwise, documents without IDs fail to be imported.
|
764
780
|
#
|
765
|
-
#
|
766
|
-
#
|
767
|
-
# {::Google::Cloud::DiscoveryEngine::V1::
|
781
|
+
# Supported data sources:
|
782
|
+
#
|
783
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource}.
|
768
784
|
# {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
|
769
|
-
# or
|
785
|
+
# must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
786
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}.
|
770
787
|
# {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
|
771
|
-
#
|
788
|
+
# must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
789
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::SpannerSource SpannerSource}.
|
790
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
|
791
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
|
792
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
|
772
793
|
# @param id_field [::String]
|
773
|
-
# The field
|
774
|
-
#
|
794
|
+
# The field indicates the ID field or column to be used as unique IDs of
|
795
|
+
# the documents.
|
775
796
|
#
|
776
797
|
# For {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} it is the key of
|
777
798
|
# the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`.
|
778
|
-
# For
|
779
|
-
#
|
799
|
+
# For others, it may be the column name of the table where the unique ids are
|
800
|
+
# stored.
|
780
801
|
#
|
781
|
-
# The values of the JSON field or the
|
802
|
+
# The values of the JSON field or the table column are used as the
|
782
803
|
# {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s. The JSON field
|
783
|
-
# or the
|
784
|
-
#
|
804
|
+
# or the table column must be of string type, and the values must be set as
|
805
|
+
# valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
785
806
|
# with 1-63 characters. Otherwise, documents without valid IDs fail to be
|
786
807
|
# imported.
|
787
808
|
#
|
788
|
-
# Only set this field when
|
789
|
-
# {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
|
790
|
-
# {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}, and when
|
791
|
-
# {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
|
792
|
-
# or
|
793
|
-
# {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
|
794
|
-
# is `custom`. And only set this field when
|
809
|
+
# Only set this field when
|
795
810
|
# {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#auto_generate_ids auto_generate_ids}
|
796
811
|
# is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
797
812
|
#
|
798
813
|
# If it is unset, a default value `_id` is used when importing from the
|
799
814
|
# allowed data sources.
|
800
815
|
#
|
816
|
+
# Supported data sources:
|
817
|
+
#
|
818
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource}.
|
819
|
+
# {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
|
820
|
+
# must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
821
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}.
|
822
|
+
# {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
|
823
|
+
# must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
824
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::SpannerSource SpannerSource}.
|
825
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
|
826
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
|
827
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
|
828
|
+
#
|
801
829
|
# @yield [response, operation] Access the result along with the RPC operation
|
802
830
|
# @yieldparam response [::Gapic::Operation]
|
803
831
|
# @yieldparam operation [::GRPC::ActiveCall::Operation]
|
@@ -126,6 +126,27 @@ module Google
|
|
126
126
|
resource.call(**args)
|
127
127
|
end
|
128
128
|
|
129
|
+
##
|
130
|
+
# Create a fully-qualified FhirStore resource string.
|
131
|
+
#
|
132
|
+
# The resource will be in the following format:
|
133
|
+
#
|
134
|
+
# `projects/{project}/locations/{location}/datasets/{dataset}/fhirStores/{fhir_store}`
|
135
|
+
#
|
136
|
+
# @param project [String]
|
137
|
+
# @param location [String]
|
138
|
+
# @param dataset [String]
|
139
|
+
# @param fhir_store [String]
|
140
|
+
#
|
141
|
+
# @return [::String]
|
142
|
+
def fhir_store_path project:, location:, dataset:, fhir_store:
|
143
|
+
raise ::ArgumentError, "project cannot contain /" if project.to_s.include? "/"
|
144
|
+
raise ::ArgumentError, "location cannot contain /" if location.to_s.include? "/"
|
145
|
+
raise ::ArgumentError, "dataset cannot contain /" if dataset.to_s.include? "/"
|
146
|
+
|
147
|
+
"projects/#{project}/locations/#{location}/datasets/#{dataset}/fhirStores/#{fhir_store}"
|
148
|
+
end
|
149
|
+
|
129
150
|
extend self
|
130
151
|
end
|
131
152
|
end
|
@@ -501,7 +501,7 @@ module Google
|
|
501
501
|
# @param options [::Gapic::CallOptions, ::Hash]
|
502
502
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
503
503
|
#
|
504
|
-
# @overload update_document(document: nil, allow_missing: nil)
|
504
|
+
# @overload update_document(document: nil, allow_missing: nil, update_mask: nil)
|
505
505
|
# Pass arguments to `update_document` via keyword arguments. Note that at
|
506
506
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
507
507
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -521,6 +521,9 @@ module Google
|
|
521
521
|
# If set to true, and the
|
522
522
|
# {::Google::Cloud::DiscoveryEngine::V1::Document Document} is not found, a new
|
523
523
|
# {::Google::Cloud::DiscoveryEngine::V1::Document Document} will be created.
|
524
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
525
|
+
# Indicates which fields in the provided imported 'document' to update. If
|
526
|
+
# not set, will by default update all fields.
|
524
527
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
525
528
|
# @yieldparam result [::Google::Cloud::DiscoveryEngine::V1::Document]
|
526
529
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|
@@ -685,7 +688,7 @@ module Google
|
|
685
688
|
# @param options [::Gapic::CallOptions, ::Hash]
|
686
689
|
# Overrides the default settings for this call, e.g, timeout, retries etc. Optional.
|
687
690
|
#
|
688
|
-
# @overload import_documents(inline_source: nil, gcs_source: nil, bigquery_source: nil, parent: nil, error_config: nil, reconciliation_mode: nil, auto_generate_ids: nil, id_field: nil)
|
691
|
+
# @overload import_documents(inline_source: nil, gcs_source: nil, bigquery_source: nil, fhir_store_source: nil, spanner_source: nil, cloud_sql_source: nil, firestore_source: nil, bigtable_source: nil, parent: nil, error_config: nil, reconciliation_mode: nil, update_mask: nil, auto_generate_ids: nil, id_field: nil)
|
689
692
|
# Pass arguments to `import_documents` via keyword arguments. Note that at
|
690
693
|
# least one keyword argument is required. To specify no parameters, or to keep all
|
691
694
|
# the default parameter values, pass an empty Hash as a request object (see above).
|
@@ -696,6 +699,16 @@ module Google
|
|
696
699
|
# Cloud Storage location for the input content.
|
697
700
|
# @param bigquery_source [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource, ::Hash]
|
698
701
|
# BigQuery input source.
|
702
|
+
# @param fhir_store_source [::Google::Cloud::DiscoveryEngine::V1::FhirStoreSource, ::Hash]
|
703
|
+
# FhirStore input source.
|
704
|
+
# @param spanner_source [::Google::Cloud::DiscoveryEngine::V1::SpannerSource, ::Hash]
|
705
|
+
# Spanner input source.
|
706
|
+
# @param cloud_sql_source [::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource, ::Hash]
|
707
|
+
# Cloud SQL input source.
|
708
|
+
# @param firestore_source [::Google::Cloud::DiscoveryEngine::V1::FirestoreSource, ::Hash]
|
709
|
+
# Firestore input source.
|
710
|
+
# @param bigtable_source [::Google::Cloud::DiscoveryEngine::V1::BigtableSource, ::Hash]
|
711
|
+
# Cloud Bigtable input source.
|
699
712
|
# @param parent [::String]
|
700
713
|
# Required. The parent branch resource name, such as
|
701
714
|
# `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}/branches/{branch}`.
|
@@ -706,6 +719,9 @@ module Google
|
|
706
719
|
# The mode of reconciliation between existing documents and the documents to
|
707
720
|
# be imported. Defaults to
|
708
721
|
# {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
|
722
|
+
# @param update_mask [::Google::Protobuf::FieldMask, ::Hash]
|
723
|
+
# Indicates which fields in the provided imported documents to update. If
|
724
|
+
# not set, the default is to update all fields.
|
709
725
|
# @param auto_generate_ids [::Boolean]
|
710
726
|
# Whether to automatically generate IDs for the documents if absent.
|
711
727
|
#
|
@@ -720,41 +736,53 @@ module Google
|
|
720
736
|
# {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#id_field id_field},
|
721
737
|
# otherwise, documents without IDs fail to be imported.
|
722
738
|
#
|
723
|
-
#
|
724
|
-
#
|
725
|
-
# {::Google::Cloud::DiscoveryEngine::V1::
|
739
|
+
# Supported data sources:
|
740
|
+
#
|
741
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource}.
|
726
742
|
# {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
|
727
|
-
# or
|
743
|
+
# must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
744
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}.
|
728
745
|
# {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
|
729
|
-
#
|
746
|
+
# must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
747
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::SpannerSource SpannerSource}.
|
748
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
|
749
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
|
750
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
|
730
751
|
# @param id_field [::String]
|
731
|
-
# The field
|
732
|
-
#
|
752
|
+
# The field indicates the ID field or column to be used as unique IDs of
|
753
|
+
# the documents.
|
733
754
|
#
|
734
755
|
# For {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} it is the key of
|
735
756
|
# the JSON field. For instance, `my_id` for JSON `{"my_id": "some_uuid"}`.
|
736
|
-
# For
|
737
|
-
#
|
757
|
+
# For others, it may be the column name of the table where the unique ids are
|
758
|
+
# stored.
|
738
759
|
#
|
739
|
-
# The values of the JSON field or the
|
760
|
+
# The values of the JSON field or the table column are used as the
|
740
761
|
# {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s. The JSON field
|
741
|
-
# or the
|
742
|
-
#
|
762
|
+
# or the table column must be of string type, and the values must be set as
|
763
|
+
# valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
|
743
764
|
# with 1-63 characters. Otherwise, documents without valid IDs fail to be
|
744
765
|
# imported.
|
745
766
|
#
|
746
|
-
# Only set this field when
|
747
|
-
# {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
|
748
|
-
# {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}, and when
|
749
|
-
# {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
|
750
|
-
# or
|
751
|
-
# {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
|
752
|
-
# is `custom`. And only set this field when
|
767
|
+
# Only set this field when
|
753
768
|
# {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#auto_generate_ids auto_generate_ids}
|
754
769
|
# is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
755
770
|
#
|
756
771
|
# If it is unset, a default value `_id` is used when importing from the
|
757
772
|
# allowed data sources.
|
773
|
+
#
|
774
|
+
# Supported data sources:
|
775
|
+
#
|
776
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource}.
|
777
|
+
# {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
|
778
|
+
# must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
779
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource}.
|
780
|
+
# {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
|
781
|
+
# must be `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
|
782
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::SpannerSource SpannerSource}.
|
783
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::CloudSqlSource CloudSqlSource}.
|
784
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::FirestoreSource FirestoreSource}.
|
785
|
+
# * {::Google::Cloud::DiscoveryEngine::V1::BigtableSource BigtableSource}.
|
758
786
|
# @yield [result, operation] Access the result along with the TransportOperation object
|
759
787
|
# @yieldparam result [::Gapic::Operation]
|
760
788
|
# @yieldparam operation [::Gapic::Rest::TransportOperation]
|