GoogleCloudAiplatformV1Tool

import type { GoogleCloudAiplatformV1Tool } from "https://googleapis.deno.dev/v1/aiplatform:v1.ts";

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).

interface GoogleCloudAiplatformV1Tool {

codeExecution?: GoogleCloudAiplatformV1ToolCodeExecution;

computerUse?: GoogleCloudAiplatformV1ToolComputerUse;

enterpriseWebSearch?: GoogleCloudAiplatformV1EnterpriseWebSearch;

functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[];

googleSearch?: GoogleCloudAiplatformV1ToolGoogleSearch;

googleSearchRetrieval?: GoogleCloudAiplatformV1GoogleSearchRetrieval;

retrieval?: GoogleCloudAiplatformV1Retrieval;

urlContext?: GoogleCloudAiplatformV1UrlContext;

}

§Properties

codeExecution?: GoogleCloudAiplatformV1ToolCodeExecution

[src]

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

computerUse?: GoogleCloudAiplatformV1ToolComputerUse

[src]

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

enterpriseWebSearch?: GoogleCloudAiplatformV1EnterpriseWebSearch

[src]

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

functionDeclarations?: GoogleCloudAiplatformV1FunctionDeclaration[]

[src]

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.

googleSearch?: GoogleCloudAiplatformV1ToolGoogleSearch

[src]

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

googleSearchRetrieval?: GoogleCloudAiplatformV1GoogleSearchRetrieval

[src]

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

retrieval?: GoogleCloudAiplatformV1Retrieval

[src]

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.

urlContext?: GoogleCloudAiplatformV1UrlContext

[src]

Optional. Tool to support URL context retrieval.