public final class GeminiExample extends GeneratedMessageV3 implements GeminiExampleOrBuilder
Format for Gemini examples used for Vertex Multimodal datasets.
Protobuf type google.cloud.aiplatform.v1beta1.GeminiExample
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CACHED_CONTENT_FIELD_NUMBER
public static final int CACHED_CONTENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
CONTENTS_FIELD_NUMBER
public static final int CONTENTS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int GENERATION_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int LABELS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int MODEL_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SAFETY_SETTINGS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOLS_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
public static final int TOOL_CONFIG_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
|
Static Methods
public static GeminiExample getDefaultInstance()
public static final Descriptors.Descriptor getDescriptor()
public static GeminiExample.Builder newBuilder()
public static GeminiExample.Builder newBuilder(GeminiExample prototype)
public static GeminiExample parseDelimitedFrom(InputStream input)
public static GeminiExample parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GeminiExample parseFrom(byte[] data)
| Parameter |
| Name |
Description |
data |
byte[]
|
public static GeminiExample parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static GeminiExample parseFrom(ByteString data)
public static GeminiExample parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static GeminiExample parseFrom(CodedInputStream input)
public static GeminiExample parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static GeminiExample parseFrom(InputStream input)
public static GeminiExample parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static GeminiExample parseFrom(ByteBuffer data)
public static GeminiExample parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Parser<GeminiExample> parser()
Methods
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];
| Parameter |
| Name |
Description |
key |
String
|
public boolean equals(Object obj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
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) = { ... }
| Returns |
| Type |
Description |
String |
The cachedContent.
|
getCachedContentBytes()
public 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for cachedContent.
|
getContents(int index)
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
int |
|
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];
getContentsOrBuilder(int index)
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1beta1.ContentOrBuilder> |
|
public GeminiExample getDefaultInstanceForType()
public GenerationConfig getGenerationConfig()
Optional. Generation config.
.google.cloud.aiplatform.v1beta1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
public GenerationConfigOrBuilder getGenerationConfigOrBuilder()
Optional. Generation config.
.google.cloud.aiplatform.v1beta1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
public Map<String,String> getLabels()
public int getLabelsCount()
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];
| Returns |
| Type |
Description |
int |
|
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];
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];
| Returns |
| Type |
Description |
String |
|
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];
| Parameter |
| Name |
Description |
key |
String
|
| Returns |
| Type |
Description |
String |
|
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) = { ... }
| Returns |
| Type |
Description |
String |
The model.
|
public 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) = { ... }
| Returns |
| Type |
Description |
ByteString |
The bytes for model.
|
public Parser<GeminiExample> getParserForType()
Overrides
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
int |
|
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];
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1beta1.SafetySettingOrBuilder> |
|
public int getSerializedSize()
| Returns |
| Type |
Description |
int |
|
Overrides
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];
| Returns |
| Type |
Description |
Content |
The systemInstruction.
|
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];
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];
| Returns |
| Type |
Description |
ToolConfig |
The toolConfig.
|
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];
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];
| Parameter |
| Name |
Description |
index |
int
|
| Returns |
| Type |
Description |
Tool |
|
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];
| Returns |
| Type |
Description |
int |
|
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];
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];
| Parameter |
| Name |
Description |
index |
int
|
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];
| Returns |
| Type |
Description |
List<? extends com.google.cloud.aiplatform.v1beta1.ToolOrBuilder> |
|
public boolean hasGenerationConfig()
Optional. Generation config.
.google.cloud.aiplatform.v1beta1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];
| Returns |
| Type |
Description |
boolean |
Whether the generationConfig field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the systemInstruction field is set.
|
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];
| Returns |
| Type |
Description |
boolean |
Whether the toolConfig field is set.
|
| Returns |
| Type |
Description |
int |
|
Overrides
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Overrides
protected MapFieldReflectionAccessor internalGetMapFieldReflection(int number)
| Parameter |
| Name |
Description |
number |
int
|
| Returns |
| Type |
Description |
com.google.protobuf.MapFieldReflectionAccessor |
|
Overrides
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
public final boolean isInitialized()
Overrides
public GeminiExample.Builder newBuilderForType()
protected GeminiExample.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Overrides
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
| Returns |
| Type |
Description |
Object |
|
Overrides
public GeminiExample.Builder toBuilder()
public void writeTo(CodedOutputStream output)
Overrides
