diff --git a/api_names_out.yaml b/api_names_out.yaml index 9432dbc325b..06054d36bee 100644 --- a/api_names_out.yaml +++ b/api_names_out.yaml @@ -15426,6 +15426,7 @@ "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1AggregationResult": google_cloud_aiplatform_v1beta1_aggregation_result "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1AggregationResult/aggregationMetric": aggregation_metric "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1AggregationResult/bleuMetricValue": bleu_metric_value +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1AggregationResult/customCodeExecutionResult": custom_code_execution_result "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1AggregationResult/exactMatchMetricValue": exact_match_metric_value "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1AggregationResult/pairwiseMetricResult": pairwise_metric_result "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1AggregationResult/pointwiseMetricResult": pointwise_metric_result @@ -16047,6 +16048,10 @@ "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CsvDestination/gcsDestination": gcs_destination "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CsvSource": google_cloud_aiplatform_v1beta1_csv_source "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CsvSource/gcsSource": gcs_source +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CustomCodeExecutionResult": google_cloud_aiplatform_v1beta1_custom_code_execution_result +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CustomCodeExecutionResult/score": score +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec": google_cloud_aiplatform_v1beta1_custom_code_execution_spec +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec/evaluationFunction": evaluation_function "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CustomJob": google_cloud_aiplatform_v1beta1_custom_job "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CustomJob/createTime": create_time "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1CustomJob/displayName": display_name @@ -16838,6 +16843,12 @@ "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecutableCode": google_cloud_aiplatform_v1beta1_executable_code "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecutableCode/code": code "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecutableCode/language": language +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteCodeRequest": google_cloud_aiplatform_v1beta1_execute_code_request +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteCodeRequest/inputs": inputs +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteCodeRequest/inputs/input": input +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteCodeResponse": google_cloud_aiplatform_v1beta1_execute_code_response +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteCodeResponse/outputs": outputs +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteCodeResponse/outputs/output": output "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteExtensionRequest": google_cloud_aiplatform_v1beta1_execute_extension_request "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteExtensionRequest/operationId": operation_id "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ExecuteExtensionRequest/operationParams": operation_params @@ -18375,6 +18386,8 @@ "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Memory/fact": fact "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Memory/name": name "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Memory/revisionExpireTime": revision_expire_time +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Memory/revisionLabels": revision_labels +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Memory/revisionLabels/revision_label": revision_label "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Memory/revisionTtl": revision_ttl "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Memory/scope": scope "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Memory/scope/scope": scope @@ -18454,6 +18467,7 @@ "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Metric/aggregationMetrics": aggregation_metrics "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Metric/aggregationMetrics/aggregation_metric": aggregation_metric "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Metric/bleuSpec": bleu_spec +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Metric/customCodeExecutionSpec": custom_code_execution_spec "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Metric/exactMatchSpec": exact_match_spec "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Metric/llmBasedMetricSpec": llm_based_metric_spec "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Metric/pairwiseMetricSpec": pairwise_metric_spec @@ -19799,6 +19813,8 @@ "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1RagCorpus/ragEmbeddingModelConfig": rag_embedding_model_config "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1RagCorpus/ragFilesCount": rag_files_count "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1RagCorpus/ragVectorDbConfig": rag_vector_db_config +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1RagCorpus/satisfiesPzi": satisfies_pzi +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1RagCorpus/satisfiesPzs": satisfies_pzs "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1RagCorpus/updateTime": update_time "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1RagCorpus/vectorDbConfig": vector_db_config "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1RagCorpus/vertexAiSearchConfig": vertex_ai_search_config @@ -20033,11 +20049,15 @@ ? "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineContextSpecMemoryBankConfigTtlConfigGranularTtlConfig/generateUpdatedTtl" : generate_updated_ttl "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec": google_cloud_aiplatform_v1beta1_reasoning_engine_spec +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/agentCard": agent_card +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/agentCard/agent_card": agent_card "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/agentFramework": agent_framework "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/classMethods": class_methods "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/classMethods/class_method": class_method "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/classMethods/class_method/class_method": class_method "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/deploymentSpec": deployment_spec +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/effectiveIdentity": effective_identity +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/identityType": identity_type "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/packageSpec": package_spec "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/serviceAccount": service_account "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1ReasoningEngineSpec/sourceCodeSpec": source_code_spec @@ -21533,6 +21553,8 @@ "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Session/createTime": create_time "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Session/displayName": display_name "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Session/expireTime": expire_time +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Session/labels": labels +"/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Session/labels/label": label "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Session/name": name "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Session/sessionState": session_state "/aiplatform:v1beta1/GoogleCloudAiplatformV1beta1Session/sessionState/session_state": session_state @@ -23290,6 +23312,9 @@ "/aiplatform:v1beta1/aiplatform.pipelineJobs.operations.wait": wait_pipeline_job_operation "/aiplatform:v1beta1/aiplatform.pipelineJobs.operations.wait/name": name "/aiplatform:v1beta1/aiplatform.pipelineJobs.operations.wait/timeout": timeout +"/aiplatform:v1beta1/aiplatform.project.locations.datasets.getIamPolicy": get_project_location_dataset_iam_policy +"/aiplatform:v1beta1/aiplatform.project.locations.datasets.getIamPolicy/options.requestedPolicyVersion": options_requested_policy_version +"/aiplatform:v1beta1/aiplatform.project.locations.datasets.getIamPolicy/resource": resource "/aiplatform:v1beta1/aiplatform.projects.fetchPublisherModelConfig": fetch_project_publisher_model_config "/aiplatform:v1beta1/aiplatform.projects.fetchPublisherModelConfig/name": name "/aiplatform:v1beta1/aiplatform.projects.getCacheConfig": get_project_cache_config @@ -23574,6 +23599,11 @@ "/aiplatform:v1beta1/aiplatform.projects.locations.datasets.searchDataItems/pageSize": page_size "/aiplatform:v1beta1/aiplatform.projects.locations.datasets.searchDataItems/pageToken": page_token "/aiplatform:v1beta1/aiplatform.projects.locations.datasets.searchDataItems/savedQuery": saved_query +"/aiplatform:v1beta1/aiplatform.projects.locations.datasets.setIamPolicy": set_project_location_dataset_iam_policy +"/aiplatform:v1beta1/aiplatform.projects.locations.datasets.setIamPolicy/resource": resource +"/aiplatform:v1beta1/aiplatform.projects.locations.datasets.testIamPermissions": test_project_location_dataset_iam_permissions +"/aiplatform:v1beta1/aiplatform.projects.locations.datasets.testIamPermissions/permissions": permissions +"/aiplatform:v1beta1/aiplatform.projects.locations.datasets.testIamPermissions/resource": resource "/aiplatform:v1beta1/aiplatform.projects.locations.deploy": deploy_project_location "/aiplatform:v1beta1/aiplatform.projects.locations.deploy/destination": destination "/aiplatform:v1beta1/aiplatform.projects.locations.deployPublisherModel": deploy_project_location_publisher_model @@ -25101,6 +25131,8 @@ "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.examples.operations.wait": wait_project_location_reasoning_engine_example_operation "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.examples.operations.wait/name": name "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.examples.operations.wait/timeout": timeout +"/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.executeCode": execute_project_location_reasoning_engine_code +"/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.executeCode/name": name "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.get": get_project_location_reasoning_engine "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.get/name": name "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.list": list_project_location_reasoning_engines @@ -25207,6 +25239,7 @@ "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.sessions.delete/name": name "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.sessions.events.list": list_project_location_reasoning_engine_session_events "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.sessions.events.list/filter": filter +"/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.sessions.events.list/orderBy": order_by "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.sessions.events.list/pageSize": page_size "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.sessions.events.list/pageToken": page_token "/aiplatform:v1beta1/aiplatform.projects.locations.reasoningEngines.sessions.events.list/parent": parent @@ -25731,6 +25764,8 @@ "/aiplatform:v1beta1/aiplatform.reasoningEngines.examples.operations.wait": wait_reasoning_engine_example_operation "/aiplatform:v1beta1/aiplatform.reasoningEngines.examples.operations.wait/name": name "/aiplatform:v1beta1/aiplatform.reasoningEngines.examples.operations.wait/timeout": timeout +"/aiplatform:v1beta1/aiplatform.reasoningEngines.executeCode": execute_reasoning_engine_code +"/aiplatform:v1beta1/aiplatform.reasoningEngines.executeCode/name": name "/aiplatform:v1beta1/aiplatform.reasoningEngines.get": get_reasoning_engine "/aiplatform:v1beta1/aiplatform.reasoningEngines.get/name": name "/aiplatform:v1beta1/aiplatform.reasoningEngines.list": list_reasoning_engines @@ -25801,6 +25836,19 @@ "/aiplatform:v1beta1/aiplatform.reasoningEngines.patch/updateMask": update_mask "/aiplatform:v1beta1/aiplatform.reasoningEngines.query": query_reasoning_engine "/aiplatform:v1beta1/aiplatform.reasoningEngines.query/name": name +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.create": create_reasoning_engine_sandbox_environment +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.create/parent": parent +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.delete": delete_reasoning_engine_sandbox_environment +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.delete/name": name +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.execute": execute_reasoning_engine_sandbox_environment +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.execute/name": name +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.get": get_reasoning_engine_sandbox_environment +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.get/name": name +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.list": list_reasoning_engine_sandbox_environments +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.list/filter": filter +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.list/pageSize": page_size +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.list/pageToken": page_token +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.list/parent": parent "/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel": cancel_reasoning_engine_sandbox_environment_operation "/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.operations.cancel/name": name "/aiplatform:v1beta1/aiplatform.reasoningEngines.sandboxEnvironments.operations.delete": delete_reasoning_engine_sandbox_environment_operation @@ -25824,6 +25872,7 @@ "/aiplatform:v1beta1/aiplatform.reasoningEngines.sessions.delete/name": name "/aiplatform:v1beta1/aiplatform.reasoningEngines.sessions.events.list": list_reasoning_engine_session_events "/aiplatform:v1beta1/aiplatform.reasoningEngines.sessions.events.list/filter": filter +"/aiplatform:v1beta1/aiplatform.reasoningEngines.sessions.events.list/orderBy": order_by "/aiplatform:v1beta1/aiplatform.reasoningEngines.sessions.events.list/pageSize": page_size "/aiplatform:v1beta1/aiplatform.reasoningEngines.sessions.events.list/pageToken": page_token "/aiplatform:v1beta1/aiplatform.reasoningEngines.sessions.events.list/parent": parent diff --git a/generated/google-apis-aiplatform_v1beta1/CHANGELOG.md b/generated/google-apis-aiplatform_v1beta1/CHANGELOG.md index 815c7e140ac..a89d1380461 100644 --- a/generated/google-apis-aiplatform_v1beta1/CHANGELOG.md +++ b/generated/google-apis-aiplatform_v1beta1/CHANGELOG.md @@ -1,5 +1,9 @@ # Release history for google-apis-aiplatform_v1beta1 +### v0.66.0 (2025-11-09) + +* Regenerated from discovery document revision 20251101 + ### v0.65.0 (2025-11-02) * Regenerated from discovery document revision 20251027 diff --git a/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/classes.rb b/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/classes.rb index d412793b0b6..435b4ae6c41 100644 --- a/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/classes.rb +++ b/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/classes.rb @@ -818,6 +818,11 @@ class GoogleCloudAiplatformV1beta1AggregationResult # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuMetricValue] attr_accessor :bleu_metric_value + # Result for custom code execution metric. + # Corresponds to the JSON property `customCodeExecutionResult` + # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionResult] + attr_accessor :custom_code_execution_result + # Exact match metric value for an instance. # Corresponds to the JSON property `exactMatchMetricValue` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExactMatchMetricValue] @@ -846,6 +851,7 @@ def initialize(**args) def update!(**args) @aggregation_metric = args[:aggregation_metric] if args.key?(:aggregation_metric) @bleu_metric_value = args[:bleu_metric_value] if args.key?(:bleu_metric_value) + @custom_code_execution_result = args[:custom_code_execution_result] if args.key?(:custom_code_execution_result) @exact_match_metric_value = args[:exact_match_metric_value] if args.key?(:exact_match_metric_value) @pairwise_metric_result = args[:pairwise_metric_result] if args.key?(:pairwise_metric_result) @pointwise_metric_result = args[:pointwise_metric_result] if args.key?(:pointwise_metric_result) @@ -1830,7 +1836,9 @@ class GoogleCloudAiplatformV1beta1AutoraterConfig attr_accessor :flip_enabled alias_method :flip_enabled?, :flip_enabled - # Generation config. + # Configuration for content generation. This message contains all the parameters + # that control how the model generates content. It allows you to influence the + # randomness, length, and structure of the output. # Corresponds to the JSON property `generationConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig] attr_accessor :generation_config @@ -3204,20 +3212,21 @@ def update!(**args) end end - # Content blob. + # A content blob. A Blob contains data of a specific media type. It is used to + # represent images, audio, and video. class GoogleCloudAiplatformV1beta1Blob include Google::Apis::Core::Hashable - # Required. Raw bytes. + # Required. The raw bytes of the data. # Corresponds to the JSON property `data` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :data - # Optional. Display name of the blob. Used to provide a label or filename to - # distinguish blobs. This field is only returned in PromptMessage for prompt - # management. It is currently used in the Gemini GenerateContent calls only when - # server side tools (code_execution, google_search, and url_context) are enabled. + # Optional. The display name of the blob. Used to provide a label or filename to + # distinguish blobs. This field is only returned in `PromptMessage` for prompt + # management. It is used in the Gemini calls only when server-side tools (` + # code_execution`, `google_search`, and `url_context`) are enabled. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name @@ -3356,10 +3365,9 @@ class GoogleCloudAiplatformV1beta1CachedContent # @return [String] attr_accessor :name - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `systemInstruction` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :system_instruction @@ -3577,58 +3585,70 @@ def update!(**args) class GoogleCloudAiplatformV1beta1Candidate include Google::Apis::Core::Hashable - # Output only. Average log probability score of the candidate. + # Output only. The average log probability of the tokens in this candidate. This + # is a length-normalized score that can be used to compare the quality of + # candidates of different lengths. A higher average log probability suggests a + # more confident and coherent response. # Corresponds to the JSON property `avgLogprobs` # @return [Float] attr_accessor :avg_logprobs - # A collection of source attributions for a piece of content. + # A collection of citations that apply to a piece of generated content. # Corresponds to the JSON property `citationMetadata` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CitationMetadata] attr_accessor :citation_metadata - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content - # Output only. Describes the reason the mode stopped generating tokens in more - # detail. This is only filled when `finish_reason` is set. + # Output only. Describes the reason the model stopped generating tokens in more + # detail. This field is returned only when `finish_reason` is set. # Corresponds to the JSON property `finishMessage` # @return [String] attr_accessor :finish_message # Output only. The reason why the model stopped generating tokens. If empty, the - # model has not stopped generating the tokens. + # model has not stopped generating. # Corresponds to the JSON property `finishReason` # @return [String] attr_accessor :finish_reason - # Metadata returned to client when grounding is enabled. + # Information about the sources that support the content of a response. When + # grounding is enabled, the model returns citations for claims in the response. + # This object contains the retrieved sources. # Corresponds to the JSON property `groundingMetadata` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata] attr_accessor :grounding_metadata - # Output only. Index of the candidate. + # Output only. The 0-based index of this candidate in the list of generated + # responses. This is useful for distinguishing between multiple candidates when ` + # candidate_count` > 1. # Corresponds to the JSON property `index` # @return [Fixnum] attr_accessor :index - # Logprobs Result + # The log probabilities of the tokens generated by the model. This is useful for + # understanding the model's confidence in its predictions and for debugging. For + # example, you can use log probabilities to identify when the model is making a + # less confident prediction or to explore alternative responses that the model + # considered. A low log probability can also indicate that the model is " + # hallucinating" or generating factually incorrect information. # Corresponds to the JSON property `logprobsResult` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LogprobsResult] attr_accessor :logprobs_result - # Output only. List of ratings for the safety of a response candidate. There is - # at most one rating per category. + # Output only. A list of ratings for the safety of a response candidate. There + # is at most one rating per category. # Corresponds to the JSON property `safetyRatings` # @return [Array] attr_accessor :safety_ratings - # Metadata related to url context retrieval tool. + # Metadata returned when the model uses the `url_context` tool to get + # information from a user-provided URL. # Corresponds to the JSON property `urlContextMetadata` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1UrlContextMetadata] attr_accessor :url_context_metadata @@ -3891,16 +3911,16 @@ def update!(**args) end end - # Source attributions for content. + # A citation for a piece of generatedcontent. class GoogleCloudAiplatformV1beta1Citation include Google::Apis::Core::Hashable - # Output only. End index into the content. + # Output only. The end index of the citation in the content. # Corresponds to the JSON property `endIndex` # @return [Fixnum] attr_accessor :end_index - # Output only. License of the attribution. + # Output only. The license of the source of the citation. # Corresponds to the JSON property `license` # @return [String] attr_accessor :license @@ -3917,17 +3937,17 @@ class GoogleCloudAiplatformV1beta1Citation # @return [Google::Apis::AiplatformV1beta1::GoogleTypeDate] attr_accessor :publication_date - # Output only. Start index into the content. + # Output only. The start index of the citation in the content. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index - # Output only. Title of the attribution. + # Output only. The title of the source of the citation. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # Output only. Url reference of the attribution. + # Output only. The URI of the source of the citation. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -3947,11 +3967,11 @@ def update!(**args) end end - # A collection of source attributions for a piece of content. + # A collection of citations that apply to a piece of generated content. class GoogleCloudAiplatformV1beta1CitationMetadata include Google::Apis::Core::Hashable - # Output only. List of citations. + # Output only. A list of citations for the content. # Corresponds to the JSON property `citations` # @return [Array] attr_accessor :citations @@ -4479,22 +4499,21 @@ def update!(**args) end end - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. class GoogleCloudAiplatformV1beta1Content include Google::Apis::Core::Hashable - # Required. Ordered `Parts` that constitute a single message. Parts may have - # different IANA MIME types. + # Required. A list of Part objects that make up a single message. Parts of a + # message can have different MIME types. A Content message must have at least + # one Part. # Corresponds to the JSON property `parts` # @return [Array] attr_accessor :parts - # Optional. The producer of the content. Must be either 'user' or 'model'. - # Useful to set for multi-turn conversations, otherwise can be left blank or - # unset. + # Optional. The producer of the content. Must be either 'user' or 'model'. If + # not set, the service will default to 'user'. # Corresponds to the JSON property `role` # @return [String] attr_accessor :role @@ -4580,10 +4599,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1ContentsExampleExpectedContent include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -4807,10 +4825,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1CorroborateContentRequest include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -4893,7 +4910,9 @@ class GoogleCloudAiplatformV1beta1CountTokensRequest # @return [Array] attr_accessor :contents - # Generation config. + # Configuration for content generation. This message contains all the parameters + # that control how the model generates content. It allows you to influence the + # randomness, length, and structure of the output. # Corresponds to the JSON property `generationConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig] attr_accessor :generation_config @@ -4910,10 +4929,9 @@ class GoogleCloudAiplatformV1beta1CountTokensRequest # @return [String] attr_accessor :model - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `systemInstruction` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :system_instruction @@ -5698,6 +5716,56 @@ def update!(**args) end end + # Result for custom code execution metric. + class GoogleCloudAiplatformV1beta1CustomCodeExecutionResult + include Google::Apis::Core::Hashable + + # Output only. Custom code execution score. + # Corresponds to the JSON property `score` + # @return [Float] + attr_accessor :score + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @score = args[:score] if args.key?(:score) + end + end + + # Specificies a metric that is populated by evaluating user-defined Python code. + class GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec + include Google::Apis::Core::Hashable + + # Required. Python function. Expected user to define the following function, e.g. + # : def evaluate(instance: dict[str, Any]) -> float: Please include this + # function signature in the code snippet. Instance is the evaluation instance, + # any fields populated in the instance are available to the function as instance[ + # field_name]. Example: Example input: ``` instance= EvaluationInstance( + # response=EvaluationInstance.InstanceData(text="The answer is 4."), reference= + # EvaluationInstance.InstanceData(text="4") ) ``` Example converted input: ``` ` + # 'response': `'text': 'The answer is 4.'`, 'reference': `'text': '4'` ` ``` + # Example python function: ``` def evaluate(instance: dict[str, Any]) -> float: + # if instance'response' == instance'reference': return 1.0 return 0.0 ``` + # CustomCodeExecutionSpec is also supported in Batch Evaluation (EvalDataset RPC) + # and Tuning Evaluation. Each line in the input jsonl file will be converted to + # dict[str, Any] and passed to the evaluation function. + # Corresponds to the JSON property `evaluationFunction` + # @return [String] + attr_accessor :evaluation_function + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @evaluation_function = args[:evaluation_function] if args.key?(:evaluation_function) + end + end + # Represents a job that runs custom workloads such as a Docker container or a # Python package. A CustomJob can have multiple worker pools and each worker # pool can have its own machine and input spec. A CustomJob will be cleaned up @@ -8427,10 +8495,9 @@ class GoogleCloudAiplatformV1beta1EmbedContentRequest attr_accessor :auto_truncate alias_method :auto_truncate?, :auto_truncate - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -9845,11 +9912,6 @@ class GoogleCloudAiplatformV1beta1EvaluationInstanceAgentData # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents] attr_accessor :events - # A JSON string containing a sequence of events. - # Corresponds to the JSON property `eventsText` - # @return [String] - attr_accessor :events_text - # Represents a list of tools for an agent. # Corresponds to the JSON property `tools` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools] @@ -9875,7 +9937,6 @@ def update!(**args) @agent_config = args[:agent_config] if args.key?(:agent_config) @developer_instruction = args[:developer_instruction] if args.key?(:developer_instruction) @events = args[:events] if args.key?(:events) - @events_text = args[:events_text] if args.key?(:events_text) @tools = args[:tools] if args.key?(:tools) @tools_text = args[:tools_text] if args.key?(:tools_text) end @@ -10456,7 +10517,9 @@ class GoogleCloudAiplatformV1beta1EvaluationRunEvaluationConfigAutoraterConfig # @return [String] attr_accessor :autorater_model - # Generation config. + # Configuration for content generation. This message contains all the parameters + # that control how the model generates content. It allows you to influence the + # randomness, length, and structure of the output. # Corresponds to the JSON property `generationConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig] attr_accessor :generation_config @@ -10541,7 +10604,9 @@ class GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfig # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig] attr_accessor :agent_config - # Generation config. + # Configuration for content generation. This message contains all the parameters + # that control how the model generates content. It allows you to influence the + # randomness, length, and structure of the output. # Corresponds to the JSON property `generationConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig] attr_accessor :generation_config @@ -10570,10 +10635,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1EvaluationRunInferenceConfigAgentConfig include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `developerInstruction` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :developer_instruction @@ -10997,7 +11061,9 @@ class GoogleCloudAiplatformV1beta1EventMetadata # @return [Hash] attr_accessor :custom_metadata - # Metadata returned to client when grounding is enabled. + # Information about the sources that support the content of a response. When + # grounding is enabled, the model returns citations for claims in the response. + # This object contains the retrieved sources. # Corresponds to the JSON property `groundingMetadata` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata] attr_accessor :grounding_metadata @@ -11460,6 +11526,44 @@ def update!(**args) end end + # Request message for SandboxEnvironmentExecutionService.ExecuteCode. + class GoogleCloudAiplatformV1beta1ExecuteCodeRequest + include Google::Apis::Core::Hashable + + # Required. The inputs used for the stateless code execution. + # Corresponds to the JSON property `inputs` + # @return [Array] + attr_accessor :inputs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @inputs = args[:inputs] if args.key?(:inputs) + end + end + + # Response message for SandboxEnvironmentExecutionService.ExecuteCode. + class GoogleCloudAiplatformV1beta1ExecuteCodeResponse + include Google::Apis::Core::Hashable + + # The outputs from the sandbox environment. + # Corresponds to the JSON property `outputs` + # @return [Array] + attr_accessor :outputs + + def initialize(**args) + update!(**args) + end + + # Update properties of this object + def update!(**args) + @outputs = args[:outputs] if args.key?(:outputs) + end + end + # Request message for ExtensionExecutionService.ExecuteExtension. class GoogleCloudAiplatformV1beta1ExecuteExtensionRequest include Google::Apis::Core::Hashable @@ -15769,20 +15873,21 @@ def update!(**args) end end - # URI based data. + # URI-based data. A FileData message contains a URI pointing to data of a + # specific media type. It is used to represent images, audio, and video stored + # in Google Cloud Storage. class GoogleCloudAiplatformV1beta1FileData include Google::Apis::Core::Hashable - # Optional. Display name of the file data. Used to provide a label or filename - # to distinguish file datas. This field is only returned in PromptMessage for - # prompt management. It is currently used in the Gemini GenerateContent calls - # only when server side tools (code_execution, google_search, and url_context) - # are enabled. + # Optional. The display name of the file. Used to provide a label or filename to + # distinguish files. This field is only returned in `PromptMessage` for prompt + # management. It is used in the Gemini calls only when server side tools (` + # code_execution`, `google_search`, and `url_context`) are enabled. # Corresponds to the JSON property `displayName` # @return [String] attr_accessor :display_name - # Required. URI. + # Required. The URI of the file in Google Cloud Storage. # Corresponds to the JSON property `fileUri` # @return [String] attr_accessor :file_uri @@ -16719,7 +16824,9 @@ class GoogleCloudAiplatformV1beta1GeminiExample # @return [Array] attr_accessor :contents - # Generation config. + # Configuration for content generation. This message contains all the parameters + # that control how the model generates content. It allows you to influence the + # randomness, length, and structure of the output. # Corresponds to the JSON property `generationConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig] attr_accessor :generation_config @@ -16747,10 +16854,9 @@ class GoogleCloudAiplatformV1beta1GeminiExample # @return [Array] attr_accessor :safety_settings - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `systemInstruction` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :system_instruction @@ -16815,10 +16921,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1GeminiPreferenceExampleCompletion include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `completion` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :completion @@ -17011,7 +17116,9 @@ class GoogleCloudAiplatformV1beta1GenerateContentRequest # @return [Array] attr_accessor :contents - # Generation config. + # Configuration for content generation. This message contains all the parameters + # that control how the model generates content. It allows you to influence the + # randomness, length, and structure of the output. # Corresponds to the JSON property `generationConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig] attr_accessor :generation_config @@ -17025,7 +17132,10 @@ class GoogleCloudAiplatformV1beta1GenerateContentRequest # @return [Hash] attr_accessor :labels - # Configuration for Model Armor integrations of prompt and responses. + # Configuration for Model Armor. Model Armor is a Google Cloud service that + # provides safety and security filtering for prompts and responses. It helps + # protect your AI applications from risks such as harmful content, sensitive + # data leakage, and prompt injection attacks. # Corresponds to the JSON property `modelArmorConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ModelArmorConfig] attr_accessor :model_armor_config @@ -17036,10 +17146,9 @@ class GoogleCloudAiplatformV1beta1GenerateContentRequest # @return [Array] attr_accessor :safety_settings - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `systemInstruction` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :system_instruction @@ -17454,10 +17563,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1GenerateMemoriesRequestDirectContentsSourceEvent include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -17682,50 +17790,72 @@ def update!(**args) end end - # Generation config. + # Configuration for content generation. This message contains all the parameters + # that control how the model generates content. It allows you to influence the + # randomness, length, and structure of the output. class GoogleCloudAiplatformV1beta1GenerationConfig include Google::Apis::Core::Hashable - # Optional. If enabled, audio timestamp will be included in the request to the - # model. + # Optional. If enabled, audio timestamps will be included in the request to the + # model. This can be useful for synchronizing audio with other modalities in the + # response. # Corresponds to the JSON property `audioTimestamp` # @return [Boolean] attr_accessor :audio_timestamp alias_method :audio_timestamp?, :audio_timestamp - # Optional. Number of candidates to generate. + # Optional. The number of candidate responses to generate. A higher ` + # candidate_count` can provide more options to choose from, but it also consumes + # more resources. This can be useful for generating a variety of responses and + # selecting the best one. # Corresponds to the JSON property `candidateCount` # @return [Fixnum] attr_accessor :candidate_count # Optional. If enabled, the model will detect emotions and adapt its responses - # accordingly. + # accordingly. For example, if the model detects that the user is frustrated, it + # may provide a more empathetic response. # Corresponds to the JSON property `enableAffectiveDialog` # @return [Boolean] attr_accessor :enable_affective_dialog alias_method :enable_affective_dialog?, :enable_affective_dialog - # Optional. Frequency penalties. + # Optional. Penalizes tokens based on their frequency in the generated text. A + # positive value helps to reduce the repetition of words and phrases. Valid + # values can range from [-2.0, 2.0]. # Corresponds to the JSON property `frequencyPenalty` # @return [Float] attr_accessor :frequency_penalty - # Config for image generation features. + # Configuration for image generation. This message allows you to control various + # aspects of image generation, such as the output format, aspect ratio, and + # whether the model can generate images of people. # Corresponds to the JSON property `imageConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ImageConfig] attr_accessor :image_config - # Optional. Logit probabilities. + # Optional. The number of top log probabilities to return for each token. This + # can be used to see which other tokens were considered likely candidates for a + # given position. A higher value will return more options, but it will also + # increase the size of the response. # Corresponds to the JSON property `logprobs` # @return [Fixnum] attr_accessor :logprobs - # Optional. The maximum number of output tokens to generate per message. + # Optional. The maximum number of tokens to generate in the response. A token is + # approximately four characters. The default value varies by model. This + # parameter can be used to control the length of the generated text and prevent + # overly long responses. # Corresponds to the JSON property `maxOutputTokens` # @return [Fixnum] attr_accessor :max_output_tokens - # Optional. If specified, the media resolution specified will be used. + # Optional. The token resolution at which input media content is sampled. This + # is used to control the trade-off between the quality of the response and the + # number of tokens used to represent the media. A higher resolution allows the + # model to perceive more detail, which can lead to a more nuanced response, but + # it will also use more tokens. This does not affect the image dimensions sent + # to the model. # Corresponds to the JSON property `mediaResolution` # @return [String] attr_accessor :media_resolution @@ -17735,44 +17865,41 @@ class GoogleCloudAiplatformV1beta1GenerationConfig # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigModelConfig] attr_accessor :model_config - # Optional. Positive penalties. + # Optional. Penalizes tokens that have already appeared in the generated text. A + # positive value encourages the model to generate more diverse and less + # repetitive text. Valid values can range from [-2.0, 2.0]. # Corresponds to the JSON property `presencePenalty` # @return [Float] attr_accessor :presence_penalty - # Optional. Output schema of the generated response. This is an alternative to ` - # response_schema` that accepts [JSON Schema](https://json-schema.org/). If set, - # `response_schema` must be omitted, but `response_mime_type` is required. While - # the full JSON Schema may be sent, not all features are supported. Specifically, - # only the following properties are supported: - `$id` - `$defs` - `$ref` - `$ - # anchor` - `type` - `format` - `title` - `description` - `enum` (for strings - # and numbers) - `items` - `prefixItems` - `minItems` - `maxItems` - `minimum` - - # `maximum` - `anyOf` - `oneOf` (interpreted the same as `anyOf`) - `properties` - # - `additionalProperties` - `required` The non-standard `propertyOrdering` - # property may also be set. Cyclic references are unrolled to a limited degree - # and, as such, may only be used within non-required properties. (Nullable - # properties are not sufficient.) If `$ref` is set on a sub-schema, no other - # properties, except for than those starting as a `$`, may be set. + # Optional. When this field is set, response_schema must be omitted and + # response_mime_type must be set to `application/json`. # Corresponds to the JSON property `responseJsonSchema` # @return [Object] attr_accessor :response_json_schema - # Optional. If true, export the logprobs results in response. + # Optional. If set to true, the log probabilities of the output tokens are + # returned. Log probabilities are the logarithm of the probability of a token + # appearing in the output. A higher log probability means the token is more + # likely to be generated. This can be useful for analyzing the model's + # confidence in its own output and for debugging. # Corresponds to the JSON property `responseLogprobs` # @return [Boolean] attr_accessor :response_logprobs alias_method :response_logprobs?, :response_logprobs - # Optional. Output response mimetype of the generated candidate text. Supported - # mimetype: - `text/plain`: (default) Text output. - `application/json`: JSON - # response in the candidates. The model needs to be prompted to output the + # Optional. The IANA standard MIME type of the response. The model will generate + # output that conforms to this MIME type. Supported values include 'text/plain' ( + # default) and 'application/json'. The model needs to be prompted to output the # appropriate response type, otherwise the behavior is undefined. This is a # preview feature. # Corresponds to the JSON property `responseMimeType` # @return [String] attr_accessor :response_mime_type - # Optional. The modalities of the response. + # Optional. The modalities of the response. The model will generate a response + # that includes all the specified modalities. For example, if this is set to `[ + # TEXT, IMAGE]`, the response will include both text and an image. # Corresponds to the JSON property `responseModalities` # @return [Array] attr_accessor :response_modalities @@ -17784,42 +17911,68 @@ class GoogleCloudAiplatformV1beta1GenerationConfig # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Schema] attr_accessor :response_schema - # The configuration for routing the request to a specific model. + # The configuration for routing the request to a specific model. This can be + # used to control which model is used for the generation, either automatically + # or by specifying a model name. # Corresponds to the JSON property `routingConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig] attr_accessor :routing_config - # Optional. Seed. + # Optional. A seed for the random number generator. By setting a seed, you can + # make the model's output mostly deterministic. For a given prompt and + # parameters (like temperature, top_p, etc.), the model will produce the same + # response every time. However, it's not a guaranteed absolute deterministic + # behavior. This is different from parameters like `temperature`, which control + # the *level* of randomness. `seed` ensures that the "random" choices the model + # makes are the same on every run, making it essential for testing and ensuring + # reproducible results. # Corresponds to the JSON property `seed` # @return [Fixnum] attr_accessor :seed - # The speech generation config. + # Configuration for speech generation. # Corresponds to the JSON property `speechConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SpeechConfig] attr_accessor :speech_config - # Optional. Stop sequences. + # Optional. A list of character sequences that will stop the model from + # generating further tokens. If a stop sequence is generated, the output will + # end at that point. This is useful for controlling the length and structure of + # the output. For example, you can use ["\n", "###"] to stop generation at a new + # line or a specific marker. # Corresponds to the JSON property `stopSequences` # @return [Array] attr_accessor :stop_sequences - # Optional. Controls the randomness of predictions. + # Optional. Controls the randomness of the output. A higher temperature results + # in more creative and diverse responses, while a lower temperature makes the + # output more predictable and focused. The valid range is (0.0, 2.0]. # Corresponds to the JSON property `temperature` # @return [Float] attr_accessor :temperature - # Config for thinking features. + # Configuration for the model's thinking features. "Thinking" is a process where + # the model breaks down a complex task into smaller, manageable steps. This + # allows the model to reason about the task, plan its approach, and execute the + # plan to generate a high-quality response. # Corresponds to the JSON property `thinkingConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig] attr_accessor :thinking_config - # Optional. If specified, top-k sampling will be used. + # Optional. Specifies the top-k sampling threshold. The model considers only the + # top k most probable tokens for the next token. This can be useful for + # generating more coherent and less random text. For example, a `top_k` of 40 + # means the model will choose the next word from the 40 most likely words. # Corresponds to the JSON property `topK` # @return [Float] attr_accessor :top_k - # Optional. If specified, nucleus sampling will be used. + # Optional. Specifies the nucleus sampling threshold. The model considers only + # the smallest set of tokens whose cumulative probability is at least `top_p`. + # This helps generate more diverse and less repetitive responses. For example, a + # `top_p` of 0.9 means the model considers tokens until the cumulative + # probability of the tokens to select from reaches 0.9. It's recommended to + # adjust either temperature or `top_p`, but not both. # Corresponds to the JSON property `topP` # @return [Float] attr_accessor :top_p @@ -17875,17 +18028,21 @@ def update!(**args) end end - # The configuration for routing the request to a specific model. + # The configuration for routing the request to a specific model. This can be + # used to control which model is used for the generation, either automatically + # or by specifying a model name. class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfig include Google::Apis::Core::Hashable - # When automated routing is specified, the routing will be determined by the - # pretrained routing model and customer provided model routing preference. + # The configuration for automated routing. When automated routing is specified, + # the routing will be determined by the pretrained routing model and customer + # provided model routing preference. # Corresponds to the JSON property `autoMode` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode] attr_accessor :auto_mode - # When manual routing is set, the specified model will be used directly. + # The configuration for manual routing. When manual routing is specified, the + # model will be selected based on the model name provided. # Corresponds to the JSON property `manualMode` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode] attr_accessor :manual_mode @@ -17901,8 +18058,9 @@ def update!(**args) end end - # When automated routing is specified, the routing will be determined by the - # pretrained routing model and customer provided model routing preference. + # The configuration for automated routing. When automated routing is specified, + # the routing will be determined by the pretrained routing model and customer + # provided model routing preference. class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigAutoRoutingMode include Google::Apis::Core::Hashable @@ -17921,13 +18079,12 @@ def update!(**args) end end - # When manual routing is set, the specified model will be used directly. + # The configuration for manual routing. When manual routing is specified, the + # model will be selected based on the model name provided. class GoogleCloudAiplatformV1beta1GenerationConfigRoutingConfigManualRoutingMode include Google::Apis::Core::Hashable - # The model name to use. Only the public LLM models are accepted. See [Supported - # models](https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/ - # inference#supported-models). + # The name of the model to use. Only public LLM models are accepted. # Corresponds to the JSON property `modelName` # @return [String] attr_accessor :model_name @@ -17942,18 +18099,26 @@ def update!(**args) end end - # Config for thinking features. + # Configuration for the model's thinking features. "Thinking" is a process where + # the model breaks down a complex task into smaller, manageable steps. This + # allows the model to reason about the task, plan its approach, and execute the + # plan to generate a high-quality response. class GoogleCloudAiplatformV1beta1GenerationConfigThinkingConfig include Google::Apis::Core::Hashable - # Optional. Indicates whether to include thoughts in the response. If true, - # thoughts are returned only when available. + # Optional. If true, the model will include its thoughts in the response. " + # Thoughts" are the intermediate steps the model takes to arrive at the final + # response. They can provide insights into the model's reasoning process and + # help with debugging. If this is true, thoughts are returned only when + # available. # Corresponds to the JSON property `includeThoughts` # @return [Boolean] attr_accessor :include_thoughts alias_method :include_thoughts?, :include_thoughts - # Optional. Indicates the thinking budget in tokens. + # Optional. The token budget for the model's thinking process. The model will + # make a best effort to stay within this budget. This can be used to control the + # trade-off between response quality and latency. # Corresponds to the JSON property `thinkingBudget` # @return [Fixnum] attr_accessor :thinking_budget @@ -18207,21 +18372,30 @@ def update!(**args) end end - # Grounding chunk. + # A piece of evidence that supports a claim made by the model. This is used to + # show a citation for a claim made by the model. When grounding is enabled, the + # model returns a `GroundingChunk` that contains a reference to the source of + # the information. class GoogleCloudAiplatformV1beta1GroundingChunk include Google::Apis::Core::Hashable - # Chunk from Google Maps. + # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains + # information about a place, such as its name, address, and reviews. This is + # used to provide the user with rich, location-based information. # Corresponds to the JSON property `maps` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMaps] attr_accessor :maps - # Chunk from context retrieved by the retrieval tools. + # Context retrieved from a data source to ground the model's response. This is + # used when a retrieval tool fetches information from a user-provided corpus or + # a public dataset. # Corresponds to the JSON property `retrievedContext` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext] attr_accessor :retrieved_context - # Chunk from the web. + # A `Web` chunk is a piece of evidence that comes from a web page. It contains + # the URI of the web page, the title of the page, and the domain of the page. + # This is used to provide the user with a link to the source of the information. # Corresponds to the JSON property `web` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkWeb] attr_accessor :web @@ -18238,32 +18412,36 @@ def update!(**args) end end - # Chunk from Google Maps. + # A `Maps` chunk is a piece of evidence that comes from Google Maps. It contains + # information about a place, such as its name, address, and reviews. This is + # used to provide the user with rich, location-based information. class GoogleCloudAiplatformV1beta1GroundingChunkMaps include Google::Apis::Core::Hashable - # Sources used to generate the place answer. + # The sources that were used to generate the place answer. This includes review + # snippets and photos that were used to generate the answer, as well as URIs to + # flag content. # Corresponds to the JSON property `placeAnswerSources` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources] attr_accessor :place_answer_sources - # This Place's resource name, in `places/`place_id`` format. Can be used to look - # up the Place. + # This Place's resource name, in `places/`place_id`` format. This can be used to + # look up the place in the Google Maps API. # Corresponds to the JSON property `placeId` # @return [String] attr_accessor :place_id - # Text of the place answer. + # The text of the place answer. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text - # Title of the place. + # The title of the place. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # URI reference of the place. + # The URI of the place. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -18282,11 +18460,13 @@ def update!(**args) end end - # Sources used to generate the place answer. + # The sources that were used to generate the place answer. This includes review + # snippets and photos that were used to generate the answer, as well as URIs to + # flag content. class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSources include Google::Apis::Core::Hashable - # Snippets of reviews that are used to generate the answer. + # Snippets of reviews that were used to generate the answer. # Corresponds to the JSON property `reviewSnippets` # @return [Array] attr_accessor :review_snippets @@ -18301,7 +18481,7 @@ def update!(**args) end end - # Encapsulates a review snippet. + # A review snippet that is used to generate the answer. class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnippet include Google::Apis::Core::Hashable @@ -18310,12 +18490,12 @@ class GoogleCloudAiplatformV1beta1GroundingChunkMapsPlaceAnswerSourcesReviewSnip # @return [String] attr_accessor :google_maps_uri - # Id of the review referencing the place. + # The ID of the review that is being referenced. # Corresponds to the JSON property `reviewId` # @return [String] attr_accessor :review_id - # Title of the review. + # The title of the review. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title @@ -18332,12 +18512,16 @@ def update!(**args) end end - # Chunk from context retrieved by the retrieval tools. + # Context retrieved from a data source to ground the model's response. This is + # used when a retrieval tool fetches information from a user-provided corpus or + # a public dataset. class GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext include Google::Apis::Core::Hashable - # Output only. The full document name for the referenced Vertex AI Search - # document. + # Output only. The full resource name of the referenced Vertex AI Search + # document. This is used to identify the specific document that was retrieved. + # The format is `projects/`project`/locations/`location`/collections/`collection` + # /dataStores/`data_store`/branches/`branch`/documents/`document``. # Corresponds to the JSON property `documentName` # @return [String] attr_accessor :document_name @@ -18348,17 +18532,17 @@ class GoogleCloudAiplatformV1beta1GroundingChunkRetrievedContext # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagChunk] attr_accessor :rag_chunk - # Text of the attribution. + # The content of the retrieved data source. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text - # Title of the attribution. + # The title of the retrieved data source. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # URI reference of the attribution. + # The URI of the retrieved data source. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -18377,21 +18561,24 @@ def update!(**args) end end - # Chunk from the web. + # A `Web` chunk is a piece of evidence that comes from a web page. It contains + # the URI of the web page, the title of the page, and the domain of the page. + # This is used to provide the user with a link to the source of the information. class GoogleCloudAiplatformV1beta1GroundingChunkWeb include Google::Apis::Core::Hashable - # Domain of the (original) URI. + # The domain of the web page that contains the evidence. This can be used to + # filter out low-quality sources. # Corresponds to the JSON property `domain` # @return [String] attr_accessor :domain - # Title of the chunk. + # The title of the web page that contains the evidence. # Corresponds to the JSON property `title` # @return [String] attr_accessor :title - # URI reference of the chunk. + # The URI of the web page that contains the evidence. # Corresponds to the JSON property `uri` # @return [String] attr_accessor :uri @@ -18408,49 +18595,63 @@ def update!(**args) end end - # Metadata returned to client when grounding is enabled. + # Information about the sources that support the content of a response. When + # grounding is enabled, the model returns citations for claims in the response. + # This object contains the retrieved sources. class GoogleCloudAiplatformV1beta1GroundingMetadata include Google::Apis::Core::Hashable - # Optional. Output only. Resource name of the Google Maps widget context token - # to be used with the PlacesContextElement widget to render contextual data. - # This is populated only for Google Maps grounding. + # Optional. Output only. A token that can be used to render a Google Maps widget + # with the contextual data. This field is populated only when the grounding + # source is Google Maps. # Corresponds to the JSON property `googleMapsWidgetContextToken` # @return [String] attr_accessor :google_maps_widget_context_token - # List of supporting references retrieved from specified grounding source. + # A list of supporting references retrieved from the grounding source. This + # field is populated when the grounding source is Google Search, Vertex AI + # Search, or Google Maps. # Corresponds to the JSON property `groundingChunks` # @return [Array] attr_accessor :grounding_chunks - # Optional. List of grounding support. + # Optional. A list of grounding supports that connect the generated content to + # the grounding chunks. This field is populated when the grounding source is + # Google Search or Vertex AI Search. # Corresponds to the JSON property `groundingSupports` # @return [Array] attr_accessor :grounding_supports - # Metadata related to retrieval in the grounding flow. + # Metadata related to the retrieval grounding source. This is part of the ` + # GroundingMetadata` returned when grounding is enabled. # Corresponds to the JSON property `retrievalMetadata` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RetrievalMetadata] attr_accessor :retrieval_metadata - # Optional. Queries executed by the retrieval tools. + # Optional. The queries that were executed by the retrieval tools. This field is + # populated only when the grounding source is a retrieval tool, such as Vertex + # AI Search. # Corresponds to the JSON property `retrievalQueries` # @return [Array] attr_accessor :retrieval_queries - # Google search entry point. + # An entry point for displaying Google Search results. A `SearchEntryPoint` is + # populated when the grounding source for a model's response is Google Search. + # It provides information that you can use to display the search results in your + # application. # Corresponds to the JSON property `searchEntryPoint` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SearchEntryPoint] attr_accessor :search_entry_point - # Optional. Output only. List of source flagging uris. This is currently - # populated only for Google Maps grounding. + # Optional. Output only. A list of URIs that can be used to flag a place or + # review for inappropriate content. This field is populated only when the + # grounding source is Google Maps. # Corresponds to the JSON property `sourceFlaggingUris` # @return [Array] attr_accessor :source_flagging_uris - # Optional. Web search queries for the following-up web search. + # Optional. The web search queries that were used to generate the content. This + # field is populated only when the grounding source is Google Search. # Corresponds to the JSON property `webSearchQueries` # @return [Array] attr_accessor :web_search_queries @@ -18472,17 +18673,17 @@ def update!(**args) end end - # Source content flagging uri for a place or review. This is currently populated - # only for Google Maps grounding. + # A URI that can be used to flag a place or review for inappropriate content. + # This is populated only when the grounding source is Google Maps. class GoogleCloudAiplatformV1beta1GroundingMetadataSourceFlaggingUri include Google::Apis::Core::Hashable - # A link where users can flag a problem with the source (place or review). + # The URI that can be used to flag the content. # Corresponds to the JSON property `flagContentUri` # @return [String] attr_accessor :flag_content_uri - # Id of the place or review. + # The ID of the place or review. # Corresponds to the JSON property `sourceId` # @return [String] attr_accessor :source_id @@ -18498,27 +18699,30 @@ def update!(**args) end end - # Grounding support. + # A collection of supporting references for a segment of the model's response. class GoogleCloudAiplatformV1beta1GroundingSupport include Google::Apis::Core::Hashable - # Confidence score of the support references. Ranges from 0 to 1. 1 is the most - # confident. For Gemini 2.0 and before, this list must have the same size as the - # grounding_chunk_indices. For Gemini 2.5 and after, this list will be empty and + # The confidence scores for the support references. This list is parallel to the + # `grounding_chunk_indices` list. A score is a value between 0.0 and 1.0, with a + # higher score indicating a higher confidence that the reference supports the + # claim. For Gemini 2.0 and before, this list has the same size as ` + # grounding_chunk_indices`. For Gemini 2.5 and later, this list is empty and # should be ignored. # Corresponds to the JSON property `confidenceScores` # @return [Array] attr_accessor :confidence_scores - # A list of indices (into 'grounding_chunk') specifying the citations associated - # with the claim. For instance [1,3,4] means that grounding_chunk[1], - # grounding_chunk[3], grounding_chunk[4] are the retrieved content attributed to - # the claim. + # A list of indices into the `grounding_chunks` field of the `GroundingMetadata` + # message. These indices specify which grounding chunks support the claim made + # in the content segment. For example, if this field has the values `[1, 3]`, it + # means that `grounding_chunks[1]` and `grounding_chunks[3]` are the sources for + # the claim in the content segment. # Corresponds to the JSON property `groundingChunkIndices` # @return [Array] attr_accessor :grounding_chunk_indices - # Segment of the content. + # A segment of the content. # Corresponds to the JSON property `segment` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Segment] attr_accessor :segment @@ -18697,7 +18901,9 @@ def update!(**args) end end - # Config for image generation features. + # Configuration for image generation. This message allows you to control various + # aspects of image generation, such as the output format, aspect ratio, and + # whether the model can generate images of people. class GoogleCloudAiplatformV1beta1ImageConfig include Google::Apis::Core::Hashable @@ -22189,17 +22395,24 @@ def update!(**args) end end - # Logprobs Result + # The log probabilities of the tokens generated by the model. This is useful for + # understanding the model's confidence in its predictions and for debugging. For + # example, you can use log probabilities to identify when the model is making a + # less confident prediction or to explore alternative responses that the model + # considered. A low log probability can also indicate that the model is " + # hallucinating" or generating factually incorrect information. class GoogleCloudAiplatformV1beta1LogprobsResult include Google::Apis::Core::Hashable - # Length = total number of decoding steps. The chosen candidates may or may not - # be in top_candidates. + # A list of the chosen candidate tokens at each decoding step. The length of + # this list is equal to the total number of decoding steps. Note that the chosen + # candidate might not be in `top_candidates`. # Corresponds to the JSON property `chosenCandidates` # @return [Array] attr_accessor :chosen_candidates - # Length = total number of decoding steps. + # A list of the top candidate tokens at each decoding step. The length of this + # list is equal to the total number of decoding steps. # Corresponds to the JSON property `topCandidates` # @return [Array] attr_accessor :top_candidates @@ -22215,21 +22428,27 @@ def update!(**args) end end - # Candidate for the logprobs token and score. + # A single token and its associated log probability. class GoogleCloudAiplatformV1beta1LogprobsResultCandidate include Google::Apis::Core::Hashable - # The candidate's log probability. + # The log probability of this token. A higher value indicates that the model was + # more confident in this token. The log probability can be used to assess the + # relative likelihood of different tokens and to identify when the model is + # uncertain. # Corresponds to the JSON property `logProbability` # @return [Float] attr_accessor :log_probability - # The candidate's token string value. + # The token's string representation. # Corresponds to the JSON property `token` # @return [String] attr_accessor :token - # The candidate's token id value. + # The token's numerical ID. While the `token` field provides the string + # representation of the token, the `token_id` is the numerical representation + # that the model uses internally. This can be useful for developers who want to + # build custom logic based on the model's vocabulary. # Corresponds to the JSON property `tokenId` # @return [Fixnum] attr_accessor :token_id @@ -22246,11 +22465,12 @@ def update!(**args) end end - # Candidates with top log probabilities at each decoding step. + # A list of the top candidate tokens and their log probabilities at each + # decoding step. This can be used to see what other tokens the model considered. class GoogleCloudAiplatformV1beta1LogprobsResultTopCandidates include Google::Apis::Core::Hashable - # Sorted by log probability in descending order. + # The list of candidate tokens, sorted by log probability in descending order. # Corresponds to the JSON property `candidates` # @return [Array] attr_accessor :candidates @@ -22530,6 +22750,12 @@ class GoogleCloudAiplatformV1beta1Memory # @return [String] attr_accessor :revision_expire_time + # Optional. Input only. The labels to apply to the Memory Revision created as a + # result of this request. + # Corresponds to the JSON property `revisionLabels` + # @return [Hash] + attr_accessor :revision_labels + # Optional. Input only. The TTL for the revision. The expiration time is # computed: now + TTL. # Corresponds to the JSON property `revisionTtl` @@ -22573,6 +22799,7 @@ def update!(**args) @fact = args[:fact] if args.key?(:fact) @name = args[:name] if args.key?(:name) @revision_expire_time = args[:revision_expire_time] if args.key?(:revision_expire_time) + @revision_labels = args[:revision_labels] if args.key?(:revision_labels) @revision_ttl = args[:revision_ttl] if args.key?(:revision_ttl) @scope = args[:scope] if args.key?(:scope) @topics = args[:topics] if args.key?(:topics) @@ -22670,10 +22897,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1MemoryBankCustomizationConfigGenerateMemoriesExampleConversationSourceEvent include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -23082,6 +23308,11 @@ class GoogleCloudAiplatformV1beta1Metric # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuSpec] attr_accessor :bleu_spec + # Specificies a metric that is populated by evaluating user-defined Python code. + # Corresponds to the JSON property `customCodeExecutionSpec` + # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec] + attr_accessor :custom_code_execution_spec + # Spec for exact match metric - returns 1 if prediction and reference exactly # matches, otherwise 0. # Corresponds to the JSON property `exactMatchSpec` @@ -23122,6 +23353,7 @@ def initialize(**args) def update!(**args) @aggregation_metrics = args[:aggregation_metrics] if args.key?(:aggregation_metrics) @bleu_spec = args[:bleu_spec] if args.key?(:bleu_spec) + @custom_code_execution_spec = args[:custom_code_execution_spec] if args.key?(:custom_code_execution_spec) @exact_match_spec = args[:exact_match_spec] if args.key?(:exact_match_spec) @llm_based_metric_spec = args[:llm_based_metric_spec] if args.key?(:llm_based_metric_spec) @pairwise_metric_spec = args[:pairwise_metric_spec] if args.key?(:pairwise_metric_spec) @@ -23692,16 +23924,21 @@ def update!(**args) end end - # Represents token counting info for a single modality. + # Represents a breakdown of token usage by modality. This message is used in + # CountTokensResponse and GenerateContentResponse.UsageMetadata to provide a + # detailed view of how many tokens are used by each modality (e.g., text, image, + # video) in a request. This is particularly useful for multimodal models, + # allowing you to track and manage token consumption for billing and quota + # purposes. class GoogleCloudAiplatformV1beta1ModalityTokenCount include Google::Apis::Core::Hashable - # The modality associated with this token count. + # The modality that this token count applies to. # Corresponds to the JSON property `modality` # @return [String] attr_accessor :modality - # Number of tokens. + # The number of tokens counted for this modality. # Corresponds to the JSON property `tokenCount` # @return [Fixnum] attr_accessor :token_count @@ -24002,17 +24239,29 @@ def update!(**args) end end - # Configuration for Model Armor integrations of prompt and responses. + # Configuration for Model Armor. Model Armor is a Google Cloud service that + # provides safety and security filtering for prompts and responses. It helps + # protect your AI applications from risks such as harmful content, sensitive + # data leakage, and prompt injection attacks. class GoogleCloudAiplatformV1beta1ModelArmorConfig include Google::Apis::Core::Hashable - # Optional. The name of the Model Armor template to use for prompt sanitization. + # Optional. The resource name of the Model Armor template to use for prompt + # screening. A Model Armor template is a set of customized filters and + # thresholds that define how Model Armor screens content. If specified, Model + # Armor will use this template to check the user's prompt for safety and + # security risks before it is sent to the model. The name must be in the format ` + # projects/`project`/locations/`location`/templates/`template``. # Corresponds to the JSON property `promptTemplateName` # @return [String] attr_accessor :prompt_template_name - # Optional. The name of the Model Armor template to use for response - # sanitization. + # Optional. The resource name of the Model Armor template to use for response + # screening. A Model Armor template is a set of customized filters and + # thresholds that define how Model Armor screens content. If specified, Model + # Armor will use this template to check the model's response for safety and + # security risks before it is returned to the user. The name must be in the + # format `projects/`project`/locations/`location`/templates/`template``. # Corresponds to the JSON property `responseTemplateName` # @return [String] attr_accessor :response_template_name @@ -26753,8 +27002,7 @@ def update!(**args) end end - # Configuration for a multi-speaker text-to-speech setup. Enables the use of up - # to two distinct voices in a single synthesis request. + # Configuration for a multi-speaker text-to-speech request. class GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig include Google::Apis::Core::Hashable @@ -28558,10 +28806,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1OptimizePromptRequest include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -28586,10 +28833,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1OptimizePromptResponse include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -29109,11 +29355,11 @@ def update!(**args) end end - # A datatype containing media that is part of a multi-part `Content` message. A ` + # A datatype containing media that is part of a multi-part Content message. A ` # Part` consists of data which has an associated datatype. A `Part` can only - # contain one of the accepted types in `Part.data`. A `Part` must have a fixed - # IANA MIME type identifying the type and subtype of the media if `inline_data` - # or `file_data` field is filled with raw bytes. + # contain one of the accepted types in `Part.data`. For media types that are not + # text, `Part` must have a fixed IANA MIME type identifying the type and subtype + # of the media if `inline_data` or `file_data` field is filled with raw bytes. class GoogleCloudAiplatformV1beta1Part include Google::Apis::Core::Hashable @@ -29132,7 +29378,9 @@ class GoogleCloudAiplatformV1beta1Part # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecutableCode] attr_accessor :executable_code - # URI based data. + # URI-based data. A FileData message contains a URI pointing to data of a + # specific media type. It is used to represent images, audio, and video stored + # in Google Cloud Storage. # Corresponds to the JSON property `fileData` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FileData] attr_accessor :file_data @@ -29152,17 +29400,19 @@ class GoogleCloudAiplatformV1beta1Part # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1FunctionResponse] attr_accessor :function_response - # Content blob. + # A content blob. A Blob contains data of a specific media type. It is used to + # represent images, audio, and video. # Corresponds to the JSON property `inlineData` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Blob] attr_accessor :inline_data - # Optional. Text part (can be code). + # Optional. The text content of the part. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text - # Optional. Indicates if the part is thought from the model. + # Optional. Indicates whether the `part` represents the model's thought process + # or reasoning. # Corresponds to the JSON property `thought` # @return [Boolean] attr_accessor :thought @@ -29175,7 +29425,8 @@ class GoogleCloudAiplatformV1beta1Part # @return [String] attr_accessor :thought_signature - # Metadata describes the input video content. + # Provides metadata for a video, including the start and end offsets for + # clipping and the frame rate. # Corresponds to the JSON property `videoMetadata` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VideoMetadata] attr_accessor :video_metadata @@ -30394,11 +30645,11 @@ def update!(**args) end end - # The configuration for the prebuilt speaker to use. + # Configuration for a prebuilt voice. class GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig include Google::Apis::Core::Hashable - # The name of the preset voice to use. + # The name of the prebuilt voice to use. # Corresponds to the JSON property `voiceName` # @return [String] attr_accessor :voice_name @@ -32981,6 +33232,18 @@ class GoogleCloudAiplatformV1beta1RagCorpus # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig] attr_accessor :rag_vector_db_config + # Output only. Reserved for future use. + # Corresponds to the JSON property `satisfiesPzi` + # @return [Boolean] + attr_accessor :satisfies_pzi + alias_method :satisfies_pzi?, :satisfies_pzi + + # Output only. Reserved for future use. + # Corresponds to the JSON property `satisfiesPzs` + # @return [Boolean] + attr_accessor :satisfies_pzs + alias_method :satisfies_pzs?, :satisfies_pzs + # Output only. Timestamp when this RagCorpus was last updated. # Corresponds to the JSON property `updateTime` # @return [String] @@ -33012,6 +33275,8 @@ def update!(**args) @rag_embedding_model_config = args[:rag_embedding_model_config] if args.key?(:rag_embedding_model_config) @rag_files_count = args[:rag_files_count] if args.key?(:rag_files_count) @rag_vector_db_config = args[:rag_vector_db_config] if args.key?(:rag_vector_db_config) + @satisfies_pzi = args[:satisfies_pzi] if args.key?(:satisfies_pzi) + @satisfies_pzs = args[:satisfies_pzs] if args.key?(:satisfies_pzs) @update_time = args[:update_time] if args.key?(:update_time) @vector_db_config = args[:vector_db_config] if args.key?(:vector_db_config) @vertex_ai_search_config = args[:vertex_ai_search_config] if args.key?(:vertex_ai_search_config) @@ -34901,6 +35166,13 @@ def update!(**args) class GoogleCloudAiplatformV1beta1ReasoningEngineSpec include Google::Apis::Core::Hashable + # Optional. The A2A Agent Card for the agent (if available). It follows the + # specification at https://a2a-protocol.org/latest/specification/#5-agent- + # discovery-the-agent-card. + # Corresponds to the JSON property `agentCard` + # @return [Hash] + attr_accessor :agent_card + # Optional. The OSS agent framework used to develop the agent. Currently # supported values: "google-adk", "langchain", "langgraph", "ag2", "llama-index", # "custom". @@ -34919,6 +35191,23 @@ class GoogleCloudAiplatformV1beta1ReasoningEngineSpec # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec] attr_accessor :deployment_spec + # Output only. The identity to use for the Reasoning Engine. It can contain one + # of the following values: * service-`project`@gcp-sa-aiplatform-re.googleapis. + # com (for SERVICE_AGENT identity type) * `name`@`project`.gserviceaccount.com ( + # for SERVICE_ACCOUNT identity type) * agents.global.`org`.system.id.goog/ + # resources/aiplatform/projects/`project`/locations/`location`/reasoningEngines/` + # reasoning_engine` (for AGENT_IDENTITY identity type) + # Corresponds to the JSON property `effectiveIdentity` + # @return [String] + attr_accessor :effective_identity + + # Optional. The identity type to use for the Reasoning Engine. If not specified, + # the `service_account` field will be used if set, otherwise the default Vertex + # AI Reasoning Engine Service Agent in the project will be used. + # Corresponds to the JSON property `identityType` + # @return [String] + attr_accessor :identity_type + # User-provided package specification, containing pickled object and package # requirements. # Corresponds to the JSON property `packageSpec` @@ -34945,9 +35234,12 @@ def initialize(**args) # Update properties of this object def update!(**args) + @agent_card = args[:agent_card] if args.key?(:agent_card) @agent_framework = args[:agent_framework] if args.key?(:agent_framework) @class_methods = args[:class_methods] if args.key?(:class_methods) @deployment_spec = args[:deployment_spec] if args.key?(:deployment_spec) + @effective_identity = args[:effective_identity] if args.key?(:effective_identity) + @identity_type = args[:identity_type] if args.key?(:identity_type) @package_spec = args[:package_spec] if args.key?(:package_spec) @service_account = args[:service_account] if args.key?(:service_account) @source_code_spec = args[:source_code_spec] if args.key?(:source_code_spec) @@ -35044,8 +35336,8 @@ class GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec # @return [String] attr_accessor :pickle_object_gcs_uri - # Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11. If not - # specified, default value is 3.10. + # Optional. The Python version. Supported values are 3.9, 3.10, 3.11, 3.12, 3.13. + # If not specified, the default value is 3.10. # Corresponds to the JSON property `pythonVersion` # @return [String] attr_accessor :python_version @@ -35916,15 +36208,17 @@ def update!(**args) end end - # Metadata related to retrieval in the grounding flow. + # Metadata related to the retrieval grounding source. This is part of the ` + # GroundingMetadata` returned when grounding is enabled. class GoogleCloudAiplatformV1beta1RetrievalMetadata include Google::Apis::Core::Hashable - # Optional. Score indicating how likely information from Google Search could - # help answer the prompt. The score is in the range `[0, 1]`, where 0 is the - # least likely and 1 is the most likely. This score is only populated when - # Google Search grounding and dynamic retrieval is enabled. It will be compared - # to the threshold to determine whether to trigger Google Search. + # Optional. A score indicating how likely it is that a Google Search query could + # help answer the prompt. The score is in the range of `[0, 1]`. A score of 1 + # means the model is confident that a search will be helpful, and 0 means it is + # not. This score is populated only when Google Search grounding and dynamic + # retrieval are enabled. The score is used to determine whether to trigger a + # search. # Corresponds to the JSON property `googleSearchDynamicRetrievalScore` # @return [Float] attr_accessor :google_search_dynamic_retrieval_score @@ -36889,18 +37183,18 @@ def update!(**args) end end - # Safety rating corresponding to the generated content. + # A safety rating for a piece of content. The safety rating contains the harm + # category and the harm probability level. class GoogleCloudAiplatformV1beta1SafetyRating include Google::Apis::Core::Hashable - # Output only. Indicates whether the content was filtered out because of this - # rating. + # Output only. Indicates whether the content was blocked because of this rating. # Corresponds to the JSON property `blocked` # @return [Boolean] attr_accessor :blocked alias_method :blocked?, :blocked - # Output only. Harm category. + # Output only. The harm category of this rating. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category @@ -36912,22 +37206,22 @@ class GoogleCloudAiplatformV1beta1SafetyRating # @return [String] attr_accessor :overwritten_threshold - # Output only. Harm probability levels in the content. + # Output only. The probability of harm for this category. # Corresponds to the JSON property `probability` # @return [String] attr_accessor :probability - # Output only. Harm probability score. + # Output only. The probability score of harm for this category. # Corresponds to the JSON property `probabilityScore` # @return [Float] attr_accessor :probability_score - # Output only. Harm severity levels in the content. + # Output only. The severity of harm for this category. # Corresponds to the JSON property `severity` # @return [String] attr_accessor :severity - # Output only. Harm severity score. + # Output only. The severity score of harm for this category. # Corresponds to the JSON property `severityScore` # @return [Float] attr_accessor :severity_score @@ -36979,22 +37273,24 @@ def update!(**args) end end - # Safety settings. + # A safety setting that affects the safety-blocking behavior. A SafetySetting + # consists of a harm category and a threshold for that category. class GoogleCloudAiplatformV1beta1SafetySetting include Google::Apis::Core::Hashable - # Required. Harm category. + # Required. The harm category to be blocked. # Corresponds to the JSON property `category` # @return [String] attr_accessor :category - # Optional. Specify if the threshold is used for probability or severity score. - # If not specified, the threshold is used for probability score. + # Optional. The method for blocking content. If not specified, the default + # behavior is to use the probability score. # Corresponds to the JSON property `method` # @return [String] attr_accessor :method_prop - # Required. The harm block threshold. + # Required. The threshold for blocking content. If the harm probability exceeds + # this threshold, the content will be blocked. # Corresponds to the JSON property `threshold` # @return [String] attr_accessor :threshold @@ -40619,7 +40915,9 @@ class GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage # @return [Array] attr_accessor :contents - # Generation config. + # Configuration for content generation. This message contains all the parameters + # that control how the model generates content. It allows you to influence the + # randomness, length, and structure of the output. # Corresponds to the JSON property `generationConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GenerationConfig] attr_accessor :generation_config @@ -40635,10 +40933,9 @@ class GoogleCloudAiplatformV1beta1SchemaPromptSpecPromptMessage # @return [Array] attr_accessor :safety_settings - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `systemInstruction` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :system_instruction @@ -40720,10 +41017,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1SchemaPromptSpecStructuredPrompt include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `context` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :context @@ -44493,17 +44789,23 @@ def update!(**args) end end - # Google search entry point. + # An entry point for displaying Google Search results. A `SearchEntryPoint` is + # populated when the grounding source for a model's response is Google Search. + # It provides information that you can use to display the search results in your + # application. class GoogleCloudAiplatformV1beta1SearchEntryPoint include Google::Apis::Core::Hashable - # Optional. Web content snippet that can be embedded in a web page or an app - # webview. + # Optional. An HTML snippet that can be embedded in a web page or an application' + # s webview. This snippet displays a search result, including the title, URL, + # and a brief description of the search result. # Corresponds to the JSON property `renderedContent` # @return [String] attr_accessor :rendered_content - # Optional. Base64 encoded JSON representing array of tuple. + # Optional. A base64-encoded JSON object that contains a list of search queries + # and their corresponding search URLs. This information can be used to build a + # custom search UI. # Corresponds to the JSON property `sdkBlob` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] @@ -45122,28 +45424,31 @@ def update!(**args) end end - # Segment of the content. + # A segment of the content. class GoogleCloudAiplatformV1beta1Segment include Google::Apis::Core::Hashable - # Output only. End index in the given Part, measured in bytes. Offset from the - # start of the Part, exclusive, starting at zero. + # Output only. The end index of the segment in the `Part`, measured in bytes. + # This marks the end of the segment and is exclusive, meaning the segment + # includes content up to, but not including, the byte at this index. # Corresponds to the JSON property `endIndex` # @return [Fixnum] attr_accessor :end_index - # Output only. The index of a Part object within its parent Content object. + # Output only. The index of the `Part` object that this segment belongs to. This + # is useful for associating the segment with a specific part of the content. # Corresponds to the JSON property `partIndex` # @return [Fixnum] attr_accessor :part_index - # Output only. Start index in the given Part, measured in bytes. Offset from the - # start of the Part, inclusive, starting at zero. + # Output only. The start index of the segment in the `Part`, measured in bytes. + # This marks the beginning of the segment and is inclusive, meaning the byte at + # this index is the first byte of the segment. # Corresponds to the JSON property `startIndex` # @return [Fixnum] attr_accessor :start_index - # Output only. The text corresponding to the segment from the response. + # Output only. The text of the segment. # Corresponds to the JSON property `text` # @return [String] attr_accessor :text @@ -45216,6 +45521,15 @@ class GoogleCloudAiplatformV1beta1Session # @return [String] attr_accessor :expire_time + # The labels with user-defined metadata to organize your Sessions. Label keys + # and values can be no longer than 64 characters (Unicode codepoints), can only + # contain lowercase letters, numeric characters, underscores and dashes. + # International characters are allowed. See https://goo.gl/xmQnxf for more + # information and examples of labels. + # Corresponds to the JSON property `labels` + # @return [Hash] + attr_accessor :labels + # Identifier. The resource name of the session. Format: 'projects/`project`/ # locations/`location`/reasoningEngines/`reasoning_engine`/sessions/`session`'. # Corresponds to the JSON property `name` @@ -45251,6 +45565,7 @@ def update!(**args) @create_time = args[:create_time] if args.key?(:create_time) @display_name = args[:display_name] if args.key?(:display_name) @expire_time = args[:expire_time] if args.key?(:expire_time) + @labels = args[:labels] if args.key?(:labels) @name = args[:name] if args.key?(:name) @session_state = args[:session_state] if args.key?(:session_state) @ttl = args[:ttl] if args.key?(:ttl) @@ -45273,10 +45588,9 @@ class GoogleCloudAiplatformV1beta1SessionEvent # @return [String] attr_accessor :author - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -45588,7 +45902,7 @@ def update!(**args) end end - # Configuration for a single speaker in a multi speaker setup. + # Configuration for a single speaker in a multi-speaker setup. class GoogleCloudAiplatformV1beta1SpeakerVoiceConfig include Google::Apis::Core::Hashable @@ -45598,7 +45912,7 @@ class GoogleCloudAiplatformV1beta1SpeakerVoiceConfig # @return [String] attr_accessor :speaker - # The configuration for the voice to use. + # Configuration for a voice. # Corresponds to the JSON property `voiceConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VoiceConfig] attr_accessor :voice_config @@ -45745,22 +46059,21 @@ def update!(**args) end end - # The speech generation config. + # Configuration for speech generation. class GoogleCloudAiplatformV1beta1SpeechConfig include Google::Apis::Core::Hashable - # Optional. Language code (ISO 639. e.g. en-US) for the speech synthesization. + # Optional. The language code (ISO 639-1) for the speech synthesis. # Corresponds to the JSON property `languageCode` # @return [String] attr_accessor :language_code - # Configuration for a multi-speaker text-to-speech setup. Enables the use of up - # to two distinct voices in a single synthesis request. + # Configuration for a multi-speaker text-to-speech request. # Corresponds to the JSON property `multiSpeakerVoiceConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MultiSpeakerVoiceConfig] attr_accessor :multi_speaker_voice_config - # The configuration for the voice to use. + # Configuration for a voice. # Corresponds to the JSON property `voiceConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1VoiceConfig] attr_accessor :voice_config @@ -47986,10 +48299,9 @@ def update!(**args) class GoogleCloudAiplatformV1beta1SyntheticField include Google::Apis::Core::Hashable - # The base structured datatype containing multi-part content of a message. A ` - # Content` includes a `role` field designating the producer of the `Content` and - # a `parts` field containing multi-part data that contains the content of the - # message turn. + # The structured data content of a message. A Content message contains a `role` + # field, which indicates the producer of the content, and a `parts` field, which + # contains the multi-part data of the message. # Corresponds to the JSON property `content` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Content] attr_accessor :content @@ -51651,11 +51963,13 @@ def update!(**args) end end - # Metadata related to url context retrieval tool. + # Metadata returned when the model uses the `url_context` tool to get + # information from a user-provided URL. class GoogleCloudAiplatformV1beta1UrlContextMetadata include Google::Apis::Core::Hashable - # Output only. List of url context. + # Output only. A list of URL metadata, with one entry for each URL retrieved by + # the tool. # Corresponds to the JSON property `urlMetadata` # @return [Array] attr_accessor :url_metadata @@ -51670,16 +51984,16 @@ def update!(**args) end end - # Context of the a single url retrieval. + # The metadata for a single URL retrieval. class GoogleCloudAiplatformV1beta1UrlMetadata include Google::Apis::Core::Hashable - # Retrieved url by the tool. + # The URL retrieved by the tool. # Corresponds to the JSON property `retrievedUrl` # @return [String] attr_accessor :retrieved_url - # Status of the url retrieval. + # The status of the URL retrieval. # Corresponds to the JSON property `urlRetrievalStatus` # @return [String] attr_accessor :url_retrieval_status @@ -52110,7 +52424,8 @@ def update!(**args) end end - # Metadata describes the input video content. + # Provides metadata for a video, including the start and end offsets for + # clipping and the frame rate. class GoogleCloudAiplatformV1beta1VideoMetadata include Google::Apis::Core::Hashable @@ -52120,7 +52435,7 @@ class GoogleCloudAiplatformV1beta1VideoMetadata attr_accessor :end_offset # Optional. The frame rate of the video sent to the model. If not specified, the - # default value will be 1.0. The fps range is (0.0, 24.0]. + # default value is 1.0. The valid range is (0.0, 24.0]. # Corresponds to the JSON property `fps` # @return [Float] attr_accessor :fps @@ -52142,11 +52457,11 @@ def update!(**args) end end - # The configuration for the voice to use. + # Configuration for a voice. class GoogleCloudAiplatformV1beta1VoiceConfig include Google::Apis::Core::Hashable - # The configuration for the prebuilt speaker to use. + # Configuration for a prebuilt voice. # Corresponds to the JSON property `prebuiltVoiceConfig` # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PrebuiltVoiceConfig] attr_accessor :prebuilt_voice_config diff --git a/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/gem_version.rb b/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/gem_version.rb index a75ac70624c..a6e052d883e 100644 --- a/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/gem_version.rb +++ b/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/gem_version.rb @@ -16,13 +16,13 @@ module Google module Apis module AiplatformV1beta1 # Version of the google-apis-aiplatform_v1beta1 gem - GEM_VERSION = "0.65.0" + GEM_VERSION = "0.66.0" # Version of the code generator used to generate this client GENERATOR_VERSION = "0.18.0" # Revision of the discovery document this client was generated from - REVISION = "20251027" + REVISION = "20251101" end end end diff --git a/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/representations.rb b/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/representations.rb index 42b5288a2c9..38ad848885b 100644 --- a/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/representations.rb +++ b/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/representations.rb @@ -1132,6 +1132,18 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudAiplatformV1beta1CustomCodeExecutionResult + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudAiplatformV1beta1CustomJob class Representation < Google::Apis::Core::JsonRepresentation; end @@ -1894,6 +1906,18 @@ class Representation < Google::Apis::Core::JsonRepresentation; end include Google::Apis::Core::JsonObjectSupport end + class GoogleCloudAiplatformV1beta1ExecuteCodeRequest + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + + class GoogleCloudAiplatformV1beta1ExecuteCodeResponse + class Representation < Google::Apis::Core::JsonRepresentation; end + + include Google::Apis::Core::JsonObjectSupport + end + class GoogleCloudAiplatformV1beta1ExecuteExtensionRequest class Representation < Google::Apis::Core::JsonRepresentation; end @@ -9247,6 +9271,8 @@ class Representation < Google::Apis::Core::JsonRepresentation property :aggregation_metric, as: 'aggregationMetric' property :bleu_metric_value, as: 'bleuMetricValue', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuMetricValue, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuMetricValue::Representation + property :custom_code_execution_result, as: 'customCodeExecutionResult', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionResult, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionResult::Representation + property :exact_match_metric_value, as: 'exactMatchMetricValue', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExactMatchMetricValue, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExactMatchMetricValue::Representation property :pairwise_metric_result, as: 'pairwiseMetricResult', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PairwiseMetricResult, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1PairwiseMetricResult::Representation @@ -10745,6 +10771,20 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudAiplatformV1beta1CustomCodeExecutionResult + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :score, as: 'score' + end + end + + class GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec + # @private + class Representation < Google::Apis::Core::JsonRepresentation + property :evaluation_function, as: 'evaluationFunction' + end + end + class GoogleCloudAiplatformV1beta1CustomJob # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -11841,7 +11881,6 @@ class Representation < Google::Apis::Core::JsonRepresentation property :events, as: 'events', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataEvents::Representation - property :events_text, as: 'eventsText' property :tools, as: 'tools', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EvaluationInstanceAgentDataTools::Representation property :tools_text, as: 'toolsText' @@ -12323,6 +12362,22 @@ class Representation < Google::Apis::Core::JsonRepresentation end end + class GoogleCloudAiplatformV1beta1ExecuteCodeRequest + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :inputs, as: 'inputs', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk::Representation + + end + end + + class GoogleCloudAiplatformV1beta1ExecuteCodeResponse + # @private + class Representation < Google::Apis::Core::JsonRepresentation + collection :outputs, as: 'outputs', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Chunk::Representation + + end + end + class GoogleCloudAiplatformV1beta1ExecuteExtensionRequest # @private class Representation < Google::Apis::Core::JsonRepresentation @@ -15535,6 +15590,7 @@ class Representation < Google::Apis::Core::JsonRepresentation property :fact, as: 'fact' property :name, as: 'name' property :revision_expire_time, as: 'revisionExpireTime' + hash :revision_labels, as: 'revisionLabels' property :revision_ttl, as: 'revisionTtl' hash :scope, as: 'scope' collection :topics, as: 'topics', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryTopicId, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1MemoryTopicId::Representation @@ -15698,6 +15754,8 @@ class Representation < Google::Apis::Core::JsonRepresentation collection :aggregation_metrics, as: 'aggregationMetrics' property :bleu_spec, as: 'bleuSpec', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuSpec, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1BleuSpec::Representation + property :custom_code_execution_spec, as: 'customCodeExecutionSpec', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1CustomCodeExecutionSpec::Representation + property :exact_match_spec, as: 'exactMatchSpec', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExactMatchSpec, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExactMatchSpec::Representation property :llm_based_metric_spec, as: 'llmBasedMetricSpec', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LlmBasedMetricSpec, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1LlmBasedMetricSpec::Representation @@ -18454,6 +18512,8 @@ class Representation < Google::Apis::Core::JsonRepresentation property :rag_files_count, as: 'ragFilesCount' property :rag_vector_db_config, as: 'ragVectorDbConfig', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig::Representation + property :satisfies_pzi, as: 'satisfiesPzi' + property :satisfies_pzs, as: 'satisfiesPzs' property :update_time, as: 'updateTime' property :vector_db_config, as: 'vectorDbConfig', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1RagVectorDbConfig::Representation @@ -19073,10 +19133,13 @@ class Representation < Google::Apis::Core::JsonRepresentation class GoogleCloudAiplatformV1beta1ReasoningEngineSpec # @private class Representation < Google::Apis::Core::JsonRepresentation + hash :agent_card, as: 'agentCard' property :agent_framework, as: 'agentFramework' collection :class_methods, as: 'classMethods' property :deployment_spec, as: 'deploymentSpec', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecDeploymentSpec::Representation + property :effective_identity, as: 'effectiveIdentity' + property :identity_type, as: 'identityType' property :package_spec, as: 'packageSpec', class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec, decorator: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ReasoningEngineSpecPackageSpec::Representation property :service_account, as: 'serviceAccount' @@ -21927,6 +21990,7 @@ class Representation < Google::Apis::Core::JsonRepresentation property :create_time, as: 'createTime' property :display_name, as: 'displayName' property :expire_time, as: 'expireTime' + hash :labels, as: 'labels' property :name, as: 'name' hash :session_state, as: 'sessionState' property :ttl, as: 'ttl' diff --git a/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/service.rb b/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/service.rb index 99f7a5a929e..639ab50173e 100644 --- a/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/service.rb +++ b/generated/google-apis-aiplatform_v1beta1/lib/google/apis/aiplatform_v1beta1/service.rb @@ -9165,6 +9165,51 @@ def wait_pipeline_job_operation(name, timeout: nil, fields: nil, quota_user: nil execute_or_queue_command(command, &block) end + # Gets the access control policy for a resource. Returns an empty policy if the + # resource exists and does not have a policy set. + # @param [String] resource + # REQUIRED: The resource for which the policy is being requested. See [Resource + # names](https://cloud.google.com/apis/design/resource_names) for the + # appropriate value for this field. + # @param [Fixnum] options_requested_policy_version + # Optional. The maximum policy version that will be used to format the policy. + # Valid values are 0, 1, and 3. Requests specifying an invalid value will be + # rejected. Requests for policies with any conditional role bindings must + # specify version 3. Policies with no conditional role bindings may specify any + # valid value or leave the field unset. The policy in the response might use the + # policy version that you specified, or it might use a lower policy version. For + # example, if you specify version 3, but the policy has no conditional role + # bindings, the response uses version 1. To learn which resources support + # conditions in their IAM policies, see the [IAM documentation](https://cloud. + # google.com/iam/help/conditions/resource-policies). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleIamV1Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleIamV1Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_project_location_dataset_iam_policy(resource, options_requested_policy_version: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:getIamPolicy', options) + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy + command.params['resource'] = resource unless resource.nil? + command.query['options.requestedPolicyVersion'] = options_requested_policy_version unless options_requested_policy_version.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Fetches the configs of publisher models. # @param [String] name # Required. The name of the publisher model, in the format of `projects/`project` @@ -9640,8 +9685,8 @@ def get_project_location_rag_engine_config(name, fields: nil, quota_user: nil, o # @param [String] name # The resource that owns the locations collection, if applicable. # @param [Array, String] extra_location_types - # Optional. Unless explicitly documented otherwise, don't use this unsupported - # field which is primarily intended for internal usage. + # Optional. Do not use this field. It is unsupported and is ignored unless + # explicitly documented otherwise. This is primarily for internal usage. # @param [String] filter # A filter to narrow down results to a preferred subset. The filtering language # accepts strings like `"displayName=tokyo"`, and is documented in more detail @@ -11715,6 +11760,84 @@ def search_project_location_dataset_data_items(dataset, annotation_filters: nil, execute_or_queue_command(command, &block) end + # Sets the access control policy on the specified resource. Replaces any + # existing policy. Can return `NOT_FOUND`, `INVALID_ARGUMENT`, and ` + # PERMISSION_DENIED` errors. + # @param [String] resource + # REQUIRED: The resource for which the policy is being specified. See [Resource + # names](https://cloud.google.com/apis/design/resource_names) for the + # appropriate value for this field. + # @param [Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest] google_iam_v1_set_iam_policy_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleIamV1Policy] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleIamV1Policy] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def set_project_location_dataset_iam_policy(resource, google_iam_v1_set_iam_policy_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:setIamPolicy', options) + command.request_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1SetIamPolicyRequest::Representation + command.request_object = google_iam_v1_set_iam_policy_request_object + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleIamV1Policy + command.params['resource'] = resource unless resource.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Returns permissions that a caller has on the specified resource. If the + # resource does not exist, this will return an empty set of permissions, not a ` + # NOT_FOUND` error. Note: This operation is designed to be used for building + # permission-aware UIs and command-line tools, not for authorization checking. + # This operation may "fail open" without warning. + # @param [String] resource + # REQUIRED: The resource for which the policy detail is being requested. See [ + # Resource names](https://cloud.google.com/apis/design/resource_names) for the + # appropriate value for this field. + # @param [Array, String] permissions + # The set of permissions to check for the `resource`. Permissions with wildcards + # (such as `*` or `storage.*`) are not allowed. For more information see [IAM + # Overview](https://cloud.google.com/iam/docs/overview#permissions). + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def test_project_location_dataset_iam_permissions(resource, permissions: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+resource}:testIamPermissions', options) + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleIamV1TestIamPermissionsResponse + command.params['resource'] = resource unless resource.nil? + command.query['permissions'] = permissions unless permissions.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets an AnnotationSpec. # @param [String] name # Required. The name of the AnnotationSpec resource. Format: `projects/`project`/ @@ -32117,6 +32240,40 @@ def delete_project_location_reasoning_engine(name, force: nil, fields: nil, quot execute_or_queue_command(command, &block) end + # Executes code statelessly. + # @param [String] name + # Required. The resource name of the sandbox environment to execute. Format: ` + # projects/`project`/locations/`location`/reasoningEngines/`reasoning_engine`` + # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeRequest] google_cloud_aiplatform_v1beta1_execute_code_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def execute_project_location_reasoning_engine_code(name, google_cloud_aiplatform_v1beta1_execute_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:executeCode', options) + command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeRequest::Representation + command.request_object = google_cloud_aiplatform_v1beta1_execute_code_request_object + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeResponse::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets a reasoning engine. # @param [String] name # Required. The name of the ReasoningEngine resource. Format: `projects/`project` @@ -34067,6 +34224,10 @@ def patch_project_location_reasoning_engine_session(name, google_cloud_aiplatfor # Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. # `timestamp>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 # format) More detail in [AIP-160](https://google.aip.dev/160). + # @param [String] order_by + # Optional. A comma-separated list of fields to order by, sorted in ascending + # order. Use "desc" after a field name for descending. Supported fields: * ` + # timestamp` Example: `timestamp desc`. # @param [Fixnum] page_size # Optional. The maximum number of events to return. The service may return fewer # than this value. If unspecified, at most 100 events will be returned. These @@ -34091,12 +34252,13 @@ def patch_project_location_reasoning_engine_session(name, google_cloud_aiplatfor # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_project_location_reasoning_engine_session_events(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_project_location_reasoning_engine_session_events(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/events', options) command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEventsResponse::Representation command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEventsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil? @@ -39782,6 +39944,40 @@ def delete_reasoning_engine(name, force: nil, fields: nil, quota_user: nil, opti execute_or_queue_command(command, &block) end + # Executes code statelessly. + # @param [String] name + # Required. The resource name of the sandbox environment to execute. Format: ` + # projects/`project`/locations/`location`/reasoningEngines/`reasoning_engine`` + # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeRequest] google_cloud_aiplatform_v1beta1_execute_code_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def execute_reasoning_engine_code(name, google_cloud_aiplatform_v1beta1_execute_code_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:executeCode', options) + command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeRequest::Representation + command.request_object = google_cloud_aiplatform_v1beta1_execute_code_request_object + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeResponse::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteCodeResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Gets a reasoning engine. # @param [String] name # Required. The name of the ReasoningEngine resource. Format: `projects/`project` @@ -41136,6 +41332,185 @@ def wait_reasoning_engine_operation(name, timeout: nil, fields: nil, quota_user: execute_or_queue_command(command, &block) end + # Creates a SandboxEnvironment in a given reasoning engine. + # @param [String] parent + # Required. The resource name of the reasoning engine to create the + # SandboxEnvironment in. Format: `projects/`project`/locations/`location`/ + # reasoningEngines/`reasoning_engine``. + # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironment] google_cloud_aiplatform_v1beta1_sandbox_environment_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def create_reasoning_engine_sandbox_environment(parent, google_cloud_aiplatform_v1beta1_sandbox_environment_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+parent}/sandboxEnvironments', options) + command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironment::Representation + command.request_object = google_cloud_aiplatform_v1beta1_sandbox_environment_object + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation + command.params['parent'] = parent unless parent.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Deletes the specific SandboxEnvironment. + # @param [String] name + # Required. The resource name of the SandboxEnvironment to delete. Format: ` + # projects/`project`/locations/`location`/reasoningEngines/`reasoning_engine`/ + # sandboxEnvironments/`sandbox_environment`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def delete_reasoning_engine_sandbox_environment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:delete, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleLongrunningOperation + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Executes using a sandbox environment. + # @param [String] name + # Required. The resource name of the sandbox environment to execute. Format: ` + # projects/`project`/locations/`location`/reasoningEngines/`reasoning_engine`/ + # sandboxEnvironments/`sandbox_environment`` + # @param [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest] google_cloud_aiplatform_v1beta1_execute_sandbox_environment_request_object + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def execute_reasoning_engine_sandbox_environment(name, google_cloud_aiplatform_v1beta1_execute_sandbox_environment_request_object = nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:post, 'v1beta1/{+name}:execute', options) + command.request_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentRequest::Representation + command.request_object = google_cloud_aiplatform_v1beta1_execute_sandbox_environment_request_object + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ExecuteSandboxEnvironmentResponse + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Gets details of the specific SandboxEnvironment. + # @param [String] name + # Required. The resource name of the sandbox environment. Format: `projects/` + # project`/locations/`location`/reasoningEngines/`reasoning_engine`/ + # sandboxEnvironments/`sandbox_environment`` + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironment] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironment] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def get_reasoning_engine_sandbox_environment(name, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+name}', options) + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironment::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1SandboxEnvironment + command.params['name'] = name unless name.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + + # Lists SandboxEnvironments in a given reasoning engine. + # @param [String] parent + # Required. The resource name of the reasoning engine to list sandbox + # environments from. Format: `projects/`project`/locations/`location`/ + # reasoningEngines/`reasoning_engine`` + # @param [String] filter + # Optional. The standard list filter. More detail in [AIP-160](https://google. + # aip.dev/160). + # @param [Fixnum] page_size + # Optional. The maximum number of SandboxEnvironments to return. The service may + # return fewer than this value. If unspecified, at most 100 SandboxEnvironments + # will be returned. + # @param [String] page_token + # Optional. The standard list page token, received from a previous ` + # ListSandboxEnvironments` call. Provide this to retrieve the subsequent page. + # @param [String] fields + # Selector specifying which fields to include in a partial response. + # @param [String] quota_user + # Available to use for quota purposes for server-side applications. Can be any + # arbitrary string assigned to a user, but should not exceed 40 characters. + # @param [Google::Apis::RequestOptions] options + # Request-specific options + # + # @yield [result, err] Result & error if block supplied + # @yieldparam result [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse] parsed result object + # @yieldparam err [StandardError] error object if request failed + # + # @return [Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse] + # + # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried + # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification + # @raise [Google::Apis::AuthorizationError] Authorization is required + def list_reasoning_engine_sandbox_environments(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + command = make_simple_command(:get, 'v1beta1/{+parent}/sandboxEnvironments', options) + command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse::Representation + command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListSandboxEnvironmentsResponse + command.params['parent'] = parent unless parent.nil? + command.query['filter'] = filter unless filter.nil? + command.query['pageSize'] = page_size unless page_size.nil? + command.query['pageToken'] = page_token unless page_token.nil? + command.query['fields'] = fields unless fields.nil? + command.query['quotaUser'] = quota_user unless quota_user.nil? + execute_or_queue_command(command, &block) + end + # Starts asynchronous cancellation on a long-running operation. The server makes # a best effort to cancel the operation, but success is not guaranteed. If the # server doesn't support this method, it returns `google.rpc.Code.UNIMPLEMENTED`. @@ -41553,6 +41928,10 @@ def patch_reasoning_engine_session(name, google_cloud_aiplatform_v1beta1_session # Optional. The standard list filter. Supported fields: * `timestamp` range (i.e. # `timestamp>="2025-01-31T11:30:00-04:00"` where the timestamp is in RFC 3339 # format) More detail in [AIP-160](https://google.aip.dev/160). + # @param [String] order_by + # Optional. A comma-separated list of fields to order by, sorted in ascending + # order. Use "desc" after a field name for descending. Supported fields: * ` + # timestamp` Example: `timestamp desc`. # @param [Fixnum] page_size # Optional. The maximum number of events to return. The service may return fewer # than this value. If unspecified, at most 100 events will be returned. These @@ -41577,12 +41956,13 @@ def patch_reasoning_engine_session(name, google_cloud_aiplatform_v1beta1_session # @raise [Google::Apis::ServerError] An error occurred on the server and the request can be retried # @raise [Google::Apis::ClientError] The request is invalid and should not be retried without modification # @raise [Google::Apis::AuthorizationError] Authorization is required - def list_reasoning_engine_session_events(parent, filter: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) + def list_reasoning_engine_session_events(parent, filter: nil, order_by: nil, page_size: nil, page_token: nil, fields: nil, quota_user: nil, options: nil, &block) command = make_simple_command(:get, 'v1beta1/{+parent}/events', options) command.response_representation = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEventsResponse::Representation command.response_class = Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1ListEventsResponse command.params['parent'] = parent unless parent.nil? command.query['filter'] = filter unless filter.nil? + command.query['orderBy'] = order_by unless order_by.nil? command.query['pageSize'] = page_size unless page_size.nil? command.query['pageToken'] = page_token unless page_token.nil? command.query['fields'] = fields unless fields.nil?