Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Tool

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1/classes.rb,
lib/google/apis/aiplatform_v1/representations.rb,
lib/google/apis/aiplatform_v1/representations.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).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1Tool

Returns a new instance of GoogleCloudAiplatformV1Tool.



43714
43715
43716
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43714

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#code_execution ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolCodeExecution

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. Corresponds to the JSON property codeExecution

Returns:



43659
43660
43661
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43659

def code_execution
  @code_execution
end

#computer_use ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolComputerUse

Tool to support computer use. Corresponds to the JSON property computerUse

Returns:



43664
43665
43666
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43664

def computer_use
  @computer_use
end

#enterprise_web_search ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EnterpriseWebSearch

Tool to search public web data, powered by Vertex AI Search and Sec4 compliance. Corresponds to the JSON property enterpriseWebSearch

Returns:



43670
43671
43672
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43670

def enterprise_web_search
  @enterprise_web_search
end

#function_declarations ⇒ Array<Google::Apis::AiplatformV1::GoogleCloudAiplatformV1FunctionDeclaration>

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 512 function declarations can be provided. Corresponds to the JSON property functionDeclarations

Returns:



43680
43681
43682
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43680

def function_declarations
  @function_declarations
end

#google_maps ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GoogleMaps

Tool to retrieve public maps data for grounding, powered by Google. Corresponds to the JSON property googleMaps

Returns:



43685
43686
43687
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43685

def google_maps
  @google_maps
end

#google_search ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolGoogleSearch

GoogleSearch tool type. Tool to support Google Search in Model. Powered by Google. Corresponds to the JSON property googleSearch

Returns:



43691
43692
43693
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43691

def google_search
  @google_search
end

#google_search_retrieval ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GoogleSearchRetrieval

Tool to retrieve public web data for grounding, powered by Google. Corresponds to the JSON property googleSearchRetrieval

Returns:



43696
43697
43698
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43696

def google_search_retrieval
  @google_search_retrieval
end

#parallel_ai_search ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1ToolParallelAiSearch

ParallelAiSearch tool type. A tool that uses the Parallel.ai search engine for grounding. Corresponds to the JSON property parallelAiSearch

Returns:



43702
43703
43704
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43702

def parallel_ai_search
  @parallel_ai_search
end

#retrieval ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Retrieval

Defines a retrieval tool that model can call to access external knowledge. Corresponds to the JSON property retrieval

Returns:



43707
43708
43709
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43707

def retrieval
  @retrieval
end

#url_context ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1UrlContext

Tool to support URL context. Corresponds to the JSON property urlContext

Returns:



43712
43713
43714
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43712

def url_context
  @url_context
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



43719
43720
43721
43722
43723
43724
43725
43726
43727
43728
43729
43730
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 43719

def update!(**args)
  @code_execution = args[:code_execution] if args.key?(:code_execution)
  @computer_use = args[:computer_use] if args.key?(:computer_use)
  @enterprise_web_search = args[:enterprise_web_search] if args.key?(:enterprise_web_search)
  @function_declarations = args[:function_declarations] if args.key?(:function_declarations)
  @google_maps = args[:google_maps] if args.key?(:google_maps)
  @google_search = args[:google_search] if args.key?(:google_search)
  @google_search_retrieval = args[:google_search_retrieval] if args.key?(:google_search_retrieval)
  @parallel_ai_search = args[:parallel_ai_search] if args.key?(:parallel_ai_search)
  @retrieval = args[:retrieval] if args.key?(:retrieval)
  @url_context = args[:url_context] if args.key?(:url_context)
end