google-cloud-discovery_engine-v1 0.1.0 → 0.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (50) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +33 -4
  4. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +39 -3
  5. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +968 -0
  6. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/credentials.rb +47 -0
  7. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +176 -0
  8. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +897 -0
  9. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +450 -0
  10. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest.rb +52 -0
  11. data/lib/google/cloud/discovery_engine/v1/conversational_search_service.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1/document_service/client.rb +33 -9
  13. data/lib/google/cloud/discovery_engine/v1/document_service/operations.rb +10 -1
  14. data/lib/google/cloud/discovery_engine/v1/document_service/rest/client.rb +153 -8
  15. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +117 -0
  16. data/lib/google/cloud/discovery_engine/v1/rest.rb +2 -1
  17. data/lib/google/cloud/discovery_engine/v1/schema_service/client.rb +24 -1
  18. data/lib/google/cloud/discovery_engine/v1/schema_service/operations.rb +10 -1
  19. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/client.rb +119 -0
  20. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +117 -0
  21. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +55 -10
  22. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +67 -12
  23. data/lib/google/cloud/discovery_engine/v1/user_event_service/client.rb +29 -6
  24. data/lib/google/cloud/discovery_engine/v1/user_event_service/operations.rb +10 -1
  25. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/client.rb +74 -5
  26. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +117 -0
  27. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  28. data/lib/google/cloud/discovery_engine/v1.rb +2 -1
  29. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +2 -1
  30. data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +1 -1
  31. data/lib/google/cloud/discoveryengine/v1/conversation_pb.rb +54 -0
  32. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +61 -0
  33. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_services_pb.rb +67 -0
  34. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +1 -1
  35. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +13 -1
  36. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
  37. data/lib/google/cloud/discoveryengine/v1/user_event_service_services_pb.rb +1 -1
  38. data/proto_docs/google/api/field_behavior.rb +14 -0
  39. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +19 -2
  40. data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +15 -2
  41. data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +113 -0
  42. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +206 -0
  43. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +8 -5
  44. data/proto_docs/google/cloud/discoveryengine/v1/document_service.rb +4 -3
  45. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +23 -19
  46. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +455 -19
  47. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +44 -32
  48. data/proto_docs/google/cloud/discoveryengine/v1/user_event_service.rb +1 -1
  49. data/proto_docs/google/protobuf/field_mask.rb +229 -0
  50. metadata +38 -5
@@ -51,9 +51,10 @@ module Google
51
51
  # Use `default_branch` as the branch ID, to list documents under the default
52
52
  # branch.
53
53
  #
54
- # If the caller does not have permission to list [Documents][]s under this
55
- # branch, regardless of whether or not this branch exists, a
56
- # `PERMISSION_DENIED` error is returned.
54
+ # If the caller does not have permission to list
55
+ # {::Google::Cloud::DiscoveryEngine::V1::Document Document}s under this branch,
56
+ # regardless of whether or not this branch exists, a `PERMISSION_DENIED`
57
+ # error is returned.
57
58
  # @!attribute [rw] page_size
58
59
  # @return [::Integer]
59
60
  # Maximum number of {::Google::Cloud::DiscoveryEngine::V1::Document Document}s to
@@ -43,11 +43,15 @@ module Google
43
43
  # document must
44
44
  # have a valid {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}.
45
45
  # * `content`: Unstructured data (e.g. PDF, HTML). Each file matched by
46
- # `input_uris` will become a document, with the ID set to the first 128
46
+ # `input_uris` becomes a document, with the ID set to the first 128
47
47
  # bits of SHA256(URI) encoded as a hex string.
48
48
  # * `custom`: One custom data JSON per row in arbitrary format that conforms
49
- # the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
50
- # store. This can only be used by the GENERIC Data Store vertical.
49
+ # to the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
50
+ # data store. This can only be used by Gen App Builder.
51
+ # * `csv`: A CSV file with header conforming to the defined
52
+ # {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the
53
+ # data store. Each entry after the header is imported as a Document.
54
+ # This can only be used by Gen App Builder.
51
55
  #
52
56
  # Supported values for user even imports:
53
57
  #
@@ -98,9 +102,9 @@ module Google
98
102
  # {::Google::Cloud::DiscoveryEngine::V1::Document#json_data Document.json_data}
99
103
  # or
100
104
  # {::Google::Cloud::DiscoveryEngine::V1::Document#struct_data Document.struct_data}.
101
- # * `custom`: One custom data per row in arbitrary format that conforms the
102
- # defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
103
- # store. This can only be used by the GENERIC Data Store vertical.
105
+ # * `custom`: One custom data per row in arbitrary format that conforms to
106
+ # the defined {::Google::Cloud::DiscoveryEngine::V1::Schema Schema} of the data
107
+ # store. This can only be used by Gen App Builder.
104
108
  class BigQuerySource
105
109
  include ::Google::Protobuf::MessageExts
106
110
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -110,7 +114,7 @@ module Google
110
114
  # @!attribute [rw] gcs_prefix
111
115
  # @return [::String]
112
116
  # Cloud Storage prefix for import errors. This must be an empty,
113
- # existing Cloud Storage directory. Import errors will be written to
117
+ # existing Cloud Storage directory. Import errors are written to
114
118
  # sharded files in this directory, one per line, as a JSON-encoded
115
119
  # `google.rpc.Status` message.
116
120
  class ImportErrorConfig
@@ -121,13 +125,13 @@ module Google
121
125
  # Request message for the ImportUserEvents request.
122
126
  # @!attribute [rw] inline_source
123
127
  # @return [::Google::Cloud::DiscoveryEngine::V1::ImportUserEventsRequest::InlineSource]
124
- # Required. The Inline source for the input content for UserEvents.
128
+ # The Inline source for the input content for UserEvents.
125
129
  # @!attribute [rw] gcs_source
126
130
  # @return [::Google::Cloud::DiscoveryEngine::V1::GcsSource]
127
- # Required. Cloud Storage location for the input content.
131
+ # Cloud Storage location for the input content.
128
132
  # @!attribute [rw] bigquery_source
129
133
  # @return [::Google::Cloud::DiscoveryEngine::V1::BigQuerySource]
130
- # Required. BigQuery input source.
134
+ # BigQuery input source.
131
135
  # @!attribute [rw] parent
132
136
  # @return [::String]
133
137
  # Required. Parent DataStore resource name, of the form
@@ -172,7 +176,7 @@ module Google
172
176
  extend ::Google::Protobuf::MessageExts::ClassMethods
173
177
  end
174
178
 
175
- # Metadata related to the progress of the Import operation. This will be
179
+ # Metadata related to the progress of the Import operation. This is
176
180
  # returned by the google.longrunning.Operation.metadata field.
177
181
  # @!attribute [rw] create_time
178
182
  # @return [::Google::Protobuf::Timestamp]
@@ -192,8 +196,8 @@ module Google
192
196
  extend ::Google::Protobuf::MessageExts::ClassMethods
193
197
  end
194
198
 
195
- # Metadata related to the progress of the ImportDocuments operation. This will
196
- # be returned by the google.longrunning.Operation.metadata field.
199
+ # Metadata related to the progress of the ImportDocuments operation. This is
200
+ # returned by the google.longrunning.Operation.metadata field.
197
201
  # @!attribute [rw] create_time
198
202
  # @return [::Google::Protobuf::Timestamp]
199
203
  # Operation create time.
@@ -248,7 +252,7 @@ module Google
248
252
  # `false`, {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s have
249
253
  # to be specified using
250
254
  # {::Google::Cloud::DiscoveryEngine::V1::ImportDocumentsRequest#id_field id_field},
251
- # otherwises, documents without IDs will fail to be imported.
255
+ # otherwise, documents without IDs fail to be imported.
252
256
  #
253
257
  # Only set this field when using
254
258
  # {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
@@ -256,7 +260,7 @@ module Google
256
260
  # {::Google::Cloud::DiscoveryEngine::V1::GcsSource#data_schema GcsSource.data_schema}
257
261
  # or
258
262
  # {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource#data_schema BigQuerySource.data_schema}
259
- # is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
263
+ # is `custom` or `csv`. Otherwise, an INVALID_ARGUMENT error is thrown.
260
264
  # @!attribute [rw] id_field
261
265
  # @return [::String]
262
266
  # The field in the Cloud Storage and BigQuery sources that indicates the
@@ -267,12 +271,12 @@ module Google
267
271
  # For {::Google::Cloud::DiscoveryEngine::V1::BigQuerySource BigQuerySource} it is
268
272
  # the column name of the BigQuery table where the unique ids are stored.
269
273
  #
270
- # The values of the JSON field or the BigQuery column will be used as the
274
+ # The values of the JSON field or the BigQuery column are used as the
271
275
  # {::Google::Cloud::DiscoveryEngine::V1::Document#id Document.id}s. The JSON field
272
276
  # or the BigQuery column must be of string type, and the values must be set
273
277
  # as valid strings conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
274
- # with 1-63 characters. Otherwise, documents without valid IDs will fail to
275
- # be imported.
278
+ # with 1-63 characters. Otherwise, documents without valid IDs fail to be
279
+ # imported.
276
280
  #
277
281
  # Only set this field when using
278
282
  # {::Google::Cloud::DiscoveryEngine::V1::GcsSource GcsSource} or
@@ -304,7 +308,7 @@ module Google
304
308
  # Indicates how imported documents are reconciled with the existing documents
305
309
  # created or imported before.
306
310
  module ReconciliationMode
307
- # Defaults to INCREMENTAL.
311
+ # Defaults to `INCREMENTAL`.
308
312
  RECONCILIATION_MODE_UNSPECIFIED = 0
309
313
 
310
314
  # Inserts new documents or updates existing documents.