Class FunctionCallingConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1.FunctionCallingConfig
All Implemented Interfaces:
FunctionCallingConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

@Generated public final class FunctionCallingConfig extends com.google.protobuf.GeneratedMessage implements FunctionCallingConfigOrBuilder
 Function calling config.
 
Protobuf type google.cloud.aiplatform.v1.FunctionCallingConfig
See Also:
  • Field Details

    • MODE_FIELD_NUMBER

      public static final int MODE_FIELD_NUMBER
      See Also:
    • ALLOWED_FUNCTION_NAMES_FIELD_NUMBER

      public static final int ALLOWED_FUNCTION_NAMES_FIELD_NUMBER
      See Also:
    • STREAM_FUNCTION_CALL_ARGUMENTS_FIELD_NUMBER

      public static final int STREAM_FUNCTION_CALL_ARGUMENTS_FIELD_NUMBER
      See Also:
  • Method Details

    • getDescriptor

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

      protected com.google.protobuf.GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage
    • getModeValue

      public int getModeValue()
       Optional. Function calling mode.
       
      .google.cloud.aiplatform.v1.FunctionCallingConfig.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModeValue in interface FunctionCallingConfigOrBuilder
      Returns:
      The enum numeric value on the wire for mode.
    • getMode

      public FunctionCallingConfig.Mode getMode()
       Optional. Function calling mode.
       
      .google.cloud.aiplatform.v1.FunctionCallingConfig.Mode mode = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMode in interface FunctionCallingConfigOrBuilder
      Returns:
      The mode.
    • getAllowedFunctionNamesList

      public com.google.protobuf.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];
      Specified by:
      getAllowedFunctionNamesList in interface FunctionCallingConfigOrBuilder
      Returns:
      A list containing the allowedFunctionNames.
    • 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];
      Specified by:
      getAllowedFunctionNamesCount in interface FunctionCallingConfigOrBuilder
      Returns:
      The count of allowedFunctionNames.
    • getAllowedFunctionNames

      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];
      Specified by:
      getAllowedFunctionNames in interface FunctionCallingConfigOrBuilder
      Parameters:
      index - The index of the element to return.
      Returns:
      The allowedFunctionNames at the given index.
    • getAllowedFunctionNamesBytes

      public com.google.protobuf.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];
      Specified by:
      getAllowedFunctionNamesBytes in interface FunctionCallingConfigOrBuilder
      Parameters:
      index - The index of the value to return.
      Returns:
      The bytes of the allowedFunctionNames at the given index.
    • getStreamFunctionCallArguments

      public boolean getStreamFunctionCallArguments()
       Optional. When set to true, arguments of a single function call will be
       streamed out in multiple parts/contents/responses. Partial parameter
       results will be returned in the [FunctionCall.partial_args] field.
       
      bool stream_function_call_arguments = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getStreamFunctionCallArguments in interface FunctionCallingConfigOrBuilder
      Returns:
      The streamFunctionCallArguments.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • 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.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • 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 FunctionCallingConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FunctionCallingConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FunctionCallingConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FunctionCallingConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FunctionCallingConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FunctionCallingConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static FunctionCallingConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static FunctionCallingConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static FunctionCallingConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static FunctionCallingConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static FunctionCallingConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static FunctionCallingConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public FunctionCallingConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static FunctionCallingConfig.Builder newBuilder()
    • newBuilder

      public static FunctionCallingConfig.Builder newBuilder(FunctionCallingConfig prototype)
    • toBuilder

      public FunctionCallingConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected FunctionCallingConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static FunctionCallingConfig getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<FunctionCallingConfig> parser()
    • getParserForType

      public com.google.protobuf.Parser<FunctionCallingConfig> 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.GeneratedMessage
    • getDefaultInstanceForType

      public FunctionCallingConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder