Class GenerateGroundedContentRequest.GenerationSpec.Builder (0.49.0)

Version 0.49.0

• 0.50.0 (latest)
• 0.49.0
• 0.48.0
• 0.47.0
• 0.45.0
• 0.44.0
• 0.43.0
• 0.42.0
• 0.41.0
• 0.40.0
• 0.39.0
• 0.38.0
• 0.37.0
• 0.36.0
• 0.35.0
• 0.33.0
• 0.32.0
• 0.31.0
• 0.30.0
• 0.29.0
• 0.28.0
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.20.0
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.0
• 0.14.0
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.0
• 0.7.0
• 0.5.0
• 0.4.0
• 0.3.0
• 0.2.0
• 0.1.0

public static final class GenerateGroundedContentRequest.GenerationSpec.Builder extends GeneratedMessageV3.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder> implements GenerateGroundedContentRequest.GenerationSpecOrBuilder

Content generation specification.

Protobuf type google.cloud.discoveryengine.v1.GenerateGroundedContentRequest.GenerationSpec

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > GenerateGroundedContentRequest.GenerationSpec.Builder

Implements

GenerateGroundedContentRequest.GenerationSpecOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

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

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

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

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

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public GenerateGroundedContentRequest.GenerationSpec.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public GenerateGroundedContentRequest.GenerationSpec build()

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec

buildPartial()

public GenerateGroundedContentRequest.GenerationSpec buildPartial()

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec

clear()

public GenerateGroundedContentRequest.GenerationSpec.Builder clear()

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public GenerateGroundedContentRequest.GenerationSpec.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearFrequencyPenalty()

public GenerateGroundedContentRequest.GenerationSpec.Builder clearFrequencyPenalty()

If specified, custom value for frequency penalty will be used.

optional float frequency_penalty = 8;

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

clearLanguageCode()

public GenerateGroundedContentRequest.GenerationSpec.Builder clearLanguageCode()

Language code for content. Use language tags defined by BCP47.

string language_code = 2;

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

clearMaxOutputTokens()

public GenerateGroundedContentRequest.GenerationSpec.Builder clearMaxOutputTokens()

If specified, custom value for max output tokens will be used.

optional int32 max_output_tokens = 10;

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

clearModelId()

public GenerateGroundedContentRequest.GenerationSpec.Builder clearModelId()

Specifies which Vertex model id to use for generation.

string model_id = 3;

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public GenerateGroundedContentRequest.GenerationSpec.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPresencePenalty()

public GenerateGroundedContentRequest.GenerationSpec.Builder clearPresencePenalty()

If specified, custom value for presence penalty will be used.

optional float presence_penalty = 9;

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

clearTemperature()

public GenerateGroundedContentRequest.GenerationSpec.Builder clearTemperature()

If specified, custom value for the temperature will be used.

optional float temperature = 4;

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

clearTopK()

public GenerateGroundedContentRequest.GenerationSpec.Builder clearTopK()

If specified, custom value for top-k sampling will be used.

optional int32 top_k = 7;

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

clearTopP()

public GenerateGroundedContentRequest.GenerationSpec.Builder clearTopP()

If specified, custom value for nucleus sampling will be used.

optional float top_p = 5;

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

clone()

public GenerateGroundedContentRequest.GenerationSpec.Builder clone()

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public GenerateGroundedContentRequest.GenerationSpec getDefaultInstanceForType()

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getFrequencyPenalty()

public float getFrequencyPenalty()

If specified, custom value for frequency penalty will be used.

optional float frequency_penalty = 8;

Returns
Type	Description
float	The frequencyPenalty.

getLanguageCode()

public String getLanguageCode()

Language code for content. Use language tags defined by BCP47.

string language_code = 2;

Returns
Type	Description
String	The languageCode.

getLanguageCodeBytes()

public ByteString getLanguageCodeBytes()

Language code for content. Use language tags defined by BCP47.

string language_code = 2;

Returns
Type	Description
ByteString	The bytes for languageCode.

getMaxOutputTokens()

public int getMaxOutputTokens()

If specified, custom value for max output tokens will be used.

optional int32 max_output_tokens = 10;

Returns
Type	Description
int	The maxOutputTokens.

getModelId()

public String getModelId()

Specifies which Vertex model id to use for generation.

string model_id = 3;

Returns
Type	Description
String	The modelId.

getModelIdBytes()

public ByteString getModelIdBytes()

Specifies which Vertex model id to use for generation.

string model_id = 3;

Returns
Type	Description
ByteString	The bytes for modelId.

getPresencePenalty()

public float getPresencePenalty()

If specified, custom value for presence penalty will be used.

optional float presence_penalty = 9;

Returns
Type	Description
float	The presencePenalty.

getTemperature()

public float getTemperature()

If specified, custom value for the temperature will be used.

optional float temperature = 4;

Returns
Type	Description
float	The temperature.

getTopK()

public int getTopK()

If specified, custom value for top-k sampling will be used.

optional int32 top_k = 7;

Returns
Type	Description
int	The topK.

getTopP()

public float getTopP()

If specified, custom value for nucleus sampling will be used.

optional float top_p = 5;

Returns
Type	Description
float	The topP.

hasFrequencyPenalty()

public boolean hasFrequencyPenalty()

If specified, custom value for frequency penalty will be used.

optional float frequency_penalty = 8;

Returns
Type	Description
boolean	Whether the frequencyPenalty field is set.

hasMaxOutputTokens()

public boolean hasMaxOutputTokens()

If specified, custom value for max output tokens will be used.

optional int32 max_output_tokens = 10;

Returns
Type	Description
boolean	Whether the maxOutputTokens field is set.

hasPresencePenalty()

public boolean hasPresencePenalty()

If specified, custom value for presence penalty will be used.

optional float presence_penalty = 9;

Returns
Type	Description
boolean	Whether the presencePenalty field is set.

hasTemperature()

public boolean hasTemperature()

If specified, custom value for the temperature will be used.

optional float temperature = 4;

Returns
Type	Description
boolean	Whether the temperature field is set.

hasTopK()

public boolean hasTopK()

If specified, custom value for top-k sampling will be used.

optional int32 top_k = 7;

Returns
Type	Description
boolean	Whether the topK field is set.

hasTopP()

public boolean hasTopP()

If specified, custom value for nucleus sampling will be used.

optional float top_p = 5;

Returns
Type	Description
boolean	Whether the topP field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(GenerateGroundedContentRequest.GenerationSpec other)

public GenerateGroundedContentRequest.GenerationSpec.Builder mergeFrom(GenerateGroundedContentRequest.GenerationSpec other)

Parameter
Name	Description
other	GenerateGroundedContentRequest.GenerationSpec

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public GenerateGroundedContentRequest.GenerationSpec.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public GenerateGroundedContentRequest.GenerationSpec.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final GenerateGroundedContentRequest.GenerationSpec.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setFrequencyPenalty(float value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setFrequencyPenalty(float value)

If specified, custom value for frequency penalty will be used.

optional float frequency_penalty = 8;

Parameter
Name	Description
value	float The frequencyPenalty to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setLanguageCode(String value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setLanguageCode(String value)

Language code for content. Use language tags defined by BCP47.

string language_code = 2;

Parameter
Name	Description
value	String The languageCode to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setLanguageCodeBytes(ByteString value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setLanguageCodeBytes(ByteString value)

Language code for content. Use language tags defined by BCP47.

string language_code = 2;

Parameter
Name	Description
value	ByteString The bytes for languageCode to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setMaxOutputTokens(int value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setMaxOutputTokens(int value)

If specified, custom value for max output tokens will be used.

optional int32 max_output_tokens = 10;

Parameter
Name	Description
value	int The maxOutputTokens to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setModelId(String value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setModelId(String value)

Specifies which Vertex model id to use for generation.

string model_id = 3;

Parameter
Name	Description
value	String The modelId to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setModelIdBytes(ByteString value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setModelIdBytes(ByteString value)

Specifies which Vertex model id to use for generation.

string model_id = 3;

Parameter
Name	Description
value	ByteString The bytes for modelId to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setPresencePenalty(float value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setPresencePenalty(float value)

If specified, custom value for presence penalty will be used.

optional float presence_penalty = 9;

Parameter
Name	Description
value	float The presencePenalty to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setTemperature(float value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setTemperature(float value)

If specified, custom value for the temperature will be used.

optional float temperature = 4;

Parameter
Name	Description
value	float The temperature to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setTopK(int value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setTopK(int value)

If specified, custom value for top-k sampling will be used.

optional int32 top_k = 7;

Parameter
Name	Description
value	int The topK to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setTopP(float value)

public GenerateGroundedContentRequest.GenerationSpec.Builder setTopP(float value)

If specified, custom value for nucleus sampling will be used.

optional float top_p = 5;

Parameter
Name	Description
value	float The topP to set.

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final GenerateGroundedContentRequest.GenerationSpec.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
GenerateGroundedContentRequest.GenerationSpec.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)