Package com.google.cloud.aiplatform.v1beta1

Class GeminiExample

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.aiplatform.v1beta1.GeminiExample
All Implemented Interfaces:
GeminiExampleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class GeminiExample extends com.google.protobuf.GeneratedMessage implements GeminiExampleOrBuilder
 Format for Gemini examples used for Vertex Multimodal datasets.
Protobuf type google.cloud.aiplatform.v1beta1.GeminiExample
See Also:

  • Field Details

    • MODEL_FIELD_NUMBER

      public static final int MODEL_FIELD_NUMBER
      See Also:

    • CONTENTS_FIELD_NUMBER

      public static final int CONTENTS_FIELD_NUMBER
      See Also:

    • SYSTEM_INSTRUCTION_FIELD_NUMBER

      public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER
      See Also:

    • CACHED_CONTENT_FIELD_NUMBER

      public static final int CACHED_CONTENT_FIELD_NUMBER
      See Also:

    • TOOLS_FIELD_NUMBER

      public static final int TOOLS_FIELD_NUMBER
      See Also:

    • TOOL_CONFIG_FIELD_NUMBER

      public static final int TOOL_CONFIG_FIELD_NUMBER
      See Also:

    • LABELS_FIELD_NUMBER

      public static final int LABELS_FIELD_NUMBER
      See Also:

    • SAFETY_SETTINGS_FIELD_NUMBER

      public static final int SAFETY_SETTINGS_FIELD_NUMBER
      See Also:

    • MODEL_ARMOR_CONFIG_FIELD_NUMBER

      public static final int MODEL_ARMOR_CONFIG_FIELD_NUMBER
      See Also:

    • GENERATION_CONFIG_FIELD_NUMBER

      public static final int GENERATION_CONFIG_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetMapFieldReflection

      protected com.google.protobuf.MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
      Overrides:
      internalGetMapFieldReflection in class com.google.protobuf.GeneratedMessage

    • internalGetFieldAccessorTable

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

    • getModel

      public String getModel()
       Optional. The fully qualified name of the publisher model or tuned model
 endpoint to use.

 Publisher model format:
 `projects/{project}/locations/{location}/publishers/*/models/*`

 Tuned model endpoint format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string model = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getModel in interface GeminiExampleOrBuilder
      Returns:
      The model.

    • getModelBytes

      public com.google.protobuf.ByteString getModelBytes()
       Optional. The fully qualified name of the publisher model or tuned model
 endpoint to use.

 Publisher model format:
 `projects/{project}/locations/{location}/publishers/*/models/*`

 Tuned model endpoint format:
 `projects/{project}/locations/{location}/endpoints/{endpoint}`
      string model = 1 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getModelBytes in interface GeminiExampleOrBuilder
      Returns:
      The bytes for model.

    • getContentsList

      public List<Content> getContentsList()
       Required. The content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn
 queries, this is a repeated field that contains conversation history +
 latest request.
      repeated .google.cloud.aiplatform.v1beta1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getContentsList in interface GeminiExampleOrBuilder

    • getContentsOrBuilderList

      public List<? extends ContentOrBuilder> getContentsOrBuilderList()
       Required. The content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn
 queries, this is a repeated field that contains conversation history +
 latest request.
      repeated .google.cloud.aiplatform.v1beta1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getContentsOrBuilderList in interface GeminiExampleOrBuilder

    • getContentsCount

      public int getContentsCount()
       Required. The content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn
 queries, this is a repeated field that contains conversation history +
 latest request.
      repeated .google.cloud.aiplatform.v1beta1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getContentsCount in interface GeminiExampleOrBuilder

    • getContents

      public Content getContents(int index)
       Required. The content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn
 queries, this is a repeated field that contains conversation history +
 latest request.
      repeated .google.cloud.aiplatform.v1beta1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getContents in interface GeminiExampleOrBuilder

    • getContentsOrBuilder

      public ContentOrBuilder getContentsOrBuilder(int index)
       Required. The content of the current conversation with the model.

 For single-turn queries, this is a single instance. For multi-turn
 queries, this is a repeated field that contains conversation history +
 latest request.
      repeated .google.cloud.aiplatform.v1beta1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getContentsOrBuilder in interface GeminiExampleOrBuilder

    • hasSystemInstruction

      public boolean hasSystemInstruction()
       Optional. The user provided system instructions for the model.
 Note: only text should be used in parts and content in each part will be
 in a separate paragraph.
      optional .google.cloud.aiplatform.v1beta1.Content system_instruction = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSystemInstruction in interface GeminiExampleOrBuilder
      Returns:
      Whether the systemInstruction field is set.

    • getSystemInstruction

      public Content getSystemInstruction()
       Optional. The user provided system instructions for the model.
 Note: only text should be used in parts and content in each part will be
 in a separate paragraph.
      optional .google.cloud.aiplatform.v1beta1.Content system_instruction = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSystemInstruction in interface GeminiExampleOrBuilder
      Returns:
      The systemInstruction.

    • getSystemInstructionOrBuilder

      public ContentOrBuilder getSystemInstructionOrBuilder()
       Optional. The user provided system instructions for the model.
 Note: only text should be used in parts and content in each part will be
 in a separate paragraph.
      optional .google.cloud.aiplatform.v1beta1.Content system_instruction = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSystemInstructionOrBuilder in interface GeminiExampleOrBuilder

    • getCachedContent

      public String getCachedContent()
       Optional. The name of the cached content used as context to serve the
 prediction. Note: only used in explicit caching, where users can have
 control over caching (e.g. what content to cache) and enjoy guaranteed cost
 savings. Format:
 `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
      string cached_content = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCachedContent in interface GeminiExampleOrBuilder
      Returns:
      The cachedContent.

    • getCachedContentBytes

      public com.google.protobuf.ByteString getCachedContentBytes()
       Optional. The name of the cached content used as context to serve the
 prediction. Note: only used in explicit caching, where users can have
 control over caching (e.g. what content to cache) and enjoy guaranteed cost
 savings. Format:
 `projects/{project}/locations/{location}/cachedContents/{cachedContent}`
      string cached_content = 9 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }
      Specified by:
      getCachedContentBytes in interface GeminiExampleOrBuilder
      Returns:
      The bytes for cachedContent.

    • getToolsList

      public List<Tool> getToolsList()
       Optional. A list of `Tools` the model may use to generate the next
 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.
      repeated .google.cloud.aiplatform.v1beta1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolsList in interface GeminiExampleOrBuilder

    • getToolsOrBuilderList

      public List<? extends ToolOrBuilder> getToolsOrBuilderList()
       Optional. A list of `Tools` the model may use to generate the next
 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.
      repeated .google.cloud.aiplatform.v1beta1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolsOrBuilderList in interface GeminiExampleOrBuilder

    • getToolsCount

      public int getToolsCount()
       Optional. A list of `Tools` the model may use to generate the next
 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.
      repeated .google.cloud.aiplatform.v1beta1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolsCount in interface GeminiExampleOrBuilder

    • getTools

      public Tool getTools(int index)
       Optional. A list of `Tools` the model may use to generate the next
 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.
      repeated .google.cloud.aiplatform.v1beta1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getTools in interface GeminiExampleOrBuilder

    • getToolsOrBuilder

      public ToolOrBuilder getToolsOrBuilder(int index)
       Optional. A list of `Tools` the model may use to generate the next
 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.
      repeated .google.cloud.aiplatform.v1beta1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolsOrBuilder in interface GeminiExampleOrBuilder

    • hasToolConfig

      public boolean hasToolConfig()
       Optional. Tool config. This config is shared for all tools provided in the
 request.
      .google.cloud.aiplatform.v1beta1.ToolConfig tool_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasToolConfig in interface GeminiExampleOrBuilder
      Returns:
      Whether the toolConfig field is set.

    • getToolConfig

      public ToolConfig getToolConfig()
       Optional. Tool config. This config is shared for all tools provided in the
 request.
      .google.cloud.aiplatform.v1beta1.ToolConfig tool_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolConfig in interface GeminiExampleOrBuilder
      Returns:
      The toolConfig.

    • getToolConfigOrBuilder

      public ToolConfigOrBuilder getToolConfigOrBuilder()
       Optional. Tool config. This config is shared for all tools provided in the
 request.
      .google.cloud.aiplatform.v1beta1.ToolConfig tool_config = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getToolConfigOrBuilder in interface GeminiExampleOrBuilder

    • getLabelsCount

      public int getLabelsCount()
      Description copied from interface: GeminiExampleOrBuilder
       Optional. The labels with user-defined metadata for the request. It is used
 for billing and reporting only.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are
 allowed. Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsCount in interface GeminiExampleOrBuilder

    • containsLabels

      public boolean containsLabels(String key)
       Optional. The labels with user-defined metadata for the request. It is used
 for billing and reporting only.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are
 allowed. Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      containsLabels in interface GeminiExampleOrBuilder

    • getLabels

      @Deprecated public Map<String,String> getLabels()
      Deprecated.
      Use getLabelsMap() instead.
      Specified by:
      getLabels in interface GeminiExampleOrBuilder

    • getLabelsMap

      public Map<String,String> getLabelsMap()
       Optional. The labels with user-defined metadata for the request. It is used
 for billing and reporting only.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are
 allowed. Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsMap in interface GeminiExampleOrBuilder

    • getLabelsOrDefault

      public String getLabelsOrDefault(String key, String defaultValue)
       Optional. The labels with user-defined metadata for the request. It is used
 for billing and reporting only.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are
 allowed. Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrDefault in interface GeminiExampleOrBuilder

    • getLabelsOrThrow

      public String getLabelsOrThrow(String key)
       Optional. The labels with user-defined metadata for the request. It is used
 for billing and reporting only.

 Label keys and values can be no longer than 63 characters
 (Unicode codepoints) and can only contain lowercase letters, numeric
 characters, underscores, and dashes. International characters are
 allowed. Label values are optional. Label keys must start with a letter.
      map<string, string> labels = 10 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getLabelsOrThrow in interface GeminiExampleOrBuilder

    • getSafetySettingsList

      public List<SafetySetting> getSafetySettingsList()
       Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
      repeated .google.cloud.aiplatform.v1beta1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsList in interface GeminiExampleOrBuilder

    • getSafetySettingsOrBuilderList

      public List<? extends SafetySettingOrBuilder> getSafetySettingsOrBuilderList()
       Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
      repeated .google.cloud.aiplatform.v1beta1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsOrBuilderList in interface GeminiExampleOrBuilder

    • getSafetySettingsCount

      public int getSafetySettingsCount()
       Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
      repeated .google.cloud.aiplatform.v1beta1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsCount in interface GeminiExampleOrBuilder

    • getSafetySettings

      public SafetySetting getSafetySettings(int index)
       Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
      repeated .google.cloud.aiplatform.v1beta1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettings in interface GeminiExampleOrBuilder

    • getSafetySettingsOrBuilder

      public SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)
       Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
      repeated .google.cloud.aiplatform.v1beta1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySettingsOrBuilder in interface GeminiExampleOrBuilder

    • hasModelArmorConfig

      public boolean hasModelArmorConfig()
       Optional. Settings for prompt and response sanitization using the Model
 Armor service. If supplied, safety_settings must not be supplied.
      .google.cloud.aiplatform.v1beta1.ModelArmorConfig model_armor_config = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasModelArmorConfig in interface GeminiExampleOrBuilder
      Returns:
      Whether the modelArmorConfig field is set.

    • getModelArmorConfig

      public ModelArmorConfig getModelArmorConfig()
       Optional. Settings for prompt and response sanitization using the Model
 Armor service. If supplied, safety_settings must not be supplied.
      .google.cloud.aiplatform.v1beta1.ModelArmorConfig model_armor_config = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModelArmorConfig in interface GeminiExampleOrBuilder
      Returns:
      The modelArmorConfig.

    • getModelArmorConfigOrBuilder

      public ModelArmorConfigOrBuilder getModelArmorConfigOrBuilder()
       Optional. Settings for prompt and response sanitization using the Model
 Armor service. If supplied, safety_settings must not be supplied.
      .google.cloud.aiplatform.v1beta1.ModelArmorConfig model_armor_config = 11 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getModelArmorConfigOrBuilder in interface GeminiExampleOrBuilder

    • hasGenerationConfig

      public boolean hasGenerationConfig()
       Optional. Generation config.
      .google.cloud.aiplatform.v1beta1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasGenerationConfig in interface GeminiExampleOrBuilder
      Returns:
      Whether the generationConfig field is set.

    • getGenerationConfig

      public GenerationConfig getGenerationConfig()
       Optional. Generation config.
      .google.cloud.aiplatform.v1beta1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationConfig in interface GeminiExampleOrBuilder
      Returns:
      The generationConfig.

    • getGenerationConfigOrBuilder

      public GenerationConfigOrBuilder getGenerationConfigOrBuilder()
       Optional. Generation config.
      .google.cloud.aiplatform.v1beta1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGenerationConfigOrBuilder in interface GeminiExampleOrBuilder

    • 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 GeminiExample parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static GeminiExample parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static GeminiExample parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static GeminiExample.Builder newBuilder()

    • newBuilder

      public static GeminiExample.Builder newBuilder(GeminiExample prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static GeminiExample getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<GeminiExample> 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 GeminiExample getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder