Class FunctionCallingConfig (1.12.0) 

public final class FunctionCallingConfig extends GeneratedMessageV3 implements FunctionCallingConfigOrBuilder

Function calling config.

Protobuf type google.cloud.vertexai.v1.FunctionCallingConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > FunctionCallingConfig

Static Fields

ALLOWED_FUNCTION_NAMES_FIELD_NUMBER

public static final int ALLOWED_FUNCTION_NAMES_FIELD_NUMBER
Field Value
Type Description
int

MODE_FIELD_NUMBER

public static final int MODE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static FunctionCallingConfig getDefaultInstance()
Returns
Type Description
FunctionCallingConfig

getDescriptor()

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

newBuilder()

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

newBuilder(FunctionCallingConfig prototype)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

Methods

equals(Object obj)

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

getAllowedFunctionNames(int index)

public String getAllowedFunctionNames(int index)

Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

repeated string allowed_function_names = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.
Returns
Type Description
String

The allowedFunctionNames at the given index.

getAllowedFunctionNamesBytes(int index)

public ByteString getAllowedFunctionNamesBytes(int index)

Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

repeated string allowed_function_names = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.
Returns
Type Description
ByteString

The bytes of the allowedFunctionNames at the given index.

getAllowedFunctionNamesCount()

public int getAllowedFunctionNamesCount()

Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

repeated string allowed_function_names = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of allowedFunctionNames.

getAllowedFunctionNamesList()

public ProtocolStringList getAllowedFunctionNamesList()

Optional. Function names to call. Only set when the Mode is ANY. Function names should match [FunctionDeclaration.name]. With mode set to ANY, model will predict a function call from the set of function names provided.

repeated string allowed_function_names = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the allowedFunctionNames.

getDefaultInstanceForType()

public FunctionCallingConfig getDefaultInstanceForType()
Returns
Type Description
FunctionCallingConfig

getMode()

public FunctionCallingConfig.Mode getMode()

Optional. Function calling mode.

.google.cloud.vertexai.v1.FunctionCallingConfig.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
FunctionCallingConfig.Mode

The mode.

getModeValue()

public int getModeValue()

Optional. Function calling mode.

.google.cloud.vertexai.v1.FunctionCallingConfig.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for mode.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

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 FunctionCallingConfig.Builder newBuilderForType()
Returns
Type Description
FunctionCallingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

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

writeTo(CodedOutputStream output)

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