Class Generator (4.97.0)

public final class Generator extends GeneratedMessage implements GeneratorOrBuilder

LLM generator.

Protobuf type google.cloud.dialogflow.v2.Generator

Implements

GeneratorOrBuilder

Static Fields

AGENT_COACHING_CONTEXT_FIELD_NUMBER

public static final int AGENT_COACHING_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

CES_APP_SPECS_FIELD_NUMBER

public static final int CES_APP_SPECS_FIELD_NUMBER
Field Value
Type Description
int

CES_TOOL_SPECS_FIELD_NUMBER

public static final int CES_TOOL_SPECS_FIELD_NUMBER
Field Value
Type Description
int

CREATE_TIME_FIELD_NUMBER

public static final int CREATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

DESCRIPTION_FIELD_NUMBER

public static final int DESCRIPTION_FIELD_NUMBER
Field Value
Type Description
int

FREE_FORM_CONTEXT_FIELD_NUMBER

public static final int FREE_FORM_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

INFERENCE_PARAMETER_FIELD_NUMBER

public static final int INFERENCE_PARAMETER_FIELD_NUMBER
Field Value
Type Description
int

NAME_FIELD_NUMBER

public static final int NAME_FIELD_NUMBER
Field Value
Type Description
int

PUBLISHED_MODEL_FIELD_NUMBER

public static final int PUBLISHED_MODEL_FIELD_NUMBER
Field Value
Type Description
int

SUGGESTION_DEDUPING_CONFIG_FIELD_NUMBER

public static final int SUGGESTION_DEDUPING_CONFIG_FIELD_NUMBER
Field Value
Type Description
int

SUMMARIZATION_CONTEXT_FIELD_NUMBER

public static final int SUMMARIZATION_CONTEXT_FIELD_NUMBER
Field Value
Type Description
int

TOOLSET_TOOLS_FIELD_NUMBER

public static final int TOOLSET_TOOLS_FIELD_NUMBER
Field Value
Type Description
int

TOOLS_FIELD_NUMBER

public static final int TOOLS_FIELD_NUMBER
Field Value
Type Description
int

TRIGGER_EVENT_FIELD_NUMBER

public static final int TRIGGER_EVENT_FIELD_NUMBER
Field Value
Type Description
int

UPDATE_TIME_FIELD_NUMBER

public static final int UPDATE_TIME_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Generator getDefaultInstance()
Returns
Type Description
Generator

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Generator.Builder newBuilder()
Returns
Type Description
Generator.Builder

newBuilder(Generator prototype)

public static Generator.Builder newBuilder(Generator prototype)
Parameter
Name Description
prototype Generator
Returns
Type Description
Generator.Builder

parseDelimitedFrom(InputStream input)

public static Generator parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Generator
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Generator parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Generator
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Generator parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Generator
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Generator parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Generator
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Generator parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Generator
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Generator parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Generator
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Generator parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Generator
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Generator parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Generator
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Generator parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Generator
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Generator parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Generator
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Generator parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Generator
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Generator parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Generator
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Generator> parser()
Returns
Type Description
Parser<Generator>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getAgentCoachingContext()

public AgentCoachingContext getAgentCoachingContext()

Input of prebuilt Agent Coaching feature.

.google.cloud.dialogflow.v2.AgentCoachingContext agent_coaching_context = 12;

Returns
Type Description
AgentCoachingContext

The agentCoachingContext.

getAgentCoachingContextOrBuilder()

public AgentCoachingContextOrBuilder getAgentCoachingContextOrBuilder()

Input of prebuilt Agent Coaching feature.

.google.cloud.dialogflow.v2.AgentCoachingContext agent_coaching_context = 12;

Returns
Type Description
AgentCoachingContextOrBuilder

getCesAppSpecs(int index)

public CesAppSpec getCesAppSpecs(int index)

Optional. List of CES app specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesAppSpec ces_app_specs = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CesAppSpec

getCesAppSpecsCount()

public int getCesAppSpecsCount()

Optional. List of CES app specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesAppSpec ces_app_specs = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCesAppSpecsList()

public List<CesAppSpec> getCesAppSpecsList()

Optional. List of CES app specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesAppSpec ces_app_specs = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<CesAppSpec>

getCesAppSpecsOrBuilder(int index)

public CesAppSpecOrBuilder getCesAppSpecsOrBuilder(int index)

Optional. List of CES app specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesAppSpec ces_app_specs = 29 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CesAppSpecOrBuilder

getCesAppSpecsOrBuilderList()

public List<? extends CesAppSpecOrBuilder> getCesAppSpecsOrBuilderList()

Optional. List of CES app specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesAppSpec ces_app_specs = 29 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.CesAppSpecOrBuilder>

getCesToolSpecs(int index)

public CesToolSpec getCesToolSpecs(int index)

Optional. List of CES tool specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesToolSpec ces_tool_specs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CesToolSpec

getCesToolSpecsCount()

public int getCesToolSpecsCount()

Optional. List of CES tool specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesToolSpec ces_tool_specs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getCesToolSpecsList()

public List<CesToolSpec> getCesToolSpecsList()

Optional. List of CES tool specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesToolSpec ces_tool_specs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<CesToolSpec>

getCesToolSpecsOrBuilder(int index)

public CesToolSpecOrBuilder getCesToolSpecsOrBuilder(int index)

Optional. List of CES tool specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesToolSpec ces_tool_specs = 28 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
CesToolSpecOrBuilder

getCesToolSpecsOrBuilderList()

public List<? extends CesToolSpecOrBuilder> getCesToolSpecsOrBuilderList()

Optional. List of CES tool specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.CesToolSpec ces_tool_specs = 28 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.CesToolSpecOrBuilder>

getContextCase()

public Generator.ContextCase getContextCase()
Returns
Type Description
Generator.ContextCase

getCreateTime()

public Timestamp getCreateTime()

Output only. Creation time of this generator.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The createTime.

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. Creation time of this generator.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

getDefaultInstanceForType()

public Generator getDefaultInstanceForType()
Returns
Type Description
Generator

getDescription()

public String getDescription()

Optional. Human readable description of the generator.

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

Returns
Type Description
String

The description.

getDescriptionBytes()

public ByteString getDescriptionBytes()

Optional. Human readable description of the generator.

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

Returns
Type Description
ByteString

The bytes for description.

getFoundationModelCase()

public Generator.FoundationModelCase getFoundationModelCase()
Returns
Type Description
Generator.FoundationModelCase

getFreeFormContext()

public FreeFormContext getFreeFormContext()

Input of free from generator to LLM.

.google.cloud.dialogflow.v2.FreeFormContext free_form_context = 11;

Returns
Type Description
FreeFormContext

The freeFormContext.

getFreeFormContextOrBuilder()

public FreeFormContextOrBuilder getFreeFormContextOrBuilder()

Input of free from generator to LLM.

.google.cloud.dialogflow.v2.FreeFormContext free_form_context = 11;

Returns
Type Description
FreeFormContextOrBuilder

getInferenceParameter()

public InferenceParameter getInferenceParameter()

Optional. Inference parameters for this generator.

.google.cloud.dialogflow.v2.InferenceParameter inference_parameter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InferenceParameter

The inferenceParameter.

getInferenceParameterOrBuilder()

public InferenceParameterOrBuilder getInferenceParameterOrBuilder()

Optional. Inference parameters for this generator.

.google.cloud.dialogflow.v2.InferenceParameter inference_parameter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
InferenceParameterOrBuilder

getName()

public String getName()

Output only. Identifier. The resource name of the generator. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
String

The name.

getNameBytes()

public ByteString getNameBytes()

Output only. Identifier. The resource name of the generator. Format: projects/<Project ID>/locations/<Location ID>/generators/<Generator ID>

string name = 1 [(.google.api.field_behavior) = IDENTIFIER, (.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
ByteString

The bytes for name.

getParserForType()

public Parser<Generator> getParserForType()
Returns
Type Description
Parser<Generator>
Overrides

getPublishedModel()

public String getPublishedModel()

Optional. The published Large Language Model name.

  • To use the latest model version, specify the model name without version number. Example: text-bison
  • To use a stable model version, specify the version number as well. Example: text-bison@002.

string published_model = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The publishedModel.

getPublishedModelBytes()

public ByteString getPublishedModelBytes()

Optional. The published Large Language Model name.

  • To use the latest model version, specify the model name without version number. Example: text-bison
  • To use a stable model version, specify the version number as well. Example: text-bison@002.

string published_model = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for publishedModel.

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getSuggestionDedupingConfig()

public SuggestionDedupingConfig getSuggestionDedupingConfig()

Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature.

.google.cloud.dialogflow.v2.SuggestionDedupingConfig suggestion_deduping_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SuggestionDedupingConfig

The suggestionDedupingConfig.

getSuggestionDedupingConfigOrBuilder()

public SuggestionDedupingConfigOrBuilder getSuggestionDedupingConfigOrBuilder()

Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature.

.google.cloud.dialogflow.v2.SuggestionDedupingConfig suggestion_deduping_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
SuggestionDedupingConfigOrBuilder

getSummarizationContext()

public SummarizationContext getSummarizationContext()

Input of prebuilt Summarization feature.

.google.cloud.dialogflow.v2.SummarizationContext summarization_context = 13;

Returns
Type Description
SummarizationContext

The summarizationContext.

getSummarizationContextOrBuilder()

public SummarizationContextOrBuilder getSummarizationContextOrBuilder()

Input of prebuilt Summarization feature.

.google.cloud.dialogflow.v2.SummarizationContext summarization_context = 13;

Returns
Type Description
SummarizationContextOrBuilder

getTools(int index)

public String getTools(int index)

Optional. Resource names of the tools that the generator can choose from. Format: projects/<Project ID>/locations/<Location ID>/tools/<tool ID>.

repeated string tools = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The tools at the given index.

getToolsBytes(int index)

public ByteString getToolsBytes(int index)

Optional. Resource names of the tools that the generator can choose from. Format: projects/<Project ID>/locations/<Location ID>/tools/<tool ID>.

repeated string tools = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the tools at the given index.

getToolsCount()

public int getToolsCount()

Optional. Resource names of the tools that the generator can choose from. Format: projects/<Project ID>/locations/<Location ID>/tools/<tool ID>.

repeated string tools = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
int

The count of tools.

getToolsList()

public ProtocolStringList getToolsList()

Optional. Resource names of the tools that the generator can choose from. Format: projects/<Project ID>/locations/<Location ID>/tools/<tool ID>.

repeated string tools = 14 [(.google.api.field_behavior) = OPTIONAL, (.google.api.resource_reference) = { ... }

Returns
Type Description
ProtocolStringList

A list containing the tools.

getToolsetTools(int index)

public ToolsetTool getToolsetTools(int index)

Optional. List of CES toolset specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.ToolsetTool toolset_tools = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ToolsetTool

getToolsetToolsCount()

public int getToolsetToolsCount()

Optional. List of CES toolset specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.ToolsetTool toolset_tools = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

getToolsetToolsList()

public List<ToolsetTool> getToolsetToolsList()

Optional. List of CES toolset specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.ToolsetTool toolset_tools = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<ToolsetTool>

getToolsetToolsOrBuilder(int index)

public ToolsetToolOrBuilder getToolsetToolsOrBuilder(int index)

Optional. List of CES toolset specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.ToolsetTool toolset_tools = 27 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int
Returns
Type Description
ToolsetToolOrBuilder

getToolsetToolsOrBuilderList()

public List<? extends ToolsetToolOrBuilder> getToolsetToolsOrBuilderList()

Optional. List of CES toolset specs that the generator can choose from.

repeated .google.cloud.dialogflow.v2.ToolsetTool toolset_tools = 27 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
List<? extends com.google.cloud.dialogflow.v2.ToolsetToolOrBuilder>

getTriggerEvent()

public TriggerEvent getTriggerEvent()

Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.

.google.cloud.dialogflow.v2.TriggerEvent trigger_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
TriggerEvent

The triggerEvent.

getTriggerEventValue()

public int getTriggerEventValue()

Optional. The trigger event of the generator. It defines when the generator is triggered in a conversation.

.google.cloud.dialogflow.v2.TriggerEvent trigger_event = 5 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The enum numeric value on the wire for triggerEvent.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. Update time of this generator.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
Timestamp

The updateTime.

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. Update time of this generator.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
TimestampOrBuilder

hasAgentCoachingContext()

public boolean hasAgentCoachingContext()

Input of prebuilt Agent Coaching feature.

.google.cloud.dialogflow.v2.AgentCoachingContext agent_coaching_context = 12;

Returns
Type Description
boolean

Whether the agentCoachingContext field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. Creation time of this generator.

.google.protobuf.Timestamp create_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the createTime field is set.

hasFreeFormContext()

public boolean hasFreeFormContext()

Input of free from generator to LLM.

.google.cloud.dialogflow.v2.FreeFormContext free_form_context = 11;

Returns
Type Description
boolean

Whether the freeFormContext field is set.

hasInferenceParameter()

public boolean hasInferenceParameter()

Optional. Inference parameters for this generator.

.google.cloud.dialogflow.v2.InferenceParameter inference_parameter = 4 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the inferenceParameter field is set.

hasPublishedModel()

public boolean hasPublishedModel()

Optional. The published Large Language Model name.

  • To use the latest model version, specify the model name without version number. Example: text-bison
  • To use a stable model version, specify the version number as well. Example: text-bison@002.

string published_model = 15 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the publishedModel field is set.

hasSuggestionDedupingConfig()

public boolean hasSuggestionDedupingConfig()

Optional. Configuration for suggestion deduping. This is only applicable to AI Coach feature.

.google.cloud.dialogflow.v2.SuggestionDedupingConfig suggestion_deduping_config = 23 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

Whether the suggestionDedupingConfig field is set.

hasSummarizationContext()

public boolean hasSummarizationContext()

Input of prebuilt Summarization feature.

.google.cloud.dialogflow.v2.SummarizationContext summarization_context = 13;

Returns
Type Description
boolean

Whether the summarizationContext field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. Update time of this generator.

.google.protobuf.Timestamp update_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns
Type Description
boolean

Whether the updateTime field is set.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Generator.Builder newBuilderForType()
Returns
Type Description
Generator.Builder

newBuilderForType(AbstractMessage.BuilderParent parent)

protected Generator.Builder newBuilderForType(AbstractMessage.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Generator.Builder
Overrides

toBuilder()

public Generator.Builder toBuilder()
Returns
Type Description
Generator.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException