google-cloud-ai_platform-v1 0.58.0 → 0.59.0

data/proto_docs/google/cloud/aiplatform/v1/api_auth.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+# Auto-generated by gapic-generator-ruby. DO NOT EDIT!
+
+
+module Google
+  module Cloud
+    module AIPlatform
+      module V1
+        # The generic reusable api auth config.
+        # @!attribute [rw] api_key_config
+        #   @return [::Google::Cloud::AIPlatform::V1::ApiAuth::ApiKeyConfig]
+        #     The API secret.
+        class ApiAuth
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The API secret.
+          # @!attribute [rw] api_key_secret_version
+          #   @return [::String]
+          #     Required. The SecretManager secret version resource name storing API key.
+          #     e.g. projects/\\{project}/secrets/\\{secret}/versions/\\{version}
+          class ApiKeyConfig
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+      end
+    end
+  end
+end

data/proto_docs/google/cloud/aiplatform/v1/endpoint.rb

@@ -135,6 +135,9 @@ module Google
         #     dedicated_endpoint_enabled is true.
         #     Format:
         #     `https://{endpoint_id}.{region}-{project_number}.prediction.vertexai.goog`.
+        # @!attribute [rw] client_connection_config
+        #   @return [::Google::Cloud::AIPlatform::V1::ClientConnectionConfig]
+        #     Configurations that are applied to the endpoint for online prediction.
         # @!attribute [r] satisfies_pzs
         #   @return [::Boolean]
         #     Output only. Reserved for future use.
@@ -269,6 +272,9 @@ module Google
         # @!attribute [rw] faster_deployment_config
         #   @return [::Google::Cloud::AIPlatform::V1::FasterDeploymentConfig]
         #     Configuration for faster model deployment.
+        # @!attribute [r] status
+        #   @return [::Google::Cloud::AIPlatform::V1::DeployedModel::Status]
+        #     Output only. Runtime status of the deployed model.
         # @!attribute [rw] system_labels
         #   @return [::Google::Protobuf::Map{::String => ::String}]
         #     System labels to apply to Model Garden deployments.
@@ -277,6 +283,21 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
 
+          # Runtime status of the deployed model.
+          # @!attribute [r] message
+          #   @return [::String]
+          #     Output only. The latest deployed model's status message (if any).
+          # @!attribute [r] last_update_time
+          #   @return [::Google::Protobuf::Timestamp]
+          #     Output only. The time at which the status was last updated.
+          # @!attribute [r] available_replica_count
+          #   @return [::Integer]
+          #     Output only. The number of available replicas of the deployed model.
+          class Status
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # @!attribute [rw] key
           #   @return [::String]
           # @!attribute [rw] value
@@ -339,6 +360,15 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # Configurations (e.g. inference timeout) that are applied on your endpoints.
+        # @!attribute [rw] inference_timeout
+        #   @return [::Google::Protobuf::Duration]
+        #     Customizable online prediction request timeout.
+        class ClientConnectionConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
       end
     end
   end

data/proto_docs/google/cloud/aiplatform/v1/endpoint_service.rb

@@ -160,6 +160,28 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Request message for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint_long_running EndpointService.UpdateEndpointLongRunning}.
+        # @!attribute [rw] endpoint
+        #   @return [::Google::Cloud::AIPlatform::V1::Endpoint]
+        #     Required. The Endpoint which replaces the resource on the server. Currently
+        #     we only support updating the `client_connection_config` field, all the
+        #     other fields' update will be blocked.
+        class UpdateEndpointLongRunningRequest
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # Runtime operation information for
+        # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#update_endpoint_long_running EndpointService.UpdateEndpointLongRunning}.
+        # @!attribute [rw] generic_metadata
+        #   @return [::Google::Cloud::AIPlatform::V1::GenericOperationMetadata]
+        #     The operation generic information.
+        class UpdateEndpointOperationMetadata
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
         # Request message for
         # {::Google::Cloud::AIPlatform::V1::EndpointService::Client#delete_endpoint EndpointService.DeleteEndpoint}.
         # @!attribute [rw] name

data/proto_docs/google/cloud/aiplatform/v1/io.rb

@@ -129,6 +129,164 @@ module Google
           include ::Google::Protobuf::MessageExts
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
+
+        # The Google Drive location for the input content.
+        # @!attribute [rw] resource_ids
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::GoogleDriveSource::ResourceId>]
+        #     Required. Google Drive resource IDs.
+        class GoogleDriveSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The type and ID of the Google Drive resource.
+          # @!attribute [rw] resource_type
+          #   @return [::Google::Cloud::AIPlatform::V1::GoogleDriveSource::ResourceId::ResourceType]
+          #     Required. The type of the Google Drive resource.
+          # @!attribute [rw] resource_id
+          #   @return [::String]
+          #     Required. The ID of the Google Drive resource.
+          class ResourceId
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # The type of the Google Drive resource.
+            module ResourceType
+              # Unspecified resource type.
+              RESOURCE_TYPE_UNSPECIFIED = 0
+
+              # File resource type.
+              RESOURCE_TYPE_FILE = 1
+
+              # Folder resource type.
+              RESOURCE_TYPE_FOLDER = 2
+            end
+          end
+        end
+
+        # The input content is encapsulated and uploaded in the request.
+        class DirectUploadSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+        end
+
+        # The Slack source for the ImportRagFilesRequest.
+        # @!attribute [rw] channels
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::SlackSource::SlackChannels>]
+        #     Required. The Slack channels.
+        class SlackSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # SlackChannels contains the Slack channels and corresponding access token.
+          # @!attribute [rw] channels
+          #   @return [::Array<::Google::Cloud::AIPlatform::V1::SlackSource::SlackChannels::SlackChannel>]
+          #     Required. The Slack channel IDs.
+          # @!attribute [rw] api_key_config
+          #   @return [::Google::Cloud::AIPlatform::V1::ApiAuth::ApiKeyConfig]
+          #     Required. The SecretManager secret version resource name (e.g.
+          #     projects/\\{project}/secrets/\\{secret}/versions/\\{version}) storing the
+          #     Slack channel access token that has access to the slack channel IDs.
+          #     See: https://api.slack.com/tutorials/tracks/getting-a-token.
+          class SlackChannels
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+
+            # SlackChannel contains the Slack channel ID and the time range to import.
+            # @!attribute [rw] channel_id
+            #   @return [::String]
+            #     Required. The Slack channel ID.
+            # @!attribute [rw] start_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Optional. The starting timestamp for messages to import.
+            # @!attribute [rw] end_time
+            #   @return [::Google::Protobuf::Timestamp]
+            #     Optional. The ending timestamp for messages to import.
+            class SlackChannel
+              include ::Google::Protobuf::MessageExts
+              extend ::Google::Protobuf::MessageExts::ClassMethods
+            end
+          end
+        end
+
+        # The Jira source for the ImportRagFilesRequest.
+        # @!attribute [rw] jira_queries
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::JiraSource::JiraQueries>]
+        #     Required. The Jira queries.
+        class JiraSource
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # JiraQueries contains the Jira queries and corresponding authentication.
+          # @!attribute [rw] projects
+          #   @return [::Array<::String>]
+          #     A list of Jira projects to import in their entirety.
+          # @!attribute [rw] custom_queries
+          #   @return [::Array<::String>]
+          #     A list of custom Jira queries to import. For information about JQL (Jira
+          #     Query Language), see
+          #     https://support.atlassian.com/jira-service-management-cloud/docs/use-advanced-search-with-jira-query-language-jql/
+          # @!attribute [rw] email
+          #   @return [::String]
+          #     Required. The Jira email address.
+          # @!attribute [rw] server_uri
+          #   @return [::String]
+          #     Required. The Jira server URI.
+          # @!attribute [rw] api_key_config
+          #   @return [::Google::Cloud::AIPlatform::V1::ApiAuth::ApiKeyConfig]
+          #     Required. The SecretManager secret version resource name (e.g.
+          #     projects/\\{project}/secrets/\\{secret}/versions/\\{version}) storing the
+          #     Jira API key. See [Manage API tokens for your Atlassian
+          #     account](https://support.atlassian.com/atlassian-account/docs/manage-api-tokens-for-your-atlassian-account/).
+          class JiraQueries
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
+        # The SharePointSources to pass to ImportRagFiles.
+        # @!attribute [rw] share_point_sources
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::SharePointSources::SharePointSource>]
+        #     The SharePoint sources.
+        class SharePointSources
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # An individual SharePointSource.
+          # @!attribute [rw] sharepoint_folder_path
+          #   @return [::String]
+          #     The path of the SharePoint folder to download from.
+          # @!attribute [rw] sharepoint_folder_id
+          #   @return [::String]
+          #     The ID of the SharePoint folder to download from.
+          # @!attribute [rw] drive_name
+          #   @return [::String]
+          #     The name of the drive to download from.
+          # @!attribute [rw] drive_id
+          #   @return [::String]
+          #     The ID of the drive to download from.
+          # @!attribute [rw] client_id
+          #   @return [::String]
+          #     The Application ID for the app registered in Microsoft Azure Portal.
+          #     The application must also be configured with MS Graph permissions
+          #     "Files.ReadAll", "Sites.ReadAll" and BrowserSiteLists.Read.All.
+          # @!attribute [rw] client_secret
+          #   @return [::Google::Cloud::AIPlatform::V1::ApiAuth::ApiKeyConfig]
+          #     The application secret for the app registered in Azure.
+          # @!attribute [rw] tenant_id
+          #   @return [::String]
+          #     Unique identifier of the Azure Active Directory Instance.
+          # @!attribute [rw] sharepoint_site_name
+          #   @return [::String]
+          #     The name of the SharePoint site to download from. This can be the site
+          #     name or the site id.
+          # @!attribute [r] file_id
+          #   @return [::String]
+          #     Output only. The SharePoint file id. Output only.
+          class SharePointSource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
       end
     end
   end

data/proto_docs/google/cloud/aiplatform/v1/machine_resources.rb

@@ -89,6 +89,14 @@ module Google
         #     quotas. Specifically, you will be charged for (max_replica_count *
         #     number of cores in the selected machine type) and (max_replica_count *
         #     number of GPUs per replica in the selected machine type).
+        # @!attribute [rw] required_replica_count
+        #   @return [::Integer]
+        #     Optional. Number of required available replicas for the deployment to
+        #     succeed. This field is only needed when partial model deployment/mutation
+        #     is desired. If set, the model deploy/mutate operation will succeed once
+        #     available_replica_count reaches required_replica_count, and the rest of
+        #     the replicas will be retried. If not set, the default
+        #     required_replica_count will be min_replica_count.
         # @!attribute [rw] autoscaling_metric_specs
         #   @return [::Array<::Google::Cloud::AIPlatform::V1::AutoscalingMetricSpec>]
         #     Immutable. The metric specifications that overrides a resource

data/proto_docs/google/cloud/aiplatform/v1/notebook_execution_job.rb

@@ -35,6 +35,9 @@ module Google
         # @!attribute [rw] notebook_runtime_template_resource_name
         #   @return [::String]
         #     The NotebookRuntimeTemplate to source compute configuration from.
+        # @!attribute [rw] custom_environment_spec
+        #   @return [::Google::Cloud::AIPlatform::V1::NotebookExecutionJob::CustomEnvironmentSpec]
+        #     The custom compute configuration for an execution job.
         # @!attribute [rw] gcs_output_uri
         #   @return [::String]
         #     The Cloud Storage location to upload the result to. Format:
@@ -134,6 +137,21 @@ module Google
             extend ::Google::Protobuf::MessageExts::ClassMethods
           end
 
+          # Compute configuration to use for an execution job.
+          # @!attribute [rw] machine_spec
+          #   @return [::Google::Cloud::AIPlatform::V1::MachineSpec]
+          #     The specification of a single machine for the execution job.
+          # @!attribute [rw] persistent_disk_spec
+          #   @return [::Google::Cloud::AIPlatform::V1::PersistentDiskSpec]
+          #     The specification of a persistent disk to attach for the execution job.
+          # @!attribute [rw] network_spec
+          #   @return [::Google::Cloud::AIPlatform::V1::NetworkSpec]
+          #     The network configuration to use for the execution job.
+          class CustomEnvironmentSpec
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+
           # @!attribute [rw] key
           #   @return [::String]
           # @!attribute [rw] value

data/proto_docs/google/cloud/aiplatform/v1/tool.rb

@@ -133,6 +133,10 @@ module Google
         # @!attribute [rw] vertex_ai_search
         #   @return [::Google::Cloud::AIPlatform::V1::VertexAISearch]
         #     Set to use data source powered by Vertex AI Search.
+        # @!attribute [rw] vertex_rag_store
+        #   @return [::Google::Cloud::AIPlatform::V1::VertexRagStore]
+        #     Set to use data source powered by Vertex RAG store.
+        #     User data is uploaded via the VertexRagDataService.
         # @!attribute [rw] disable_attribution
         #   @deprecated This field is deprecated and may be removed in the next major version update.
         #   @return [::Boolean]
@@ -142,6 +146,45 @@ module Google
           extend ::Google::Protobuf::MessageExts::ClassMethods
         end
 
+        # Retrieve from Vertex RAG Store for grounding.
+        # @!attribute [rw] rag_resources
+        #   @return [::Array<::Google::Cloud::AIPlatform::V1::VertexRagStore::RagResource>]
+        #     Optional. The representation of the rag source. It can be used to specify
+        #     corpus only or ragfiles. Currently only support one corpus or multiple
+        #     files from one corpus. In the future we may open up multiple corpora
+        #     support.
+        # @!attribute [rw] similarity_top_k
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Integer]
+        #     Optional. Number of top k results to return from the selected corpora.
+        # @!attribute [rw] vector_distance_threshold
+        #   @deprecated This field is deprecated and may be removed in the next major version update.
+        #   @return [::Float]
+        #     Optional. Only return results with vector distance smaller than the
+        #     threshold.
+        # @!attribute [rw] rag_retrieval_config
+        #   @return [::Google::Cloud::AIPlatform::V1::RagRetrievalConfig]
+        #     Optional. The retrieval config for the Rag query.
+        class VertexRagStore
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # The definition of the Rag resource.
+          # @!attribute [rw] rag_corpus
+          #   @return [::String]
+          #     Optional. RagCorpora resource name.
+          #     Format:
+          #     `projects/{project}/locations/{location}/ragCorpora/{rag_corpus}`
+          # @!attribute [rw] rag_file_ids
+          #   @return [::Array<::String>]
+          #     Optional. rag_file_id. The files should be in the same rag_corpus set in
+          #     rag_corpus field.
+          class RagResource
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
+
         # Retrieve from Vertex AI Search datastore for grounding.
         # See https://cloud.google.com/products/agent-builder
         # @!attribute [rw] datastore
@@ -227,6 +270,35 @@ module Google
             NONE = 3
           end
         end
+
+        # Specifies the context retrieval config.
+        # @!attribute [rw] top_k
+        #   @return [::Integer]
+        #     Optional. The number of contexts to retrieve.
+        # @!attribute [rw] filter
+        #   @return [::Google::Cloud::AIPlatform::V1::RagRetrievalConfig::Filter]
+        #     Optional. Config for filters.
+        class RagRetrievalConfig
+          include ::Google::Protobuf::MessageExts
+          extend ::Google::Protobuf::MessageExts::ClassMethods
+
+          # Config for filters.
+          # @!attribute [rw] vector_distance_threshold
+          #   @return [::Float]
+          #     Optional. Only returns contexts with vector distance smaller than the
+          #     threshold.
+          # @!attribute [rw] vector_similarity_threshold
+          #   @return [::Float]
+          #     Optional. Only returns contexts with vector similarity larger than the
+          #     threshold.
+          # @!attribute [rw] metadata_filter
+          #   @return [::String]
+          #     Optional. String for metadata filtering.
+          class Filter
+            include ::Google::Protobuf::MessageExts
+            extend ::Google::Protobuf::MessageExts::ClassMethods
+          end
+        end
       end
     end
   end