Class FunctionCallingConfig.Builder (1.12.0)

public static final class FunctionCallingConfig.Builder extends GeneratedMessageV3.Builder<FunctionCallingConfig.Builder> implements FunctionCallingConfigOrBuilder

Function calling config.

Protobuf type google.cloud.vertexai.v1.FunctionCallingConfig

Static Methods

getDescriptor()

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

Methods

addAllAllowedFunctionNames(Iterable<String> values)

public FunctionCallingConfig.Builder addAllAllowedFunctionNames(Iterable<String> values)

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
values Iterable<String>

The allowedFunctionNames to add.

Returns
Type Description
FunctionCallingConfig.Builder

This builder for chaining.

addAllowedFunctionNames(String value)

public FunctionCallingConfig.Builder addAllowedFunctionNames(String value)

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
value String

The allowedFunctionNames to add.

Returns
Type Description
FunctionCallingConfig.Builder

This builder for chaining.

addAllowedFunctionNamesBytes(ByteString value)

public FunctionCallingConfig.Builder addAllowedFunctionNamesBytes(ByteString value)

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
value ByteString

The bytes of the allowedFunctionNames to add.

Returns
Type Description
FunctionCallingConfig.Builder

This builder for chaining.

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public FunctionCallingConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FunctionCallingConfig.Builder
Overrides

build()

public FunctionCallingConfig build()
Returns
Type Description
FunctionCallingConfig

buildPartial()

public FunctionCallingConfig buildPartial()
Returns
Type Description
FunctionCallingConfig

clear()

public FunctionCallingConfig.Builder clear()
Returns
Type Description
FunctionCallingConfig.Builder
Overrides

clearAllowedFunctionNames()

public FunctionCallingConfig.Builder clearAllowedFunctionNames()

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
FunctionCallingConfig.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public FunctionCallingConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
FunctionCallingConfig.Builder
Overrides

clearMode()

public FunctionCallingConfig.Builder clearMode()

Optional. Function calling mode.

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

Returns
Type Description
FunctionCallingConfig.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public FunctionCallingConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
FunctionCallingConfig.Builder
Overrides

clone()

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

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

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.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(FunctionCallingConfig other)

public FunctionCallingConfig.Builder mergeFrom(FunctionCallingConfig other)
Parameter
Name Description
other FunctionCallingConfig
Returns
Type Description
FunctionCallingConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public FunctionCallingConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
FunctionCallingConfig.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public FunctionCallingConfig.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
FunctionCallingConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final FunctionCallingConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FunctionCallingConfig.Builder
Overrides

setAllowedFunctionNames(int index, String value)

public FunctionCallingConfig.Builder setAllowedFunctionNames(int index, String value)

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];

Parameters
Name Description
index int

The index to set the value at.

value String

The allowedFunctionNames to set.

Returns
Type Description
FunctionCallingConfig.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public FunctionCallingConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
FunctionCallingConfig.Builder
Overrides

setMode(FunctionCallingConfig.Mode value)

public FunctionCallingConfig.Builder setMode(FunctionCallingConfig.Mode value)

Optional. Function calling mode.

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

Parameter
Name Description
value FunctionCallingConfig.Mode

The mode to set.

Returns
Type Description
FunctionCallingConfig.Builder

This builder for chaining.

setModeValue(int value)

public FunctionCallingConfig.Builder setModeValue(int value)

Optional. Function calling mode.

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

Parameter
Name Description
value int

The enum numeric value on the wire for mode to set.

Returns
Type Description
FunctionCallingConfig.Builder

This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public FunctionCallingConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
FunctionCallingConfig.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final FunctionCallingConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
FunctionCallingConfig.Builder
Overrides