public static final class LlmCall.RetrievedExample extends GeneratedMessage implements LlmCall.RetrievedExampleOrBuilderRelevant example used for the LLM prompt.
Protobuf type google.cloud.dialogflow.cx.v3beta1.LlmCall.RetrievedExample
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > LlmCall.RetrievedExampleImplements
LlmCall.RetrievedExampleOrBuilderStatic Fields
EXAMPLE_DISPLAY_NAME_FIELD_NUMBER
public static final int EXAMPLE_DISPLAY_NAME_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
EXAMPLE_ID_FIELD_NUMBER
public static final int EXAMPLE_ID_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
MATCHED_RETRIEVAL_LABEL_FIELD_NUMBER
public static final int MATCHED_RETRIEVAL_LABEL_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
RETRIEVAL_STRATEGY_FIELD_NUMBER
public static final int RETRIEVAL_STRATEGY_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static LlmCall.RetrievedExample getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static LlmCall.RetrievedExample.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample.Builder |
|
newBuilder(LlmCall.RetrievedExample prototype)
public static LlmCall.RetrievedExample.Builder newBuilder(LlmCall.RetrievedExample prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
LlmCall.RetrievedExample |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample.Builder |
|
parseDelimitedFrom(InputStream input)
public static LlmCall.RetrievedExample parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LlmCall.RetrievedExample parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static LlmCall.RetrievedExample parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static LlmCall.RetrievedExample parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static LlmCall.RetrievedExample parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static LlmCall.RetrievedExample parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static LlmCall.RetrievedExample parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static LlmCall.RetrievedExample parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static LlmCall.RetrievedExample parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static LlmCall.RetrievedExample parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static LlmCall.RetrievedExample parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static LlmCall.RetrievedExample parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<LlmCall.RetrievedExample> parser()| Returns | |
|---|---|
| Type | Description |
Parser<RetrievedExample> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public LlmCall.RetrievedExample getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample |
|
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. |
getParserForType()
public Parser<LlmCall.RetrievedExample> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<RetrievedExample> |
|
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. |
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public LlmCall.RetrievedExample.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected LlmCall.RetrievedExample.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample.Builder |
|
toBuilder()
public LlmCall.RetrievedExample.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
LlmCall.RetrievedExample.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|