com.google.cloud.aiplatform.v1beta1

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
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.
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.
ToolConfig	getToolConfig() Tool config.
ToolConfigOrBuilder	getToolConfigOrBuilder() Tool config.
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	hasToolConfig() Tool config.

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 name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
 

string model = 5 [(.google.api.field_behavior) = REQUIRED];

Returns:

The model.

getModelBytes

com.google.protobuf.ByteString getModelBytes()

 Required. The name of the publisher model requested to serve the
 prediction. Format:
 `projects/{project}/locations/{location}/publishers/*/models/*`
 

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

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

hasToolConfig

boolean hasToolConfig()

 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:

Whether the toolConfig field is set.

getToolConfig

ToolConfig getToolConfig()

 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:

The toolConfig.

getToolConfigOrBuilder

ToolConfigOrBuilder getToolConfigOrBuilder()

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

getSafetySettingsList

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

getSafetySettings

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

getSafetySettingsCount

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

getSafetySettingsOrBuilderList

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

getSafetySettingsOrBuilder

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

hasGenerationConfig

boolean hasGenerationConfig()

 Optional. Generation config.
 

.google.cloud.aiplatform.v1beta1.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.v1beta1.GenerationConfig generation_config = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns:

The generationConfig.

getGenerationConfigOrBuilder

GenerationConfigOrBuilder getGenerationConfigOrBuilder()

 Optional. Generation config.
 

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