Class GenerateContentRequest (0.2.0)

public final class GenerateContentRequest extends GeneratedMessageV3 implements GenerateContentRequestOrBuilder

Request message for [PredictionService.GenerateContent].

Protobuf type google.cloud.vertexai.v1beta1.GenerateContentRequest

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > GenerateContentRequest

Implements

GenerateContentRequestOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashBoolean(boolean)

AbstractMessage.hashCode()

AbstractMessage.hashEnum(Internal.EnumLite)

AbstractMessage.hashEnumList(List<? extends Internal.EnumLite>)

AbstractMessage.hashFields(int,Map<Descriptors.FieldDescriptor,Object>)

AbstractMessage.hashLong(long)

AbstractMessage.toString()

AbstractMessageLite.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)

com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseDelimitedWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream)

GeneratedMessageV3.<M>parseWithIOException(Parser<M>,InputStream,ExtensionRegistryLite)

com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)

GeneratedMessageV3.<V>serializeBooleanMapTo(CodedOutputStream,MapField<Boolean,V>,MapEntry<Boolean,V>,int)

GeneratedMessageV3.<V>serializeIntegerMapTo(CodedOutputStream,MapField<Integer,V>,MapEntry<Integer,V>,int)

GeneratedMessageV3.<V>serializeLongMapTo(CodedOutputStream,MapField<Long,V>,MapEntry<Long,V>,int)

GeneratedMessageV3.<V>serializeStringMapTo(CodedOutputStream,MapField<String,V>,MapEntry<String,V>,int)

GeneratedMessageV3.canUseUnsafe()

GeneratedMessageV3.computeStringSize(int,Object)

GeneratedMessageV3.computeStringSizeNoTag(Object)

GeneratedMessageV3.emptyBooleanList()

GeneratedMessageV3.emptyDoubleList()

GeneratedMessageV3.emptyFloatList()

GeneratedMessageV3.emptyIntList()

GeneratedMessageV3.emptyLongList()

GeneratedMessageV3.getAllFields()

GeneratedMessageV3.getDescriptorForType()

GeneratedMessageV3.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.getParserForType()

GeneratedMessageV3.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessageV3.getSerializedSize()

GeneratedMessageV3.getUnknownFields()

GeneratedMessageV3.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.internalGetFieldAccessorTable()

GeneratedMessageV3.internalGetMapField(int)

com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)

GeneratedMessageV3.isInitialized()

GeneratedMessageV3.isStringEmpty(Object)

GeneratedMessageV3.makeExtensionsImmutable()

GeneratedMessageV3.mergeFromAndMakeImmutableInternal(CodedInputStream,ExtensionRegistryLite)

GeneratedMessageV3.mutableCopy(Internal.BooleanList)

GeneratedMessageV3.mutableCopy(Internal.DoubleList)

GeneratedMessageV3.mutableCopy(Internal.FloatList)

GeneratedMessageV3.mutableCopy(Internal.IntList)

GeneratedMessageV3.mutableCopy(Internal.LongList)

GeneratedMessageV3.newBooleanList()

GeneratedMessageV3.newBuilderForType(AbstractMessage.BuilderParent)

GeneratedMessageV3.newBuilderForType(GeneratedMessageV3.BuilderParent)

GeneratedMessageV3.newDoubleList()

GeneratedMessageV3.newFloatList()

GeneratedMessageV3.newInstance(GeneratedMessageV3.UnusedPrivateParameter)

GeneratedMessageV3.newIntList()

GeneratedMessageV3.newLongList()

GeneratedMessageV3.parseUnknownField(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.parseUnknownFieldProto3(CodedInputStream,UnknownFieldSet.Builder,ExtensionRegistryLite,int)

GeneratedMessageV3.writeReplace()

GeneratedMessageV3.writeString(CodedOutputStream,int,Object)

GeneratedMessageV3.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessageV3.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

CONTENTS_FIELD_NUMBER

public static final int CONTENTS_FIELD_NUMBER

Field Value
Type	Description
`int`

ENDPOINT_FIELD_NUMBER

public static final int ENDPOINT_FIELD_NUMBER

Field Value
Type	Description
`int`

GENERATION_CONFIG_FIELD_NUMBER

public static final int GENERATION_CONFIG_FIELD_NUMBER

Field Value
Type	Description
`int`

MODEL_FIELD_NUMBER

public static final int MODEL_FIELD_NUMBER

Field Value
Type	Description
`int`

SAFETY_SETTINGS_FIELD_NUMBER

public static final int SAFETY_SETTINGS_FIELD_NUMBER

Field Value
Type	Description
`int`

TOOLS_FIELD_NUMBER

public static final int TOOLS_FIELD_NUMBER

Field Value
Type	Description
`int`

Static Methods

getDefaultInstance()

public static GenerateContentRequest getDefaultInstance()

Returns
Type	Description
`GenerateContentRequest`

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
`Descriptor`

newBuilder()

public static GenerateContentRequest.Builder newBuilder()

Returns
Type	Description
`GenerateContentRequest.Builder`

newBuilder(GenerateContentRequest prototype)

public static GenerateContentRequest.Builder newBuilder(GenerateContentRequest prototype)

Parameter
Name	Description
`prototype`	`GenerateContentRequest`

Returns
Type	Description
`GenerateContentRequest.Builder`

parseDelimitedFrom(InputStream input)

public static GenerateContentRequest parseDelimitedFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`IOException`

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateContentRequest parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`IOException`

parseFrom(byte[] data)

public static GenerateContentRequest parseFrom(byte[] data)

Parameter
Name	Description
`data`	`byte[]`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static GenerateContentRequest parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`byte[]`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data)

public static GenerateContentRequest parseFrom(ByteString data)

Parameter
Name	Description
`data`	`ByteString`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static GenerateContentRequest parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteString`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(CodedInputStream input)

public static GenerateContentRequest parseFrom(CodedInputStream input)

Parameter
Name	Description
`input`	`CodedInputStream`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`IOException`

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateContentRequest parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`CodedInputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input)

public static GenerateContentRequest parseFrom(InputStream input)

Parameter
Name	Description
`input`	`InputStream`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`IOException`

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static GenerateContentRequest parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`input`	`InputStream`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`IOException`

parseFrom(ByteBuffer data)

public static GenerateContentRequest parseFrom(ByteBuffer data)

Parameter
Name	Description
`data`	`ByteBuffer`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static GenerateContentRequest parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
`data`	`ByteBuffer`
`extensionRegistry`	`ExtensionRegistryLite`

Returns
Type	Description
`GenerateContentRequest`

Exceptions
Type	Description
`InvalidProtocolBufferException`

parser()

public static Parser<GenerateContentRequest> parser()

Returns
Type	Description
`Parser<GenerateContentRequest>`

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
`obj`	`Object`

Returns
Type	Description
`boolean`

Overrides

AbstractMessage.equals(Object other)

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`Content`

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

Returns
Type	Description
`List<Content>`

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`ContentOrBuilder`

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

Returns
Type	Description
`List<? extends com.google.cloud.vertexai.api.ContentOrBuilder>`

getDefaultInstanceForType()

public GenerateContentRequest getDefaultInstanceForType()

Returns
Type	Description
`GenerateContentRequest`

getEndpoint()

public String getEndpoint()

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`String`	The endpoint.

getEndpointBytes()

public ByteString getEndpointBytes()

Required. The name of the Endpoint requested to serve the prediction. Format: projects/{project}/locations/{location}/endpoints/{endpoint}

string endpoint = 1 [(.google.api.field_behavior) = REQUIRED, (.google.api.resource_reference) = { ... }

Returns
Type	Description
`ByteString`	The bytes for endpoint.

getGenerationConfig()

public GenerationConfig getGenerationConfig()

Optional. Generation config.

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

Returns
Type	Description
`GenerationConfig`	The generationConfig.

getGenerationConfigOrBuilder()

public GenerationConfigOrBuilder getGenerationConfigOrBuilder()

Optional. Generation config.

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

Returns
Type	Description
`GenerationConfigOrBuilder`

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

Returns
Type	Description
`String`	The model.

getModelBytes()

public 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
Type	Description
`ByteString`	The bytes for model.

getParserForType()

public Parser<GenerateContentRequest> getParserForType()

Returns
Type	Description
`Parser<GenerateContentRequest>`

Overrides

GeneratedMessageV3.getParserForType()

getSafetySettings(int index)

public SafetySetting getSafetySettings(int index)

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SafetySetting`

getSafetySettingsCount()

public int getSafetySettingsCount()

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

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

Returns
Type	Description
`int`

getSafetySettingsList()

public List<SafetySetting> getSafetySettingsList()

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

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

Returns
Type	Description
`List<SafetySetting>`

getSafetySettingsOrBuilder(int index)

public SafetySettingOrBuilder getSafetySettingsOrBuilder(int index)

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

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

Parameter
Name	Description
`index`	`int`

Returns
Type	Description
`SafetySettingOrBuilder`

getSafetySettingsOrBuilderList()

public List<? extends SafetySettingOrBuilder> getSafetySettingsOrBuilderList()

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

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

Returns
Type	Description
`List<? extends com.google.cloud.vertexai.api.SafetySettingOrBuilder>`

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
`int`

Overrides

GeneratedMessageV3.getSerializedSize()

getTools(int index)

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. The only supported tool is currently Function