Class: Google::Cloud::AIPlatform::V1::Tool

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

Overview

Tool details that the model may use to generate response.

A Tool is a piece of code that enables the system to interact with external systems to perform an action, or set of actions, outside of knowledge and scope of the model. A Tool object should contain exactly one type of Tool (e.g FunctionDeclaration, Retrieval or GoogleSearchRetrieval).

Defined Under Namespace

Classes: CodeExecution, ComputerUse, GoogleSearch

Instance Attribute Summary collapse

Instance Attribute Details

#code_execution ⇒ ::Google::Cloud::AIPlatform::V1::Tool::CodeExecution

Returns Optional. CodeExecution tool type. Enables the model to execute code as part of generation.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 72

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

  # GoogleSearch tool type.
  # Tool to support Google Search in Model. Powered by Google.
  class GoogleSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool that executes code generated by the model, and automatically returns
  # the result to the model.
  #
  # See also [ExecutableCode]and [CodeExecutionResult] which are input and
  # output to this tool.
  class CodeExecution
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool to support computer use.
  # @!attribute [rw] environment
  #   @return [::Google::Cloud::AIPlatform::V1::Tool::ComputerUse::Environment]
  #     Required. The environment being operated.
  class ComputerUse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the environment being operated, such as a web browser.
    module Environment
      # Defaults to browser.
      ENVIRONMENT_UNSPECIFIED = 0

      # Operates in a web browser.
      ENVIRONMENT_BROWSER = 1
    end
  end
end

#computer_use ⇒ ::Google::Cloud::AIPlatform::V1::Tool::ComputerUse

Returns Optional. Tool to support the model interacting directly with the computer. If enabled, it automatically populates computer-use specific Function Declarations.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 72

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

  # GoogleSearch tool type.
  # Tool to support Google Search in Model. Powered by Google.
  class GoogleSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool that executes code generated by the model, and automatically returns
  # the result to the model.
  #
  # See also [ExecutableCode]and [CodeExecutionResult] which are input and
  # output to this tool.
  class CodeExecution
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool to support computer use.
  # @!attribute [rw] environment
  #   @return [::Google::Cloud::AIPlatform::V1::Tool::ComputerUse::Environment]
  #     Required. The environment being operated.
  class ComputerUse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the environment being operated, such as a web browser.
    module Environment
      # Defaults to browser.
      ENVIRONMENT_UNSPECIFIED = 0

      # Operates in a web browser.
      ENVIRONMENT_BROWSER = 1
    end
  end
end

#enterprise_web_search ⇒ ::Google::Cloud::AIPlatform::V1::EnterpriseWebSearch

Returns Optional. Tool to support searching public web data, powered by Vertex AI Search and Sec4 compliance.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 72

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

  # GoogleSearch tool type.
  # Tool to support Google Search in Model. Powered by Google.
  class GoogleSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool that executes code generated by the model, and automatically returns
  # the result to the model.
  #
  # See also [ExecutableCode]and [CodeExecutionResult] which are input and
  # output to this tool.
  class CodeExecution
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool to support computer use.
  # @!attribute [rw] environment
  #   @return [::Google::Cloud::AIPlatform::V1::Tool::ComputerUse::Environment]
  #     Required. The environment being operated.
  class ComputerUse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the environment being operated, such as a web browser.
    module Environment
      # Defaults to browser.
      ENVIRONMENT_UNSPECIFIED = 0

      # Operates in a web browser.
      ENVIRONMENT_BROWSER = 1
    end
  end
end

#function_declarations ⇒ ::Array<::Google::Cloud::AIPlatform::V1::FunctionDeclaration>

Returns Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.

Returns:

  • (::Array<::Google::Cloud::AIPlatform::V1::FunctionDeclaration>) —

    Optional. Function tool type. One or more function declarations to be passed to the model along with the current user query. Model may decide to call a subset of these functions by populating FunctionCall in the response. User should provide a FunctionResponse for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 128 function declarations can be provided.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 72

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

  # GoogleSearch tool type.
  # Tool to support Google Search in Model. Powered by Google.
  class GoogleSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool that executes code generated by the model, and automatically returns
  # the result to the model.
  #
  # See also [ExecutableCode]and [CodeExecutionResult] which are input and
  # output to this tool.
  class CodeExecution
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool to support computer use.
  # @!attribute [rw] environment
  #   @return [::Google::Cloud::AIPlatform::V1::Tool::ComputerUse::Environment]
  #     Required. The environment being operated.
  class ComputerUse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the environment being operated, such as a web browser.
    module Environment
      # Defaults to browser.
      ENVIRONMENT_UNSPECIFIED = 0

      # Operates in a web browser.
      ENVIRONMENT_BROWSER = 1
    end
  end
end

#google_search ⇒ ::Google::Cloud::AIPlatform::V1::Tool::GoogleSearch

Returns Optional. GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 72

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

  # GoogleSearch tool type.
  # Tool to support Google Search in Model. Powered by Google.
  class GoogleSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool that executes code generated by the model, and automatically returns
  # the result to the model.
  #
  # See also [ExecutableCode]and [CodeExecutionResult] which are input and
  # output to this tool.
  class CodeExecution
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool to support computer use.
  # @!attribute [rw] environment
  #   @return [::Google::Cloud::AIPlatform::V1::Tool::ComputerUse::Environment]
  #     Required. The environment being operated.
  class ComputerUse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the environment being operated, such as a web browser.
    module Environment
      # Defaults to browser.
      ENVIRONMENT_UNSPECIFIED = 0

      # Operates in a web browser.
      ENVIRONMENT_BROWSER = 1
    end
  end
end

#google_search_retrieval ⇒ ::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval

Returns Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 72

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

  # GoogleSearch tool type.
  # Tool to support Google Search in Model. Powered by Google.
  class GoogleSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool that executes code generated by the model, and automatically returns
  # the result to the model.
  #
  # See also [ExecutableCode]and [CodeExecutionResult] which are input and
  # output to this tool.
  class CodeExecution
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool to support computer use.
  # @!attribute [rw] environment
  #   @return [::Google::Cloud::AIPlatform::V1::Tool::ComputerUse::Environment]
  #     Required. The environment being operated.
  class ComputerUse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the environment being operated, such as a web browser.
    module Environment
      # Defaults to browser.
      ENVIRONMENT_UNSPECIFIED = 0

      # Operates in a web browser.
      ENVIRONMENT_BROWSER = 1
    end
  end
end

#retrieval ⇒ ::Google::Cloud::AIPlatform::V1::Retrieval

Returns Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.

Returns:

  • (::Google::Cloud::AIPlatform::V1::Retrieval) —

    Optional. Retrieval tool type. System will always execute the provided retrieval tool(s) to get external knowledge to answer the prompt. Retrieval results are presented to the model for generation.



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 72

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

  # GoogleSearch tool type.
  # Tool to support Google Search in Model. Powered by Google.
  class GoogleSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool that executes code generated by the model, and automatically returns
  # the result to the model.
  #
  # See also [ExecutableCode]and [CodeExecutionResult] which are input and
  # output to this tool.
  class CodeExecution
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool to support computer use.
  # @!attribute [rw] environment
  #   @return [::Google::Cloud::AIPlatform::V1::Tool::ComputerUse::Environment]
  #     Required. The environment being operated.
  class ComputerUse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the environment being operated, such as a web browser.
    module Environment
      # Defaults to browser.
      ENVIRONMENT_UNSPECIFIED = 0

      # Operates in a web browser.
      ENVIRONMENT_BROWSER = 1
    end
  end
end

#url_context ⇒ ::Google::Cloud::AIPlatform::V1::UrlContext

Returns Optional. Tool to support URL context retrieval.

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
 
# File 'proto_docs/google/cloud/aiplatform/v1/tool.rb', line 72

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

  # GoogleSearch tool type.
  # Tool to support Google Search in Model. Powered by Google.
  class GoogleSearch
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool that executes code generated by the model, and automatically returns
  # the result to the model.
  #
  # See also [ExecutableCode]and [CodeExecutionResult] which are input and
  # output to this tool.
  class CodeExecution
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end

  # Tool to support computer use.
  # @!attribute [rw] environment
  #   @return [::Google::Cloud::AIPlatform::V1::Tool::ComputerUse::Environment]
  #     Required. The environment being operated.
  class ComputerUse
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods

    # Represents the environment being operated, such as a web browser.
    module Environment
      # Defaults to browser.
      ENVIRONMENT_UNSPECIFIED = 0

      # Operates in a web browser.
      ENVIRONMENT_BROWSER = 1
    end
  end
end