Interface ToolUseExampleOrBuilder (3.40.0)

public interface ToolUseExampleOrBuilder extends MessageOrBuilder

Implements

MessageOrBuilder

Methods

getDisplayName()

public abstract String getDisplayName()

Required. The display name for example.

string display_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public abstract ByteString getDisplayNameBytes()

Required. The display name for example.

string display_name = 1 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for displayName.

getExtensionOperation()

public abstract ToolUseExample.ExtensionOperation getExtensionOperation()

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Returns
TypeDescription
ToolUseExample.ExtensionOperation

The extensionOperation.

getExtensionOperationOrBuilder()

public abstract ToolUseExample.ExtensionOperationOrBuilder getExtensionOperationOrBuilder()

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Returns
TypeDescription
ToolUseExample.ExtensionOperationOrBuilder

getFunctionName()

public abstract String getFunctionName()

Function name to call.

string function_name = 11;

Returns
TypeDescription
String

The functionName.

getFunctionNameBytes()

public abstract ByteString getFunctionNameBytes()

Function name to call.

string function_name = 11;

Returns
TypeDescription
ByteString

The bytes for functionName.

getQuery()

public abstract String getQuery()

Required. Query that should be routed to this tool.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
String

The query.

getQueryBytes()

public abstract ByteString getQueryBytes()

Required. Query that should be routed to this tool.

string query = 2 [(.google.api.field_behavior) = REQUIRED];

Returns
TypeDescription
ByteString

The bytes for query.

getRequestParams()

public abstract Struct getRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
Struct

The requestParams.

getRequestParamsOrBuilder()

public abstract StructOrBuilder getRequestParamsOrBuilder()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
StructOrBuilder

getResponseParams()

public abstract Struct getResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
Struct

The responseParams.

getResponseParamsOrBuilder()

public abstract StructOrBuilder getResponseParamsOrBuilder()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
StructOrBuilder

getResponseSummary()

public abstract String getResponseSummary()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
TypeDescription
String

The responseSummary.

getResponseSummaryBytes()

public abstract ByteString getResponseSummaryBytes()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
TypeDescription
ByteString

The bytes for responseSummary.

getTargetCase()

public abstract ToolUseExample.TargetCase getTargetCase()
Returns
TypeDescription
ToolUseExample.TargetCase

hasExtensionOperation()

public abstract boolean hasExtensionOperation()

Extension operation to call.

.google.cloud.aiplatform.v1beta1.ToolUseExample.ExtensionOperation extension_operation = 10;

Returns
TypeDescription
boolean

Whether the extensionOperation field is set.

hasFunctionName()

public abstract boolean hasFunctionName()

Function name to call.

string function_name = 11;

Returns
TypeDescription
boolean

Whether the functionName field is set.

hasRequestParams()

public abstract boolean hasRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
boolean

Whether the requestParams field is set.

hasResponseParams()

public abstract boolean hasResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
boolean

Whether the responseParams field is set.