Class ToolUseExample (3.40.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
TypeDescription
int

EXTENSION_OPERATION_FIELD_NUMBER

public static final int EXTENSION_OPERATION_FIELD_NUMBER
Field Value
TypeDescription
int

FUNCTION_NAME_FIELD_NUMBER

public static final int FUNCTION_NAME_FIELD_NUMBER
Field Value
TypeDescription
int

QUERY_FIELD_NUMBER

public static final int QUERY_FIELD_NUMBER
Field Value
TypeDescription
int

REQUEST_PARAMS_FIELD_NUMBER

public static final int REQUEST_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

RESPONSE_PARAMS_FIELD_NUMBER

public static final int RESPONSE_PARAMS_FIELD_NUMBER
Field Value
TypeDescription
int

RESPONSE_SUMMARY_FIELD_NUMBER

public static final int RESPONSE_SUMMARY_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static ToolUseExample getDefaultInstance()
Returns
TypeDescription
ToolUseExample

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static ToolUseExample.Builder newBuilder()
Returns
TypeDescription
ToolUseExample.Builder

newBuilder(ToolUseExample prototype)

public static ToolUseExample.Builder newBuilder(ToolUseExample prototype)
Parameter
NameDescription
prototypeToolUseExample
Returns
TypeDescription
ToolUseExample.Builder

parseDelimitedFrom(InputStream input)

public static ToolUseExample parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static ToolUseExample parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static ToolUseExample parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static ToolUseExample parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static ToolUseExample parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static ToolUseExample parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static ToolUseExample parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
ToolUseExample
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<ToolUseExample> parser()
Returns
TypeDescription
Parser<ToolUseExample>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public ToolUseExample getDefaultInstanceForType()
Returns
TypeDescription
ToolUseExample

getDisplayName()

public String getDisplayName()

Required. The display name for example.

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

Returns
TypeDescription
String

The displayName.

getDisplayNameBytes()

public 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 ToolUseExample.ExtensionOperation getExtensionOperation()

Extension operation to call.

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

Returns
TypeDescription
ToolUseExample.ExtensionOperation

The extensionOperation.

getExtensionOperationOrBuilder()

public ToolUseExample.ExtensionOperationOrBuilder getExtensionOperationOrBuilder()

Extension operation to call.

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

Returns
TypeDescription
ToolUseExample.ExtensionOperationOrBuilder

getFunctionName()

public String getFunctionName()

Function name to call.

string function_name = 11;

Returns
TypeDescription
String

The functionName.

getFunctionNameBytes()

public ByteString getFunctionNameBytes()

Function name to call.

string function_name = 11;

Returns
TypeDescription
ByteString

The bytes for functionName.

getParserForType()

public Parser<ToolUseExample> getParserForType()
Returns
TypeDescription
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
TypeDescription
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
TypeDescription
ByteString

The bytes for query.

getRequestParams()

public Struct getRequestParams()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
Struct

The requestParams.

getRequestParamsOrBuilder()

public StructOrBuilder getRequestParamsOrBuilder()

Request parameters used for executing this tool.

.google.protobuf.Struct request_params = 3;

Returns
TypeDescription
StructOrBuilder

getResponseParams()

public Struct getResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
Struct

The responseParams.

getResponseParamsOrBuilder()

public StructOrBuilder getResponseParamsOrBuilder()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
StructOrBuilder

getResponseSummary()

public String getResponseSummary()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
TypeDescription
String

The responseSummary.

getResponseSummaryBytes()

public ByteString getResponseSummaryBytes()

Summary of the tool response to the user query.

string response_summary = 5;

Returns
TypeDescription
ByteString

The bytes for responseSummary.

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getTargetCase()

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

hasExtensionOperation()

public 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 boolean hasFunctionName()

Function name to call.

string function_name = 11;

Returns
TypeDescription
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
TypeDescription
boolean

Whether the requestParams field is set.

hasResponseParams()

public boolean hasResponseParams()

Response parameters generated by this tool.

.google.protobuf.Struct response_params = 4;

Returns
TypeDescription
boolean

Whether the responseParams field is set.

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public ToolUseExample.Builder newBuilderForType()
Returns
TypeDescription
ToolUseExample.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected ToolUseExample.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
ToolUseExample.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public ToolUseExample.Builder toBuilder()
Returns
TypeDescription
ToolUseExample.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException