Class ToolUseExample (3.46.0)

public final class ToolUseExample extends GeneratedMessageV3 implements ToolUseExampleOrBuilder

A single example of the tool usage.

Protobuf type google.cloud.aiplatform.v1beta1.ToolUseExample

Static Fields

DISPLAY_NAME_FIELD_NUMBER

public static final int DISPLAY_NAME_FIELD_NUMBER
Field Value
Type Description
int

EXTENSION_OPERATION_FIELD_NUMBER

public static final int EXTENSION_OPERATION_FIELD_NUMBER
Field Value
Type Description
int

FUNCTION_NAME_FIELD_NUMBER

public static final int FUNCTION_NAME_FIELD_NUMBER
Field Value
Type Description
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
Type Description
int

REQUEST_PARAMS_FIELD_NUMBER

public static final int REQUEST_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_PARAMS_FIELD_NUMBER

public static final int RESPONSE_PARAMS_FIELD_NUMBER
Field Value
Type Description
int

RESPONSE_SUMMARY_FIELD_NUMBER

public static final int RESPONSE_SUMMARY_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static ToolUseExample getDefaultInstance()
Returns
Type Description
ToolUseExample

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static ToolUseExample.Builder newBuilder()
Returns
Type Description
ToolUseExample.Builder

newBuilder(ToolUseExample prototype)

public static ToolUseExample.Builder newBuilder(ToolUseExample prototype)
Parameter
Name Description
prototype ToolUseExample
Returns
Type Description
ToolUseExample.Builder

parseDelimitedFrom(InputStream input)

public static ToolUseExample parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ToolUseExample
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUseExample
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static ToolUseExample parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
ToolUseExample
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUseExample
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ToolUseExample parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
ToolUseExample
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUseExample
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ToolUseExample parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
ToolUseExample
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUseExample
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static ToolUseExample parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
ToolUseExample
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUseExample
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static ToolUseExample parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
ToolUseExample
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
ToolUseExample
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<ToolUseExample> parser()
Returns
Type Description
Parser<ToolUseExample>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public ToolUseExample getDefaultInstanceForType()
Returns
Type Description
ToolUseExample

getDisplayName()

public String getDisplayName()

Required. The display name for example.

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

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

Required. The display name for example.

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

Returns
Type Description
ByteString

The bytes for displayName.

getExtensionOperation()

public ToolUseExample.ExtensionOperation getExtensionOperation()

Extension operation to call.

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

Returns
Type Description
ToolUseExample.ExtensionOperation

The extensionOperation.

getExtensionOperationOrBuilder()

public ToolUseExample.ExtensionOperationOrBuilder getExtensionOperationOrBuilder()

Extension operation to call.

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

Returns
Type Description
ToolUseExample.ExtensionOperationOrBuilder

getFunctionName()

public String getFunctionName()

Function name to call.

string function_name = 11;

Returns
Type Description
String

The functionName.

getFunctionNameBytes()

public ByteString getFunctionNameBytes()

Function name to call.

string function_name = 11;

Returns
Type Description
ByteString

The bytes for functionName.

getParserForType()

public Parser<ToolUseExample> getParserForType()
Returns
Type Description
Parser<ToolUseExample>
Overrides

getQuery()

public String getQuery()

Required. Query that should be routed to this tool.

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

Returns
Type Description
String

The query.

getQueryBytes()

public ByteString getQueryBytes()

Required. Query that should be routed to this tool.

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

Returns
Type Description
ByteString

The bytes for query.

getRequestParams()

public Struct getRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
Type Description
Struct

The requestParams.

getRequestParamsOrBuilder()

public StructOrBuilder getRequestParamsOrBuilder()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
Type Description
StructOrBuilder

getResponseParams()

public Struct getResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
Type Description
Struct

The responseParams.

getResponseParamsOrBuilder()

public StructOrBuilder getResponseParamsOrBuilder()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
Type Description
StructOrBuilder

getResponseSummary()

public String getResponseSummary()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
Type Description
String

The responseSummary.

getResponseSummaryBytes()

public ByteString getResponseSummaryBytes()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
Type Description
ByteString

The bytes for responseSummary.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getTargetCase()

public ToolUseExample.TargetCase getTargetCase()
Returns
Type Description
ToolUseExample.TargetCase

hasExtensionOperation()

public boolean hasExtensionOperation()

Extension operation to call.

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

Returns
Type Description
boolean

Whether the extensionOperation field is set.

hasFunctionName()

public boolean hasFunctionName()

Function name to call.

string function_name = 11;

Returns
Type Description
boolean

Whether the functionName field is set.

hasRequestParams()

public boolean hasRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
Type Description
boolean

Whether the requestParams field is set.

hasResponseParams()

public boolean hasResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
Type Description
boolean

Whether the responseParams field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public ToolUseExample.Builder newBuilderForType()
Returns
Type Description
ToolUseExample.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ToolUseExample.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
ToolUseExample.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public ToolUseExample.Builder toBuilder()
Returns
Type Description
ToolUseExample.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException