google-apis-discoveryengine_v1alpha 0.44.0 → 0.45.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -51,147 +51,6 @@ module Google
51
51
  @batch_path = 'batch'
52
52
  end
53
53
 
54
- # Gets the Widget Config using the uuid.
55
- # @param [String] location
56
- # Required. The location resource where lookup widget will be performed. Format:
57
- # `locations/`location``
58
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest] google_cloud_discoveryengine_v1alpha_lookup_widget_config_request_object
59
- # @param [String] fields
60
- # Selector specifying which fields to include in a partial response.
61
- # @param [String] quota_user
62
- # Available to use for quota purposes for server-side applications. Can be any
63
- # arbitrary string assigned to a user, but should not exceed 40 characters.
64
- # @param [Google::Apis::RequestOptions] options
65
- # Request-specific options
66
- #
67
- # @yield [result, err] Result & error if block supplied
68
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse] parsed result object
69
- # @yieldparam err [StandardError] error object if request failed
70
- #
71
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse]
72
- #
73
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
74
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
75
- # @raise [Google::Apis::AuthorizationError] Authorization is required
76
- def lookup_location_widget_config(location, google_cloud_discoveryengine_v1alpha_lookup_widget_config_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
77
- command = make_simple_command(:post, 'v1alpha/{+location}/lookupWidgetConfig', options)
78
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigRequest::Representation
79
- command.request_object = google_cloud_discoveryengine_v1alpha_lookup_widget_config_request_object
80
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse::Representation
81
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaLookupWidgetConfigResponse
82
- command.params['location'] = location unless location.nil?
83
- command.query['fields'] = fields unless fields.nil?
84
- command.query['quotaUser'] = quota_user unless quota_user.nil?
85
- execute_or_queue_command(command, &block)
86
- end
87
-
88
- # Performs a user input completion with keyword suggestion. Similar to the
89
- # CompletionService.CompleteQuery method, but a widget version that allows
90
- # CompleteQuery without API Key. It supports CompleteQuery with or without JWT
91
- # token.
92
- # @param [String] location
93
- # Required. The location resource where widget complete query will be performed.
94
- # Format: `locations/`location``
95
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest] google_cloud_discoveryengine_v1alpha_widget_complete_query_request_object
96
- # @param [String] fields
97
- # Selector specifying which fields to include in a partial response.
98
- # @param [String] quota_user
99
- # Available to use for quota purposes for server-side applications. Can be any
100
- # arbitrary string assigned to a user, but should not exceed 40 characters.
101
- # @param [Google::Apis::RequestOptions] options
102
- # Request-specific options
103
- #
104
- # @yield [result, err] Result & error if block supplied
105
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse] parsed result object
106
- # @yieldparam err [StandardError] error object if request failed
107
- #
108
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse]
109
- #
110
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
111
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
112
- # @raise [Google::Apis::AuthorizationError] Authorization is required
113
- def widget_location_complete_query(location, google_cloud_discoveryengine_v1alpha_widget_complete_query_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
114
- command = make_simple_command(:post, 'v1alpha/{+location}/widgetCompleteQuery', options)
115
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryRequest::Representation
116
- command.request_object = google_cloud_discoveryengine_v1alpha_widget_complete_query_request_object
117
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse::Representation
118
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetCompleteQueryResponse
119
- command.params['location'] = location unless location.nil?
120
- command.query['fields'] = fields unless fields.nil?
121
- command.query['quotaUser'] = quota_user unless quota_user.nil?
122
- execute_or_queue_command(command, &block)
123
- end
124
-
125
- # Converse a conversation with Widget.
126
- # @param [String] location
127
- # Required. The location resource where widget converse conversation will be
128
- # performed. Format: `locations/`location``
129
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest] google_cloud_discoveryengine_v1alpha_widget_converse_conversation_request_object
130
- # @param [String] fields
131
- # Selector specifying which fields to include in a partial response.
132
- # @param [String] quota_user
133
- # Available to use for quota purposes for server-side applications. Can be any
134
- # arbitrary string assigned to a user, but should not exceed 40 characters.
135
- # @param [Google::Apis::RequestOptions] options
136
- # Request-specific options
137
- #
138
- # @yield [result, err] Result & error if block supplied
139
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse] parsed result object
140
- # @yieldparam err [StandardError] error object if request failed
141
- #
142
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse]
143
- #
144
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
145
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
146
- # @raise [Google::Apis::AuthorizationError] Authorization is required
147
- def widget_location_converse_conversation(location, google_cloud_discoveryengine_v1alpha_widget_converse_conversation_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
148
- command = make_simple_command(:post, 'v1alpha/{+location}/widgetConverseConversation', options)
149
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationRequest::Representation
150
- command.request_object = google_cloud_discoveryengine_v1alpha_widget_converse_conversation_request_object
151
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse::Representation
152
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetConverseConversationResponse
153
- command.params['location'] = location unless location.nil?
154
- command.query['fields'] = fields unless fields.nil?
155
- command.query['quotaUser'] = quota_user unless quota_user.nil?
156
- execute_or_queue_command(command, &block)
157
- end
158
-
159
- # Performs a search. Similar to the SearchService.Search method, but a widget
160
- # version that allows search without API Key. It supports search with or without
161
- # JWT token.
162
- # @param [String] location
163
- # Required. The location resource where widget search will be performed. Format:
164
- # `locations/`location``
165
- # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest] google_cloud_discoveryengine_v1alpha_widget_search_request_object
166
- # @param [String] fields
167
- # Selector specifying which fields to include in a partial response.
168
- # @param [String] quota_user
169
- # Available to use for quota purposes for server-side applications. Can be any
170
- # arbitrary string assigned to a user, but should not exceed 40 characters.
171
- # @param [Google::Apis::RequestOptions] options
172
- # Request-specific options
173
- #
174
- # @yield [result, err] Result & error if block supplied
175
- # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse] parsed result object
176
- # @yieldparam err [StandardError] error object if request failed
177
- #
178
- # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse]
179
- #
180
- # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
181
- # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
182
- # @raise [Google::Apis::AuthorizationError] Authorization is required
183
- def widget_location_search(location, google_cloud_discoveryengine_v1alpha_widget_search_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
184
- command = make_simple_command(:post, 'v1alpha/{+location}/widgetSearch', options)
185
- command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchRequest::Representation
186
- command.request_object = google_cloud_discoveryengine_v1alpha_widget_search_request_object
187
- command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse::Representation
188
- command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaWidgetSearchResponse
189
- command.params['location'] = location unless location.nil?
190
- command.query['fields'] = fields unless fields.nil?
191
- command.query['quotaUser'] = quota_user unless quota_user.nil?
192
- execute_or_queue_command(command, &block)
193
- end
194
-
195
54
  # Gets a Project. Returns NOT_FOUND when the project is not yet created.
196
55
  # @param [String] name
197
56
  # Required. Full resource name of a Project, such as `projects/`
@@ -722,7 +581,7 @@ module Google
722
581
  # permission to list DataStores under this location, regardless of whether or
723
582
  # not this data store exists, a PERMISSION_DENIED error is returned.
724
583
  # @param [String] filter
725
- # Filter by solution type. For example: filter = 'solution_type:
584
+ # Filter by solution type . For example: filter = 'solution_type:
726
585
  # SOLUTION_TYPE_SEARCH'
727
586
  # @param [Fixnum] page_size
728
587
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
@@ -1581,6 +1440,38 @@ module Google
1581
1440
  execute_or_queue_command(command, &block)
1582
1441
  end
1583
1442
 
1443
+ # Gets a list of all the custom models.
1444
+ # @param [String] data_store
1445
+ # Required. The resource name of the parent Data Store, such as `projects/*/
1446
+ # locations/global/collections/default_collection/dataStores/default_data_store`.
1447
+ # This field is used to identify the data store where to fetch the models from.
1448
+ # @param [String] fields
1449
+ # Selector specifying which fields to include in a partial response.
1450
+ # @param [String] quota_user
1451
+ # Available to use for quota purposes for server-side applications. Can be any
1452
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
1453
+ # @param [Google::Apis::RequestOptions] options
1454
+ # Request-specific options
1455
+ #
1456
+ # @yield [result, err] Result & error if block supplied
1457
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse] parsed result object
1458
+ # @yieldparam err [StandardError] error object if request failed
1459
+ #
1460
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse]
1461
+ #
1462
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
1463
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
1464
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
1465
+ def list_project_location_collection_data_store_custom_models(data_store, fields: nil, quota_user: nil, options: nil, &block)
1466
+ command = make_simple_command(:get, 'v1alpha/{+dataStore}/customModels', options)
1467
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse::Representation
1468
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaListCustomModelsResponse
1469
+ command.params['dataStore'] = data_store unless data_store.nil?
1470
+ command.query['fields'] = fields unless fields.nil?
1471
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
1472
+ execute_or_queue_command(command, &block)
1473
+ end
1474
+
1584
1475
  # Gets the latest state of a long-running operation. Clients can use this method
1585
1476
  # to poll the operation result at intervals as recommended by the API service.
1586
1477
  # @param [String] name
@@ -4573,7 +4464,7 @@ module Google
4573
4464
  # permission to list DataStores under this location, regardless of whether or
4574
4465
  # not this data store exists, a PERMISSION_DENIED error is returned.
4575
4466
  # @param [String] filter
4576
- # Filter by solution type. For example: filter = 'solution_type:
4467
+ # Filter by solution type . For example: filter = 'solution_type:
4577
4468
  # SOLUTION_TYPE_SEARCH'
4578
4469
  # @param [Fixnum] page_size
4579
4470
  # Maximum number of DataStores to return. If unspecified, defaults to 10. The
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: google-apis-discoveryengine_v1alpha
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.44.0
4
+ version: 0.45.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Google LLC
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-04-21 00:00:00.000000000 Z
11
+ date: 2024-05-05 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: google-apis-core
@@ -58,7 +58,7 @@ licenses:
58
58
  metadata:
59
59
  bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
60
60
  changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha/CHANGELOG.md
61
- documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.44.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.45.0
62
62
  source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-discoveryengine_v1alpha
63
63
  post_install_message:
64
64
  rdoc_options: []