Class GoogleCloudAiplatformV1beta1Tool

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

Inheritance

object

GoogleCloudAiplatformV1beta1Tool

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.FirebaseML.v2beta.Data

Assembly: Google.Apis.FirebaseML.v2beta.dll

Syntax

public class GoogleCloudAiplatformV1beta1Tool : IDirectResponseSchema

Properties

CodeExecution

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

Declaration

[JsonProperty("codeExecution")]
public virtual GoogleCloudAiplatformV1beta1ToolCodeExecution CodeExecution { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1ToolCodeExecution

ComputerUse

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

Declaration

[JsonProperty("computerUse")]
public virtual GoogleCloudAiplatformV1beta1ToolComputerUse ComputerUse { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1ToolComputerUse

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

EnterpriseWebSearch

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

Declaration

[JsonProperty("enterpriseWebSearch")]
public virtual GoogleCloudAiplatformV1beta1EnterpriseWebSearch EnterpriseWebSearch { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1EnterpriseWebSearch

FunctionDeclarations

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.

Declaration

[JsonProperty("functionDeclarations")]
public virtual IList<GoogleCloudAiplatformV1beta1FunctionDeclaration> FunctionDeclarations { get; set; }

Property Value

Type	Description
IList<GoogleCloudAiplatformV1beta1FunctionDeclaration>

GoogleSearch

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

Declaration

[JsonProperty("googleSearch")]
public virtual GoogleCloudAiplatformV1beta1ToolGoogleSearch GoogleSearch { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1ToolGoogleSearch

GoogleSearchRetrieval

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

Declaration

[JsonProperty("googleSearchRetrieval")]
public virtual GoogleCloudAiplatformV1beta1GoogleSearchRetrieval GoogleSearchRetrieval { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1GoogleSearchRetrieval

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.

Declaration

[JsonProperty("retrieval")]
public virtual GoogleCloudAiplatformV1beta1Retrieval Retrieval { get; set; }

Property Value

Type	Description
GoogleCloudAiplatformV1beta1Retrieval

Implements

IDirectResponseSchema