google-cloud-discovery_engine-v1 0.4.2 → 0.5.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (90) hide show
  1. checksums.yaml +4 -4
  2. data/lib/google/cloud/discovery_engine/v1/completion_service/client.rb +235 -4
  3. data/lib/google/cloud/discovery_engine/v1/completion_service/operations.rb +801 -0
  4. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/client.rb +221 -4
  5. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/operations.rb +1091 -0
  6. data/lib/google/cloud/discovery_engine/v1/completion_service/rest/service_stub.rb +136 -0
  7. data/lib/google/cloud/discovery_engine/v1/completion_service/rest.rb +1 -0
  8. data/lib/google/cloud/discovery_engine/v1/completion_service.rb +1 -0
  9. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/client.rb +20 -3
  10. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/paths.rb +91 -0
  11. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/client.rb +20 -3
  12. data/lib/google/cloud/discovery_engine/v1/conversational_search_service/rest/service_stub.rb +45 -0
  13. data/lib/google/cloud/discovery_engine/v1/data_store_service/client.rb +924 -0
  14. data/lib/google/cloud/discovery_engine/v1/data_store_service/credentials.rb +47 -0
  15. data/lib/google/cloud/discovery_engine/v1/data_store_service/operations.rb +801 -0
  16. data/lib/google/cloud/discovery_engine/v1/data_store_service/paths.rb +97 -0
  17. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/client.rb +863 -0
  18. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/operations.rb +1091 -0
  19. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest/service_stub.rb +403 -0
  20. data/lib/google/cloud/discovery_engine/v1/data_store_service/rest.rb +54 -0
  21. data/lib/google/cloud/discovery_engine/v1/data_store_service.rb +57 -0
  22. data/lib/google/cloud/discovery_engine/v1/document_service/rest/operations.rb +14 -0
  23. data/lib/google/cloud/discovery_engine/v1/engine_service/client.rb +885 -0
  24. data/lib/google/cloud/discovery_engine/v1/engine_service/credentials.rb +47 -0
  25. data/lib/google/cloud/discovery_engine/v1/engine_service/operations.rb +801 -0
  26. data/lib/google/cloud/discovery_engine/v1/engine_service/paths.rb +73 -0
  27. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/client.rb +824 -0
  28. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/operations.rb +1091 -0
  29. data/lib/google/cloud/discovery_engine/v1/engine_service/rest/service_stub.rb +366 -0
  30. data/lib/google/cloud/discovery_engine/v1/engine_service/rest.rb +54 -0
  31. data/lib/google/cloud/discovery_engine/v1/engine_service.rb +57 -0
  32. data/lib/google/cloud/discovery_engine/v1/rest.rb +3 -0
  33. data/lib/google/cloud/discovery_engine/v1/schema_service/rest/operations.rb +14 -0
  34. data/lib/google/cloud/discovery_engine/v1/search_service/client.rb +40 -4
  35. data/lib/google/cloud/discovery_engine/v1/search_service/paths.rb +19 -0
  36. data/lib/google/cloud/discovery_engine/v1/search_service/rest/client.rb +40 -4
  37. data/lib/google/cloud/discovery_engine/v1/search_service/rest/service_stub.rb +8 -0
  38. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/client.rb +1631 -0
  39. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/credentials.rb +47 -0
  40. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/operations.rb +801 -0
  41. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/paths.rb +127 -0
  42. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/client.rb +1521 -0
  43. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/operations.rb +1091 -0
  44. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest/service_stub.rb +860 -0
  45. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service/rest.rb +53 -0
  46. data/lib/google/cloud/discovery_engine/v1/site_search_engine_service.rb +56 -0
  47. data/lib/google/cloud/discovery_engine/v1/user_event_service/rest/operations.rb +14 -0
  48. data/lib/google/cloud/discovery_engine/v1/version.rb +1 -1
  49. data/lib/google/cloud/discovery_engine/v1.rb +3 -0
  50. data/lib/google/cloud/discoveryengine/v1/common_pb.rb +5 -1
  51. data/lib/google/cloud/discoveryengine/v1/completion_pb.rb +45 -0
  52. data/lib/google/cloud/discoveryengine/v1/completion_service_pb.rb +4 -1
  53. data/lib/google/cloud/discoveryengine/v1/completion_service_services_pb.rb +8 -0
  54. data/lib/google/cloud/discoveryengine/v1/conversation_pb.rb +1 -1
  55. data/lib/google/cloud/discoveryengine/v1/conversational_search_service_pb.rb +1 -1
  56. data/lib/google/cloud/discoveryengine/v1/data_store_pb.rb +49 -0
  57. data/lib/google/cloud/discoveryengine/v1/data_store_service_pb.rb +62 -0
  58. data/lib/google/cloud/discoveryengine/v1/data_store_service_services_pb.rb +61 -0
  59. data/lib/google/cloud/discoveryengine/v1/document_pb.rb +1 -1
  60. data/lib/google/cloud/discoveryengine/v1/document_service_pb.rb +1 -1
  61. data/lib/google/cloud/discoveryengine/v1/engine_pb.rb +53 -0
  62. data/lib/google/cloud/discoveryengine/v1/engine_service_pb.rb +62 -0
  63. data/lib/google/cloud/discoveryengine/v1/engine_service_services_pb.rb +55 -0
  64. data/lib/google/cloud/discoveryengine/v1/import_config_pb.rb +7 -1
  65. data/lib/google/cloud/discoveryengine/v1/purge_config_pb.rb +6 -1
  66. data/lib/google/cloud/discoveryengine/v1/schema_pb.rb +1 -1
  67. data/lib/google/cloud/discoveryengine/v1/schema_service_pb.rb +1 -1
  68. data/lib/google/cloud/discoveryengine/v1/search_service_pb.rb +8 -1
  69. data/lib/google/cloud/discoveryengine/v1/site_search_engine_pb.rb +54 -0
  70. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_pb.rb +82 -0
  71. data/lib/google/cloud/discoveryengine/v1/site_search_engine_service_services_pb.rb +73 -0
  72. data/lib/google/cloud/discoveryengine/v1/user_event_pb.rb +1 -1
  73. data/lib/google/cloud/discoveryengine/v1/user_event_service_pb.rb +1 -1
  74. data/proto_docs/google/cloud/discoveryengine/v1/common.rb +51 -0
  75. data/proto_docs/google/cloud/discoveryengine/v1/completion.rb +53 -0
  76. data/proto_docs/google/cloud/discoveryengine/v1/completion_service.rb +10 -4
  77. data/proto_docs/google/cloud/discoveryengine/v1/conversation.rb +2 -0
  78. data/proto_docs/google/cloud/discoveryengine/v1/conversational_search_service.rb +19 -1
  79. data/proto_docs/google/cloud/discoveryengine/v1/data_store.rb +88 -0
  80. data/proto_docs/google/cloud/discoveryengine/v1/data_store_service.rb +214 -0
  81. data/proto_docs/google/cloud/discoveryengine/v1/document.rb +1 -1
  82. data/proto_docs/google/cloud/discoveryengine/v1/engine.rb +214 -0
  83. data/proto_docs/google/cloud/discoveryengine/v1/engine_service.rb +177 -0
  84. data/proto_docs/google/cloud/discoveryengine/v1/import_config.rb +66 -0
  85. data/proto_docs/google/cloud/discoveryengine/v1/purge_config.rb +41 -0
  86. data/proto_docs/google/cloud/discoveryengine/v1/search_service.rb +149 -4
  87. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine.rb +160 -0
  88. data/proto_docs/google/cloud/discoveryengine/v1/site_search_engine_service.rb +525 -0
  89. data/proto_docs/google/cloud/discoveryengine/v1/user_event.rb +3 -3
  90. metadata +48 -2
@@ -0,0 +1,214 @@
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 V1
24
+ # Metadata that describes the training and serving parameters of an
25
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}.
26
+ # @!attribute [rw] chat_engine_config
27
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig]
28
+ # Configurations for the Chat Engine. Only applicable if
29
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type} is
30
+ # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
31
+ # @!attribute [rw] search_engine_config
32
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::SearchEngineConfig]
33
+ # Configurations for the Search Engine. Only applicable if
34
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type} is
35
+ # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}.
36
+ # @!attribute [r] chat_engine_metadata
37
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata]
38
+ # Output only. Additional information of the Chat Engine. Only applicable
39
+ # if {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type}
40
+ # is
41
+ # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT}.
42
+ # @!attribute [rw] name
43
+ # @return [::String]
44
+ # Immutable. The fully qualified resource name of the engine.
45
+ #
46
+ # This field must be a UTF-8 encoded string with a length limit of 1024
47
+ # characters.
48
+ #
49
+ # Format:
50
+ # `projects/{project_number}/locations/{location}/collections/{collection}/engines/{engine}`
51
+ # engine should be 1-63 characters, and valid characters are
52
+ # /[a-z0-9][a-z0-9-_]*/. Otherwise, an INVALID_ARGUMENT error is returned.
53
+ # @!attribute [rw] display_name
54
+ # @return [::String]
55
+ # Required. The display name of the engine. Should be human readable. UTF-8
56
+ # encoded string with limit of 1024 characters.
57
+ # @!attribute [r] create_time
58
+ # @return [::Google::Protobuf::Timestamp]
59
+ # Output only. Timestamp the Recommendation Engine was created at.
60
+ # @!attribute [r] update_time
61
+ # @return [::Google::Protobuf::Timestamp]
62
+ # Output only. Timestamp the Recommendation Engine was last updated.
63
+ # @!attribute [rw] data_store_ids
64
+ # @return [::Array<::String>]
65
+ # The data stores associated with this engine.
66
+ #
67
+ # For
68
+ # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_SEARCH SOLUTION_TYPE_SEARCH}
69
+ # and
70
+ # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_RECOMMENDATION SOLUTION_TYPE_RECOMMENDATION}
71
+ # type of engines, they can only associate with at most one data store.
72
+ #
73
+ # If {::Google::Cloud::DiscoveryEngine::V1::Engine#solution_type solution_type} is
74
+ # {::Google::Cloud::DiscoveryEngine::V1::SolutionType::SOLUTION_TYPE_CHAT SOLUTION_TYPE_CHAT},
75
+ # multiple {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}s in the
76
+ # same [Collection][google.cloud.discoveryengine.v1.Collection] can be
77
+ # associated here.
78
+ #
79
+ # Note that when used in
80
+ # {::Google::Cloud::DiscoveryEngine::V1::CreateEngineRequest CreateEngineRequest},
81
+ # one DataStore id must be provided as the system will use it for necessary
82
+ # initializations.
83
+ # @!attribute [rw] solution_type
84
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SolutionType]
85
+ # Required. The solutions of the engine.
86
+ # @!attribute [rw] industry_vertical
87
+ # @return [::Google::Cloud::DiscoveryEngine::V1::IndustryVertical]
88
+ # The industry vertical that the engine registers.
89
+ # The restriction of the Engine industry vertical is based on
90
+ # {::Google::Cloud::DiscoveryEngine::V1::DataStore DataStore}: If unspecified,
91
+ # default to `GENERIC`. Vertical on Engine has to match vertical of the
92
+ # DataStore liniked to the engine.
93
+ # @!attribute [rw] common_config
94
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::CommonConfig]
95
+ # Common config spec that specifies the metadata of the engine.
96
+ class Engine
97
+ include ::Google::Protobuf::MessageExts
98
+ extend ::Google::Protobuf::MessageExts::ClassMethods
99
+
100
+ # Configurations for a Search Engine.
101
+ # @!attribute [rw] search_tier
102
+ # @return [::Google::Cloud::DiscoveryEngine::V1::SearchTier]
103
+ # The search feature tier of this engine.
104
+ #
105
+ # Different tiers might have different
106
+ # pricing. To learn more, please check the pricing documentation.
107
+ #
108
+ # Defaults to
109
+ # {::Google::Cloud::DiscoveryEngine::V1::SearchTier::SEARCH_TIER_STANDARD SearchTier.SEARCH_TIER_STANDARD}
110
+ # if not specified.
111
+ # @!attribute [rw] search_add_ons
112
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SearchAddOn>]
113
+ # The add-on that this search engine enables.
114
+ class SearchEngineConfig
115
+ include ::Google::Protobuf::MessageExts
116
+ extend ::Google::Protobuf::MessageExts::ClassMethods
117
+ end
118
+
119
+ # Configurations for a Chat Engine.
120
+ # @!attribute [rw] agent_creation_config
121
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineConfig::AgentCreationConfig]
122
+ # The configurationt generate the Dialogflow agent that is associated to
123
+ # this Engine.
124
+ #
125
+ # Note that these configurations are one-time consumed by
126
+ # and passed to Dialogflow service. It means they cannot be retrieved using
127
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
128
+ # or
129
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
130
+ # API after engine creation.
131
+ # @!attribute [rw] dialogflow_agent_to_link
132
+ # @return [::String]
133
+ # The resource name of an exist Dialogflow agent to link to this Chat
134
+ # Engine. Customers can either provide `agent_creation_config` to create
135
+ # agent or provide an agent name that links the agent with the Chat engine.
136
+ #
137
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
138
+ # ID>`.
139
+ #
140
+ # Note that the `dialogflow_agent_to_link` are one-time consumed by and
141
+ # passed to Dialogflow service. It means they cannot be retrieved using
142
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
143
+ # or
144
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
145
+ # API after engine creation. Please use
146
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine::ChatEngineMetadata#dialogflow_agent ChatEngineMetadata.dialogflow_agent}
147
+ # for actual agent association after Engine is created.
148
+ class ChatEngineConfig
149
+ include ::Google::Protobuf::MessageExts
150
+ extend ::Google::Protobuf::MessageExts::ClassMethods
151
+
152
+ # Configurations for generating a Dialogflow agent.
153
+ #
154
+ # Note that these configurations are one-time consumed by
155
+ # and passed to Dialogflow service. It means they cannot be retrieved using
156
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
157
+ # or
158
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
159
+ # API after engine creation.
160
+ # @!attribute [rw] business
161
+ # @return [::String]
162
+ # Name of the company, organization or other entity that the agent
163
+ # represents. Used for knowledge connector LLM prompt and for knowledge
164
+ # search.
165
+ # @!attribute [rw] default_language_code
166
+ # @return [::String]
167
+ # Required. The default language of the agent as a language tag.
168
+ # See [Language
169
+ # Support](https://cloud.google.com/dialogflow/docs/reference/language)
170
+ # for a list of the currently supported language codes.
171
+ # @!attribute [rw] time_zone
172
+ # @return [::String]
173
+ # Required. The time zone of the agent from the [time zone
174
+ # database](https://www.iana.org/time-zones), e.g., America/New_York,
175
+ # Europe/Paris.
176
+ # @!attribute [rw] location
177
+ # @return [::String]
178
+ # Agent location for Agent creation, supported values: global/us/eu.
179
+ # If not provided, us Engine will create Agent using us-central-1 by
180
+ # default; eu Engine will create Agent using eu-west-1 by default.
181
+ class AgentCreationConfig
182
+ include ::Google::Protobuf::MessageExts
183
+ extend ::Google::Protobuf::MessageExts::ClassMethods
184
+ end
185
+ end
186
+
187
+ # Common configurations for an Engine.
188
+ # @!attribute [rw] company_name
189
+ # @return [::String]
190
+ # Immutable. The name of the company, business or entity that is associated
191
+ # with the engine. Setting this may help improve LLM related features.
192
+ class CommonConfig
193
+ include ::Google::Protobuf::MessageExts
194
+ extend ::Google::Protobuf::MessageExts::ClassMethods
195
+ end
196
+
197
+ # Additional information of a Chat Engine.
198
+ # Fields in this message are output only.
199
+ # @!attribute [rw] dialogflow_agent
200
+ # @return [::String]
201
+ # The resource name of a Dialogflow agent, that this Chat Engine refers
202
+ # to.
203
+ #
204
+ # Format: `projects/<Project ID>/locations/<Location ID>/agents/<Agent
205
+ # ID>`.
206
+ class ChatEngineMetadata
207
+ include ::Google::Protobuf::MessageExts
208
+ extend ::Google::Protobuf::MessageExts::ClassMethods
209
+ end
210
+ end
211
+ end
212
+ end
213
+ end
214
+ end
@@ -0,0 +1,177 @@
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 V1
24
+ # Request for
25
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}
26
+ # method.
27
+ # @!attribute [rw] parent
28
+ # @return [::String]
29
+ # Required. The parent resource name, such as
30
+ # `projects/{project}/locations/{location}/collections/{collection}`.
31
+ # @!attribute [rw] engine
32
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine]
33
+ # Required. The {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to create.
34
+ # @!attribute [rw] engine_id
35
+ # @return [::String]
36
+ # Required. The ID to use for the
37
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, which will become the
38
+ # final component of the {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}'s
39
+ # resource name.
40
+ #
41
+ # This field must conform to [RFC-1034](https://tools.ietf.org/html/rfc1034)
42
+ # standard with a length limit of 63 characters. Otherwise, an
43
+ # INVALID_ARGUMENT error is returned.
44
+ class CreateEngineRequest
45
+ include ::Google::Protobuf::MessageExts
46
+ extend ::Google::Protobuf::MessageExts::ClassMethods
47
+ end
48
+
49
+ # Metadata related to the progress of the
50
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#create_engine EngineService.CreateEngine}
51
+ # operation. This will be returned by the google.longrunning.Operation.metadata
52
+ # field.
53
+ # @!attribute [rw] create_time
54
+ # @return [::Google::Protobuf::Timestamp]
55
+ # Operation create time.
56
+ # @!attribute [rw] update_time
57
+ # @return [::Google::Protobuf::Timestamp]
58
+ # Operation last update time. If the operation is done, this is also the
59
+ # finish time.
60
+ class CreateEngineMetadata
61
+ include ::Google::Protobuf::MessageExts
62
+ extend ::Google::Protobuf::MessageExts::ClassMethods
63
+ end
64
+
65
+ # Request message for
66
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#delete_engine EngineService.DeleteEngine}
67
+ # method.
68
+ # @!attribute [rw] name
69
+ # @return [::String]
70
+ # Required. Full resource name of
71
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, such as
72
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
73
+ #
74
+ # If the caller does not have permission to delete the
75
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, regardless of whether or
76
+ # not it exists, a PERMISSION_DENIED error is returned.
77
+ #
78
+ # If the {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to delete does not
79
+ # exist, a NOT_FOUND error is returned.
80
+ class DeleteEngineRequest
81
+ include ::Google::Protobuf::MessageExts
82
+ extend ::Google::Protobuf::MessageExts::ClassMethods
83
+ end
84
+
85
+ # Metadata related to the progress of the
86
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#delete_engine EngineService.DeleteEngine}
87
+ # operation. This will be returned by the google.longrunning.Operation.metadata
88
+ # field.
89
+ # @!attribute [rw] create_time
90
+ # @return [::Google::Protobuf::Timestamp]
91
+ # Operation create time.
92
+ # @!attribute [rw] update_time
93
+ # @return [::Google::Protobuf::Timestamp]
94
+ # Operation last update time. If the operation is done, this is also the
95
+ # finish time.
96
+ class DeleteEngineMetadata
97
+ include ::Google::Protobuf::MessageExts
98
+ extend ::Google::Protobuf::MessageExts::ClassMethods
99
+ end
100
+
101
+ # Request message for
102
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#get_engine EngineService.GetEngine}
103
+ # method.
104
+ # @!attribute [rw] name
105
+ # @return [::String]
106
+ # Required. Full resource name of
107
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, such as
108
+ # `projects/{project}/locations/{location}/collections/{collection_id}/engines/{engine_id}`.
109
+ class GetEngineRequest
110
+ include ::Google::Protobuf::MessageExts
111
+ extend ::Google::Protobuf::MessageExts::ClassMethods
112
+ end
113
+
114
+ # Request message for
115
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
116
+ # method.
117
+ # @!attribute [rw] parent
118
+ # @return [::String]
119
+ # Required. The parent resource name, such as
120
+ # `projects/{project}/locations/{location}/collections/{collection_id}`.
121
+ # @!attribute [rw] page_size
122
+ # @return [::Integer]
123
+ # Optional. Not supported.
124
+ # @!attribute [rw] page_token
125
+ # @return [::String]
126
+ # Optional. Not supported.
127
+ # @!attribute [rw] filter
128
+ # @return [::String]
129
+ # Optional. Filter by solution type. For example:
130
+ # solution_type=SOLUTION_TYPE_SEARCH
131
+ class ListEnginesRequest
132
+ include ::Google::Protobuf::MessageExts
133
+ extend ::Google::Protobuf::MessageExts::ClassMethods
134
+ end
135
+
136
+ # Response message for
137
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#list_engines EngineService.ListEngines}
138
+ # method.
139
+ # @!attribute [rw] engines
140
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::Engine>]
141
+ # All the customer's {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}s.
142
+ # @!attribute [rw] next_page_token
143
+ # @return [::String]
144
+ # Not supported.
145
+ class ListEnginesResponse
146
+ include ::Google::Protobuf::MessageExts
147
+ extend ::Google::Protobuf::MessageExts::ClassMethods
148
+ end
149
+
150
+ # Request message for
151
+ # {::Google::Cloud::DiscoveryEngine::V1::EngineService::Client#update_engine EngineService.UpdateEngine}
152
+ # method.
153
+ # @!attribute [rw] engine
154
+ # @return [::Google::Cloud::DiscoveryEngine::V1::Engine]
155
+ # Required. The {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to update.
156
+ #
157
+ # If the caller does not have permission to update the
158
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine Engine}, regardless of whether or
159
+ # not it exists, a PERMISSION_DENIED error is returned.
160
+ #
161
+ # If the {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to update does not
162
+ # exist, a NOT_FOUND error is returned.
163
+ # @!attribute [rw] update_mask
164
+ # @return [::Google::Protobuf::FieldMask]
165
+ # Indicates which fields in the provided
166
+ # {::Google::Cloud::DiscoveryEngine::V1::Engine Engine} to update.
167
+ #
168
+ # If an unsupported or unknown field is provided, an INVALID_ARGUMENT error
169
+ # is returned.
170
+ class UpdateEngineRequest
171
+ include ::Google::Protobuf::MessageExts
172
+ extend ::Google::Protobuf::MessageExts::ClassMethods
173
+ end
174
+ end
175
+ end
176
+ end
177
+ end
@@ -334,6 +334,72 @@ module Google
334
334
  include ::Google::Protobuf::MessageExts
335
335
  extend ::Google::Protobuf::MessageExts::ClassMethods
336
336
  end
337
+
338
+ # Request message for
339
+ # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#import_suggestion_deny_list_entries CompletionService.ImportSuggestionDenyListEntries}
340
+ # method.
341
+ # @!attribute [rw] inline_source
342
+ # @return [::Google::Cloud::DiscoveryEngine::V1::ImportSuggestionDenyListEntriesRequest::InlineSource]
343
+ # The Inline source for the input content for suggestion deny list entries.
344
+ # @!attribute [rw] gcs_source
345
+ # @return [::Google::Cloud::DiscoveryEngine::V1::GcsSource]
346
+ # Cloud Storage location for the input content.
347
+ #
348
+ # Only 1 file can be specified that contains all entries to import.
349
+ # Supported values `gcs_source.schema` for autocomplete suggestion deny
350
+ # list entry imports:
351
+ #
352
+ # * `suggestion_deny_list` (default): One JSON [SuggestionDenyListEntry]
353
+ # per line.
354
+ # @!attribute [rw] parent
355
+ # @return [::String]
356
+ # Required. The parent data store resource name for which to import denylist
357
+ # entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
358
+ class ImportSuggestionDenyListEntriesRequest
359
+ include ::Google::Protobuf::MessageExts
360
+ extend ::Google::Protobuf::MessageExts::ClassMethods
361
+
362
+ # The inline source for SuggestionDenyListEntry.
363
+ # @!attribute [rw] entries
364
+ # @return [::Array<::Google::Cloud::DiscoveryEngine::V1::SuggestionDenyListEntry>]
365
+ # Required. A list of all denylist entries to import. Max of 1000 items.
366
+ class InlineSource
367
+ include ::Google::Protobuf::MessageExts
368
+ extend ::Google::Protobuf::MessageExts::ClassMethods
369
+ end
370
+ end
371
+
372
+ # Response message for
373
+ # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#import_suggestion_deny_list_entries CompletionService.ImportSuggestionDenyListEntries}
374
+ # method.
375
+ # @!attribute [rw] error_samples
376
+ # @return [::Array<::Google::Rpc::Status>]
377
+ # A sample of errors encountered while processing the request.
378
+ # @!attribute [rw] imported_entries_count
379
+ # @return [::Integer]
380
+ # Count of deny list entries successfully imported.
381
+ # @!attribute [rw] failed_entries_count
382
+ # @return [::Integer]
383
+ # Count of deny list entries that failed to be imported.
384
+ class ImportSuggestionDenyListEntriesResponse
385
+ include ::Google::Protobuf::MessageExts
386
+ extend ::Google::Protobuf::MessageExts::ClassMethods
387
+ end
388
+
389
+ # Metadata related to the progress of the ImportSuggestionDenyListEntries
390
+ # operation. This is returned by the google.longrunning.Operation.metadata
391
+ # field.
392
+ # @!attribute [rw] create_time
393
+ # @return [::Google::Protobuf::Timestamp]
394
+ # Operation create time.
395
+ # @!attribute [rw] update_time
396
+ # @return [::Google::Protobuf::Timestamp]
397
+ # Operation last update time. If the operation is done, this is also the
398
+ # finish time.
399
+ class ImportSuggestionDenyListEntriesMetadata
400
+ include ::Google::Protobuf::MessageExts
401
+ extend ::Google::Protobuf::MessageExts::ClassMethods
402
+ end
337
403
  end
338
404
  end
339
405
  end
@@ -78,6 +78,47 @@ module Google
78
78
  include ::Google::Protobuf::MessageExts
79
79
  extend ::Google::Protobuf::MessageExts::ClassMethods
80
80
  end
81
+
82
+ # Request message for
83
+ # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#purge_suggestion_deny_list_entries CompletionService.PurgeSuggestionDenyListEntries}
84
+ # method.
85
+ # @!attribute [rw] parent
86
+ # @return [::String]
87
+ # Required. The parent data store resource name for which to import denylist
88
+ # entries. Follows pattern projects/*/locations/*/collections/*/dataStores/*.
89
+ class PurgeSuggestionDenyListEntriesRequest
90
+ include ::Google::Protobuf::MessageExts
91
+ extend ::Google::Protobuf::MessageExts::ClassMethods
92
+ end
93
+
94
+ # Response message for
95
+ # {::Google::Cloud::DiscoveryEngine::V1::CompletionService::Client#purge_suggestion_deny_list_entries CompletionService.PurgeSuggestionDenyListEntries}
96
+ # method.
97
+ # @!attribute [rw] purge_count
98
+ # @return [::Integer]
99
+ # Number of suggestion deny list entries purged.
100
+ # @!attribute [rw] error_samples
101
+ # @return [::Array<::Google::Rpc::Status>]
102
+ # A sample of errors encountered while processing the request.
103
+ class PurgeSuggestionDenyListEntriesResponse
104
+ include ::Google::Protobuf::MessageExts
105
+ extend ::Google::Protobuf::MessageExts::ClassMethods
106
+ end
107
+
108
+ # Metadata related to the progress of the PurgeSuggestionDenyListEntries
109
+ # operation. This is returned by the google.longrunning.Operation.metadata
110
+ # field.
111
+ # @!attribute [rw] create_time
112
+ # @return [::Google::Protobuf::Timestamp]
113
+ # Operation create time.
114
+ # @!attribute [rw] update_time
115
+ # @return [::Google::Protobuf::Timestamp]
116
+ # Operation last update time. If the operation is done, this is also the
117
+ # finish time.
118
+ class PurgeSuggestionDenyListEntriesMetadata
119
+ include ::Google::Protobuf::MessageExts
120
+ extend ::Google::Protobuf::MessageExts::ClassMethods
121
+ end
81
122
  end
82
123
  end
83
124
  end