- 0.55.0 (latest)
- 0.54.0
- 0.53.0
- 0.52.0
- 0.51.0
- 0.50.0
- 0.49.0
- 0.48.0
- 0.47.0
- 0.46.0
- 0.45.0
- 0.44.0
- 0.43.0
- 0.42.0
- 0.41.0
- 0.40.0
- 0.39.0
- 0.38.0
- 0.37.0
- 0.36.0
- 0.35.0
- 0.34.0
- 0.33.0
- 0.32.0
- 0.31.0
- 0.30.0
- 0.29.0
- 0.28.0
- 0.27.0
- 0.26.0
- 0.25.0
- 0.24.0
- 0.23.0
- 0.22.0
- 0.21.0
- 0.20.0
- 0.19.0
- 0.18.0
- 0.17.0
- 0.16.0
- 0.15.0
- 0.14.0
- 0.13.0
- 0.12.0
- 0.11.0
- 0.10.0
- 0.9.1
- 0.8.0
- 0.7.0
- 0.6.0
- 0.5.0
- 0.4.0
- 0.3.0
- 0.2.0
- 0.1.0
Reference documentation and code samples for the Vertex AI V1 API class Google::Cloud::AIPlatform::V1::Tool.
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).
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#function_declarations
def function_declarations() -> ::Array<::Google::Cloud::AIPlatform::V1::FunctionDeclaration>
- (::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][content.part.function_call] in the response. User should provide a [FunctionResponse][content.part.function_response] for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.
#function_declarations=
def function_declarations=(value) -> ::Array<::Google::Cloud::AIPlatform::V1::FunctionDeclaration>
- value (::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][content.part.function_call] in the response. User should provide a [FunctionResponse][content.part.function_response] for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.
- (::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][content.part.function_call] in the response. User should provide a [FunctionResponse][content.part.function_response] for each function call in the next turn. Based on the function responses, Model will generate the final response back to the user. Maximum 64 function declarations can be provided.
#google_search_retrieval
def google_search_retrieval() -> ::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval
- (::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval) — Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
#google_search_retrieval=
def google_search_retrieval=(value) -> ::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval
- value (::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval) — Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
- (::Google::Cloud::AIPlatform::V1::GoogleSearchRetrieval) — Optional. GoogleSearchRetrieval tool type. Specialized retrieval tool that is powered by Google search.
#retrieval
def retrieval() -> ::Google::Cloud::AIPlatform::V1::Retrieval
- (::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.
#retrieval=
def retrieval=(value) -> ::Google::Cloud::AIPlatform::V1::Retrieval
- value (::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.
- (::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.