Package com.google.cloud.discoveryengine.v1beta

Class GenerateGroundedContentRequest.GenerationSpec.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderT>

com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder>

com.google.cloud.discoveryengine.v1beta.GenerateGroundedContentRequest.GenerationSpec.Builder

All Implemented Interfaces:

GenerateGroundedContentRequest.GenerationSpecOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

GenerateGroundedContentRequest.GenerationSpec

public static final class GenerateGroundedContentRequest.GenerationSpec.Builder
extends com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder>
implements GenerateGroundedContentRequest.GenerationSpecOrBuilder

 Content generation specification.
 

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

Method Summary

Modifier and Type	Method	Description
GenerateGroundedContentRequest.GenerationSpec	build()
GenerateGroundedContentRequest.GenerationSpec	buildPartial()
GenerateGroundedContentRequest.GenerationSpec.Builder	clear()
GenerateGroundedContentRequest.GenerationSpec.Builder	clearFrequencyPenalty()	If specified, custom value for frequency penalty will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	clearLanguageCode()	Language code for content.
GenerateGroundedContentRequest.GenerationSpec.Builder	clearMaxOutputTokens()	If specified, custom value for max output tokens will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	clearModelId()	Specifies which Vertex model id to use for generation.
GenerateGroundedContentRequest.GenerationSpec.Builder	clearPresencePenalty()	If specified, custom value for presence penalty will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	clearTemperature()	If specified, custom value for the temperature will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	clearTopK()	If specified, custom value for top-k sampling will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	clearTopP()	If specified, custom value for nucleus sampling will be used.
GenerateGroundedContentRequest.GenerationSpec	getDefaultInstanceForType()
static final com.google.protobuf.Descriptors.Descriptor	getDescriptor()
com.google.protobuf.Descriptors.Descriptor	getDescriptorForType()
float	getFrequencyPenalty()	If specified, custom value for frequency penalty will be used.
String	getLanguageCode()	Language code for content.
com.google.protobuf.ByteString	getLanguageCodeBytes()	Language code for content.
int	getMaxOutputTokens()	If specified, custom value for max output tokens will be used.
String	getModelId()	Specifies which Vertex model id to use for generation.
com.google.protobuf.ByteString	getModelIdBytes()	Specifies which Vertex model id to use for generation.
float	getPresencePenalty()	If specified, custom value for presence penalty will be used.
float	getTemperature()	If specified, custom value for the temperature will be used.
int	getTopK()	If specified, custom value for top-k sampling will be used.
float	getTopP()	If specified, custom value for nucleus sampling will be used.
boolean	hasFrequencyPenalty()	If specified, custom value for frequency penalty will be used.
boolean	hasMaxOutputTokens()	If specified, custom value for max output tokens will be used.
boolean	hasPresencePenalty()	If specified, custom value for presence penalty will be used.
boolean	hasTemperature()	If specified, custom value for the temperature will be used.
boolean	hasTopK()	If specified, custom value for top-k sampling will be used.
boolean	hasTopP()	If specified, custom value for nucleus sampling will be used.
protected com.google.protobuf.GeneratedMessage.FieldAccessorTable	internalGetFieldAccessorTable()
final boolean	isInitialized()
GenerateGroundedContentRequest.GenerationSpec.Builder	mergeFrom(GenerateGroundedContentRequest.GenerationSpec other)
GenerateGroundedContentRequest.GenerationSpec.Builder	mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
GenerateGroundedContentRequest.GenerationSpec.Builder	mergeFrom(com.google.protobuf.Message other)
GenerateGroundedContentRequest.GenerationSpec.Builder	setFrequencyPenalty(float value)	If specified, custom value for frequency penalty will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	setLanguageCode(String value)	Language code for content.
GenerateGroundedContentRequest.GenerationSpec.Builder	setLanguageCodeBytes(com.google.protobuf.ByteString value)	Language code for content.
GenerateGroundedContentRequest.GenerationSpec.Builder	setMaxOutputTokens(int value)	If specified, custom value for max output tokens will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	setModelId(String value)	Specifies which Vertex model id to use for generation.
GenerateGroundedContentRequest.GenerationSpec.Builder	setModelIdBytes(com.google.protobuf.ByteString value)	Specifies which Vertex model id to use for generation.
GenerateGroundedContentRequest.GenerationSpec.Builder	setPresencePenalty(float value)	If specified, custom value for presence penalty will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	setTemperature(float value)	If specified, custom value for the temperature will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	setTopK(int value)	If specified, custom value for top-k sampling will be used.
GenerateGroundedContentRequest.GenerationSpec.Builder	setTopP(float value)	If specified, custom value for nucleus sampling will be used.

Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.Message.Builder

mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder

mergeFrom

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Method Details

getDescriptor

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

internalGetFieldAccessorTable

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

Specified by:

internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder>

clear

public GenerateGroundedContentRequest.GenerationSpec.Builder clear()

Specified by:

clear in interface com.google.protobuf.Message.Builder

Specified by:

clear in interface com.google.protobuf.MessageLite.Builder

Overrides:

clear in class com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder>

getDescriptorForType

public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.Message.Builder

Specified by:

getDescriptorForType in interface com.google.protobuf.MessageOrBuilder

Overrides:

getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder>

getDefaultInstanceForType

public GenerateGroundedContentRequest.GenerationSpec getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder

build

public GenerateGroundedContentRequest.GenerationSpec build()

Specified by:

build in interface com.google.protobuf.Message.Builder

Specified by:

build in interface com.google.protobuf.MessageLite.Builder

buildPartial

public GenerateGroundedContentRequest.GenerationSpec buildPartial()

Specified by:

buildPartial in interface com.google.protobuf.Message.Builder

Specified by:

buildPartial in interface com.google.protobuf.MessageLite.Builder

mergeFrom

public GenerateGroundedContentRequest.GenerationSpec.Builder mergeFrom(com.google.protobuf.Message other)

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder>

mergeFrom

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

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface com.google.protobuf.MessageLiteOrBuilder

Overrides:

isInitialized in class com.google.protobuf.GeneratedMessage.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder>

mergeFrom

public GenerateGroundedContentRequest.GenerationSpec.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                                                throws IOException

Specified by:

mergeFrom in interface com.google.protobuf.Message.Builder

Specified by:

mergeFrom in interface com.google.protobuf.MessageLite.Builder

Overrides:

mergeFrom in class com.google.protobuf.AbstractMessage.Builder<GenerateGroundedContentRequest.GenerationSpec.Builder>

Throws:

IOException

getModelId

public String getModelId()

 Specifies which Vertex model id to use for generation.
 

string model_id = 3;

Specified by:

getModelId in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The modelId.

getModelIdBytes

public com.google.protobuf.ByteString getModelIdBytes()

 Specifies which Vertex model id to use for generation.
 

string model_id = 3;

Specified by:

getModelIdBytes in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The bytes for modelId.

setModelId

public GenerateGroundedContentRequest.GenerationSpec.Builder setModelId(String value)

 Specifies which Vertex model id to use for generation.
 

string model_id = 3;

Parameters:

value - The modelId to set.

Returns:

This builder for chaining.

clearModelId

public GenerateGroundedContentRequest.GenerationSpec.Builder clearModelId()

 Specifies which Vertex model id to use for generation.
 

string model_id = 3;

Returns:

This builder for chaining.

setModelIdBytes

public GenerateGroundedContentRequest.GenerationSpec.Builder setModelIdBytes(com.google.protobuf.ByteString value)

 Specifies which Vertex model id to use for generation.
 

string model_id = 3;

Parameters:

value - The bytes for modelId to set.

Returns:

This builder for chaining.

getLanguageCode

public String getLanguageCode()

 Language code for content. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 

string language_code = 2;

Specified by:

getLanguageCode in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The languageCode.

getLanguageCodeBytes

public com.google.protobuf.ByteString getLanguageCodeBytes()

 Language code for content. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 

string language_code = 2;

Specified by:

getLanguageCodeBytes in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The bytes for languageCode.

setLanguageCode

public GenerateGroundedContentRequest.GenerationSpec.Builder setLanguageCode(String value)

 Language code for content. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 

string language_code = 2;

Parameters:

value - The languageCode to set.

Returns:

This builder for chaining.

clearLanguageCode

public GenerateGroundedContentRequest.GenerationSpec.Builder clearLanguageCode()

 Language code for content. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 

string language_code = 2;

Returns:

This builder for chaining.

setLanguageCodeBytes

public GenerateGroundedContentRequest.GenerationSpec.Builder setLanguageCodeBytes(com.google.protobuf.ByteString value)

 Language code for content. Use language tags defined by
 [BCP47](https://www.rfc-editor.org/rfc/bcp/bcp47.txt).
 

string language_code = 2;

Parameters:

value - The bytes for languageCode to set.

Returns:

This builder for chaining.

hasTemperature

public boolean hasTemperature()

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

optional float temperature = 4;

Specified by:

hasTemperature in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

Whether the temperature field is set.

getTemperature

public float getTemperature()

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

optional float temperature = 4;

Specified by:

getTemperature in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The temperature.

setTemperature

public GenerateGroundedContentRequest.GenerationSpec.Builder setTemperature(float value)

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

optional float temperature = 4;

Parameters:

value - The temperature to set.

Returns:

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:

This builder for chaining.

hasTopP

public boolean hasTopP()

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

optional float top_p = 5;

Specified by:

hasTopP in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

Whether the topP field is set.

getTopP

public float getTopP()

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

optional float top_p = 5;

Specified by:

getTopP in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The topP.

setTopP

public GenerateGroundedContentRequest.GenerationSpec.Builder setTopP(float value)

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

optional float top_p = 5;

Parameters:

value - The topP to set.

Returns:

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:

This builder for chaining.

hasTopK

public boolean hasTopK()

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

optional int32 top_k = 7;

Specified by:

hasTopK in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

Whether the topK field is set.

getTopK

public int getTopK()

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

optional int32 top_k = 7;

Specified by:

getTopK in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The topK.

setTopK

public GenerateGroundedContentRequest.GenerationSpec.Builder setTopK(int value)

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

optional int32 top_k = 7;

Parameters:

value - The topK to set.

Returns:

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:

This builder for chaining.

hasFrequencyPenalty

public boolean hasFrequencyPenalty()

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

optional float frequency_penalty = 8;

Specified by:

hasFrequencyPenalty in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

Whether the frequencyPenalty field is set.

getFrequencyPenalty

public float getFrequencyPenalty()

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

optional float frequency_penalty = 8;

Specified by:

getFrequencyPenalty in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The frequencyPenalty.

setFrequencyPenalty

public GenerateGroundedContentRequest.GenerationSpec.Builder setFrequencyPenalty(float value)

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

optional float frequency_penalty = 8;

Parameters:

value - The frequencyPenalty to set.

Returns:

This builder for chaining.

clearFrequencyPenalty

public GenerateGroundedContentRequest.GenerationSpec.Builder clearFrequencyPenalty()

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

optional float frequency_penalty = 8;

Returns:

This builder for chaining.

hasPresencePenalty

public boolean hasPresencePenalty()

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

optional float presence_penalty = 9;

Specified by:

hasPresencePenalty in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

Whether the presencePenalty field is set.

getPresencePenalty

public float getPresencePenalty()

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

optional float presence_penalty = 9;

Specified by:

getPresencePenalty in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The presencePenalty.

setPresencePenalty

public GenerateGroundedContentRequest.GenerationSpec.Builder setPresencePenalty(float value)

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

optional float presence_penalty = 9;

Parameters:

value - The presencePenalty to set.

Returns:

This builder for chaining.

clearPresencePenalty

public GenerateGroundedContentRequest.GenerationSpec.Builder clearPresencePenalty()

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

optional float presence_penalty = 9;

Returns:

This builder for chaining.

hasMaxOutputTokens

public boolean hasMaxOutputTokens()

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

optional int32 max_output_tokens = 10;

Specified by:

hasMaxOutputTokens in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

Whether the maxOutputTokens field is set.

getMaxOutputTokens

public int getMaxOutputTokens()

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

optional int32 max_output_tokens = 10;

Specified by:

getMaxOutputTokens in interface GenerateGroundedContentRequest.GenerationSpecOrBuilder

Returns:

The maxOutputTokens.

setMaxOutputTokens

public GenerateGroundedContentRequest.GenerationSpec.Builder setMaxOutputTokens(int value)

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

optional int32 max_output_tokens = 10;

Parameters:

value - The maxOutputTokens to set.

Returns:

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:

This builder for chaining.