com.google.cloud.aiplatform.v1

Class GenerateContentRequest

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.aiplatform.v1.GenerateContentRequest

All Implemented Interfaces:

GenerateContentRequestOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable

public final class GenerateContentRequest
extends com.google.protobuf.GeneratedMessageV3
implements GenerateContentRequestOrBuilder

 Request message for [PredictionService.GenerateContent].
 

Protobuf type google.cloud.aiplatform.v1.GenerateContentRequest

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GenerateContentRequest.Builder Request message for [PredictionService.GenerateContent].

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	CONTENTS_FIELD_NUMBER
static int	GENERATION_CONFIG_FIELD_NUMBER
static int	MODEL_FIELD_NUMBER
static int	SAFETY_SETTINGS_FIELD_NUMBER
static int	SYSTEM_INSTRUCTION_FIELD_NUMBER
static int	TOOLS_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Content	getContents(int index) Required.
int	getContentsCount() Required.
List<Content>	getContentsList() Required.
ContentOrBuilder	getContentsOrBuilder(int index) Required.
List<? extends ContentOrBuilder>	getContentsOrBuilderList() Required.
static GenerateContentRequest	getDefaultInstance()
GenerateContentRequest	getDefaultInstanceForType()
static com.google.protobuf.Descriptors.Descriptor	getDescriptor()
GenerationConfig	getGenerationConfig() Optional.
GenerationConfigOrBuilder	getGenerationConfigOrBuilder() Optional.
String	getModel() Required.
com.google.protobuf.ByteString	getModelBytes() Required.
com.google.protobuf.Parser<GenerateContentRequest>	getParserForType()
SafetySetting	getSafetySettings(int index) Optional.
int	getSafetySettingsCount() Optional.
List<SafetySetting>	getSafetySettingsList() Optional.
SafetySettingOrBuilder	getSafetySettingsOrBuilder(int index) Optional.
List<? extends SafetySettingOrBuilder>	getSafetySettingsOrBuilderList() Optional.
int	getSerializedSize()
Content	getSystemInstruction() Optional.
ContentOrBuilder	getSystemInstructionOrBuilder() 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.
int	hashCode()
boolean	hasSystemInstruction() Optional.
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static GenerateContentRequest.Builder	newBuilder()
static GenerateContentRequest.Builder	newBuilder(GenerateContentRequest prototype)
GenerateContentRequest.Builder	newBuilderForType()
protected GenerateContentRequest.Builder	newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
static GenerateContentRequest	parseDelimitedFrom(InputStream input)
static GenerateContentRequest	parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentRequest	parseFrom(byte[] data)
static GenerateContentRequest	parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentRequest	parseFrom(ByteBuffer data)
static GenerateContentRequest	parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentRequest	parseFrom(com.google.protobuf.ByteString data)
static GenerateContentRequest	parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentRequest	parseFrom(com.google.protobuf.CodedInputStream input)
static GenerateContentRequest	parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static GenerateContentRequest	parseFrom(InputStream input)
static GenerateContentRequest	parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
static com.google.protobuf.Parser<GenerateContentRequest>	parser()
GenerateContentRequest.Builder	toBuilder()
void	writeTo(com.google.protobuf.CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER

See Also:

Constant Field Values

CONTENTS_FIELD_NUMBER

public static final int CONTENTS_FIELD_NUMBER

See Also:

Constant Field Values

SYSTEM_INSTRUCTION_FIELD_NUMBER

public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER

See Also:

Constant Field Values

TOOLS_FIELD_NUMBER

public static final int TOOLS_FIELD_NUMBER

See Also:

Constant Field Values

SAFETY_SETTINGS_FIELD_NUMBER

public static final int SAFETY_SETTINGS_FIELD_NUMBER

See Also:

Constant Field Values

GENERATION_CONFIG_FIELD_NUMBER

public static final int GENERATION_CONFIG_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class com.google.protobuf.GeneratedMessageV3

getDescriptor

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

internalGetFieldAccessorTable

protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

getModel

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

Specified by:

getModel in interface GenerateContentRequestOrBuilder

Returns:

The model.

getModelBytes

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

Specified by:

getModelBytes in interface GenerateContentRequestOrBuilder

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

Specified by:

getContentsList in interface GenerateContentRequestOrBuilder

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

Specified by:

getContentsOrBuilderList in interface GenerateContentRequestOrBuilder

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

Specified by:

getContentsCount in interface GenerateContentRequestOrBuilder

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

Specified by:

getContents in interface GenerateContentRequestOrBuilder

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

Specified by:

getContentsOrBuilder in interface GenerateContentRequestOrBuilder

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

Specified by:

hasSystemInstruction in interface GenerateContentRequestOrBuilder

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

Specified by:

getSystemInstruction in interface GenerateContentRequestOrBuilder

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

Specified by:

getSystemInstructionOrBuilder in interface GenerateContentRequestOrBuilder

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

Specified by:

getToolsList in interface GenerateContentRequestOrBuilder

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

Specified by:

getToolsOrBuilderList in interface GenerateContentRequestOrBuilder

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

Specified by:

getToolsCount in interface GenerateContentRequestOrBuilder

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

Specified by:

getTools in interface GenerateContentRequestOrBuilder

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

Specified by:

getToolsOrBuilder in interface GenerateContentRequestOrBuilder

getSafetySettingsList

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

Specified by:

getSafetySettingsList in interface GenerateContentRequestOrBuilder

getSafetySettingsOrBuilderList

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

Specified by:

getSafetySettingsOrBuilderList in interface GenerateContentRequestOrBuilder

getSafetySettingsCount

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

Specified by:

getSafetySettingsCount in interface GenerateContentRequestOrBuilder

getSafetySettings

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

Specified by:

getSafetySettings in interface GenerateContentRequestOrBuilder

getSafetySettingsOrBuilder

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

Specified by:

getSafetySettingsOrBuilder in interface GenerateContentRequestOrBuilder

hasGenerationConfig

public boolean hasGenerationConfig()

 Optional. Generation config.
 

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

Specified by:

hasGenerationConfig in interface GenerateContentRequestOrBuilder

Returns:

Whether the generationConfig field is set.

getGenerationConfig

public GenerationConfig getGenerationConfig()

 Optional. Generation config.
 

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

Specified by:

getGenerationConfig in interface GenerateContentRequestOrBuilder

Returns:

The generationConfig.

getGenerationConfigOrBuilder

public GenerationConfigOrBuilder getGenerationConfigOrBuilder()

 Optional. Generation config.
 

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

Specified by:

getGenerationConfigOrBuilder in interface GenerateContentRequestOrBuilder

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessageV3

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.GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface com.google.protobuf.MessageLite

Overrides:

getSerializedSize in class com.google.protobuf.GeneratedMessageV3

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 GenerateContentRequest parseFrom(ByteBuffer data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentRequest parseFrom(com.google.protobuf.ByteString data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentRequest parseFrom(byte[] data)
                                        throws com.google.protobuf.InvalidProtocolBufferException

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

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

Throws:

com.google.protobuf.InvalidProtocolBufferException

parseFrom

public static GenerateContentRequest parseFrom(InputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

parseDelimitedFrom

public static GenerateContentRequest parseDelimitedFrom(InputStream input)
                                                 throws IOException

Throws:

IOException

parseDelimitedFrom

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

Throws:

IOException

parseFrom

public static GenerateContentRequest parseFrom(com.google.protobuf.CodedInputStream input)
                                        throws IOException

Throws:

IOException

parseFrom

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

Throws:

IOException

newBuilderForType

public GenerateContentRequest.Builder newBuilderForType()

Specified by:

newBuilderForType in interface com.google.protobuf.Message

Specified by:

newBuilderForType in interface com.google.protobuf.MessageLite

newBuilder

public static GenerateContentRequest.Builder newBuilder()

newBuilder

public static GenerateContentRequest.Builder newBuilder(GenerateContentRequest prototype)

toBuilder

public GenerateContentRequest.Builder toBuilder()

Specified by:

toBuilder in interface com.google.protobuf.Message

Specified by:

toBuilder in interface com.google.protobuf.MessageLite

newBuilderForType

protected GenerateContentRequest.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class com.google.protobuf.GeneratedMessageV3

getDefaultInstance

public static GenerateContentRequest getDefaultInstance()

parser

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

getParserForType

public com.google.protobuf.Parser<GenerateContentRequest> 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.GeneratedMessageV3

getDefaultInstanceForType

public GenerateContentRequest getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder