google-cloud-discovery_engine-v1beta 0.11.0 → 0.12.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (115) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1beta/completion_service/client.rb +9 -3
  3. data/lib/google/cloud/discovery_engine/v1beta/completion_service/operations.rb +13 -5
  4. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/client.rb +9 -3
  5. data/lib/google/cloud/discovery_engine/v1beta/completion_service/rest/operations.rb +21 -6
  6. data/lib/google/cloud/discovery_engine/v1beta/control_service/client.rb +875 -0
  7. data/lib/google/cloud/discovery_engine/v1beta/control_service/credentials.rb +47 -0
  8. data/lib/google/cloud/discovery_engine/v1beta/control_service/paths.rb +167 -0
  9. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/client.rb +814 -0
  10. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest/service_stub.rb +440 -0
  11. data/lib/google/cloud/discovery_engine/v1beta/control_service/rest.rb +55 -0
  12. data/lib/google/cloud/discovery_engine/v1beta/control_service.rb +58 -0
  13. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/client.rb +31 -15
  14. data/lib/google/cloud/discovery_engine/v1beta/conversational_search_service/rest/client.rb +31 -15
  15. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/client.rb +15 -7
  16. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/operations.rb +13 -5
  17. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/client.rb +15 -7
  18. data/lib/google/cloud/discovery_engine/v1beta/data_store_service/rest/operations.rb +21 -6
  19. data/lib/google/cloud/discovery_engine/v1beta/document_service/client.rb +24 -15
  20. data/lib/google/cloud/discovery_engine/v1beta/document_service/operations.rb +13 -5
  21. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/client.rb +24 -15
  22. data/lib/google/cloud/discovery_engine/v1beta/document_service/rest/operations.rb +21 -6
  23. data/lib/google/cloud/discovery_engine/v1beta/engine_service/client.rb +19 -8
  24. data/lib/google/cloud/discovery_engine/v1beta/engine_service/operations.rb +13 -5
  25. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/client.rb +19 -8
  26. data/lib/google/cloud/discovery_engine/v1beta/engine_service/rest/operations.rb +21 -6
  27. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +25 -3
  28. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +25 -3
  29. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +485 -0
  30. data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +47 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +809 -0
  32. data/lib/google/cloud/discovery_engine/v1beta/project_service/paths.rb +47 -0
  33. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +452 -0
  34. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +1092 -0
  35. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +129 -0
  36. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest.rb +54 -0
  37. data/lib/google/cloud/discovery_engine/v1beta/project_service.rb +57 -0
  38. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +24 -2
  39. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +24 -2
  40. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +24 -19
  41. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +66 -0
  42. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +24 -19
  43. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +2 -0
  44. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +18 -10
  45. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +13 -5
  46. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +18 -10
  47. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +21 -6
  48. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +15 -8
  49. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +15 -8
  50. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +104 -2
  51. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +13 -5
  52. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +97 -2
  53. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +21 -6
  54. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +59 -0
  55. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +9 -3
  56. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +9 -3
  57. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +27 -12
  58. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +13 -5
  59. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +27 -12
  60. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +21 -6
  61. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -6
  62. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +13 -5
  63. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/paths.rb +21 -0
  64. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -6
  65. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +21 -6
  66. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
  67. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  68. data/lib/google/cloud/discovery_engine/v1beta.rb +2 -0
  69. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +3 -1
  70. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
  71. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +55 -0
  72. data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +57 -0
  73. data/lib/google/cloud/discoveryengine/v1beta/control_service_services_pb.rb +69 -0
  74. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
  75. data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +48 -0
  76. data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +1 -1
  77. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
  78. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +1 -1
  79. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +1 -1
  80. data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +49 -0
  81. data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +50 -0
  82. data/lib/google/cloud/discoveryengine/v1beta/project_service_services_pb.rb +51 -0
  83. data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +1 -1
  84. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +5 -1
  85. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +2 -0
  86. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
  87. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  88. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
  89. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
  90. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +9 -1
  91. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +16 -0
  92. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +209 -0
  93. data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +126 -0
  94. data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -2
  95. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +19 -3
  96. data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +75 -0
  97. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +2 -2
  98. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +1 -0
  99. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +6 -7
  100. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +3 -3
  101. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +39 -1
  102. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +3 -0
  103. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +4 -4
  104. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +106 -0
  105. data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +57 -0
  106. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +28 -0
  107. data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +20 -19
  108. data/proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb +5 -5
  109. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +30 -24
  110. data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +31 -0
  111. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +4 -1
  112. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +3 -0
  113. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +24 -3
  114. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +13 -1
  115. metadata +30 -2
@@ -0,0 +1,106 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1beta
24
+ # Metadata and configurations for a Google Cloud project in the service.
25
+ # @!attribute [r] name
26
+ # @return [::String]
27
+ # Output only. Full resource name of the project, for example
28
+ # `projects/{project_number}`.
29
+ # Note that when making requests, project number and project id are both
30
+ # acceptable, but the server will always respond in project number.
31
+ # @!attribute [r] create_time
32
+ # @return [::Google::Protobuf::Timestamp]
33
+ # Output only. The timestamp when this project is created.
34
+ # @!attribute [r] provision_completion_time
35
+ # @return [::Google::Protobuf::Timestamp]
36
+ # Output only. The timestamp when this project is successfully provisioned.
37
+ # Empty value means this project is still provisioning and is not ready for
38
+ # use.
39
+ # @!attribute [r] service_terms_map
40
+ # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::Project::ServiceTerms}]
41
+ # Output only. A map of terms of services. The key is the `id` of
42
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Project::ServiceTerms ServiceTerms}.
43
+ class Project
44
+ include ::Google::Protobuf::MessageExts
45
+ extend ::Google::Protobuf::MessageExts::ClassMethods
46
+
47
+ # Metadata about the terms of service.
48
+ # @!attribute [rw] id
49
+ # @return [::String]
50
+ # The unique identifier of this terms of service.
51
+ # Available terms:
52
+ #
53
+ # * `GA_DATA_USE_TERMS`: [Terms for data
54
+ # use](https://cloud.google.com/retail/data-use-terms). When using this as
55
+ # `id`, the acceptable
56
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Project::ServiceTerms#version version}
57
+ # to provide is `2022-11-23`.
58
+ # @!attribute [rw] version
59
+ # @return [::String]
60
+ # The version string of the terms of service.
61
+ # For acceptable values, see the comments for
62
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Project::ServiceTerms#id id} above.
63
+ # @!attribute [rw] state
64
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::ServiceTerms::State]
65
+ # Whether the project has accepted/rejected the service terms or it is
66
+ # still pending.
67
+ # @!attribute [rw] accept_time
68
+ # @return [::Google::Protobuf::Timestamp]
69
+ # The last time when the project agreed to the terms of service.
70
+ # @!attribute [rw] decline_time
71
+ # @return [::Google::Protobuf::Timestamp]
72
+ # The last time when the project declined or revoked the agreement to terms
73
+ # of service.
74
+ class ServiceTerms
75
+ include ::Google::Protobuf::MessageExts
76
+ extend ::Google::Protobuf::MessageExts::ClassMethods
77
+
78
+ # The agreement states this terms of service.
79
+ module State
80
+ # The default value of the enum. This value is not actually used.
81
+ STATE_UNSPECIFIED = 0
82
+
83
+ # The project has given consent to the terms of service.
84
+ TERMS_ACCEPTED = 1
85
+
86
+ # The project is pending to review and accept the terms of service.
87
+ TERMS_PENDING = 2
88
+
89
+ # The project has declined or revoked the agreement to terms of service.
90
+ TERMS_DECLINED = 3
91
+ end
92
+ end
93
+
94
+ # @!attribute [rw] key
95
+ # @return [::String]
96
+ # @!attribute [rw] value
97
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Project::ServiceTerms]
98
+ class ServiceTermsMapEntry
99
+ include ::Google::Protobuf::MessageExts
100
+ extend ::Google::Protobuf::MessageExts::ClassMethods
101
+ end
102
+ end
103
+ end
104
+ end
105
+ end
106
+ end
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright 2024 Google LLC
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # https://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ # Auto-generated by gapic-generator-ruby. DO NOT EDIT!
18
+
19
+
20
+ module Google
21
+ module Cloud
22
+ module DiscoveryEngine
23
+ module V1beta
24
+ # Request for
25
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ProjectService::Client#provision_project ProjectService.ProvisionProject}
26
+ # method.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Required. Full resource name of a
30
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Project Project}, such as
31
+ # `projects/{project_id_or_number}`.
32
+ # @!attribute [rw] accept_data_use_terms
33
+ # @return [::Boolean]
34
+ # Required. Set to `true` to specify that caller has read and would like to
35
+ # give consent to the [Terms for data
36
+ # use](https://cloud.google.com/retail/data-use-terms).
37
+ # @!attribute [rw] data_use_terms_version
38
+ # @return [::String]
39
+ # Required. The version of the [Terms for data
40
+ # use](https://cloud.google.com/retail/data-use-terms) that caller has read
41
+ # and would like to give consent to.
42
+ #
43
+ # Acceptable version is `2022-11-23`, and this may change over time.
44
+ class ProvisionProjectRequest
45
+ include ::Google::Protobuf::MessageExts
46
+ extend ::Google::Protobuf::MessageExts::ClassMethods
47
+ end
48
+
49
+ # Metadata associated with a project provision operation.
50
+ class ProvisionProjectMetadata
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end
@@ -78,9 +78,37 @@ module Google
78
78
  # @return [::Boolean]
79
79
  # If true, the response will contain only record ID and score. By default, it
80
80
  # is false, the response will contain record details.
81
+ # @!attribute [rw] user_labels
82
+ # @return [::Google::Protobuf::Map{::String => ::String}]
83
+ # The user labels applied to a resource must meet the following requirements:
84
+ #
85
+ # * Each resource can have multiple labels, up to a maximum of 64.
86
+ # * Each label must be a key-value pair.
87
+ # * Keys have a minimum length of 1 character and a maximum length of 63
88
+ # characters and cannot be empty. Values can be empty and have a maximum
89
+ # length of 63 characters.
90
+ # * Keys and values can contain only lowercase letters, numeric characters,
91
+ # underscores, and dashes. All characters must use UTF-8 encoding, and
92
+ # international characters are allowed.
93
+ # * The key portion of a label must be unique. However, you can use the same
94
+ # key with multiple resources.
95
+ # * Keys must start with a lowercase letter or international character.
96
+ #
97
+ # See [Google Cloud
98
+ # Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
99
+ # for more details.
81
100
  class RankRequest
82
101
  include ::Google::Protobuf::MessageExts
83
102
  extend ::Google::Protobuf::MessageExts::ClassMethods
103
+
104
+ # @!attribute [rw] key
105
+ # @return [::String]
106
+ # @!attribute [rw] value
107
+ # @return [::String]
108
+ class UserLabelsEntry
109
+ include ::Google::Protobuf::MessageExts
110
+ extend ::Google::Protobuf::MessageExts::ClassMethods
111
+ end
84
112
  end
85
113
 
86
114
  # Response message for
@@ -30,7 +30,7 @@ module Google
30
30
  # `projects/*/locations/global/collections/*/dataStores/*/servingConfigs/*`
31
31
  #
32
32
  # One default serving config is created along with your recommendation engine
33
- # creation. The engine ID will be used as the ID of the default serving
33
+ # creation. The engine ID is used as the ID of the default serving
34
34
  # config. For example, for Engine
35
35
  # `projects/*/locations/global/collections/*/engines/my-engine`, you can use
36
36
  # `projects/*/locations/global/collections/*/engines/my-engine/servingConfigs/my-engine`
@@ -58,9 +58,9 @@ module Google
58
58
  # @!attribute [rw] page_size
59
59
  # @return [::Integer]
60
60
  # Maximum number of results to return. Set this property
61
- # to the number of recommendation results needed. If zero, the service will
62
- # choose a reasonable default. The maximum allowed value is 100. Values
63
- # above 100 will be coerced to 100.
61
+ # to the number of recommendation results needed. If zero, the service
62
+ # chooses a reasonable default. The maximum allowed value is 100. Values
63
+ # above 100 are set to 100.
64
64
  # @!attribute [rw] filter
65
65
  # @return [::String]
66
66
  # Filter for restricting recommendation results with a length limit of 5,000
@@ -81,19 +81,19 @@ module Google
81
81
  # * (available: true) AND
82
82
  # (launguage: ANY("en", "es")) OR (categories: ANY("Movie"))
83
83
  #
84
- # If your filter blocks all results, the API will return generic
84
+ # If your filter blocks all results, the API returns generic
85
85
  # (unfiltered) popular Documents. If you only want results strictly matching
86
- # the filters, set `strictFiltering` to True in
86
+ # the filters, set `strictFiltering` to `true` in
87
87
  # {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}
88
88
  # to receive empty results instead.
89
89
  #
90
- # Note that the API will never return
90
+ # Note that the API never returns
91
91
  # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s with
92
- # `storageStatus` of `EXPIRED` or `DELETED` regardless of filter choices.
92
+ # `storageStatus` as `EXPIRED` or `DELETED` regardless of filter choices.
93
93
  # @!attribute [rw] validate_only
94
94
  # @return [::Boolean]
95
- # Use validate only mode for this recommendation query. If set to true, a
96
- # fake model will be used that returns arbitrary Document IDs.
95
+ # Use validate only mode for this recommendation query. If set to `true`, a
96
+ # fake model is used that returns arbitrary Document IDs.
97
97
  # Note that the validate only mode should only be used for testing the API,
98
98
  # or if the model is not ready.
99
99
  # @!attribute [rw] params
@@ -102,16 +102,17 @@ module Google
102
102
  #
103
103
  # Allowed values:
104
104
  #
105
- # * `returnDocument`: Boolean. If set to true, the associated Document
106
- # object will be returned in
105
+ # * `returnDocument`: Boolean. If set to `true`, the associated Document
106
+ # object is returned in
107
107
  # {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult#document RecommendResponse.RecommendationResult.document}.
108
- # * `returnScore`: Boolean. If set to true, the recommendation 'score'
109
- # corresponding to each returned Document will be set in
108
+ # * `returnScore`: Boolean. If set to true, the recommendation score
109
+ # corresponding to each returned Document is set in
110
110
  # {::Google::Cloud::DiscoveryEngine::V1beta::RecommendResponse::RecommendationResult#metadata RecommendResponse.RecommendationResult.metadata}.
111
- # The given 'score' indicates the probability of a Document conversion
112
- # given the user's context and history.
113
- # * `strictFiltering`: Boolean. True by default. If set to false, the service
114
- # will return generic (unfiltered) popular Documents instead of empty if
111
+ # The given score indicates the probability of a Document conversion given
112
+ # the user's context and history.
113
+ # * `strictFiltering`: Boolean. True by default. If set to `false`, the
114
+ # service
115
+ # returns generic (unfiltered) popular Documents instead of empty if
115
116
  # your filter blocks all recommendation results.
116
117
  # * `diversityLevel`: String. Default empty. If set to be non-empty, then
117
118
  # it needs to be one of:
@@ -202,7 +203,7 @@ module Google
202
203
  # {::Google::Cloud::DiscoveryEngine::V1beta::RecommendRequest#params RecommendRequest.params}.
203
204
  # @!attribute [rw] metadata
204
205
  # @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
205
- # Additional Document metadata / annotations.
206
+ # Additional Document metadata or annotations.
206
207
  #
207
208
  # Possible values:
208
209
  #
@@ -46,9 +46,9 @@ module Google
46
46
  # to return. The service may return fewer than this value.
47
47
  #
48
48
  # If unspecified, at most 100
49
- # {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s will be returned.
49
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}s are returned.
50
50
  #
51
- # The maximum value is 1000; values above 1000 will be coerced to 1000.
51
+ # The maximum value is 1000; values above 1000 are set to 1000.
52
52
  # @!attribute [rw] page_token
53
53
  # @return [::String]
54
54
  # A page token, received from a previous
@@ -94,7 +94,7 @@ module Google
94
94
  # @!attribute [rw] schema_id
95
95
  # @return [::String]
96
96
  # Required. The ID to use for the
97
- # {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}, which will become the
97
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema}, which becomes the
98
98
  # final component of the
99
99
  # {::Google::Cloud::DiscoveryEngine::V1beta::Schema#name Schema.name}.
100
100
  #
@@ -117,8 +117,8 @@ module Google
117
117
  # @return [::Boolean]
118
118
  # If set to true, and the
119
119
  # {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} is not found, a new
120
- # {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} will be created. In
121
- # this situation, `update_mask` is ignored.
120
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Schema Schema} is created. In this
121
+ # situation, `update_mask` is ignored.
122
122
  class UpdateSchemaRequest
123
123
  include ::Google::Protobuf::MessageExts
124
124
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -78,7 +78,10 @@ module Google
78
78
  # If this field is negative, an `INVALID_ARGUMENT` is returned.
79
79
  # @!attribute [rw] data_store_specs
80
80
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>]
81
- # A list of data store specs to apply on a search call.
81
+ # Specs defining dataStores to filter on in a search call and configurations
82
+ # for those dataStores. This is only considered for engines with multiple
83
+ # dataStores use case. For single dataStore within an engine, they should
84
+ # use the specs at the top level.
82
85
  # @!attribute [rw] filter
83
86
  # @return [::String]
84
87
  # The filter syntax consists of an expression language for constructing a
@@ -115,7 +118,9 @@ module Google
115
118
  # The order in which documents are returned. Documents can be ordered by
116
119
  # a field in an {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}
117
120
  # object. Leave it unset if ordered by relevance. `order_by` expression is
118
- # case-sensitive. For more information on ordering, see
121
+ # case-sensitive.
122
+ #
123
+ # For more information on ordering for retail search, see
119
124
  # [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
120
125
  #
121
126
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
@@ -135,7 +140,7 @@ module Google
135
140
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::BoostSpec]
136
141
  # Boost specification to boost certain documents.
137
142
  # For more information on boosting, see
138
- # [Boosting](https://cloud.google.com/retail/docs/boosting#boost)
143
+ # [Boosting](https://cloud.google.com/generative-ai-app-builder/docs/boost-search-results)
139
144
  # @!attribute [rw] params
140
145
  # @return [::Google::Protobuf::Map{::String => ::Google::Protobuf::Value}]
141
146
  # Additional search parameters.
@@ -144,8 +149,7 @@ module Google
144
149
  #
145
150
  # * `user_country_code`: string. Default empty. If set to non-empty, results
146
151
  # are restricted or boosted based on the location provided.
147
- # Example:
148
- # user_country_code: "au"
152
+ # For example, `user_country_code: "au"`
149
153
  #
150
154
  # For available codes see [Country
151
155
  # Codes](https://developers.google.com/custom-search/docs/json_api_reference#countryCodes)
@@ -153,8 +157,7 @@ module Google
153
157
  # * `search_type`: double. Default empty. Enables non-webpage searching
154
158
  # depending on the value. The only valid non-default value is 1,
155
159
  # which enables image searching.
156
- # Example:
157
- # search_type: 1
160
+ # For example, `search_type: 1`
158
161
  # @!attribute [rw] query_expansion_spec
159
162
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::QueryExpansionSpec]
160
163
  # The query expansion specification that specifies the conditions under which
@@ -253,7 +256,9 @@ module Google
253
256
  extend ::Google::Protobuf::MessageExts::ClassMethods
254
257
  end
255
258
 
256
- # A struct to define data stores to filter on in a search call.
259
+ # A struct to define data stores to filter on in a search call and
260
+ # configurations for those data stores. A maximum of 1 DataStoreSpec per
261
+ # data_store is allowed. Otherwise, an `INVALID_ARGUMENT` error is returned.
257
262
  # @!attribute [rw] data_store
258
263
  # @return [::String]
259
264
  # Required. Full resource name of
@@ -270,7 +275,7 @@ module Google
270
275
  # Required. The facet key specification.
271
276
  # @!attribute [rw] limit
272
277
  # @return [::Integer]
273
- # Maximum of facet values that should be returned for this facet. If
278
+ # Maximum facet values that are returned for this facet. If
274
279
  # unspecified, defaults to 20. The maximum allowed value is 300. Values
275
280
  # above 300 are coerced to 300.
276
281
  #
@@ -367,7 +372,7 @@ module Google
367
372
  # Only supported on textual fields. Maximum is 10.
368
373
  # @!attribute [rw] contains
369
374
  # @return [::Array<::String>]
370
- # Only get facet values that contains the given strings. For example,
375
+ # Only get facet values that contain the given strings. For example,
371
376
  # suppose "category" has three values "Action > 2022",
372
377
  # "Action > 2021" and "Sci-Fi > 2022". If set "contains" to "2022", the
373
378
  # "category" facet only contains "Action > 2022" and "Sci-Fi > 2022".
@@ -518,7 +523,7 @@ module Google
518
523
  # specified. The value must be formatted as an XSD `dayTimeDuration`
519
524
  # value (a restricted subset of an ISO 8601 duration value). The
520
525
  # pattern for this is: `[nD][T[nH][nM][nS]]`.
521
- # E.g. `5D`, `3DT12H30M`, `T24H`.
526
+ # For example, `5D`, `3DT12H30M`, `T24H`.
522
527
  FRESHNESS = 2
523
528
  end
524
529
 
@@ -571,8 +576,8 @@ module Google
571
576
  # The specification for query spell correction.
572
577
  # @!attribute [rw] mode
573
578
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode]
574
- # The mode under which spell correction should take effect to
575
- # replace the original search query. Default to
579
+ # The mode under which spell correction
580
+ # replaces the original search query. Defaults to
576
581
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
577
582
  class SpellCorrectionSpec
578
583
  include ::Google::Protobuf::MessageExts
@@ -585,10 +590,10 @@ module Google
585
590
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::SpellCorrectionSpec::Mode::AUTO Mode.AUTO}.
586
591
  MODE_UNSPECIFIED = 0
587
592
 
588
- # Search API will try to find a spell suggestion if there
589
- # is any and put in the
593
+ # Search API tries to find a spelling suggestion. If a suggestion is
594
+ # found, it is put in the
590
595
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse#corrected_query SearchResponse.corrected_query}.
591
- # The spell suggestion will not be used as the search query.
596
+ # The spelling suggestion won't be used as the search query.
592
597
  SUGGESTION_ONLY = 1
593
598
 
594
599
  # Automatic spell correction built by the Search API. Search will
@@ -644,7 +649,10 @@ module Google
644
649
  # of results returned is less than `summaryResultCount`, the summary is
645
650
  # generated from all of the results.
646
651
  #
647
- # At most 10 results can be used to generate a summary.
652
+ # At most 10 results for documents mode, or 50 for chunks mode, can be
653
+ # used to generate a summary. The chunks mode is used when
654
+ # [SearchRequest.ContentSearchSpec.search_result_mode][] is set to
655
+ # [CHUNKS][SearchRequest.ContentSearchSpec.SearchResultMode.CHUNKS].
648
656
  # @!attribute [rw] include_citations
649
657
  # @return [::Boolean]
650
658
  # Specifies whether to include citations in the summary. The default
@@ -900,8 +908,6 @@ module Google
900
908
  # Controls applied as part of the Control service.
901
909
  # @!attribute [rw] geo_search_debug_info
902
910
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::GeoSearchDebugInfo>]
903
- # Debug information specifically related to forward geocoding issues arising
904
- # from Geolocation Search.
905
911
  # @!attribute [rw] query_expansion_info
906
912
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::QueryExpansionInfo]
907
913
  # Query expansion information for the returned results.
@@ -917,7 +923,7 @@ module Google
917
923
  # @!attribute [rw] document
918
924
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Document]
919
925
  # The document data snippet in the search response. Only fields that are
920
- # marked as retrievable are populated.
926
+ # marked as `retrievable` are populated.
921
927
  # @!attribute [rw] model_scores
922
928
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DoubleList}]
923
929
  # Google provided available scores.
@@ -938,7 +944,7 @@ module Google
938
944
  # A facet result.
939
945
  # @!attribute [rw] key
940
946
  # @return [::String]
941
- # The key for this facet. E.g., "colors" or "price". It matches
947
+ # The key for this facet. For example, `"colors"` or `"price"`. It matches
942
948
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::FacetSpec::FacetKey#key SearchRequest.FacetSpec.FacetKey.key}.
943
949
  # @!attribute [rw] values
944
950
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchResponse::Facet::FacetValue>]
@@ -983,17 +989,17 @@ module Google
983
989
  # Useful attribute for search result refinements.
984
990
  # @!attribute [rw] attribute_key
985
991
  # @return [::String]
986
- # Attribute key used to refine the results e.g. 'movie_type'.
992
+ # Attribute key used to refine the results. For example, `"movie_type"`.
987
993
  # @!attribute [rw] attribute_value
988
994
  # @return [::String]
989
- # Attribute value used to refine the results e.g. 'drama'.
995
+ # Attribute value used to refine the results. For example, `"drama"`.
990
996
  class RefinementAttribute
991
997
  include ::Google::Protobuf::MessageExts
992
998
  extend ::Google::Protobuf::MessageExts::ClassMethods
993
999
  end
994
1000
  end
995
1001
 
996
- # Summary of the top N search result specified by the summary spec.
1002
+ # Summary of the top N search results specified by the summary spec.
997
1003
  # @!attribute [rw] summary_text
998
1004
  # @return [::String]
999
1005
  # The summary content.
@@ -21,6 +21,31 @@ module Google
21
21
  module Cloud
22
22
  module DiscoveryEngine
23
23
  module V1beta
24
+ # Request message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#list_custom_models SearchTuningService.ListCustomModels}
26
+ # method.
27
+ # @!attribute [rw] data_store
28
+ # @return [::String]
29
+ # Required. The resource name of the parent Data Store, such as
30
+ # `projects/*/locations/global/collections/default_collection/dataStores/default_data_store`.
31
+ # This field is used to identify the data store where to fetch the models
32
+ # from.
33
+ class ListCustomModelsRequest
34
+ include ::Google::Protobuf::MessageExts
35
+ extend ::Google::Protobuf::MessageExts::ClassMethods
36
+ end
37
+
38
+ # Response message for
39
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#list_custom_models SearchTuningService.ListCustomModels}
40
+ # method.
41
+ # @!attribute [rw] models
42
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::CustomTuningModel>]
43
+ # List of custom tuning models.
44
+ class ListCustomModelsResponse
45
+ include ::Google::Protobuf::MessageExts
46
+ extend ::Google::Protobuf::MessageExts::ClassMethods
47
+ end
48
+
24
49
  # Request message for
25
50
  # {::Google::Cloud::DiscoveryEngine::V1beta::SearchTuningService::Client#train_custom_model SearchTuningService.TrainCustomModel}
26
51
  # method.
@@ -41,6 +66,9 @@ module Google
41
66
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::ImportErrorConfig]
42
67
  # The desired location of errors incurred during the data ingestion and
43
68
  # training.
69
+ # @!attribute [rw] model_id
70
+ # @return [::String]
71
+ # If not provided, a UUID will be generated.
44
72
  class TrainCustomModelRequest
45
73
  include ::Google::Protobuf::MessageExts
46
74
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -108,6 +136,9 @@ module Google
108
136
  # @!attribute [rw] metrics
109
137
  # @return [::Google::Protobuf::Map{::String => ::Float}]
110
138
  # The metrics of the trained model.
139
+ # @!attribute [rw] model_name
140
+ # @return [::String]
141
+ # Fully qualified name of the CustomTuningModel.
111
142
  class TrainCustomModelResponse
112
143
  include ::Google::Protobuf::MessageExts
113
144
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -25,7 +25,7 @@ module Google
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
27
  # Immutable. Fully qualified name
28
- # `project/*/locations/global/collections/{collection}/engines/{engine}/sessions/*`
28
+ # `projects/{project}/locations/global/collections/{collection}/engines/{engine}/sessions/*`
29
29
  # @!attribute [rw] state
30
30
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Session::State]
31
31
  # The state of the session.
@@ -53,6 +53,9 @@ module Google
53
53
  # @!attribute [rw] answer
54
54
  # @return [::String]
55
55
  # The resource name of the answer to the user query.
56
+ #
57
+ # Only set if the answer generation (/answer API call) happened in this
58
+ # turn.
56
59
  class Turn
57
60
  include ::Google::Protobuf::MessageExts
58
61
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -57,6 +57,9 @@ module Google
57
57
  # @!attribute [r] generated_uri_pattern
58
58
  # @return [::String]
59
59
  # Output only. This is system-generated based on the provided_uri_pattern.
60
+ # @!attribute [r] root_domain_uri
61
+ # @return [::String]
62
+ # Output only. Root domain of the provided_uri_pattern.
60
63
  # @!attribute [r] site_verification_info
61
64
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::SiteVerificationInfo]
62
65
  # Output only. Site ownership and validity verification status.
@@ -22,7 +22,7 @@ module Google
22
22
  module DiscoveryEngine
23
23
  module V1beta
24
24
  # UserEvent captures all metadata information Discovery Engine API needs to
25
- # know about how end users interact with customers' website.
25
+ # know about how end users interact with your website.
26
26
  # @!attribute [rw] event_type
27
27
  # @return [::String]
28
28
  # Required. User event type. Allowed values are:
@@ -63,6 +63,27 @@ module Google
63
63
  # Analytics [Client
64
64
  # ID](https://developers.google.com/analytics/devguides/collection/analyticsjs/field-reference#clientId)
65
65
  # for this field.
66
+ # @!attribute [rw] engine
67
+ # @return [::String]
68
+ # The {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} resource name, in
69
+ # the form of
70
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
71
+ #
72
+ # Optional. Only required for
73
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Engine Engine} produced user events.
74
+ # For example, user events from blended search.
75
+ # @!attribute [rw] data_store
76
+ # @return [::String]
77
+ # The {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} resource
78
+ # full name, of the form
79
+ # `projects/{project}/locations/{location}/collections/{collection_id}/dataStores/{data_store_id}`.
80
+ #
81
+ # Optional. Only required for user events whose data store can't by
82
+ # determined by
83
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#engine UserEvent.engine} or
84
+ # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent#documents UserEvent.documents}.
85
+ # If data store is set in the parent of write/import/collect user event
86
+ # requests, this field can be omitted.
66
87
  # @!attribute [rw] event_time
67
88
  # @return [::Google::Protobuf::Timestamp]
68
89
  # Only required for
@@ -187,7 +208,7 @@ module Google
187
208
  # @return [::Array<::String>]
188
209
  # A list of identifiers for the independent experiment groups this user event
189
210
  # belongs to. This is used to distinguish between user events associated with
190
- # different experiment setups on the customer end.
211
+ # different experiment setups.
191
212
  # @!attribute [rw] promotion_ids
192
213
  # @return [::Array<::String>]
193
214
  # The promotion IDs if this is an event associated with promotions.
@@ -418,7 +439,7 @@ module Google
418
439
  # @return [::Integer]
419
440
  # Quantity of the Document associated with the user event. Defaults to 1.
420
441
  #
421
- # For example, this field will be 2 if two quantities of the same Document
442
+ # For example, this field is 2 if two quantities of the same Document
422
443
  # are involved in a `add-to-cart` event.
423
444
  #
424
445
  # Required for events of the following event types:
@@ -24,11 +24,23 @@ module Google
24
24
  # Request message for WriteUserEvent method.
25
25
  # @!attribute [rw] parent
26
26
  # @return [::String]
27
- # Required. The parent DataStore resource name, such as
27
+ # Required. The parent resource name.
28
+ # If the write user event action is applied in
29
+ # {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore} level, the
30
+ # format is:
28
31
  # `projects/{project}/locations/{location}/collections/{collection}/dataStores/{data_store}`.
32
+ # If the write user event action is applied in [Location][] level, for
33
+ # example, the event with
34
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} across multiple
35
+ # {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}, the format is:
36
+ # `projects/{project}/locations/{location}`.
29
37
  # @!attribute [rw] user_event
30
38
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::UserEvent]
31
39
  # Required. User event to write.
40
+ # @!attribute [rw] write_async
41
+ # @return [::Boolean]
42
+ # If set to true, the user event is written asynchronously after
43
+ # validation, and the API responds without waiting for the write.
32
44
  class WriteUserEventRequest
33
45
  include ::Google::Protobuf::MessageExts
34
46
  extend ::Google::Protobuf::MessageExts::ClassMethods