Class LlmCall.RetrievedExample.Builder (0.92.0) 

public static final class LlmCall.RetrievedExample.Builder extends GeneratedMessageV3.Builder<LlmCall.RetrievedExample.Builder> implements LlmCall.RetrievedExampleOrBuilder

Relevant example used for the LLM prompt.

Protobuf type google.cloud.dialogflow.cx.v3beta1.LlmCall.RetrievedExample

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > LlmCall.RetrievedExample.Builder

Static Methods

getDescriptor()

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

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public LlmCall.RetrievedExample.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

build()

public LlmCall.RetrievedExample build()
Returns
Type Description
LlmCall.RetrievedExample

buildPartial()

public LlmCall.RetrievedExample buildPartial()
Returns
Type Description
LlmCall.RetrievedExample

clear()

public LlmCall.RetrievedExample.Builder clear()
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

clearExampleDisplayName()

public LlmCall.RetrievedExample.Builder clearExampleDisplayName()

The display name of the example.

string example_display_name = 2;

Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

clearExampleId()

public LlmCall.RetrievedExample.Builder clearExampleId()

The id of the example.

string example_id = 1;

Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public LlmCall.RetrievedExample.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

clearMatchedRetrievalLabel()

public LlmCall.RetrievedExample.Builder clearMatchedRetrievalLabel()

Optional. The matched retrieval label of this LLM call.

string matched_retrieval_label = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public LlmCall.RetrievedExample.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

clearRetrievalStrategy()

public LlmCall.RetrievedExample.Builder clearRetrievalStrategy()

Retrieval strategy of the example.

.google.cloud.dialogflow.cx.v3beta1.RetrievalStrategy retrieval_strategy = 3;

Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

clone()

public LlmCall.RetrievedExample.Builder clone()
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

getDefaultInstanceForType()

public LlmCall.RetrievedExample getDefaultInstanceForType()
Returns
Type Description
LlmCall.RetrievedExample

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getExampleDisplayName()

public String getExampleDisplayName()

The display name of the example.

string example_display_name = 2;

Returns
Type Description
String

The exampleDisplayName.

getExampleDisplayNameBytes()

public ByteString getExampleDisplayNameBytes()

The display name of the example.

string example_display_name = 2;

Returns
Type Description
ByteString

The bytes for exampleDisplayName.

getExampleId()

public String getExampleId()

The id of the example.

string example_id = 1;

Returns
Type Description
String

The exampleId.

getExampleIdBytes()

public ByteString getExampleIdBytes()

The id of the example.

string example_id = 1;

Returns
Type Description
ByteString

The bytes for exampleId.

getMatchedRetrievalLabel()

public String getMatchedRetrievalLabel()

Optional. The matched retrieval label of this LLM call.

string matched_retrieval_label = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
String

The matchedRetrievalLabel.

getMatchedRetrievalLabelBytes()

public ByteString getMatchedRetrievalLabelBytes()

Optional. The matched retrieval label of this LLM call.

string matched_retrieval_label = 14 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ByteString

The bytes for matchedRetrievalLabel.

getRetrievalStrategy()

public RetrievalStrategy getRetrievalStrategy()

Retrieval strategy of the example.

.google.cloud.dialogflow.cx.v3beta1.RetrievalStrategy retrieval_strategy = 3;

Returns
Type Description
RetrievalStrategy

The retrievalStrategy.

getRetrievalStrategyValue()

public int getRetrievalStrategyValue()

Retrieval strategy of the example.

.google.cloud.dialogflow.cx.v3beta1.RetrievalStrategy retrieval_strategy = 3;

Returns
Type Description
int

The enum numeric value on the wire for retrievalStrategy.

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeFrom(LlmCall.RetrievedExample other)

public LlmCall.RetrievedExample.Builder mergeFrom(LlmCall.RetrievedExample other)
Parameter
Name Description
other LlmCall.RetrievedExample
Returns
Type Description
LlmCall.RetrievedExample.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public LlmCall.RetrievedExample.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public LlmCall.RetrievedExample.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final LlmCall.RetrievedExample.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

setExampleDisplayName(String value)

public LlmCall.RetrievedExample.Builder setExampleDisplayName(String value)

The display name of the example.

string example_display_name = 2;

Parameter
Name Description
value String

The exampleDisplayName to set.
Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

setExampleDisplayNameBytes(ByteString value)

public LlmCall.RetrievedExample.Builder setExampleDisplayNameBytes(ByteString value)

The display name of the example.

string example_display_name = 2;

Parameter
Name Description
value ByteString

The bytes for exampleDisplayName to set.
Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

setExampleId(String value)

public LlmCall.RetrievedExample.Builder setExampleId(String value)

The id of the example.

string example_id = 1;

Parameter
Name Description
value String

The exampleId to set.
Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

setExampleIdBytes(ByteString value)

public LlmCall.RetrievedExample.Builder setExampleIdBytes(ByteString value)

The id of the example.

string example_id = 1;

Parameter
Name Description
value ByteString

The bytes for exampleId to set.
Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

public LlmCall.RetrievedExample.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

setMatchedRetrievalLabel(String value)

public LlmCall.RetrievedExample.Builder setMatchedRetrievalLabel(String value)

Optional. The matched retrieval label of this LLM call.

string matched_retrieval_label = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value String

The matchedRetrievalLabel to set.
Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

setMatchedRetrievalLabelBytes(ByteString value)

public LlmCall.RetrievedExample.Builder setMatchedRetrievalLabelBytes(ByteString value)

Optional. The matched retrieval label of this LLM call.

string matched_retrieval_label = 14 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
value ByteString

The bytes for matchedRetrievalLabel to set.
Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

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

public LlmCall.RetrievedExample.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides

setRetrievalStrategy(RetrievalStrategy value)

public LlmCall.RetrievedExample.Builder setRetrievalStrategy(RetrievalStrategy value)

Retrieval strategy of the example.

.google.cloud.dialogflow.cx.v3beta1.RetrievalStrategy retrieval_strategy = 3;

Parameter
Name Description
value RetrievalStrategy

The retrievalStrategy to set.
Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

setRetrievalStrategyValue(int value)

public LlmCall.RetrievedExample.Builder setRetrievalStrategyValue(int value)

Retrieval strategy of the example.

.google.cloud.dialogflow.cx.v3beta1.RetrievalStrategy retrieval_strategy = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for retrievalStrategy to set.
Returns
Type Description
LlmCall.RetrievedExample.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final LlmCall.RetrievedExample.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
LlmCall.RetrievedExample.Builder
Overrides