google-cloud-discovery_engine-v1beta 0.1.0 → 0.2.1

Sign up to get free protection for your applications and to get access to all the features.
Files changed (45) hide show
  1. checksums.yaml +4 -4
  2. data/README.md +1 -1
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +4 -2
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +4 -2
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/service_stub.rb +1 -1
  6. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +57 -3
  7. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +3 -1
  8. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +57 -3
  9. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +21 -5
  10. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/service_stub.rb +7 -7
  11. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +4 -2
  12. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +4 -2
  13. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/service_stub.rb +1 -1
  14. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +4 -2
  15. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +3 -1
  16. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +4 -2
  17. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +21 -5
  18. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/service_stub.rb +5 -5
  19. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +5 -5
  20. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +5 -5
  21. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/service_stub.rb +1 -1
  22. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +4 -2
  23. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +3 -1
  24. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +4 -2
  25. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +21 -5
  26. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +3 -3
  27. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  28. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +24 -19
  29. data/lib/google/cloud/discoveryengine/v1beta/completion_service_pb.rb +24 -13
  30. data/lib/google/cloud/discoveryengine/v1beta/document_pb.rb +25 -20
  31. data/lib/google/cloud/discoveryengine/v1beta/document_service_pb.rb +25 -25
  32. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +29 -72
  33. data/lib/google/cloud/discoveryengine/v1beta/purge_config_pb.rb +25 -16
  34. data/lib/google/cloud/discoveryengine/v1beta/recommendation_service_pb.rb +27 -21
  35. data/lib/google/cloud/discoveryengine/v1beta/schema_pb.rb +25 -8
  36. data/lib/google/cloud/discoveryengine/v1beta/schema_service_pb.rb +26 -37
  37. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +27 -107
  38. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +27 -62
  39. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +25 -11
  40. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +54 -0
  41. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +1 -3
  42. data/proto_docs/google/protobuf/any.rb +7 -4
  43. data/proto_docs/google/protobuf/struct.rb +1 -1
  44. data/proto_docs/google/protobuf/timestamp.rb +1 -3
  45. metadata +4 -4
@@ -236,6 +236,60 @@ module Google
236
236
  # The mode of reconciliation between existing documents and the documents to
237
237
  # be imported. Defaults to
238
238
  # {::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::ReconciliationMode::INCREMENTAL ReconciliationMode.INCREMENTAL}.
239
+ # @!attribute [rw] auto_generate_ids
240
+ # @return [::Boolean]
241
+ # Whether to automatically generate IDs for the documents if absent.
242
+ #
243
+ # If set to `true`,
244
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id}s are
245
+ # automatically generated based on the hash of the payload, where IDs may not
246
+ # be consistent during multiple imports. In which case
247
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest::ReconciliationMode::FULL ReconciliationMode.FULL}
248
+ # is highly recommended to avoid duplicate contents. If unset or set to
249
+ # `false`, {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id}s
250
+ # have to be specified using
251
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest#id_field id_field},
252
+ # otherwises, documents without IDs will fail to be imported.
253
+ #
254
+ # Only set this field when using
255
+ # {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource GcsSource} or
256
+ # {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource BigQuerySource}, and
257
+ # when
258
+ # {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource#data_schema GcsSource.data_schema}
259
+ # or
260
+ # {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource#data_schema BigQuerySource.data_schema}
261
+ # is `custom`. Otherwise, an INVALID_ARGUMENT error is thrown.
262
+ # @!attribute [rw] id_field
263
+ # @return [::String]
264
+ # The field in the Cloud Storage and BigQuery sources that indicates the
265
+ # unique IDs of the documents.
266
+ #
267
+ # For {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource GcsSource} it is the
268
+ # key of the JSON field. For instance, `my_id` for JSON `{"my_id":
269
+ # "some_uuid"}`. For
270
+ # {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource BigQuerySource} it is
271
+ # the column name of the BigQuery table where the unique ids are stored.
272
+ #
273
+ # The values of the JSON field or the BigQuery column will be used as the
274
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document#id Document.id}s. The JSON
275
+ # field or the BigQuery column must be of string type, and the values must be
276
+ # set as valid strings conform to
277
+ # [RFC-1034](https://tools.ietf.org/html/rfc1034) with 1-63 characters.
278
+ # Otherwise, documents without valid IDs will fail to be imported.
279
+ #
280
+ # Only set this field when using
281
+ # {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource GcsSource} or
282
+ # {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource BigQuerySource}, and
283
+ # when
284
+ # {::Google::Cloud::DiscoveryEngine::V1beta::GcsSource#data_schema GcsSource.data_schema}
285
+ # or
286
+ # {::Google::Cloud::DiscoveryEngine::V1beta::BigQuerySource#data_schema BigQuerySource.data_schema}
287
+ # is `custom`. And only set this field when
288
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ImportDocumentsRequest#auto_generate_ids auto_generate_ids}
289
+ # is unset or set as `false`. Otherwise, an INVALID_ARGUMENT error is thrown.
290
+ #
291
+ # If it is unset, a default value `_id` is used when importing from the
292
+ # allowed data sources.
239
293
  class ImportDocumentsRequest
240
294
  include ::Google::Protobuf::MessageExts
241
295
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -100,9 +100,7 @@ module Google
100
100
  # @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
101
101
  # Additional search parameters.
102
102
  #
103
- # For
104
- # [IndustryVertical.SITE_SEARCH][google.cloud.discoveryengine.v1beta.IndustryVertical.SITE_SEARCH]
105
- # vertical, supported values are:
103
+ # For public website search only, supported values are:
106
104
  #
107
105
  # * `user_country_code`: string. Default empty. If set to non-empty, results
108
106
  # are restricted or boosted based on the location provided.
@@ -43,8 +43,12 @@ module Google
43
43
  # if (any.is(Foo.class)) {
44
44
  # foo = any.unpack(Foo.class);
45
45
  # }
46
+ # // or ...
47
+ # if (any.isSameTypeAs(Foo.getDefaultInstance())) {
48
+ # foo = any.unpack(Foo.getDefaultInstance());
49
+ # }
46
50
  #
47
- # Example 3: Pack and unpack a message in Python.
51
+ # Example 3: Pack and unpack a message in Python.
48
52
  #
49
53
  # foo = Foo(...)
50
54
  # any = Any()
@@ -54,7 +58,7 @@ module Google
54
58
  # any.Unpack(foo)
55
59
  # ...
56
60
  #
57
- # Example 4: Pack and unpack a message in Go
61
+ # Example 4: Pack and unpack a message in Go
58
62
  #
59
63
  # foo := &pb.Foo{...}
60
64
  # any, err := anypb.New(foo)
@@ -73,9 +77,8 @@ module Google
73
77
  # in the type URL, for example "foo.bar.com/x/y.z" will yield type
74
78
  # name "y.z".
75
79
  #
76
- #
77
80
  # JSON
78
- #
81
+ # ====
79
82
  # The JSON representation of an `Any` value uses the regular
80
83
  # representation of the deserialized, embedded message, with an
81
84
  # additional field `@type` which contains the type URL. Example:
@@ -87,7 +87,7 @@ module Google
87
87
  # `NullValue` is a singleton enumeration to represent the null value for the
88
88
  # `Value` type union.
89
89
  #
90
- # The JSON representation for `NullValue` is JSON `null`.
90
+ # The JSON representation for `NullValue` is JSON `null`.
91
91
  module NullValue
92
92
  # Null value.
93
93
  NULL_VALUE = 0
@@ -69,7 +69,6 @@ module Google
69
69
  # Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
70
70
  # .setNanos((int) ((millis % 1000) * 1000000)).build();
71
71
  #
72
- #
73
72
  # Example 5: Compute Timestamp from Java `Instant.now()`.
74
73
  #
75
74
  # Instant now = Instant.now();
@@ -78,7 +77,6 @@ module Google
78
77
  # Timestamp.newBuilder().setSeconds(now.getEpochSecond())
79
78
  # .setNanos(now.getNano()).build();
80
79
  #
81
- #
82
80
  # Example 6: Compute Timestamp from current time in Python.
83
81
  #
84
82
  # timestamp = Timestamp()
@@ -108,7 +106,7 @@ module Google
108
106
  # [`strftime`](https://docs.python.org/2/library/time.html#time.strftime) with
109
107
  # the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one can use
110
108
  # the Joda Time's [`ISODateTimeFormat.dateTime()`](
111
- # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime%2D%2D
109
+ # http://joda-time.sourceforge.net/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime()
112
110
  # ) to obtain a formatter capable of generating timestamps in this format.
113
111
  # @!attribute [rw] seconds
114
112
  # @return [::Integer]
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-cloud-discovery_engine-v1beta
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.1.0
4
+ version: 0.2.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2023-05-24 00:00:00.000000000 Z
11
+ date: 2023-06-06 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: gapic-common
@@ -16,7 +16,7 @@ dependencies:
16
16
  requirements:
17
17
  - - ">="
18
18
  - !ruby/object:Gem::Version
19
- version: 0.18.0
19
+ version: 0.19.1
20
20
  - - "<"
21
21
  - !ruby/object:Gem::Version
22
22
  version: 2.a
@@ -26,7 +26,7 @@ dependencies:
26
26
  requirements:
27
27
  - - ">="
28
28
  - !ruby/object:Gem::Version
29
- version: 0.18.0
29
+ version: 0.19.1
30
30
  - - "<"
31
31
  - !ruby/object:Gem::Version
32
32
  version: 2.a