google-apis-discoveryengine_v1alpha 0.40.0 → 0.42.0

Sign up to get free protection for your applications and to get access to all the features.
@@ -890,6 +890,47 @@ module Google
890
890
  execute_or_queue_command(command, &block)
891
891
  end
892
892
 
893
+ # Gets the parsed layout information for a Document.
894
+ # @param [String] name
895
+ # Required. Full resource name of Document, such as `projects/`project`/
896
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
897
+ # `branch`/documents/`document``. If the caller does not have permission to
898
+ # access the Document, regardless of whether or not it exists, a `
899
+ # PERMISSION_DENIED` error is returned. If the requested Document does not exist,
900
+ # a `NOT_FOUND` error is returned.
901
+ # @param [String] processed_document_format
902
+ # What format output should be. If unspecified, defaults to JSON.
903
+ # @param [String] processed_document_type
904
+ # Required. What type of processing to return.
905
+ # @param [String] fields
906
+ # Selector specifying which fields to include in a partial response.
907
+ # @param [String] quota_user
908
+ # Available to use for quota purposes for server-side applications. Can be any
909
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
910
+ # @param [Google::Apis::RequestOptions] options
911
+ # Request-specific options
912
+ #
913
+ # @yield [result, err] Result & error if block supplied
914
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument] parsed result object
915
+ # @yieldparam err [StandardError] error object if request failed
916
+ #
917
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument]
918
+ #
919
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
920
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
921
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
922
+ def get_project_location_collection_data_store_branch_document_processed_document(name, processed_document_format: nil, processed_document_type: nil, fields: nil, quota_user: nil, options: nil, &block)
923
+ command = make_simple_command(:get, 'v1alpha/{+name}:getProcessedDocument', options)
924
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument::Representation
925
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument
926
+ command.params['name'] = name unless name.nil?
927
+ command.query['processedDocumentFormat'] = processed_document_format unless processed_document_format.nil?
928
+ command.query['processedDocumentType'] = processed_document_type unless processed_document_type.nil?
929
+ command.query['fields'] = fields unless fields.nil?
930
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
931
+ execute_or_queue_command(command, &block)
932
+ end
933
+
893
934
  # Bulk import of multiple Documents. Request processing may be synchronous. Non-
894
935
  # existing items will be created. Note: It is possible for a subset of the
895
936
  # Documents to be successfully updated.
@@ -4143,6 +4184,47 @@ module Google
4143
4184
  execute_or_queue_command(command, &block)
4144
4185
  end
4145
4186
 
4187
+ # Gets the parsed layout information for a Document.
4188
+ # @param [String] name
4189
+ # Required. Full resource name of Document, such as `projects/`project`/
4190
+ # locations/`location`/collections/`collection`/dataStores/`data_store`/branches/
4191
+ # `branch`/documents/`document``. If the caller does not have permission to
4192
+ # access the Document, regardless of whether or not it exists, a `
4193
+ # PERMISSION_DENIED` error is returned. If the requested Document does not exist,
4194
+ # a `NOT_FOUND` error is returned.
4195
+ # @param [String] processed_document_format
4196
+ # What format output should be. If unspecified, defaults to JSON.
4197
+ # @param [String] processed_document_type
4198
+ # Required. What type of processing to return.
4199
+ # @param [String] fields
4200
+ # Selector specifying which fields to include in a partial response.
4201
+ # @param [String] quota_user
4202
+ # Available to use for quota purposes for server-side applications. Can be any
4203
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
4204
+ # @param [Google::Apis::RequestOptions] options
4205
+ # Request-specific options
4206
+ #
4207
+ # @yield [result, err] Result & error if block supplied
4208
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument] parsed result object
4209
+ # @yieldparam err [StandardError] error object if request failed
4210
+ #
4211
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument]
4212
+ #
4213
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
4214
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
4215
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
4216
+ def get_project_location_data_store_branch_document_processed_document(name, processed_document_format: nil, processed_document_type: nil, fields: nil, quota_user: nil, options: nil, &block)
4217
+ command = make_simple_command(:get, 'v1alpha/{+name}:getProcessedDocument', options)
4218
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument::Representation
4219
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaProcessedDocument
4220
+ command.params['name'] = name unless name.nil?
4221
+ command.query['processedDocumentFormat'] = processed_document_format unless processed_document_format.nil?
4222
+ command.query['processedDocumentType'] = processed_document_type unless processed_document_type.nil?
4223
+ command.query['fields'] = fields unless fields.nil?
4224
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
4225
+ execute_or_queue_command(command, &block)
4226
+ end
4227
+
4146
4228
  # Bulk import of multiple Documents. Request processing may be synchronous. Non-
4147
4229
  # existing items will be created. Note: It is possible for a subset of the
4148
4230
  # Documents to be successfully updated.
@@ -5830,6 +5912,40 @@ module Google
5830
5912
  execute_or_queue_command(command, &block)
5831
5913
  end
5832
5914
 
5915
+ # Ranks a list of text records based on the given input query.
5916
+ # @param [String] ranking_config
5917
+ # Required. The resource name of the rank service config, such as `projects/`
5918
+ # project_num`/locations/`location_id`/rankingConfigs/default_ranking_config`.
5919
+ # @param [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankRequest] google_cloud_discoveryengine_v1alpha_rank_request_object
5920
+ # @param [String] fields
5921
+ # Selector specifying which fields to include in a partial response.
5922
+ # @param [String] quota_user
5923
+ # Available to use for quota purposes for server-side applications. Can be any
5924
+ # arbitrary string assigned to a user, but should not exceed 40 characters.
5925
+ # @param [Google::Apis::RequestOptions] options
5926
+ # Request-specific options
5927
+ #
5928
+ # @yield [result, err] Result & error if block supplied
5929
+ # @yieldparam result [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankResponse] parsed result object
5930
+ # @yieldparam err [StandardError] error object if request failed
5931
+ #
5932
+ # @return [Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankResponse]
5933
+ #
5934
+ # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
5935
+ # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
5936
+ # @raise [Google::Apis::AuthorizationError] Authorization is required
5937
+ def rank_project_location_ranking_config(ranking_config, google_cloud_discoveryengine_v1alpha_rank_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
5938
+ command = make_simple_command(:post, 'v1alpha/{+rankingConfig}:rank', options)
5939
+ command.request_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankRequest::Representation
5940
+ command.request_object = google_cloud_discoveryengine_v1alpha_rank_request_object
5941
+ command.response_representation = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankResponse::Representation
5942
+ command.response_class = Google::Apis::DiscoveryengineV1alpha::GoogleCloudDiscoveryengineV1alphaRankResponse
5943
+ command.params['rankingConfig'] = ranking_config unless ranking_config.nil?
5944
+ command.query['fields'] = fields unless fields.nil?
5945
+ command.query['quotaUser'] = quota_user unless quota_user.nil?
5946
+ execute_or_queue_command(command, &block)
5947
+ end
5948
+
5833
5949
  # Gets the latest state of a long-running operation. Clients can use this method
5834
5950
  # to poll the operation result at intervals as recommended by the API service.
5835
5951
  # @param [String] name
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.40.0
4
+ version: 0.42.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-03-17 00:00:00.000000000 Z
11
+ date: 2024-03-31 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.40.0
61
+ documentation_uri: https://googleapis.dev/ruby/google-apis-discoveryengine_v1alpha/v0.42.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: []