google-cloud-discovery_engine-v1beta 0.11.0 → 0.13.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (164) 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 +35 -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 +35 -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 +35 -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 +35 -6
  27. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/client.rb +824 -0
  28. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/credentials.rb +47 -0
  29. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/operations.rb +809 -0
  30. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/paths.rb +250 -0
  31. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/client.rb +770 -0
  32. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/operations.rb +1106 -0
  33. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest/service_stub.rb +306 -0
  34. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service/rest.rb +54 -0
  35. data/lib/google/cloud/discovery_engine/v1beta/evaluation_service.rb +57 -0
  36. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/client.rb +25 -3
  37. data/lib/google/cloud/discovery_engine/v1beta/grounded_generation_service/rest/client.rb +25 -3
  38. data/lib/google/cloud/discovery_engine/v1beta/project_service/client.rb +485 -0
  39. data/lib/google/cloud/discovery_engine/v1beta/project_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1beta/project_service/operations.rb +809 -0
  41. data/lib/google/cloud/discovery_engine/v1beta/project_service/paths.rb +47 -0
  42. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/client.rb +452 -0
  43. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/operations.rb +1106 -0
  44. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest/service_stub.rb +129 -0
  45. data/lib/google/cloud/discovery_engine/v1beta/project_service/rest.rb +54 -0
  46. data/lib/google/cloud/discovery_engine/v1beta/project_service.rb +57 -0
  47. data/lib/google/cloud/discovery_engine/v1beta/rank_service/client.rb +24 -2
  48. data/lib/google/cloud/discovery_engine/v1beta/rank_service/rest/client.rb +24 -2
  49. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/client.rb +24 -19
  50. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/paths.rb +66 -0
  51. data/lib/google/cloud/discovery_engine/v1beta/recommendation_service/rest/client.rb +24 -19
  52. data/lib/google/cloud/discovery_engine/v1beta/rest.rb +5 -0
  53. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/client.rb +1035 -0
  54. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/credentials.rb +47 -0
  55. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/operations.rb +809 -0
  56. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/paths.rb +73 -0
  57. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/client.rb +967 -0
  58. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/operations.rb +1106 -0
  59. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest/service_stub.rb +426 -0
  60. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service/rest.rb +54 -0
  61. data/lib/google/cloud/discovery_engine/v1beta/sample_query_service.rb +57 -0
  62. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/client.rb +911 -0
  63. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/credentials.rb +47 -0
  64. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/paths.rb +69 -0
  65. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/client.rb +850 -0
  66. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest/service_stub.rb +366 -0
  67. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service/rest.rb +53 -0
  68. data/lib/google/cloud/discovery_engine/v1beta/sample_query_set_service.rb +56 -0
  69. data/lib/google/cloud/discovery_engine/v1beta/schema_service/client.rb +18 -10
  70. data/lib/google/cloud/discovery_engine/v1beta/schema_service/operations.rb +13 -5
  71. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/client.rb +18 -10
  72. data/lib/google/cloud/discovery_engine/v1beta/schema_service/rest/operations.rb +35 -6
  73. data/lib/google/cloud/discovery_engine/v1beta/search_service/client.rb +25 -12
  74. data/lib/google/cloud/discovery_engine/v1beta/search_service/rest/client.rb +25 -12
  75. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/client.rb +104 -2
  76. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/operations.rb +13 -5
  77. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/client.rb +97 -2
  78. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/operations.rb +35 -6
  79. data/lib/google/cloud/discovery_engine/v1beta/search_tuning_service/rest/service_stub.rb +59 -0
  80. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/client.rb +9 -3
  81. data/lib/google/cloud/discovery_engine/v1beta/serving_config_service/rest/client.rb +9 -3
  82. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/client.rb +27 -12
  83. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/operations.rb +13 -5
  84. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/client.rb +27 -12
  85. data/lib/google/cloud/discovery_engine/v1beta/site_search_engine_service/rest/operations.rb +35 -6
  86. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/client.rb +23 -6
  87. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/operations.rb +13 -5
  88. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/paths.rb +21 -0
  89. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/client.rb +23 -6
  90. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/operations.rb +35 -6
  91. data/lib/google/cloud/discovery_engine/v1beta/user_event_service/rest/service_stub.rb +8 -0
  92. data/lib/google/cloud/discovery_engine/v1beta/version.rb +1 -1
  93. data/lib/google/cloud/discovery_engine/v1beta.rb +5 -0
  94. data/lib/google/cloud/discoveryengine/v1beta/answer_pb.rb +3 -1
  95. data/lib/google/cloud/discoveryengine/v1beta/chunk_pb.rb +50 -0
  96. data/lib/google/cloud/discoveryengine/v1beta/common_pb.rb +2 -1
  97. data/lib/google/cloud/discoveryengine/v1beta/control_pb.rb +55 -0
  98. data/lib/google/cloud/discoveryengine/v1beta/control_service_pb.rb +57 -0
  99. data/lib/google/cloud/discoveryengine/v1beta/control_service_services_pb.rb +69 -0
  100. data/lib/google/cloud/discoveryengine/v1beta/conversational_search_service_pb.rb +1 -1
  101. data/lib/google/cloud/discoveryengine/v1beta/custom_tuning_model_pb.rb +48 -0
  102. data/lib/google/cloud/discoveryengine/v1beta/document_processing_config_pb.rb +4 -1
  103. data/lib/google/cloud/discoveryengine/v1beta/document_service_services_pb.rb +1 -1
  104. data/lib/google/cloud/discoveryengine/v1beta/engine_pb.rb +1 -1
  105. data/lib/google/cloud/discoveryengine/v1beta/evaluation_pb.rb +56 -0
  106. data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_pb.rb +59 -0
  107. data/lib/google/cloud/discoveryengine/v1beta/evaluation_service_services_pb.rb +57 -0
  108. data/lib/google/cloud/discoveryengine/v1beta/grounded_generation_service_pb.rb +1 -1
  109. data/lib/google/cloud/discoveryengine/v1beta/grounding_pb.rb +1 -1
  110. data/lib/google/cloud/discoveryengine/v1beta/import_config_pb.rb +7 -1
  111. data/lib/google/cloud/discoveryengine/v1beta/project_pb.rb +49 -0
  112. data/lib/google/cloud/discoveryengine/v1beta/project_service_pb.rb +50 -0
  113. data/lib/google/cloud/discoveryengine/v1beta/project_service_services_pb.rb +51 -0
  114. data/lib/google/cloud/discoveryengine/v1beta/rank_service_pb.rb +1 -1
  115. data/lib/google/cloud/discoveryengine/v1beta/sample_query_pb.rb +49 -0
  116. data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_pb.rb +59 -0
  117. data/lib/google/cloud/discoveryengine/v1beta/sample_query_service_services_pb.rb +63 -0
  118. data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_pb.rb +47 -0
  119. data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_pb.rb +57 -0
  120. data/lib/google/cloud/discoveryengine/v1beta/sample_query_set_service_services_pb.rb +59 -0
  121. data/lib/google/cloud/discoveryengine/v1beta/search_service_pb.rb +5 -1
  122. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_pb.rb +5 -1
  123. data/lib/google/cloud/discoveryengine/v1beta/search_tuning_service_services_pb.rb +2 -0
  124. data/lib/google/cloud/discoveryengine/v1beta/site_search_engine_pb.rb +1 -1
  125. data/lib/google/cloud/discoveryengine/v1beta/user_event_pb.rb +1 -1
  126. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_pb.rb +1 -1
  127. data/lib/google/cloud/discoveryengine/v1beta/user_event_service_services_pb.rb +1 -1
  128. data/proto_docs/google/api/client.rb +14 -10
  129. data/proto_docs/google/api/resource.rb +7 -2
  130. data/proto_docs/google/cloud/discoveryengine/v1beta/answer.rb +9 -1
  131. data/proto_docs/google/cloud/discoveryengine/v1beta/chunk.rb +119 -0
  132. data/proto_docs/google/cloud/discoveryengine/v1beta/common.rb +16 -0
  133. data/proto_docs/google/cloud/discoveryengine/v1beta/control.rb +209 -0
  134. data/proto_docs/google/cloud/discoveryengine/v1beta/control_service.rb +126 -0
  135. data/proto_docs/google/cloud/discoveryengine/v1beta/conversation.rb +2 -2
  136. data/proto_docs/google/cloud/discoveryengine/v1beta/conversational_search_service.rb +29 -5
  137. data/proto_docs/google/cloud/discoveryengine/v1beta/custom_tuning_model.rb +75 -0
  138. data/proto_docs/google/cloud/discoveryengine/v1beta/data_store_service.rb +2 -2
  139. data/proto_docs/google/cloud/discoveryengine/v1beta/document.rb +1 -1
  140. data/proto_docs/google/cloud/discoveryengine/v1beta/document_processing_config.rb +44 -2
  141. data/proto_docs/google/cloud/discoveryengine/v1beta/document_service.rb +6 -7
  142. data/proto_docs/google/cloud/discoveryengine/v1beta/engine.rb +3 -3
  143. data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation.rb +223 -0
  144. data/proto_docs/google/cloud/discoveryengine/v1beta/evaluation_service.rb +194 -0
  145. data/proto_docs/google/cloud/discoveryengine/v1beta/grounded_generation_service.rb +39 -1
  146. data/proto_docs/google/cloud/discoveryengine/v1beta/grounding.rb +3 -0
  147. data/proto_docs/google/cloud/discoveryengine/v1beta/import_config.rb +89 -4
  148. data/proto_docs/google/cloud/discoveryengine/v1beta/project.rb +106 -0
  149. data/proto_docs/google/cloud/discoveryengine/v1beta/project_service.rb +57 -0
  150. data/proto_docs/google/cloud/discoveryengine/v1beta/rank_service.rb +28 -0
  151. data/proto_docs/google/cloud/discoveryengine/v1beta/recommendation_service.rb +20 -19
  152. data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query.rb +82 -0
  153. data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_service.rb +179 -0
  154. data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set.rb +57 -0
  155. data/proto_docs/google/cloud/discoveryengine/v1beta/sample_query_set_service.rb +186 -0
  156. data/proto_docs/google/cloud/discoveryengine/v1beta/schema_service.rb +5 -5
  157. data/proto_docs/google/cloud/discoveryengine/v1beta/search_service.rb +95 -28
  158. data/proto_docs/google/cloud/discoveryengine/v1beta/search_tuning_service.rb +31 -0
  159. data/proto_docs/google/cloud/discoveryengine/v1beta/serving_config.rb +11 -5
  160. data/proto_docs/google/cloud/discoveryengine/v1beta/session.rb +4 -1
  161. data/proto_docs/google/cloud/discoveryengine/v1beta/site_search_engine.rb +3 -0
  162. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event.rb +24 -3
  163. data/proto_docs/google/cloud/discoveryengine/v1beta/user_event_service.rb +13 -1
  164. metadata +72 -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
  #
@@ -0,0 +1,82 @@
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
+ # Sample Query captures metadata to be used for evaluation.
25
+ # @!attribute [rw] query_entry
26
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry]
27
+ # The query entry.
28
+ # @!attribute [rw] name
29
+ # @return [::String]
30
+ # Identifier. The full resource name of the sample query, in the format of
31
+ # `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
32
+ #
33
+ # This field must be a UTF-8 encoded string with a length limit of 1024
34
+ # characters.
35
+ # @!attribute [r] create_time
36
+ # @return [::Google::Protobuf::Timestamp]
37
+ # Output only. Timestamp the
38
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} was created
39
+ # at.
40
+ class SampleQuery
41
+ include ::Google::Protobuf::MessageExts
42
+ extend ::Google::Protobuf::MessageExts::ClassMethods
43
+
44
+ # Query Entry captures metadata to be used for search evaluation.
45
+ # @!attribute [rw] query
46
+ # @return [::String]
47
+ # Required. The query.
48
+ # @!attribute [rw] targets
49
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery::QueryEntry::Target>]
50
+ # List of targets for the query.
51
+ class QueryEntry
52
+ include ::Google::Protobuf::MessageExts
53
+ extend ::Google::Protobuf::MessageExts::ClassMethods
54
+
55
+ # Defines the parameters of the query's expected outcome.
56
+ # @!attribute [rw] uri
57
+ # @return [::String]
58
+ # Expected uri of the target.
59
+ #
60
+ # This field must be a UTF-8 encoded string with a length limit of 2048
61
+ # characters.
62
+ #
63
+ # Example of valid uris: `https://example.com/abc`,
64
+ # `gcs://example/example.pdf`.
65
+ # @!attribute [rw] page_numbers
66
+ # @return [::Array<::Integer>]
67
+ # Expected page numbers of the target.
68
+ #
69
+ # Each page number must be non negative.
70
+ # @!attribute [rw] score
71
+ # @return [::Float]
72
+ # Relevance score of the target.
73
+ class Target
74
+ include ::Google::Protobuf::MessageExts
75
+ extend ::Google::Protobuf::MessageExts::ClassMethods
76
+ end
77
+ end
78
+ end
79
+ end
80
+ end
81
+ end
82
+ end
@@ -0,0 +1,179 @@
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 message for
25
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#get_sample_query SampleQueryService.GetSampleQuery}
26
+ # method.
27
+ # @!attribute [rw] name
28
+ # @return [::String]
29
+ # Required. Full resource name of
30
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, such as
31
+ # `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
32
+ #
33
+ # If the caller does not have permission to access the
34
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
35
+ # of whether or not it exists, a PERMISSION_DENIED error is returned.
36
+ #
37
+ # If the requested
38
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} does not
39
+ # exist, a NOT_FOUND error is returned.
40
+ class GetSampleQueryRequest
41
+ include ::Google::Protobuf::MessageExts
42
+ extend ::Google::Protobuf::MessageExts::ClassMethods
43
+ end
44
+
45
+ # Request message for
46
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
47
+ # method.
48
+ # @!attribute [rw] parent
49
+ # @return [::String]
50
+ # Required. The parent sample query set resource name, such as
51
+ # `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
52
+ #
53
+ # If the caller does not have permission to list
54
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s under this
55
+ # sample query set, regardless of whether or not this sample query set
56
+ # exists, a `PERMISSION_DENIED` error is returned.
57
+ # @!attribute [rw] page_size
58
+ # @return [::Integer]
59
+ # Maximum number of
60
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s to return.
61
+ # If unspecified, defaults to 100. The maximum allowed value is 1000. Values
62
+ # above 1000 will be coerced to 1000.
63
+ #
64
+ # If this field is negative, an `INVALID_ARGUMENT` error is returned.
65
+ # @!attribute [rw] page_token
66
+ # @return [::String]
67
+ # A page token
68
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQueriesResponse#next_page_token ListSampleQueriesResponse.next_page_token},
69
+ # received from a previous
70
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
71
+ # call. Provide this to retrieve the subsequent page.
72
+ #
73
+ # When paginating, all other parameters provided to
74
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
75
+ # must match the call that provided the page token. Otherwise, an
76
+ # `INVALID_ARGUMENT` error is returned.
77
+ class ListSampleQueriesRequest
78
+ include ::Google::Protobuf::MessageExts
79
+ extend ::Google::Protobuf::MessageExts::ClassMethods
80
+ end
81
+
82
+ # Response message for
83
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#list_sample_queries SampleQueryService.ListSampleQueries}
84
+ # method.
85
+ # @!attribute [rw] sample_queries
86
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery>]
87
+ # The {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s.
88
+ # @!attribute [rw] next_page_token
89
+ # @return [::String]
90
+ # A token that can be sent as
91
+ # {::Google::Cloud::DiscoveryEngine::V1beta::ListSampleQueriesRequest#page_token ListSampleQueriesRequest.page_token}
92
+ # to retrieve the next page. If this field is omitted, there are no
93
+ # subsequent pages.
94
+ class ListSampleQueriesResponse
95
+ include ::Google::Protobuf::MessageExts
96
+ extend ::Google::Protobuf::MessageExts::ClassMethods
97
+ end
98
+
99
+ # Request message for
100
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#create_sample_query SampleQueryService.CreateSampleQuery}
101
+ # method.
102
+ # @!attribute [rw] parent
103
+ # @return [::String]
104
+ # Required. The parent resource name, such as
105
+ # `projects/{project}/locations/{location}/sampleQuerySets/{sampleQuerySet}`.
106
+ # @!attribute [rw] sample_query
107
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery]
108
+ # Required. The
109
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to create.
110
+ # @!attribute [rw] sample_query_id
111
+ # @return [::String]
112
+ # Required. The ID to use for the
113
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, which will
114
+ # become the final component of the
115
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery#name SampleQuery.name}.
116
+ #
117
+ # If the caller does not have permission to create the
118
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
119
+ # of whether or not it exists, a `PERMISSION_DENIED` error is returned.
120
+ #
121
+ # This field must be unique among all
122
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}s with the
123
+ # same
124
+ # {::Google::Cloud::DiscoveryEngine::V1beta::CreateSampleQueryRequest#parent parent}.
125
+ # Otherwise, an `ALREADY_EXISTS` error is returned.
126
+ #
127
+ # This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
128
+ # standard with a length limit of 63 characters. Otherwise, an
129
+ # `INVALID_ARGUMENT` error is returned.
130
+ class CreateSampleQueryRequest
131
+ include ::Google::Protobuf::MessageExts
132
+ extend ::Google::Protobuf::MessageExts::ClassMethods
133
+ end
134
+
135
+ # Request message for
136
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#update_sample_query SampleQueryService.UpdateSampleQuery}
137
+ # method.
138
+ # @!attribute [rw] sample_query
139
+ # @return [::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery]
140
+ # Required. The simple query to update.
141
+ #
142
+ # If the caller does not have permission to update the
143
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
144
+ # of whether or not it exists, a `PERMISSION_DENIED` error is returned.
145
+ #
146
+ # If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to
147
+ # update does not exist a `NOT_FOUND` error is returned.
148
+ # @!attribute [rw] update_mask
149
+ # @return [::Google::Protobuf::FieldMask]
150
+ # Indicates which fields in the provided imported 'simple query' to update.
151
+ # If not set, will by default update all fields.
152
+ class UpdateSampleQueryRequest
153
+ include ::Google::Protobuf::MessageExts
154
+ extend ::Google::Protobuf::MessageExts::ClassMethods
155
+ end
156
+
157
+ # Request message for
158
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQueryService::Client#delete_sample_query SampleQueryService.DeleteSampleQuery}
159
+ # method.
160
+ # @!attribute [rw] name
161
+ # @return [::String]
162
+ # Required. Full resource name of
163
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, such as
164
+ # `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}/sampleQueries/{sample_query}`.
165
+ #
166
+ # If the caller does not have permission to delete the
167
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery}, regardless
168
+ # of whether or not it exists, a `PERMISSION_DENIED` error is returned.
169
+ #
170
+ # If the {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuery SampleQuery} to
171
+ # delete does not exist, a `NOT_FOUND` error is returned.
172
+ class DeleteSampleQueryRequest
173
+ include ::Google::Protobuf::MessageExts
174
+ extend ::Google::Protobuf::MessageExts::ClassMethods
175
+ end
176
+ end
177
+ end
178
+ end
179
+ 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
+ # A SampleQuerySet is the parent resource of SampleQuery, and contains the
25
+ # configurations shared by all SampleQuery under it.
26
+ # @!attribute [rw] name
27
+ # @return [::String]
28
+ # Identifier. The full resource name of the
29
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}, in
30
+ # the format of
31
+ # `projects/{project}/locations/{location}/sampleQuerySets/{sample_query_set}`.
32
+ #
33
+ # This field must be a UTF-8 encoded string with a length limit of 1024
34
+ # characters.
35
+ # @!attribute [rw] display_name
36
+ # @return [::String]
37
+ # Required. The sample query set display name.
38
+ #
39
+ # This field must be a UTF-8 encoded string with a length limit of 128
40
+ # characters.
41
+ # @!attribute [r] create_time
42
+ # @return [::Google::Protobuf::Timestamp]
43
+ # Output only. Timestamp the
44
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet} was
45
+ # created at.
46
+ # @!attribute [rw] description
47
+ # @return [::String]
48
+ # The description of the
49
+ # {::Google::Cloud::DiscoveryEngine::V1beta::SampleQuerySet SampleQuerySet}.
50
+ class SampleQuerySet
51
+ include ::Google::Protobuf::MessageExts
52
+ extend ::Google::Protobuf::MessageExts::ClassMethods
53
+ end
54
+ end
55
+ end
56
+ end
57
+ end