google-apis-aiplatform_v1 0.63.0 → 0.65.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.
@@ -1142,6 +1142,77 @@ module Google
|
|
1142
1142
|
execute_or_queue_command(command, &block)
|
1143
1143
|
end
|
1144
1144
|
|
1145
|
+
# Generates rubrics for a given prompt. A rubric represents a single testable
|
1146
|
+
# criterion for evaluation. One input prompt could have multiple rubrics This
|
1147
|
+
# RPC allows users to get suggested rubrics based on provided prompt, which can
|
1148
|
+
# then be reviewed and used for subsequent evaluations.
|
1149
|
+
# @param [String] location
|
1150
|
+
# Required. The resource name of the Location to generate rubrics from. Format: `
|
1151
|
+
# projects/`project`/locations/`location``
|
1152
|
+
# @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateInstanceRubricsRequest] google_cloud_aiplatform_v1_generate_instance_rubrics_request_object
|
1153
|
+
# @param [String] fields
|
1154
|
+
# Selector specifying which fields to include in a partial response.
|
1155
|
+
# @param [String] quota_user
|
1156
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1157
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1158
|
+
# @param [Google::Apis::RequestOptions] options
|
1159
|
+
# Request-specific options
|
1160
|
+
#
|
1161
|
+
# @yield [result, err] Result & error if block supplied
|
1162
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateInstanceRubricsResponse] parsed result object
|
1163
|
+
# @yieldparam err [StandardError] error object if request failed
|
1164
|
+
#
|
1165
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateInstanceRubricsResponse]
|
1166
|
+
#
|
1167
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1168
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1169
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1170
|
+
def generate_project_location_instance_rubrics(location, google_cloud_aiplatform_v1_generate_instance_rubrics_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1171
|
+
command = make_simple_command(:post, 'v1/{+location}:generateInstanceRubrics', options)
|
1172
|
+
command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateInstanceRubricsRequest::Representation
|
1173
|
+
command.request_object = google_cloud_aiplatform_v1_generate_instance_rubrics_request_object
|
1174
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateInstanceRubricsResponse::Representation
|
1175
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateInstanceRubricsResponse
|
1176
|
+
command.params['location'] = location unless location.nil?
|
1177
|
+
command.query['fields'] = fields unless fields.nil?
|
1178
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1179
|
+
execute_or_queue_command(command, &block)
|
1180
|
+
end
|
1181
|
+
|
1182
|
+
# Generates synthetic data based on the provided configuration.
|
1183
|
+
# @param [String] location
|
1184
|
+
# Required. The resource name of the Location to run the job. Format: `projects/`
|
1185
|
+
# project`/locations/`location``
|
1186
|
+
# @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateSyntheticDataRequest] google_cloud_aiplatform_v1_generate_synthetic_data_request_object
|
1187
|
+
# @param [String] fields
|
1188
|
+
# Selector specifying which fields to include in a partial response.
|
1189
|
+
# @param [String] quota_user
|
1190
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
1191
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
1192
|
+
# @param [Google::Apis::RequestOptions] options
|
1193
|
+
# Request-specific options
|
1194
|
+
#
|
1195
|
+
# @yield [result, err] Result & error if block supplied
|
1196
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateSyntheticDataResponse] parsed result object
|
1197
|
+
# @yieldparam err [StandardError] error object if request failed
|
1198
|
+
#
|
1199
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateSyntheticDataResponse]
|
1200
|
+
#
|
1201
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
1202
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
1203
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
1204
|
+
def generate_project_location_synthetic_data(location, google_cloud_aiplatform_v1_generate_synthetic_data_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
1205
|
+
command = make_simple_command(:post, 'v1/{+location}:generateSyntheticData', options)
|
1206
|
+
command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateSyntheticDataRequest::Representation
|
1207
|
+
command.request_object = google_cloud_aiplatform_v1_generate_synthetic_data_request_object
|
1208
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateSyntheticDataResponse::Representation
|
1209
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GenerateSyntheticDataResponse
|
1210
|
+
command.params['location'] = location unless location.nil?
|
1211
|
+
command.query['fields'] = fields unless fields.nil?
|
1212
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
1213
|
+
execute_or_queue_command(command, &block)
|
1214
|
+
end
|
1215
|
+
|
1145
1216
|
# Gets information about a location.
|
1146
1217
|
# @param [String] name
|
1147
1218
|
# Resource name for the location.
|
@@ -1207,8 +1278,8 @@ module Google
|
|
1207
1278
|
# @param [String] name
|
1208
1279
|
# The resource that owns the locations collection, if applicable.
|
1209
1280
|
# @param [Array<String>, String] extra_location_types
|
1210
|
-
# Optional.
|
1211
|
-
#
|
1281
|
+
# Optional. Do not use this field. It is unsupported and is ignored unless
|
1282
|
+
# explicitly documented otherwise. This is primarily for internal usage.
|
1212
1283
|
# @param [String] filter
|
1213
1284
|
# A filter to narrow down results to a preferred subset. The filtering language
|
1214
1285
|
# accepts strings like `"displayName=tokyo"`, and is documented in more detail
|
@@ -5542,6 +5613,508 @@ module Google
|
|
5542
5613
|
execute_or_queue_command(command, &block)
|
5543
5614
|
end
|
5544
5615
|
|
5616
|
+
# Creates an Evaluation Item.
|
5617
|
+
# @param [String] parent
|
5618
|
+
# Required. The resource name of the Location to create the Evaluation Item in.
|
5619
|
+
# Format: `projects/`project`/locations/`location``
|
5620
|
+
# @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem] google_cloud_aiplatform_v1_evaluation_item_object
|
5621
|
+
# @param [String] fields
|
5622
|
+
# Selector specifying which fields to include in a partial response.
|
5623
|
+
# @param [String] quota_user
|
5624
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5625
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5626
|
+
# @param [Google::Apis::RequestOptions] options
|
5627
|
+
# Request-specific options
|
5628
|
+
#
|
5629
|
+
# @yield [result, err] Result & error if block supplied
|
5630
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem] parsed result object
|
5631
|
+
# @yieldparam err [StandardError] error object if request failed
|
5632
|
+
#
|
5633
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem]
|
5634
|
+
#
|
5635
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5636
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5637
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5638
|
+
def create_project_location_evaluation_item(parent, google_cloud_aiplatform_v1_evaluation_item_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5639
|
+
command = make_simple_command(:post, 'v1/{+parent}/evaluationItems', options)
|
5640
|
+
command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem::Representation
|
5641
|
+
command.request_object = google_cloud_aiplatform_v1_evaluation_item_object
|
5642
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem::Representation
|
5643
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem
|
5644
|
+
command.params['parent'] = parent unless parent.nil?
|
5645
|
+
command.query['fields'] = fields unless fields.nil?
|
5646
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5647
|
+
execute_or_queue_command(command, &block)
|
5648
|
+
end
|
5649
|
+
|
5650
|
+
# Deletes an Evaluation Item.
|
5651
|
+
# @param [String] name
|
5652
|
+
# Required. The name of the EvaluationItem resource to be deleted. Format: `
|
5653
|
+
# projects/`project`/locations/`location`/evaluationItems/`evaluation_item``
|
5654
|
+
# @param [String] fields
|
5655
|
+
# Selector specifying which fields to include in a partial response.
|
5656
|
+
# @param [String] quota_user
|
5657
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5658
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5659
|
+
# @param [Google::Apis::RequestOptions] options
|
5660
|
+
# Request-specific options
|
5661
|
+
#
|
5662
|
+
# @yield [result, err] Result & error if block supplied
|
5663
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
|
5664
|
+
# @yieldparam err [StandardError] error object if request failed
|
5665
|
+
#
|
5666
|
+
# @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
|
5667
|
+
#
|
5668
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5669
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5670
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5671
|
+
def delete_project_location_evaluation_item(name, fields: nil, quota_user: nil, options: nil, &block)
|
5672
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
5673
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
|
5674
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
|
5675
|
+
command.params['name'] = name unless name.nil?
|
5676
|
+
command.query['fields'] = fields unless fields.nil?
|
5677
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5678
|
+
execute_or_queue_command(command, &block)
|
5679
|
+
end
|
5680
|
+
|
5681
|
+
# Gets an Evaluation Item.
|
5682
|
+
# @param [String] name
|
5683
|
+
# Required. The name of the EvaluationItem resource. Format: `projects/`project`/
|
5684
|
+
# locations/`location`/evaluationItems/`evaluation_item``
|
5685
|
+
# @param [String] fields
|
5686
|
+
# Selector specifying which fields to include in a partial response.
|
5687
|
+
# @param [String] quota_user
|
5688
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5689
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5690
|
+
# @param [Google::Apis::RequestOptions] options
|
5691
|
+
# Request-specific options
|
5692
|
+
#
|
5693
|
+
# @yield [result, err] Result & error if block supplied
|
5694
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem] parsed result object
|
5695
|
+
# @yieldparam err [StandardError] error object if request failed
|
5696
|
+
#
|
5697
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem]
|
5698
|
+
#
|
5699
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5700
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5701
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5702
|
+
def get_project_location_evaluation_item(name, fields: nil, quota_user: nil, options: nil, &block)
|
5703
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
5704
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem::Representation
|
5705
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationItem
|
5706
|
+
command.params['name'] = name unless name.nil?
|
5707
|
+
command.query['fields'] = fields unless fields.nil?
|
5708
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5709
|
+
execute_or_queue_command(command, &block)
|
5710
|
+
end
|
5711
|
+
|
5712
|
+
# Lists Evaluation Items.
|
5713
|
+
# @param [String] parent
|
5714
|
+
# Required. The resource name of the Location from which to list the Evaluation
|
5715
|
+
# Items. Format: `projects/`project`/locations/`location``
|
5716
|
+
# @param [String] filter
|
5717
|
+
# Optional. Filter expression that matches a subset of the EvaluationItems to
|
5718
|
+
# show. For field names both snake_case and camelCase are supported. For more
|
5719
|
+
# information about filter syntax, see [AIP-160](https://google.aip.dev/160).
|
5720
|
+
# @param [String] order_by
|
5721
|
+
# Optional. A comma-separated list of fields to order by, sorted in ascending
|
5722
|
+
# order by default. Use `desc` after a field name for descending.
|
5723
|
+
# @param [Fixnum] page_size
|
5724
|
+
# Optional. The maximum number of Evaluation Items to return.
|
5725
|
+
# @param [String] page_token
|
5726
|
+
# Optional. A page token, received from a previous `ListEvaluationItems` call.
|
5727
|
+
# Provide this to retrieve the subsequent page.
|
5728
|
+
# @param [String] fields
|
5729
|
+
# Selector specifying which fields to include in a partial response.
|
5730
|
+
# @param [String] quota_user
|
5731
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5732
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5733
|
+
# @param [Google::Apis::RequestOptions] options
|
5734
|
+
# Request-specific options
|
5735
|
+
#
|
5736
|
+
# @yield [result, err] Result & error if block supplied
|
5737
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationItemsResponse] parsed result object
|
5738
|
+
# @yieldparam err [StandardError] error object if request failed
|
5739
|
+
#
|
5740
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationItemsResponse]
|
5741
|
+
#
|
5742
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5743
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5744
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5745
|
+
def list_project_location_evaluation_items(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5746
|
+
command = make_simple_command(:get, 'v1/{+parent}/evaluationItems', options)
|
5747
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationItemsResponse::Representation
|
5748
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationItemsResponse
|
5749
|
+
command.params['parent'] = parent unless parent.nil?
|
5750
|
+
command.query['filter'] = filter unless filter.nil?
|
5751
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
5752
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
5753
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
5754
|
+
command.query['fields'] = fields unless fields.nil?
|
5755
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5756
|
+
execute_or_queue_command(command, &block)
|
5757
|
+
end
|
5758
|
+
|
5759
|
+
# Cancels an Evaluation Run. Attempts to cancel a running Evaluation Run
|
5760
|
+
# asynchronously. Status of run can be checked via GetEvaluationRun.
|
5761
|
+
# @param [String] name
|
5762
|
+
# Required. The name of the EvaluationRun resource to be cancelled. Format: `
|
5763
|
+
# projects/`project`/locations/`location`/evaluationRuns/`evaluation_run``
|
5764
|
+
# @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelEvaluationRunRequest] google_cloud_aiplatform_v1_cancel_evaluation_run_request_object
|
5765
|
+
# @param [String] fields
|
5766
|
+
# Selector specifying which fields to include in a partial response.
|
5767
|
+
# @param [String] quota_user
|
5768
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5769
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5770
|
+
# @param [Google::Apis::RequestOptions] options
|
5771
|
+
# Request-specific options
|
5772
|
+
#
|
5773
|
+
# @yield [result, err] Result & error if block supplied
|
5774
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleProtobufEmpty] parsed result object
|
5775
|
+
# @yieldparam err [StandardError] error object if request failed
|
5776
|
+
#
|
5777
|
+
# @return [Google::Apis::AiplatformV1::GoogleProtobufEmpty]
|
5778
|
+
#
|
5779
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5780
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5781
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5782
|
+
def cancel_project_location_evaluation_run(name, google_cloud_aiplatform_v1_cancel_evaluation_run_request_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5783
|
+
command = make_simple_command(:post, 'v1/{+name}:cancel', options)
|
5784
|
+
command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1CancelEvaluationRunRequest::Representation
|
5785
|
+
command.request_object = google_cloud_aiplatform_v1_cancel_evaluation_run_request_object
|
5786
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleProtobufEmpty::Representation
|
5787
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleProtobufEmpty
|
5788
|
+
command.params['name'] = name unless name.nil?
|
5789
|
+
command.query['fields'] = fields unless fields.nil?
|
5790
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5791
|
+
execute_or_queue_command(command, &block)
|
5792
|
+
end
|
5793
|
+
|
5794
|
+
# Creates an Evaluation Run.
|
5795
|
+
# @param [String] parent
|
5796
|
+
# Required. The resource name of the Location to create the Evaluation Run in.
|
5797
|
+
# Format: `projects/`project`/locations/`location``
|
5798
|
+
# @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun] google_cloud_aiplatform_v1_evaluation_run_object
|
5799
|
+
# @param [String] fields
|
5800
|
+
# Selector specifying which fields to include in a partial response.
|
5801
|
+
# @param [String] quota_user
|
5802
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5803
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5804
|
+
# @param [Google::Apis::RequestOptions] options
|
5805
|
+
# Request-specific options
|
5806
|
+
#
|
5807
|
+
# @yield [result, err] Result & error if block supplied
|
5808
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun] parsed result object
|
5809
|
+
# @yieldparam err [StandardError] error object if request failed
|
5810
|
+
#
|
5811
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun]
|
5812
|
+
#
|
5813
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5814
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5815
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5816
|
+
def create_project_location_evaluation_run(parent, google_cloud_aiplatform_v1_evaluation_run_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5817
|
+
command = make_simple_command(:post, 'v1/{+parent}/evaluationRuns', options)
|
5818
|
+
command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun::Representation
|
5819
|
+
command.request_object = google_cloud_aiplatform_v1_evaluation_run_object
|
5820
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun::Representation
|
5821
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun
|
5822
|
+
command.params['parent'] = parent unless parent.nil?
|
5823
|
+
command.query['fields'] = fields unless fields.nil?
|
5824
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5825
|
+
execute_or_queue_command(command, &block)
|
5826
|
+
end
|
5827
|
+
|
5828
|
+
# Deletes an Evaluation Run.
|
5829
|
+
# @param [String] name
|
5830
|
+
# Required. The name of the EvaluationRun resource to be deleted. Format: `
|
5831
|
+
# projects/`project`/locations/`location`/evaluationRuns/`evaluation_run``
|
5832
|
+
# @param [String] fields
|
5833
|
+
# Selector specifying which fields to include in a partial response.
|
5834
|
+
# @param [String] quota_user
|
5835
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5836
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5837
|
+
# @param [Google::Apis::RequestOptions] options
|
5838
|
+
# Request-specific options
|
5839
|
+
#
|
5840
|
+
# @yield [result, err] Result & error if block supplied
|
5841
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
|
5842
|
+
# @yieldparam err [StandardError] error object if request failed
|
5843
|
+
#
|
5844
|
+
# @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
|
5845
|
+
#
|
5846
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5847
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5848
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5849
|
+
def delete_project_location_evaluation_run(name, fields: nil, quota_user: nil, options: nil, &block)
|
5850
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
5851
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
|
5852
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
|
5853
|
+
command.params['name'] = name unless name.nil?
|
5854
|
+
command.query['fields'] = fields unless fields.nil?
|
5855
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5856
|
+
execute_or_queue_command(command, &block)
|
5857
|
+
end
|
5858
|
+
|
5859
|
+
# Gets an Evaluation Run.
|
5860
|
+
# @param [String] name
|
5861
|
+
# Required. The name of the EvaluationRun resource. Format: `projects/`project`/
|
5862
|
+
# locations/`location`/evaluationRuns/`evaluation_run``
|
5863
|
+
# @param [String] fields
|
5864
|
+
# Selector specifying which fields to include in a partial response.
|
5865
|
+
# @param [String] quota_user
|
5866
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5867
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5868
|
+
# @param [Google::Apis::RequestOptions] options
|
5869
|
+
# Request-specific options
|
5870
|
+
#
|
5871
|
+
# @yield [result, err] Result & error if block supplied
|
5872
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun] parsed result object
|
5873
|
+
# @yieldparam err [StandardError] error object if request failed
|
5874
|
+
#
|
5875
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun]
|
5876
|
+
#
|
5877
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5878
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5879
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5880
|
+
def get_project_location_evaluation_run(name, fields: nil, quota_user: nil, options: nil, &block)
|
5881
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
5882
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun::Representation
|
5883
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationRun
|
5884
|
+
command.params['name'] = name unless name.nil?
|
5885
|
+
command.query['fields'] = fields unless fields.nil?
|
5886
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5887
|
+
execute_or_queue_command(command, &block)
|
5888
|
+
end
|
5889
|
+
|
5890
|
+
# Lists Evaluation Runs.
|
5891
|
+
# @param [String] parent
|
5892
|
+
# Required. The resource name of the Location from which to list the Evaluation
|
5893
|
+
# Runs. Format: `projects/`project`/locations/`location``
|
5894
|
+
# @param [String] filter
|
5895
|
+
# Optional. Filter expression that matches a subset of the EvaluationRuns to
|
5896
|
+
# show. For field names both snake_case and camelCase are supported. For more
|
5897
|
+
# information about filter syntax, see [AIP-160](https://google.aip.dev/160).
|
5898
|
+
# @param [String] order_by
|
5899
|
+
# Optional. A comma-separated list of fields to order by, sorted in ascending
|
5900
|
+
# order by default. Use `desc` after a field name for descending.
|
5901
|
+
# @param [Fixnum] page_size
|
5902
|
+
# Optional. The maximum number of Evaluation Runs to return.
|
5903
|
+
# @param [String] page_token
|
5904
|
+
# Optional. A page token, received from a previous `ListEvaluationRuns` call.
|
5905
|
+
# Provide this to retrieve the subsequent page.
|
5906
|
+
# @param [String] fields
|
5907
|
+
# Selector specifying which fields to include in a partial response.
|
5908
|
+
# @param [String] quota_user
|
5909
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5910
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5911
|
+
# @param [Google::Apis::RequestOptions] options
|
5912
|
+
# Request-specific options
|
5913
|
+
#
|
5914
|
+
# @yield [result, err] Result & error if block supplied
|
5915
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationRunsResponse] parsed result object
|
5916
|
+
# @yieldparam err [StandardError] error object if request failed
|
5917
|
+
#
|
5918
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationRunsResponse]
|
5919
|
+
#
|
5920
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5921
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5922
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5923
|
+
def list_project_location_evaluation_runs(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
5924
|
+
command = make_simple_command(:get, 'v1/{+parent}/evaluationRuns', options)
|
5925
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationRunsResponse::Representation
|
5926
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationRunsResponse
|
5927
|
+
command.params['parent'] = parent unless parent.nil?
|
5928
|
+
command.query['filter'] = filter unless filter.nil?
|
5929
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
5930
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
5931
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
5932
|
+
command.query['fields'] = fields unless fields.nil?
|
5933
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5934
|
+
execute_or_queue_command(command, &block)
|
5935
|
+
end
|
5936
|
+
|
5937
|
+
# Creates an Evaluation Set.
|
5938
|
+
# @param [String] parent
|
5939
|
+
# Required. The resource name of the Location to create the Evaluation Set in.
|
5940
|
+
# Format: `projects/`project`/locations/`location``
|
5941
|
+
# @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet] google_cloud_aiplatform_v1_evaluation_set_object
|
5942
|
+
# @param [String] fields
|
5943
|
+
# Selector specifying which fields to include in a partial response.
|
5944
|
+
# @param [String] quota_user
|
5945
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5946
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5947
|
+
# @param [Google::Apis::RequestOptions] options
|
5948
|
+
# Request-specific options
|
5949
|
+
#
|
5950
|
+
# @yield [result, err] Result & error if block supplied
|
5951
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet] parsed result object
|
5952
|
+
# @yieldparam err [StandardError] error object if request failed
|
5953
|
+
#
|
5954
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet]
|
5955
|
+
#
|
5956
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5957
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5958
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5959
|
+
def create_project_location_evaluation_set(parent, google_cloud_aiplatform_v1_evaluation_set_object = nil, fields: nil, quota_user: nil, options: nil, &block)
|
5960
|
+
command = make_simple_command(:post, 'v1/{+parent}/evaluationSets', options)
|
5961
|
+
command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet::Representation
|
5962
|
+
command.request_object = google_cloud_aiplatform_v1_evaluation_set_object
|
5963
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet::Representation
|
5964
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet
|
5965
|
+
command.params['parent'] = parent unless parent.nil?
|
5966
|
+
command.query['fields'] = fields unless fields.nil?
|
5967
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5968
|
+
execute_or_queue_command(command, &block)
|
5969
|
+
end
|
5970
|
+
|
5971
|
+
# Deletes an Evaluation Set.
|
5972
|
+
# @param [String] name
|
5973
|
+
# Required. The name of the EvaluationSet resource to be deleted. Format: `
|
5974
|
+
# projects/`project`/locations/`location`/evaluationSets/`evaluation_set``
|
5975
|
+
# @param [String] fields
|
5976
|
+
# Selector specifying which fields to include in a partial response.
|
5977
|
+
# @param [String] quota_user
|
5978
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
5979
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
5980
|
+
# @param [Google::Apis::RequestOptions] options
|
5981
|
+
# Request-specific options
|
5982
|
+
#
|
5983
|
+
# @yield [result, err] Result & error if block supplied
|
5984
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleLongrunningOperation] parsed result object
|
5985
|
+
# @yieldparam err [StandardError] error object if request failed
|
5986
|
+
#
|
5987
|
+
# @return [Google::Apis::AiplatformV1::GoogleLongrunningOperation]
|
5988
|
+
#
|
5989
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
5990
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
5991
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
5992
|
+
def delete_project_location_evaluation_set(name, fields: nil, quota_user: nil, options: nil, &block)
|
5993
|
+
command = make_simple_command(:delete, 'v1/{+name}', options)
|
5994
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
|
5995
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
|
5996
|
+
command.params['name'] = name unless name.nil?
|
5997
|
+
command.query['fields'] = fields unless fields.nil?
|
5998
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
5999
|
+
execute_or_queue_command(command, &block)
|
6000
|
+
end
|
6001
|
+
|
6002
|
+
# Gets an Evaluation Set.
|
6003
|
+
# @param [String] name
|
6004
|
+
# Required. The name of the EvaluationSet resource. Format: `projects/`project`/
|
6005
|
+
# locations/`location`/evaluationSets/`evaluation_set``
|
6006
|
+
# @param [String] fields
|
6007
|
+
# Selector specifying which fields to include in a partial response.
|
6008
|
+
# @param [String] quota_user
|
6009
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6010
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6011
|
+
# @param [Google::Apis::RequestOptions] options
|
6012
|
+
# Request-specific options
|
6013
|
+
#
|
6014
|
+
# @yield [result, err] Result & error if block supplied
|
6015
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet] parsed result object
|
6016
|
+
# @yieldparam err [StandardError] error object if request failed
|
6017
|
+
#
|
6018
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet]
|
6019
|
+
#
|
6020
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6021
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6022
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6023
|
+
def get_project_location_evaluation_set(name, fields: nil, quota_user: nil, options: nil, &block)
|
6024
|
+
command = make_simple_command(:get, 'v1/{+name}', options)
|
6025
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet::Representation
|
6026
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet
|
6027
|
+
command.params['name'] = name unless name.nil?
|
6028
|
+
command.query['fields'] = fields unless fields.nil?
|
6029
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6030
|
+
execute_or_queue_command(command, &block)
|
6031
|
+
end
|
6032
|
+
|
6033
|
+
# Lists Evaluation Sets.
|
6034
|
+
# @param [String] parent
|
6035
|
+
# Required. The resource name of the Location from which to list the Evaluation
|
6036
|
+
# Sets. Format: `projects/`project`/locations/`location``
|
6037
|
+
# @param [String] filter
|
6038
|
+
# Optional. Filter expression that matches a subset of the EvaluationSets to
|
6039
|
+
# show. For field names both snake_case and camelCase are supported. For more
|
6040
|
+
# information about filter syntax, see [AIP-160](https://google.aip.dev/160).
|
6041
|
+
# @param [String] order_by
|
6042
|
+
# Optional. A comma-separated list of fields to order by, sorted in ascending
|
6043
|
+
# order by default. Use `desc` after a field name for descending.
|
6044
|
+
# @param [Fixnum] page_size
|
6045
|
+
# Optional. The maximum number of Evaluation Sets to return.
|
6046
|
+
# @param [String] page_token
|
6047
|
+
# Optional. A page token, received from a previous `ListEvaluationSets` call.
|
6048
|
+
# Provide this to retrieve the subsequent page.
|
6049
|
+
# @param [String] fields
|
6050
|
+
# Selector specifying which fields to include in a partial response.
|
6051
|
+
# @param [String] quota_user
|
6052
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6053
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6054
|
+
# @param [Google::Apis::RequestOptions] options
|
6055
|
+
# Request-specific options
|
6056
|
+
#
|
6057
|
+
# @yield [result, err] Result & error if block supplied
|
6058
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationSetsResponse] parsed result object
|
6059
|
+
# @yieldparam err [StandardError] error object if request failed
|
6060
|
+
#
|
6061
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationSetsResponse]
|
6062
|
+
#
|
6063
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6064
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6065
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6066
|
+
def list_project_location_evaluation_sets(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block)
|
6067
|
+
command = make_simple_command(:get, 'v1/{+parent}/evaluationSets', options)
|
6068
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationSetsResponse::Representation
|
6069
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ListEvaluationSetsResponse
|
6070
|
+
command.params['parent'] = parent unless parent.nil?
|
6071
|
+
command.query['filter'] = filter unless filter.nil?
|
6072
|
+
command.query['orderBy'] = order_by unless order_by.nil?
|
6073
|
+
command.query['pageSize'] = page_size unless page_size.nil?
|
6074
|
+
command.query['pageToken'] = page_token unless page_token.nil?
|
6075
|
+
command.query['fields'] = fields unless fields.nil?
|
6076
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6077
|
+
execute_or_queue_command(command, &block)
|
6078
|
+
end
|
6079
|
+
|
6080
|
+
# Updates an Evaluation Set.
|
6081
|
+
# @param [String] name
|
6082
|
+
# Identifier. The resource name of the EvaluationSet. Format: `projects/`project`
|
6083
|
+
# /locations/`location`/evaluationSets/`evaluation_set``
|
6084
|
+
# @param [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet] google_cloud_aiplatform_v1_evaluation_set_object
|
6085
|
+
# @param [String] update_mask
|
6086
|
+
# Optional. The update mask applies to the resource. For the `FieldMask`
|
6087
|
+
# definition, see google.protobuf.FieldMask.
|
6088
|
+
# @param [String] fields
|
6089
|
+
# Selector specifying which fields to include in a partial response.
|
6090
|
+
# @param [String] quota_user
|
6091
|
+
# Available to use for quota purposes for server-side applications. Can be any
|
6092
|
+
# arbitrary string assigned to a user, but should not exceed 40 characters.
|
6093
|
+
# @param [Google::Apis::RequestOptions] options
|
6094
|
+
# Request-specific options
|
6095
|
+
#
|
6096
|
+
# @yield [result, err] Result & error if block supplied
|
6097
|
+
# @yieldparam result [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet] parsed result object
|
6098
|
+
# @yieldparam err [StandardError] error object if request failed
|
6099
|
+
#
|
6100
|
+
# @return [Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet]
|
6101
|
+
#
|
6102
|
+
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
6103
|
+
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
6104
|
+
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
6105
|
+
def patch_project_location_evaluation_set(name, google_cloud_aiplatform_v1_evaluation_set_object = nil, update_mask: nil, fields: nil, quota_user: nil, options: nil, &block)
|
6106
|
+
command = make_simple_command(:patch, 'v1/{+name}', options)
|
6107
|
+
command.request_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet::Representation
|
6108
|
+
command.request_object = google_cloud_aiplatform_v1_evaluation_set_object
|
6109
|
+
command.response_representation = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet::Representation
|
6110
|
+
command.response_class = Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EvaluationSet
|
6111
|
+
command.params['name'] = name unless name.nil?
|
6112
|
+
command.query['updateMask'] = update_mask unless update_mask.nil?
|
6113
|
+
command.query['fields'] = fields unless fields.nil?
|
6114
|
+
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
6115
|
+
execute_or_queue_command(command, &block)
|
6116
|
+
end
|
6117
|
+
|
5545
6118
|
# Creates a new FeatureGroup in a given project and location.
|
5546
6119
|
# @param [String] parent
|
5547
6120
|
# Required. The resource name of the Location to create FeatureGroups. Format: `
|
@@ -18119,6 +18692,9 @@ module Google
|
|
18119
18692
|
# @param [String] name
|
18120
18693
|
# Required. The name of the RagFile resource to be deleted. Format: `projects/`
|
18121
18694
|
# project`/locations/`location`/ragCorpora/`rag_corpus`/ragFiles/`rag_file``
|
18695
|
+
# @param [Boolean] force_delete
|
18696
|
+
# Optional. If set to true, any errors generated by external vector database
|
18697
|
+
# during the deletion will be ignored. The default value is false.
|
18122
18698
|
# @param [String] fields
|
18123
18699
|
# Selector specifying which fields to include in a partial response.
|
18124
18700
|
# @param [String] quota_user
|
@@ -18136,11 +18712,12 @@ module Google
|
|
18136
18712
|
# @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried
|
18137
18713
|
# @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification
|
18138
18714
|
# @raise [Google::Apis::AuthorizationError] Authorization is required
|
18139
|
-
def delete_project_location_rag_corpora_rag_file(name, fields: nil, quota_user: nil, options: nil, &block)
|
18715
|
+
def delete_project_location_rag_corpora_rag_file(name, force_delete: nil, fields: nil, quota_user: nil, options: nil, &block)
|
18140
18716
|
command = make_simple_command(:delete, 'v1/{+name}', options)
|
18141
18717
|
command.response_representation = Google::Apis::AiplatformV1::GoogleLongrunningOperation::Representation
|
18142
18718
|
command.response_class = Google::Apis::AiplatformV1::GoogleLongrunningOperation
|
18143
18719
|
command.params['name'] = name unless name.nil?
|
18720
|
+
command.query['forceDelete'] = force_delete unless force_delete.nil?
|
18144
18721
|
command.query['fields'] = fields unless fields.nil?
|
18145
18722
|
command.query['quotaUser'] = quota_user unless quota_user.nil?
|
18146
18723
|
execute_or_queue_command(command, &block)
|
metadata
CHANGED
@@ -1,7 +1,7 @@
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
2
2
|
name: google-apis-aiplatform_v1
|
3
3
|
version: !ruby/object:Gem::Version
|
4
|
-
version: 0.
|
4
|
+
version: 0.65.0
|
5
5
|
platform: ruby
|
6
6
|
authors:
|
7
7
|
- Google LLC
|
@@ -57,7 +57,7 @@ licenses:
|
|
57
57
|
metadata:
|
58
58
|
bug_tracker_uri: https://github.com/googleapis/google-api-ruby-client/issues
|
59
59
|
changelog_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1/CHANGELOG.md
|
60
|
-
documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.
|
60
|
+
documentation_uri: https://googleapis.dev/ruby/google-apis-aiplatform_v1/v0.65.0
|
61
61
|
source_code_uri: https://github.com/googleapis/google-api-ruby-client/tree/main/generated/google-apis-aiplatform_v1
|
62
62
|
rdoc_options: []
|
63
63
|
require_paths:
|