Class Assistant.GenerationConfig (0.90.0)

0.90.0 (latest) 0.89.0 0.87.0 0.84.0 0.83.0 0.81.0 0.79.0 0.78.0 0.77.0 0.76.0 0.74.0 0.72.0 0.71.0 0.70.0 0.69.0 0.68.0 0.66.0 0.64.0 0.63.0 0.60.0 0.59.0 0.58.0 0.56.0 0.55.0 0.54.0 0.53.0 0.52.0 0.51.0 0.50.0 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 Assistant.GenerationConfig extends GeneratedMessage implements Assistant.GenerationConfigOrBuilder

Configuration for the generation of the assistant response.

Protobuf type google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > Assistant.GenerationConfig

Implements

Assistant.GenerationConfigOrBuilder

Inherited Members

AbstractMessage.equals(Object)

AbstractMessage.findInitializationErrors()

AbstractMessage.getInitializationErrorString()

AbstractMessage.hashCode()

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

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent)

AbstractMessage.toString()

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

AbstractMessageLite.checkByteStringIsUtf8(ByteString)

AbstractMessageLite.toByteArray()

AbstractMessageLite.toByteString()

AbstractMessageLite.writeDelimitedTo(OutputStream)

AbstractMessageLite.writeTo(OutputStream)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newFileScopedGeneratedExtension(java.lang.Class<?>,com.google.protobuf.Message)

com.google.protobuf.GeneratedMessage.<ContainingT,T>newMessageScopedGeneratedExtension(com.google.protobuf.Message,int,java.lang.Class<?>,com.google.protobuf.Message)

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

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

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

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

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

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

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

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

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

com.google.protobuf.GeneratedMessage.<V>serializeBooleanMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Boolean,V>,com.google.protobuf.MapEntry<java.lang.Boolean,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeIntegerMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Integer,V>,com.google.protobuf.MapEntry<java.lang.Integer,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeLongMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.Long,V>,com.google.protobuf.MapEntry<java.lang.Long,V>,int)

com.google.protobuf.GeneratedMessage.<V>serializeStringMapTo(com.google.protobuf.CodedOutputStream,com.google.protobuf.MapField<java.lang.String,V>,com.google.protobuf.MapEntry<java.lang.String,V>,int)

com.google.protobuf.GeneratedMessage.canUseUnsafe()

GeneratedMessage.computeStringSize(int,Object)

GeneratedMessage.computeStringSizeNoTag(Object)

com.google.protobuf.GeneratedMessage.emptyBooleanList()

com.google.protobuf.GeneratedMessage.emptyDoubleList()

com.google.protobuf.GeneratedMessage.emptyFloatList()

com.google.protobuf.GeneratedMessage.emptyIntList()

com.google.protobuf.GeneratedMessage.emptyLongList()

GeneratedMessage.getAllFields()

GeneratedMessage.getDescriptorForType()

GeneratedMessage.getField(Descriptors.FieldDescriptor)

GeneratedMessage.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessage.getParserForType()

GeneratedMessage.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessage.getRepeatedFieldCount(Descriptors.FieldDescriptor)

GeneratedMessage.getSerializedSize()

GeneratedMessage.getUnknownFields()

GeneratedMessage.hasField(Descriptors.FieldDescriptor)

GeneratedMessage.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessage.internalGetFieldAccessorTable()

GeneratedMessage.internalGetMapField(int)

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

GeneratedMessage.isInitialized()

com.google.protobuf.GeneratedMessage.isStringEmpty(java.lang.Object)

GeneratedMessage.makeExtensionsImmutable()

com.google.protobuf.GeneratedMessage.mergeFromAndMakeImmutableInternal(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite)

com.google.protobuf.GeneratedMessage.newInstance(com.google.protobuf.GeneratedMessage.UnusedPrivateParameter)

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

com.google.protobuf.GeneratedMessage.parseUnknownFieldProto3(com.google.protobuf.CodedInputStream,com.google.protobuf.UnknownFieldSet.Builder,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessage.writeReplace()

GeneratedMessage.writeString(CodedOutputStream,int,Object)

GeneratedMessage.writeStringNoTag(CodedOutputStream,Object)

GeneratedMessage.writeTo(CodedOutputStream)

Object.clone()

Object.finalize()

Object.getClass()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Fields

ALLOWED_MODEL_IDS_FIELD_NUMBER

public static final int ALLOWED_MODEL_IDS_FIELD_NUMBER

Field Value
Type	Description
int

DEFAULT_LANGUAGE_FIELD_NUMBER

public static final int DEFAULT_LANGUAGE_FIELD_NUMBER

Field Value
Type	Description
int

DEFAULT_MODEL_ID_FIELD_NUMBER

public static final int DEFAULT_MODEL_ID_FIELD_NUMBER

Field Value
Type	Description
int

SYSTEM_INSTRUCTION_FIELD_NUMBER

public static final int SYSTEM_INSTRUCTION_FIELD_NUMBER

Field Value
Type	Description
int

Static Methods

getDefaultInstance()

public static Assistant.GenerationConfig getDefaultInstance()

Returns
Type	Description
Assistant.GenerationConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

newBuilder()

public static Assistant.GenerationConfig.Builder newBuilder()

Returns
Type	Description
Assistant.GenerationConfig.Builder

newBuilder(Assistant.GenerationConfig prototype)

public static Assistant.GenerationConfig.Builder newBuilder(Assistant.GenerationConfig prototype)

Parameter
Name	Description
prototype	Assistant.GenerationConfig

Returns
Type	Description
Assistant.GenerationConfig.Builder

parseDelimitedFrom(InputStream input)

public static Assistant.GenerationConfig parseDelimitedFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Assistant.GenerationConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(byte[] data)

public static Assistant.GenerationConfig parseFrom(byte[] data)

Parameter
Name	Description
data	byte[]

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Assistant.GenerationConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	byte[]
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Assistant.GenerationConfig parseFrom(ByteString data)

Parameter
Name	Description
data	ByteString

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Assistant.GenerationConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteString
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Assistant.GenerationConfig parseFrom(CodedInputStream input)

Parameter
Name	Description
input	CodedInputStream

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Assistant.GenerationConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input)

public static Assistant.GenerationConfig parseFrom(InputStream input)

Parameter
Name	Description
input	InputStream

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Assistant.GenerationConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	InputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
IOException

parseFrom(ByteBuffer data)

public static Assistant.GenerationConfig parseFrom(ByteBuffer data)

Parameter
Name	Description
data	ByteBuffer

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Assistant.GenerationConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
data	ByteBuffer
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Assistant.GenerationConfig

Exceptions
Type	Description
InvalidProtocolBufferException

parser()

public static Parser<Assistant.GenerationConfig> parser()

Returns
Type	Description
Parser<GenerationConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)

Parameter
Name	Description
obj	Object

Returns
Type	Description
boolean

Overrides

AbstractMessage.equals(Object other)

getAllowedModelIds(int index)

public String getAllowedModelIds(int index)

Optional. The list of models that are allowed to be used for assistant.

repeated string allowed_model_ids = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the element to return.

Returns
Type	Description
String	The allowedModelIds at the given index.

getAllowedModelIdsBytes(int index)

public ByteString getAllowedModelIdsBytes(int index)

Optional. The list of models that are allowed to be used for assistant.

repeated string allowed_model_ids = 2 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name	Description
index	int The index of the value to return.

Returns
Type	Description
ByteString	The bytes of the allowedModelIds at the given index.

getAllowedModelIdsCount()

public int getAllowedModelIdsCount()

Optional. The list of models that are allowed to be used for assistant.

repeated string allowed_model_ids = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
int	The count of allowedModelIds.

getAllowedModelIdsList()

public ProtocolStringList getAllowedModelIdsList()

Optional. The list of models that are allowed to be used for assistant.

repeated string allowed_model_ids = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ProtocolStringList	A list containing the allowedModelIds.

getDefaultInstanceForType()

public Assistant.GenerationConfig getDefaultInstanceForType()

Returns
Type	Description
Assistant.GenerationConfig

getDefaultLanguage()

public String getDefaultLanguage()

The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as en. If not specified, the language will be automatically detected.

string default_language = 4;

Returns
Type	Description
String	The defaultLanguage.

getDefaultLanguageBytes()

public ByteString getDefaultLanguageBytes()

The default language to use for the generation of the assistant response. Use an ISO 639-1 language code such as en. If not specified, the language will be automatically detected.

string default_language = 4;

Returns
Type	Description
ByteString	The bytes for defaultLanguage.

getDefaultModelId()

public String getDefaultModelId()

Optional. The default model to use for assistant.

string default_model_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
String	The defaultModelId.

getDefaultModelIdBytes()

public ByteString getDefaultModelIdBytes()

Optional. The default model to use for assistant.

string default_model_id = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
ByteString	The bytes for defaultModelId.

getParserForType()

public Parser<Assistant.GenerationConfig> getParserForType()

Returns
Type	Description
Parser<GenerationConfig>

Overrides

GeneratedMessage.getParserForType()

getSerializedSize()

public int getSerializedSize()

Returns
Type	Description
int

Overrides

GeneratedMessage.getSerializedSize()

getSystemInstruction()

public Assistant.GenerationConfig.SystemInstruction getSystemInstruction()

System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig.SystemInstruction system_instruction = 3;

Returns
Type	Description
Assistant.GenerationConfig.SystemInstruction	The systemInstruction.

getSystemInstructionOrBuilder()

public Assistant.GenerationConfig.SystemInstructionOrBuilder getSystemInstructionOrBuilder()

System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig.SystemInstruction system_instruction = 3;

Returns
Type	Description
Assistant.GenerationConfig.SystemInstructionOrBuilder

hasSystemInstruction()

public boolean hasSystemInstruction()

System instruction, also known as the prompt preamble for LLM calls. See also https://cloud.google.com/vertex-ai/generative-ai/docs/learn/prompts/system-instructions

.google.cloud.discoveryengine.v1beta.Assistant.GenerationConfig.SystemInstruction system_instruction = 3;

Returns
Type	Description
boolean	Whether the systemInstruction field is set.

hashCode()

public int hashCode()

Returns
Type	Description
int

Overrides

AbstractMessage.hashCode()

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessage.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessage.isInitialized()

newBuilderForType()

public Assistant.GenerationConfig.Builder newBuilderForType()

Returns
Type	Description
Assistant.GenerationConfig.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Assistant.GenerationConfig.Builder newBuilderForType(AbstractMessage.BuilderParent parent)

Parameter
Name	Description
parent	BuilderParent

Returns
Type	Description
Assistant.GenerationConfig.Builder

Overrides

AbstractMessage.newBuilderForType(AbstractMessage.BuilderParent parent)

toBuilder()

public Assistant.GenerationConfig.Builder toBuilder()

Returns
Type	Description
Assistant.GenerationConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)

Parameter
Name	Description
output	CodedOutputStream

Overrides

GeneratedMessage.writeTo(CodedOutputStream output)

Exceptions
Type	Description
IOException