Class: Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1ToolResultStep

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

Tool result step.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GenaiVertexV1beta1ToolResultStep

Returns a new instance of GenaiVertexV1beta1ToolResultStep.



5864
5865
5866
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5864

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

Instance Attribute Details

#call_id ⇒ String

Required. ID to match the ID from the function call block. Corresponds to the JSON property callId

Returns:

  • (String) 


5815
5816
5817
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5815

def call_id
  @call_id
end

#code_execution_result ⇒ Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1CodeExecutionResultStep

Code execution result step. Corresponds to the JSON property codeExecutionResult

Returns:



5820
5821
5822
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5820

def code_execution_result
  @code_execution_result
end

#file_search_result ⇒ Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1FileSearchResultStep

File Search result step. Corresponds to the JSON property fileSearchResult

Returns:



5825
5826
5827
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5825

def file_search_result
  @file_search_result
end

#function_result ⇒ Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1FunctionResultStep

Result of a function tool call. Corresponds to the JSON property functionResult

Returns:



5830
5831
5832
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5830

def function_result
  @function_result
end

#google_maps_result ⇒ Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1GoogleMapsResultStep

Google Maps result step. Corresponds to the JSON property googleMapsResult

Returns:



5835
5836
5837
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5835

def google_maps_result
  @google_maps_result
end

#google_search_result ⇒ Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1GoogleSearchResultStep

Google Search result step. Corresponds to the JSON property googleSearchResult

Returns:



5840
5841
5842
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5840

def google_search_result
  @google_search_result
end

#mcp_server_tool_result ⇒ Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1McpServerToolResultStep

MCPServer tool result step. Corresponds to the JSON property mcpServerToolResult

Returns:



5845
5846
5847
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5845

def mcp_server_tool_result
  @mcp_server_tool_result
end

#retrieval_result ⇒ Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1RetrievalResultStep

Vertex Retrieval result step. Used by Vertex Retrieval tools such as Parallel AI, Exa AI, Vertex AI Search, etc. Corresponds to the JSON property retrievalResult

Returns:



5851
5852
5853
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5851

def retrieval_result
  @retrieval_result
end

#signature ⇒ String

A signature hash for backend validation. Corresponds to the JSON property signature NOTE: Values are automatically base64 encoded/decoded in the client library.

Returns:

  • (String) 


5857
5858
5859
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5857

def signature
  @signature
end

#url_context_result ⇒ Google::Apis::AiplatformV1beta1::GenaiVertexV1beta1UrlContextResultStep

URL context result step. Corresponds to the JSON property urlContextResult

Returns:



5862
5863
5864
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5862

def url_context_result
  @url_context_result
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5869
5870
5871
5872
5873
5874
5875
5876
5877
5878
5879
5880
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 5869

def update!(**args)
  @call_id = args[:call_id] if args.key?(:call_id)
  @code_execution_result = args[:code_execution_result] if args.key?(:code_execution_result)
  @file_search_result = args[:file_search_result] if args.key?(:file_search_result)
  @function_result = args[:function_result] if args.key?(:function_result)
  @google_maps_result = args[:google_maps_result] if args.key?(:google_maps_result)
  @google_search_result = args[:google_search_result] if args.key?(:google_search_result)
  @mcp_server_tool_result = args[:mcp_server_tool_result] if args.key?(:mcp_server_tool_result)
  @retrieval_result = args[:retrieval_result] if args.key?(:retrieval_result)
  @signature = args[:signature] if args.key?(:signature)
  @url_context_result = args[:url_context_result] if args.key?(:url_context_result)
end