com.google.cloud.aiplatform.v1

Interface GenerateContentRequestOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

GenerateContentRequest, GenerateContentRequest.Builder

public interface GenerateContentRequestOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
boolean	containsLabels(String key) Optional.
String	getCachedContent() Optional.
com.google.protobuf.ByteString	getCachedContentBytes() Optional.
Content	getContents(int index) Required.
int	getContentsCount() Required.
List<Content>	getContentsList() Required.
ContentOrBuilder	getContentsOrBuilder(int index) Required.
List<? extends ContentOrBuilder>	getContentsOrBuilderList() Required.
GenerationConfig	getGenerationConfig() Optional.
GenerationConfigOrBuilder	getGenerationConfigOrBuilder() Optional.
Map<String,String>	getLabels() Deprecated.
int	getLabelsCount() Optional.
Map<String,String>	getLabelsMap() Optional.
String	getLabelsOrDefault(String key, String defaultValue) Optional.
String	getLabelsOrThrow(String key) Optional.
String	getModel() Required.
com.google.protobuf.ByteString	getModelBytes() Required.
SafetySetting	getSafetySettings(int index) Optional.
int	getSafetySettingsCount() Optional.
List<SafetySetting>	getSafetySettingsList() Optional.
SafetySettingOrBuilder	getSafetySettingsOrBuilder(int index) Optional.
List<? extends SafetySettingOrBuilder>	getSafetySettingsOrBuilderList() Optional.
Content	getSystemInstruction() Optional.
ContentOrBuilder	getSystemInstructionOrBuilder() Optional.
ToolConfig	getToolConfig() Optional.
ToolConfigOrBuilder	getToolConfigOrBuilder() Optional.
Tool	getTools(int index) Optional.
int	getToolsCount() Optional.
List<Tool>	getToolsList() Optional.
ToolOrBuilder	getToolsOrBuilder(int index) Optional.
List<? extends ToolOrBuilder>	getToolsOrBuilderList() Optional.
boolean	hasGenerationConfig() Optional.
boolean	hasSystemInstruction() Optional.
boolean	hasToolConfig() Optional.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

getModel

String getModel()

 Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Returns:

The model.

getModelBytes

com.google.protobuf.ByteString getModelBytes()

 Required. 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 = 5 [(.google.api.field_behavior) = REQUIRED];

Returns:

The bytes for model.

getContentsList

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.v1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];

getContents

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.v1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];

getContentsCount

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.v1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];

getContentsOrBuilderList

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.v1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];

getContentsOrBuilder

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.v1.Content contents = 2 [(.google.api.field_behavior) = REQUIRED];

hasSystemInstruction

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.v1.Content system_instruction = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the systemInstruction field is set.

getSystemInstruction

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.v1.Content system_instruction = 8 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The systemInstruction.

getSystemInstructionOrBuilder

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.v1.Content system_instruction = 8 [(.google.api.field_behavior) = OPTIONAL];

getCachedContent

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:

The cachedContent.

getCachedContentBytes

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) = { ... }

Returns:

The bytes for cachedContent.

getToolsList

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.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

getTools

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.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

getToolsCount

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.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

getToolsOrBuilderList

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.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

getToolsOrBuilder

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.v1.Tool tools = 6 [(.google.api.field_behavior) = OPTIONAL];

hasToolConfig

boolean hasToolConfig()

 Optional. Tool config. This config is shared for all tools provided in the
 request.
 

.google.cloud.aiplatform.v1.ToolConfig tool_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the toolConfig field is set.

getToolConfig

ToolConfig getToolConfig()

 Optional. Tool config. This config is shared for all tools provided in the
 request.
 

.google.cloud.aiplatform.v1.ToolConfig tool_config = 7 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The toolConfig.

getToolConfigOrBuilder

ToolConfigOrBuilder getToolConfigOrBuilder()

 Optional. Tool config. This config is shared for all tools provided in the
 request.
 

.google.cloud.aiplatform.v1.ToolConfig tool_config = 7 [(.google.api.field_behavior) = OPTIONAL];

getLabelsCount

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

containsLabels

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

getLabels

@Deprecated
Map<String,String> getLabels()

Deprecated.

Use getLabelsMap() instead.

getLabelsMap

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

getLabelsOrDefault

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

getLabelsOrThrow

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

getSafetySettingsList

List<SafetySetting> getSafetySettingsList()

 Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
 

repeated .google.cloud.aiplatform.v1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];

getSafetySettings

SafetySetting getSafetySettings(int index)

 Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
 

repeated .google.cloud.aiplatform.v1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];

getSafetySettingsCount

int getSafetySettingsCount()

 Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
 

repeated .google.cloud.aiplatform.v1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];

getSafetySettingsOrBuilderList

List<? extends SafetySettingOrBuilder> getSafetySettingsOrBuilderList()

 Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
 

repeated .google.cloud.aiplatform.v1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];

getSafetySettingsOrBuilder

SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)

 Optional. Per request settings for blocking unsafe content.
 Enforced on GenerateContentResponse.candidates.
 

repeated .google.cloud.aiplatform.v1.SafetySetting safety_settings = 3 [(.google.api.field_behavior) = OPTIONAL];

hasGenerationConfig

boolean hasGenerationConfig()

 Optional. Generation config.
 

.google.cloud.aiplatform.v1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

Whether the generationConfig field is set.

getGenerationConfig

GenerationConfig getGenerationConfig()

 Optional. Generation config.
 

.google.cloud.aiplatform.v1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The generationConfig.

getGenerationConfigOrBuilder

GenerationConfigOrBuilder getGenerationConfigOrBuilder()

 Optional. Generation config.
 

.google.cloud.aiplatform.v1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];