com.google.cloud.aiplatform.v1

Class Tool

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.Tool

All Implemented Interfaces:

ToolOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class Tool
extends com.google.protobuf.GeneratedMessageV3
implements ToolOrBuilder

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

Protobuf type google.cloud.aiplatform.v1.Tool

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Tool.Builder Tool details that the model may use to generate response.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	FUNCTION_DECLARATIONS_FIELD_NUMBER
static int	GOOGLE_SEARCH_RETRIEVAL_FIELD_NUMBER
static int	RETRIEVAL_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
static Tool	getDefaultInstance()
Tool	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
FunctionDeclaration	getFunctionDeclarations(int index) Optional.
int	getFunctionDeclarationsCount() Optional.
List<FunctionDeclaration>	getFunctionDeclarationsList() Optional.
FunctionDeclarationOrBuilder	getFunctionDeclarationsOrBuilder(int index) Optional.
List<? extends FunctionDeclarationOrBuilder>	getFunctionDeclarationsOrBuilderList() Optional.
GoogleSearchRetrieval	getGoogleSearchRetrieval() Optional.
GoogleSearchRetrievalOrBuilder	getGoogleSearchRetrievalOrBuilder() Optional.
com.google.protobuf.Parser<Tool>	getParserForType()
Retrieval	getRetrieval() Optional.
RetrievalOrBuilder	getRetrievalOrBuilder() Optional.
int	getSerializedSize()
boolean	hasGoogleSearchRetrieval() Optional.
int	hashCode()
boolean	hasRetrieval() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Tool.Builder	newBuilder()
static Tool.Builder	newBuilder(Tool prototype)
Tool.Builder	newBuilderForType()
protected Tool.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static Tool	parseDelimitedFrom(InputStream input)
static Tool	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool	parseFrom(byte[] data)
static Tool	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool	parseFrom(ByteBuffer data)
static Tool	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool	parseFrom(com.google.protobuf.ByteString data)
static Tool	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool	parseFrom(com.google.protobuf.CodedInputStream input)
static Tool	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static Tool	parseFrom(InputStream input)
static Tool	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<Tool>	parser()
Tool.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

FUNCTION_DECLARATIONS_FIELD_NUMBER

public static final int FUNCTION_DECLARATIONS_FIELD_NUMBER

See Also:

Constant Field Values

RETRIEVAL_FIELD_NUMBER

public static final int RETRIEVAL_FIELD_NUMBER

See Also:

Constant Field Values

GOOGLE_SEARCH_RETRIEVAL_FIELD_NUMBER

public static final int GOOGLE_SEARCH_RETRIEVAL_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getFunctionDeclarationsList

public List<FunctionDeclaration> getFunctionDeclarationsList()

 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][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarationsList in interface ToolOrBuilder

getFunctionDeclarationsOrBuilderList

public List<? extends FunctionDeclarationOrBuilder> getFunctionDeclarationsOrBuilderList()

 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][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarationsOrBuilderList in interface ToolOrBuilder

getFunctionDeclarationsCount

public int getFunctionDeclarationsCount()

 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][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarationsCount in interface ToolOrBuilder

getFunctionDeclarations

public FunctionDeclaration getFunctionDeclarations(int index)

 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][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarations in interface ToolOrBuilder

getFunctionDeclarationsOrBuilder

public FunctionDeclarationOrBuilder getFunctionDeclarationsOrBuilder(int index)

 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][content.part.function_call] in the response.
 User should provide a [FunctionResponse][content.part.function_response]
 for each function call in the next turn. Based on the function responses,
 Model will generate the final response back to the user.
 Maximum 64 function declarations can be provided.
 

repeated .google.cloud.aiplatform.v1.FunctionDeclaration function_declarations = 1 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getFunctionDeclarationsOrBuilder in interface ToolOrBuilder

hasRetrieval

public boolean hasRetrieval()

 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.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasRetrieval in interface ToolOrBuilder

Returns:

Whether the retrieval field is set.

getRetrieval

public Retrieval getRetrieval()

 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.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetrieval in interface ToolOrBuilder

Returns:

The retrieval.

getRetrievalOrBuilder

public RetrievalOrBuilder getRetrievalOrBuilder()

 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.
 

.google.cloud.aiplatform.v1.Retrieval retrieval = 2 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getRetrievalOrBuilder in interface ToolOrBuilder

hasGoogleSearchRetrieval

public boolean hasGoogleSearchRetrieval()

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

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

hasGoogleSearchRetrieval in interface ToolOrBuilder

Returns:

Whether the googleSearchRetrieval field is set.

getGoogleSearchRetrieval

public GoogleSearchRetrieval getGoogleSearchRetrieval()

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

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGoogleSearchRetrieval in interface ToolOrBuilder

Returns:

The googleSearchRetrieval.

getGoogleSearchRetrievalOrBuilder

public GoogleSearchRetrievalOrBuilder getGoogleSearchRetrievalOrBuilder()

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

.google.cloud.aiplatform.v1.GoogleSearchRetrieval google_search_retrieval = 3 [(.google.api.field_behavior) = OPTIONAL];

Specified by:

getGoogleSearchRetrievalOrBuilder in interface ToolOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

writeTo

public void writeTo(com.google.protobuf.CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface com.google.protobuf.MessageLite

Overrides:

writeTo in class com.google.protobuf.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface com.google.protobuf.Message

Overrides:

equals in class com.google.protobuf.AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface com.google.protobuf.Message

Overrides:

hashCode in class com.google.protobuf.AbstractMessage

parseFrom

public static Tool parseFrom(ByteBuffer data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool parseFrom(ByteBuffer data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool parseFrom(com.google.protobuf.ByteString data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool parseFrom(com.google.protobuf.ByteString data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool parseFrom(byte[] data)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool parseFrom(byte[] data,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static Tool parseFrom(InputStream input)
                      throws IOException

Throws:

IOException

parseFrom

public static Tool parseFrom(InputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws IOException

Throws:

IOException

parseDelimitedFrom

public static Tool parseDelimitedFrom(InputStream input)
                               throws IOException

Throws:

IOException

parseDelimitedFrom

public static Tool parseDelimitedFrom(InputStream input,
                                      com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                               throws IOException

Throws:

IOException

parseFrom

public static Tool parseFrom(com.google.protobuf.CodedInputStream input)
                      throws IOException

Throws:

IOException

parseFrom

public static Tool parseFrom(com.google.protobuf.CodedInputStream input,
                             com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                      throws IOException

Throws:

IOException

newBuilderForType

public Tool.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static Tool.Builder newBuilder()

newBuilder

public static Tool.Builder newBuilder(Tool prototype)

toBuilder

public Tool.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected Tool.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static Tool getDefaultInstance()

parser

public static com.google.protobuf.Parser<Tool> parser()

getParserForType

public com.google.protobuf.Parser<Tool> getParserForType()

Specified by:

getParserForType in interface com.google.protobuf.Message

Specified by:

getParserForType in interface com.google.protobuf.MessageLite

Overrides:

getParserForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstanceForType

public Tool getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder