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,209 @@
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
+ # Defines circumstances to be checked before allowing a behavior
25
+ # @!attribute [rw] query_terms
26
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition::QueryTerm>]
27
+ # Search only
28
+ # A list of terms to match the query on.
29
+ #
30
+ # Maximum of 10 query terms.
31
+ # @!attribute [rw] active_time_range
32
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition::TimeRange>]
33
+ # Range of time(s) specifying when condition is active.
34
+ #
35
+ # Maximum of 10 time ranges.
36
+ class Condition
37
+ include ::Google::Protobuf::MessageExts
38
+ extend ::Google::Protobuf::MessageExts::ClassMethods
39
+
40
+ # Matcher for search request query
41
+ # @!attribute [rw] value
42
+ # @return [::String]
43
+ # The specific query value to match against
44
+ #
45
+ # Must be lowercase, must be UTF-8.
46
+ # Can have at most 3 space separated terms if full_match is true.
47
+ # Cannot be an empty string.
48
+ # Maximum length of 5000 characters.
49
+ # @!attribute [rw] full_match
50
+ # @return [::Boolean]
51
+ # Whether the search query needs to exactly match the query term.
52
+ class QueryTerm
53
+ include ::Google::Protobuf::MessageExts
54
+ extend ::Google::Protobuf::MessageExts::ClassMethods
55
+ end
56
+
57
+ # Used for time-dependent conditions.
58
+ # @!attribute [rw] start_time
59
+ # @return [::Google::Protobuf::Timestamp]
60
+ # Start of time range.
61
+ #
62
+ # Range is inclusive.
63
+ # @!attribute [rw] end_time
64
+ # @return [::Google::Protobuf::Timestamp]
65
+ # End of time range.
66
+ #
67
+ # Range is inclusive.
68
+ # Must be in the future.
69
+ class TimeRange
70
+ include ::Google::Protobuf::MessageExts
71
+ extend ::Google::Protobuf::MessageExts::ClassMethods
72
+ end
73
+ end
74
+
75
+ # Defines a conditioned behavior to employ during serving.
76
+ # Must be attached to a
77
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig} to be
78
+ # considered at serving time. Permitted actions dependent on `SolutionType`.
79
+ # @!attribute [rw] boost_action
80
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::BoostAction]
81
+ # Defines a boost-type control
82
+ # @!attribute [rw] filter_action
83
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::FilterAction]
84
+ # Defines a filter-type control
85
+ # Currently not supported by Recommendation
86
+ # @!attribute [rw] redirect_action
87
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::RedirectAction]
88
+ # Defines a redirect-type control.
89
+ # @!attribute [rw] synonyms_action
90
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control::SynonymsAction]
91
+ # Treats a group of terms as synonyms of one another.
92
+ # @!attribute [rw] name
93
+ # @return [::String]
94
+ # Immutable. Fully qualified name
95
+ # `projects/*/locations/global/dataStore/*/controls/*`
96
+ # @!attribute [rw] display_name
97
+ # @return [::String]
98
+ # Required. Human readable name. The identifier used in UI views.
99
+ #
100
+ # Must be UTF-8 encoded string. Length limit is 128 characters.
101
+ # Otherwise an INVALID ARGUMENT error is thrown.
102
+ # @!attribute [r] associated_serving_config_ids
103
+ # @return [::Array<::String>]
104
+ # Output only. List of all
105
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ServingConfig ServingConfig} ids this
106
+ # control is attached to. May take up to 10 minutes to update after changes.
107
+ # @!attribute [rw] solution_type
108
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SolutionType]
109
+ # Required. Immutable. What solution the control belongs to.
110
+ #
111
+ # Must be compatible with vertical of resource.
112
+ # Otherwise an INVALID ARGUMENT error is thrown.
113
+ # @!attribute [rw] use_cases
114
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchUseCase>]
115
+ # Specifies the use case for the control.
116
+ # Affects what condition fields can be set.
117
+ # Only applies to
118
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
119
+ # Currently only allow one use case per control.
120
+ # Must be set when solution_type is
121
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SolutionType::SOLUTION_TYPE_SEARCH SolutionType.SOLUTION_TYPE_SEARCH}.
122
+ # @!attribute [rw] conditions
123
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Condition>]
124
+ # Determines when the associated action will trigger.
125
+ #
126
+ # Omit to always apply the action.
127
+ # Currently only a single condition may be specified.
128
+ # Otherwise an INVALID ARGUMENT error is thrown.
129
+ class Control
130
+ include ::Google::Protobuf::MessageExts
131
+ extend ::Google::Protobuf::MessageExts::ClassMethods
132
+
133
+ # Adjusts order of products in returned list.
134
+ # @!attribute [rw] boost
135
+ # @return [::Float]
136
+ # Required. Strength of the boost, which should be in [-1, 1]. Negative
137
+ # boost means demotion. Default is 0.0 (No-op).
138
+ # @!attribute [rw] filter
139
+ # @return [::String]
140
+ # Required. Specifies which products to apply the boost to.
141
+ #
142
+ # If no filter is provided all products will be boosted (No-op).
143
+ # Syntax documentation:
144
+ # https://cloud.google.com/retail/docs/filter-and-order
145
+ # Maximum length is 5000 characters.
146
+ # Otherwise an INVALID ARGUMENT error is thrown.
147
+ # @!attribute [rw] data_store
148
+ # @return [::String]
149
+ # Required. Specifies which data store's documents can be boosted by this
150
+ # control. Full data store name e.g.
151
+ # projects/123/locations/global/collections/default_collection/dataStores/default_data_store
152
+ class BoostAction
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+ end
156
+
157
+ # Specified which products may be included in results.
158
+ # Uses same filter as boost.
159
+ # @!attribute [rw] filter
160
+ # @return [::String]
161
+ # Required. A filter to apply on the matching condition results.
162
+ #
163
+ # Required
164
+ # Syntax documentation:
165
+ # https://cloud.google.com/retail/docs/filter-and-order
166
+ # Maximum length is 5000 characters. Otherwise an INVALID
167
+ # ARGUMENT error is thrown.
168
+ # @!attribute [rw] data_store
169
+ # @return [::String]
170
+ # Required. Specifies which data store's documents can be filtered by this
171
+ # control. Full data store name e.g.
172
+ # projects/123/locations/global/collections/default_collection/dataStores/default_data_store
173
+ class FilterAction
174
+ include ::Google::Protobuf::MessageExts
175
+ extend ::Google::Protobuf::MessageExts::ClassMethods
176
+ end
177
+
178
+ # Redirects a shopper to the provided URI.
179
+ # @!attribute [rw] redirect_uri
180
+ # @return [::String]
181
+ # Required. The URI to which the shopper will be redirected.
182
+ #
183
+ # Required.
184
+ # URI must have length equal or less than 2000 characters.
185
+ # Otherwise an INVALID ARGUMENT error is thrown.
186
+ class RedirectAction
187
+ include ::Google::Protobuf::MessageExts
188
+ extend ::Google::Protobuf::MessageExts::ClassMethods
189
+ end
190
+
191
+ # Creates a set of terms that will act as synonyms of one another.
192
+ #
193
+ # Example: "happy" will also be considered as "glad", "glad" will also be
194
+ # considered as "happy".
195
+ # @!attribute [rw] synonyms
196
+ # @return [::Array<::String>]
197
+ # Defines a set of synonyms.
198
+ # Can specify up to 100 synonyms.
199
+ # Must specify at least 2 synonyms. Otherwise an INVALID ARGUMENT error is
200
+ # thrown.
201
+ class SynonymsAction
202
+ include ::Google::Protobuf::MessageExts
203
+ extend ::Google::Protobuf::MessageExts::ClassMethods
204
+ end
205
+ end
206
+ end
207
+ end
208
+ end
209
+ end
@@ -0,0 +1,126 @@
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 CreateControl method.
25
+ # @!attribute [rw] parent
26
+ # @return [::String]
27
+ # Required. Full resource name of parent data store. Format:
28
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
29
+ # or
30
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
31
+ # @!attribute [rw] control
32
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control]
33
+ # Required. The Control to create.
34
+ # @!attribute [rw] control_id
35
+ # @return [::String]
36
+ # Required. The ID to use for the Control, which will become the final
37
+ # component of the Control's resource name.
38
+ #
39
+ # This value must be within 1-63 characters.
40
+ # Valid characters are /[a-z][0-9]-_/.
41
+ class CreateControlRequest
42
+ include ::Google::Protobuf::MessageExts
43
+ extend ::Google::Protobuf::MessageExts::ClassMethods
44
+ end
45
+
46
+ # Request for UpdateControl method.
47
+ # @!attribute [rw] control
48
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::Control]
49
+ # Required. The Control to update.
50
+ # @!attribute [rw] update_mask
51
+ # @return [::Google::Protobuf::FieldMask]
52
+ # Optional. Indicates which fields in the provided
53
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Control Control} to update. The
54
+ # following are NOT supported:
55
+ #
56
+ # * {::Google::Cloud::DiscoveryEngine::V1beta::Control#name Control.name}
57
+ # * {::Google::Cloud::DiscoveryEngine::V1beta::Control#solution_type Control.solution_type}
58
+ #
59
+ # If not set or empty, all supported fields are updated.
60
+ class UpdateControlRequest
61
+ include ::Google::Protobuf::MessageExts
62
+ extend ::Google::Protobuf::MessageExts::ClassMethods
63
+ end
64
+
65
+ # Request for DeleteControl method.
66
+ # @!attribute [rw] name
67
+ # @return [::String]
68
+ # Required. The resource name of the Control to delete. Format:
69
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
70
+ class DeleteControlRequest
71
+ include ::Google::Protobuf::MessageExts
72
+ extend ::Google::Protobuf::MessageExts::ClassMethods
73
+ end
74
+
75
+ # Request for GetControl method.
76
+ # @!attribute [rw] name
77
+ # @return [::String]
78
+ # Required. The resource name of the Control to get. Format:
79
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}/controls/{control_id}`
80
+ class GetControlRequest
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # Request for ListControls method.
86
+ # @!attribute [rw] parent
87
+ # @return [::String]
88
+ # Required. The data store resource name. Format:
89
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/dataStores/{data_store_id}`
90
+ # or
91
+ # `projects/{project_number}/locations/{location_id}/collections/{collection_id}/engines/{engine_id}`.
92
+ # @!attribute [rw] page_size
93
+ # @return [::Integer]
94
+ # Optional. Maximum number of results to return. If unspecified, defaults
95
+ # to 50. Max allowed value is 1000.
96
+ # @!attribute [rw] page_token
97
+ # @return [::String]
98
+ # Optional. A page token, received from a previous `ListControls` call.
99
+ # Provide this to retrieve the subsequent page.
100
+ # @!attribute [rw] filter
101
+ # @return [::String]
102
+ # Optional. A filter to apply on the list results. Supported features:
103
+ #
104
+ # * List all the products under the parent branch if
105
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ListControlsRequest#filter filter} is
106
+ # unset. Currently this field is unsupported.
107
+ class ListControlsRequest
108
+ include ::Google::Protobuf::MessageExts
109
+ extend ::Google::Protobuf::MessageExts::ClassMethods
110
+ end
111
+
112
+ # Response for ListControls method.
113
+ # @!attribute [rw] controls
114
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::Control>]
115
+ # All the Controls for a given data store.
116
+ # @!attribute [rw] next_page_token
117
+ # @return [::String]
118
+ # Pagination token, if not returned indicates the last page.
119
+ class ListControlsResponse
120
+ include ::Google::Protobuf::MessageExts
121
+ extend ::Google::Protobuf::MessageExts::ClassMethods
122
+ end
123
+ end
124
+ end
125
+ end
126
+ end
@@ -25,9 +25,9 @@ module Google
25
25
  # @!attribute [rw] name
26
26
  # @return [::String]
27
27
  # Immutable. Fully qualified name
28
- # `project/*/locations/global/collections/{collection}/dataStore/*/conversations/*`
28
+ # `projects/{project}/locations/global/collections/{collection}/dataStore/*/conversations/*`
29
29
  # or
30
- # `project/*/locations/global/collections/{collection}/engines/*/conversations/*`.
30
+ # `projects/{project}/locations/global/collections/{collection}/engines/*/conversations/*`.
31
31
  # @!attribute [rw] state
32
32
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Conversation::State]
33
33
  # The state of the Conversation.
@@ -247,8 +247,8 @@ module Google
247
247
  #
248
248
  # When session field is not set, the API is in sessionless mode.
249
249
  #
250
- # We support auto session mode: users can use the wildcard symbol “-” as
251
- # session id. A new id will be automatically generated and assigned.
250
+ # We support auto session mode: users can use the wildcard symbol `-` as
251
+ # session ID. A new ID will be automatically generated and assigned.
252
252
  # @!attribute [rw] safety_spec
253
253
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest::SafetySpec]
254
254
  # Model specification.
@@ -347,6 +347,13 @@ module Google
347
347
  # non-answer seeking query. If this field is set to `true`, we skip
348
348
  # generating answers for non-answer seeking queries and return
349
349
  # fallback messages instead.
350
+ # @!attribute [rw] ignore_low_relevant_content
351
+ # @return [::Boolean]
352
+ # Specifies whether to filter out queries that have low relevance.
353
+ #
354
+ # If this field is set to `false`, all search results are used regardless
355
+ # of relevance to generate answers. If set to `true` or unset, the behavior
356
+ # will be determined automatically by the service.
350
357
  class AnswerGenerationSpec
351
358
  include ::Google::Protobuf::MessageExts
352
359
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -421,6 +428,12 @@ module Google
421
428
  # [Ordering](https://cloud.google.com/retail/docs/filter-and-order#order)
422
429
  #
423
430
  # If this field is unrecognizable, an `INVALID_ARGUMENT` is returned.
431
+ # @!attribute [rw] data_store_specs
432
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SearchRequest::DataStoreSpec>]
433
+ # Specs defining dataStores to filter on in a search call and
434
+ # configurations for those dataStores. This is only considered for
435
+ # engines with multiple dataStores use case. For single dataStore within
436
+ # an engine, they should use the specs at the top level.
424
437
  class SearchParams
425
438
  include ::Google::Protobuf::MessageExts
426
439
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -561,7 +574,7 @@ module Google
561
574
  # @!attribute [rw] max_rephrase_steps
562
575
  # @return [::Integer]
563
576
  # Max rephrase steps.
564
- # The max number is 10 steps.
577
+ # The max number is 5 steps.
565
578
  # If not set or set to < 1, it will be set to 1 by default.
566
579
  class QueryRephraserSpec
567
580
  include ::Google::Protobuf::MessageExts
@@ -587,6 +600,9 @@ module Google
587
600
  # It will be only available when session field is set and valid in the
588
601
  # {::Google::Cloud::DiscoveryEngine::V1beta::AnswerQueryRequest AnswerQueryRequest}
589
602
  # request.
603
+ # @!attribute [rw] answer_query_token
604
+ # @return [::String]
605
+ # A global unique ID used for logging.
590
606
  class AnswerQueryResponse
591
607
  include ::Google::Protobuf::MessageExts
592
608
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -0,0 +1,75 @@
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 that describes a custom tuned model.
25
+ # @!attribute [rw] name
26
+ # @return [::String]
27
+ # Required. The fully qualified resource name of the model.
28
+ #
29
+ # Format:
30
+ # `projects/{project_number}/locations/{location}/collections/{collection}/dataStores/{data_store}/customTuningModels/{custom_tuning_model}`
31
+ # model must be an alpha-numerical string with limit of 40 characters.
32
+ # @!attribute [rw] display_name
33
+ # @return [::String]
34
+ # The display name of the model.
35
+ # @!attribute [rw] model_version
36
+ # @return [::Integer]
37
+ # The version of the model.
38
+ # @!attribute [rw] model_state
39
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::CustomTuningModel::ModelState]
40
+ # The state that the model is in (e.g.`TRAINING` or `TRAINING_FAILED`).
41
+ # @!attribute [rw] create_time
42
+ # @return [::Google::Protobuf::Timestamp]
43
+ # Timestamp the Model was created at.
44
+ # @!attribute [rw] training_start_time
45
+ # @return [::Google::Protobuf::Timestamp]
46
+ # Timestamp the model training was initiated.
47
+ class CustomTuningModel
48
+ include ::Google::Protobuf::MessageExts
49
+ extend ::Google::Protobuf::MessageExts::ClassMethods
50
+
51
+ # The state of the model.
52
+ module ModelState
53
+ # Default value.
54
+ MODEL_STATE_UNSPECIFIED = 0
55
+
56
+ # The model is in a paused training state.
57
+ TRAINING_PAUSED = 1
58
+
59
+ # The model is currently training.
60
+ TRAINING = 2
61
+
62
+ # The model has successfully completed training.
63
+ TRAINING_COMPLETE = 3
64
+
65
+ # The model is ready for serving.
66
+ READY_FOR_SERVING = 4
67
+
68
+ # The model training failed.
69
+ TRAINING_FAILED = 5
70
+ end
71
+ end
72
+ end
73
+ end
74
+ end
75
+ end
@@ -124,8 +124,8 @@ module Google
124
124
  # INVALID_ARGUMENT error is returned.
125
125
  # @!attribute [rw] filter
126
126
  # @return [::String]
127
- # Filter by solution type. For example: filter =
128
- # 'solution_type:SOLUTION_TYPE_SEARCH'
127
+ # Filter by solution type .
128
+ # For example: `filter = 'solution_type:SOLUTION_TYPE_SEARCH'`
129
129
  class ListDataStoresRequest
130
130
  include ::Google::Protobuf::MessageExts
131
131
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -42,6 +42,7 @@ module Google
42
42
  # @return [::Google::Protobuf::Map{::String => ::Google::Cloud::DiscoveryEngine::V1beta::DocumentProcessingConfig::ParsingConfig}]
43
43
  # Map from file type to override the default parsing configuration based on
44
44
  # the file type. Supported keys:
45
+ #
45
46
  # * `pdf`: Override parsing config for PDF files, either digital parsing, ocr
46
47
  # parsing or layout parsing is supported.
47
48
  # * `html`: Override parsing config for HTML files, only digital parsing and
@@ -59,7 +59,7 @@ module Google
59
59
  # @return [::Integer]
60
60
  # Maximum number of {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}s
61
61
  # to return. If unspecified, defaults to 100. The maximum allowed value is
62
- # 1000. Values above 1000 will be coerced to 1000.
62
+ # 1000. Values above 1000 are set to 1000.
63
63
  #
64
64
  # If this field is negative, an `INVALID_ARGUMENT` error is returned.
65
65
  # @!attribute [rw] page_token
@@ -110,8 +110,8 @@ module Google
110
110
  # @!attribute [rw] document_id
111
111
  # @return [::String]
112
112
  # Required. The ID to use for the
113
- # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}, which will become
114
- # the final component of the
113
+ # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document}, which becomes the
114
+ # final component of the
115
115
  # {::Google::Cloud::DiscoveryEngine::V1beta::Document#name Document.name}.
116
116
  #
117
117
  # If the caller does not have permission to create the
@@ -148,14 +148,13 @@ module Google
148
148
  # is not set, a `NOT_FOUND` error is returned.
149
149
  # @!attribute [rw] allow_missing
150
150
  # @return [::Boolean]
151
- # If set to true, and the
151
+ # If set to `true` and the
152
152
  # {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is not found, a
153
- # new {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} will be
154
- # created.
153
+ # new {::Google::Cloud::DiscoveryEngine::V1beta::Document Document} is be created.
155
154
  # @!attribute [rw] update_mask
156
155
  # @return [::Google::Protobuf::FieldMask]
157
156
  # Indicates which fields in the provided imported 'document' to update. If
158
- # not set, will by default update all fields.
157
+ # not set, by default updates all fields.
159
158
  class UpdateDocumentRequest
160
159
  include ::Google::Protobuf::MessageExts
161
160
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -94,7 +94,7 @@ module Google
94
94
  # The restriction of the Engine industry vertical is based on
95
95
  # {::Google::Cloud::DiscoveryEngine::V1beta::DataStore DataStore}: If unspecified,
96
96
  # default to `GENERIC`. Vertical on Engine has to match vertical of the
97
- # DataStore liniked to the engine.
97
+ # DataStore linked to the engine.
98
98
  # @!attribute [rw] common_config
99
99
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::Engine::CommonConfig]
100
100
  # Common config spec that specifies the metadata of the engine.
@@ -192,8 +192,8 @@ module Google
192
192
  # Common configurations for an Engine.
193
193
  # @!attribute [rw] company_name
194
194
  # @return [::String]
195
- # Immutable. The name of the company, business or entity that is associated
196
- # with the engine. Setting this may help improve LLM related features.
195
+ # The name of the company, business or entity that is associated with the
196
+ # engine. Setting this may help improve LLM related features.
197
197
  class CommonConfig
198
198
  include ::Google::Protobuf::MessageExts
199
199
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -43,7 +43,7 @@ module Google
43
43
  # `projects/*/locations/global/groundingConfigs/default_grounding_config`.
44
44
  # @!attribute [rw] answer_candidate
45
45
  # @return [::String]
46
- # Answer candidate to check.
46
+ # Answer candidate to check. Can have a maximum length of 1024 characters.
47
47
  # @!attribute [rw] facts
48
48
  # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::GroundingFact>]
49
49
  # List of facts for the grounding check.
@@ -51,9 +51,37 @@ module Google
51
51
  # @!attribute [rw] grounding_spec
52
52
  # @return [::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingSpec]
53
53
  # Configuration of the grounding check.
54
+ # @!attribute [rw] user_labels
55
+ # @return [::Google::Protobuf::Map{::String => ::String}]
56
+ # The user labels applied to a resource must meet the following requirements:
57
+ #
58
+ # * Each resource can have multiple labels, up to a maximum of 64.
59
+ # * Each label must be a key-value pair.
60
+ # * Keys have a minimum length of 1 character and a maximum length of 63
61
+ # characters and cannot be empty. Values can be empty and have a maximum
62
+ # length of 63 characters.
63
+ # * Keys and values can contain only lowercase letters, numeric characters,
64
+ # underscores, and dashes. All characters must use UTF-8 encoding, and
65
+ # international characters are allowed.
66
+ # * The key portion of a label must be unique. However, you can use the same
67
+ # key with multiple resources.
68
+ # * Keys must start with a lowercase letter or international character.
69
+ #
70
+ # See [Google Cloud
71
+ # Document](https://cloud.google.com/resource-manager/docs/creating-managing-labels#requirements)
72
+ # for more details.
54
73
  class CheckGroundingRequest
55
74
  include ::Google::Protobuf::MessageExts
56
75
  extend ::Google::Protobuf::MessageExts::ClassMethods
76
+
77
+ # @!attribute [rw] key
78
+ # @return [::String]
79
+ # @!attribute [rw] value
80
+ # @return [::String]
81
+ class UserLabelsEntry
82
+ include ::Google::Protobuf::MessageExts
83
+ extend ::Google::Protobuf::MessageExts::ClassMethods
84
+ end
57
85
  end
58
86
 
59
87
  # Response message for the
@@ -95,6 +123,16 @@ module Google
95
123
  # cited_chunks[1], cited_chunks[3], cited_chunks[4] are the facts cited
96
124
  # supporting for the claim. A citation to a fact indicates that the claim
97
125
  # is supported by the fact.
126
+ # @!attribute [rw] grounding_check_required
127
+ # @return [::Boolean]
128
+ # Indicates that this claim required grounding check. When the system
129
+ # decided this claim doesn't require attribution/grounding check, this
130
+ # field will be set to false. In that case, no grounding check was done for
131
+ # the claim and therefore
132
+ # {::Google::Cloud::DiscoveryEngine::V1beta::CheckGroundingResponse::Claim#citation_indices citation_indices},
133
+ # and
134
+ # [anti_citation_indices][google.cloud.discoveryengine.v1beta.CheckGroundingResponse.Claim.anti_citation_indices]
135
+ # should not be returned.
98
136
  class Claim
99
137
  include ::Google::Protobuf::MessageExts
100
138
  extend ::Google::Protobuf::MessageExts::ClassMethods
@@ -54,6 +54,9 @@ module Google
54
54
  # from the GroundingFacts provided in the request then this field will
55
55
  # contain the index of the specific fact from which this chunk was
56
56
  # retrieved.
57
+ # @!attribute [rw] index
58
+ # @return [::Integer]
59
+ # The index of this chunk. Currently, only used for the streaming mode.
57
60
  # @!attribute [rw] source_metadata
58
61
  # @return [::Google::Protobuf::Map{::String => ::String}]
59
62
  # More fine-grained information for the source reference.
@@ -24,7 +24,7 @@ module Google
24
24
  # Cloud Storage location for input content.
25
25
  # @!attribute [rw] input_uris
26
26
  # @return [::Array<::String>]
27
- # Required. Cloud Storage URIs to input files. URI can be up to
27
+ # Required. Cloud Storage URIs to input files. Each URI can be up to
28
28
  # 2000 characters long. URIs can match the full object path (for example,
29
29
  # `gs://bucket/directory/object.json`) or a pattern matching one or more
30
30
  # files, such as `gs://bucket/directory/*.json`.
@@ -54,7 +54,7 @@ module Google
54
54
  # data store. Each entry after the header is imported as a Document.
55
55
  # This can only be used by the GENERIC Data Store vertical.
56
56
  #
57
- # Supported values for user even imports:
57
+ # Supported values for user event imports:
58
58
  #
59
59
  # * `user_event` (default): One JSON
60
60
  # {::Google::Cloud::DiscoveryEngine::V1beta::UserEvent UserEvent} per line.
@@ -351,8 +351,8 @@ module Google
351
351
  # of 256 characters.
352
352
  # @!attribute [rw] collection_id
353
353
  # @return [::String]
354
- # Required. The Firestore collection to copy the data from with a length
355
- # limit of 1,500 characters.
354
+ # Required. The Firestore collection (or entity) to copy the data from with a
355
+ # length limit of 1,500 characters.
356
356
  # @!attribute [rw] gcs_staging_dir
357
357
  # @return [::String]
358
358
  # Intermediate Cloud Storage directory used for the import with a length