Class: Google::Cloud::AIPlatform::V1::ReasoningEngineSpec

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/cloud/aiplatform/v1/reasoning_engine.rb

Overview

ReasoningEngine configurations

Defined Under Namespace

Classes: DeploymentSpec, PackageSpec

Instance Attribute Summary collapse

Instance Attribute Details

#agent_framework ⇒ ::String

Returns Optional. The OSS agent framework used to develop the agent. Currently supported values: "langchain", "langgraph", "ag2", "custom".

Returns:

  • (::String) —

    Optional. The OSS agent framework used to develop the agent. Currently supported values: "langchain", "langgraph", "ag2", "custom".



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/cloud/aiplatform/v1/reasoning_engine.rb', line 49

class ReasoningEngineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User provided package spec like pickled object and package requirements.
  # @!attribute [rw] pickle_object_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the pickled python object.
  # @!attribute [rw] dependency_files_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the dependency files in tar.gz format.
  # @!attribute [rw] requirements_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the `requirements.txt` file
  # @!attribute [rw] python_version
  #   @return [::String]
  #     Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11.
  #     If not specified, default value is 3.10.
  class PackageSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification of a Reasoning Engine deployment.
  # @!attribute [rw] env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::EnvVar>]
  #     Optional. Environment variables to be set with the Reasoning Engine
  #     deployment. The environment variables can be updated through the
  #     UpdateReasoningEngine API.
  # @!attribute [rw] secret_env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::SecretEnvVar>]
  #     Optional. Environment variables where the value is a secret in Cloud
  #     Secret Manager.
  #     To use this feature, add 'Secret Manager Secret Accessor' role
  #     (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine
  #     Service Agent.
  class DeploymentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#class_methods ⇒ ::Array<::Google::Protobuf::Struct>

Returns Optional. Declarations for object class methods in OpenAPI specification format.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/cloud/aiplatform/v1/reasoning_engine.rb', line 49

class ReasoningEngineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User provided package spec like pickled object and package requirements.
  # @!attribute [rw] pickle_object_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the pickled python object.
  # @!attribute [rw] dependency_files_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the dependency files in tar.gz format.
  # @!attribute [rw] requirements_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the `requirements.txt` file
  # @!attribute [rw] python_version
  #   @return [::String]
  #     Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11.
  #     If not specified, default value is 3.10.
  class PackageSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification of a Reasoning Engine deployment.
  # @!attribute [rw] env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::EnvVar>]
  #     Optional. Environment variables to be set with the Reasoning Engine
  #     deployment. The environment variables can be updated through the
  #     UpdateReasoningEngine API.
  # @!attribute [rw] secret_env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::SecretEnvVar>]
  #     Optional. Environment variables where the value is a secret in Cloud
  #     Secret Manager.
  #     To use this feature, add 'Secret Manager Secret Accessor' role
  #     (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine
  #     Service Agent.
  class DeploymentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#deployment_spec ⇒ ::Google::Cloud::AIPlatform::V1::ReasoningEngineSpec::DeploymentSpec

Returns Optional. The specification of a Reasoning Engine deployment.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/cloud/aiplatform/v1/reasoning_engine.rb', line 49

class ReasoningEngineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User provided package spec like pickled object and package requirements.
  # @!attribute [rw] pickle_object_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the pickled python object.
  # @!attribute [rw] dependency_files_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the dependency files in tar.gz format.
  # @!attribute [rw] requirements_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the `requirements.txt` file
  # @!attribute [rw] python_version
  #   @return [::String]
  #     Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11.
  #     If not specified, default value is 3.10.
  class PackageSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification of a Reasoning Engine deployment.
  # @!attribute [rw] env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::EnvVar>]
  #     Optional. Environment variables to be set with the Reasoning Engine
  #     deployment. The environment variables can be updated through the
  #     UpdateReasoningEngine API.
  # @!attribute [rw] secret_env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::SecretEnvVar>]
  #     Optional. Environment variables where the value is a secret in Cloud
  #     Secret Manager.
  #     To use this feature, add 'Secret Manager Secret Accessor' role
  #     (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine
  #     Service Agent.
  class DeploymentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#package_spec ⇒ ::Google::Cloud::AIPlatform::V1::ReasoningEngineSpec::PackageSpec

Returns Optional. User provided package spec of the ReasoningEngine. Ignored when users directly specify a deployment image through deployment_spec.first_party_image_override, but keeping the field_behavior to avoid introducing breaking changes.

Returns:



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/cloud/aiplatform/v1/reasoning_engine.rb', line 49

class ReasoningEngineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User provided package spec like pickled object and package requirements.
  # @!attribute [rw] pickle_object_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the pickled python object.
  # @!attribute [rw] dependency_files_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the dependency files in tar.gz format.
  # @!attribute [rw] requirements_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the `requirements.txt` file
  # @!attribute [rw] python_version
  #   @return [::String]
  #     Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11.
  #     If not specified, default value is 3.10.
  class PackageSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification of a Reasoning Engine deployment.
  # @!attribute [rw] env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::EnvVar>]
  #     Optional. Environment variables to be set with the Reasoning Engine
  #     deployment. The environment variables can be updated through the
  #     UpdateReasoningEngine API.
  # @!attribute [rw] secret_env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::SecretEnvVar>]
  #     Optional. Environment variables where the value is a secret in Cloud
  #     Secret Manager.
  #     To use this feature, add 'Secret Manager Secret Accessor' role
  #     (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine
  #     Service Agent.
  class DeploymentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end

#service_account ⇒ ::String

Returns Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.

Returns:

  • (::String) —

    Optional. The service account that the Reasoning Engine artifact runs as. It should have "roles/storage.objectViewer" for reading the user project's Cloud Storage and "roles/aiplatform.user" for using Vertex extensions. If not specified, the Vertex AI Reasoning Engine Service Agent in the project will be used.



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# File 'proto_docs/google/cloud/aiplatform/v1/reasoning_engine.rb', line 49

class ReasoningEngineSpec
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods

  # User provided package spec like pickled object and package requirements.
  # @!attribute [rw] pickle_object_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the pickled python object.
  # @!attribute [rw] dependency_files_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the dependency files in tar.gz format.
  # @!attribute [rw] requirements_gcs_uri
  #   @return [::String]
  #     Optional. The Cloud Storage URI of the `requirements.txt` file
  # @!attribute [rw] python_version
  #   @return [::String]
  #     Optional. The Python version. Currently support 3.8, 3.9, 3.10, 3.11.
  #     If not specified, default value is 3.10.
  class PackageSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # The specification of a Reasoning Engine deployment.
  # @!attribute [rw] env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::EnvVar>]
  #     Optional. Environment variables to be set with the Reasoning Engine
  #     deployment. The environment variables can be updated through the
  #     UpdateReasoningEngine API.
  # @!attribute [rw] secret_env
  #   @return [::Array<::Google::Cloud::AIPlatform::V1::SecretEnvVar>]
  #     Optional. Environment variables where the value is a secret in Cloud
  #     Secret Manager.
  #     To use this feature, add 'Secret Manager Secret Accessor' role
  #     (roles/secretmanager.secretAccessor) to AI Platform Reasoning Engine
  #     Service Agent.
  class DeploymentSpec
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end