Class LlmCall.RetrievedExample

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.LlmCall.RetrievedExample
All Implemented Interfaces:
LlmCall.RetrievedExampleOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
LlmCall

public static final class LlmCall.RetrievedExample extends com.google.protobuf.GeneratedMessage implements LlmCall.RetrievedExampleOrBuilder
 Relevant example used for the LLM prompt.
 
Protobuf type google.cloud.dialogflow.cx.v3beta1.LlmCall.RetrievedExample
See Also:
  • Field Details

    • EXAMPLE_ID_FIELD_NUMBER

      public static final int EXAMPLE_ID_FIELD_NUMBER
      See Also:
    • EXAMPLE_DISPLAY_NAME_FIELD_NUMBER

      public static final int EXAMPLE_DISPLAY_NAME_FIELD_NUMBER
      See Also:
    • RETRIEVAL_STRATEGY_FIELD_NUMBER

      public static final int RETRIEVAL_STRATEGY_FIELD_NUMBER
      See Also:
    • MATCHED_RETRIEVAL_LABEL_FIELD_NUMBER

      public static final int MATCHED_RETRIEVAL_LABEL_FIELD_NUMBER
      See Also:
  • 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
    • getExampleId

      public String getExampleId()
       The id of the example.
       
      string example_id = 1;
      Specified by:
      getExampleId in interface LlmCall.RetrievedExampleOrBuilder
      Returns:
      The exampleId.
    • getExampleIdBytes

      public com.google.protobuf.ByteString getExampleIdBytes()
       The id of the example.
       
      string example_id = 1;
      Specified by:
      getExampleIdBytes in interface LlmCall.RetrievedExampleOrBuilder
      Returns:
      The bytes for exampleId.
    • getExampleDisplayName

      public String getExampleDisplayName()
       The display name of the example.
       
      string example_display_name = 2;
      Specified by:
      getExampleDisplayName in interface LlmCall.RetrievedExampleOrBuilder
      Returns:
      The exampleDisplayName.
    • getExampleDisplayNameBytes

      public com.google.protobuf.ByteString getExampleDisplayNameBytes()
       The display name of the example.
       
      string example_display_name = 2;
      Specified by:
      getExampleDisplayNameBytes in interface LlmCall.RetrievedExampleOrBuilder
      Returns:
      The bytes for exampleDisplayName.
    • getRetrievalStrategyValue

      public int getRetrievalStrategyValue()
       Retrieval strategy of the example.
       
      .google.cloud.dialogflow.cx.v3beta1.RetrievalStrategy retrieval_strategy = 3;
      Specified by:
      getRetrievalStrategyValue in interface LlmCall.RetrievedExampleOrBuilder
      Returns:
      The enum numeric value on the wire for retrievalStrategy.
    • getRetrievalStrategy

      public RetrievalStrategy getRetrievalStrategy()
       Retrieval strategy of the example.
       
      .google.cloud.dialogflow.cx.v3beta1.RetrievalStrategy retrieval_strategy = 3;
      Specified by:
      getRetrievalStrategy in interface LlmCall.RetrievedExampleOrBuilder
      Returns:
      The retrievalStrategy.
    • getMatchedRetrievalLabel

      public String getMatchedRetrievalLabel()
       Optional. The matched retrieval label of this LLM call.
       
      string matched_retrieval_label = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMatchedRetrievalLabel in interface LlmCall.RetrievedExampleOrBuilder
      Returns:
      The matchedRetrievalLabel.
    • getMatchedRetrievalLabelBytes

      public com.google.protobuf.ByteString getMatchedRetrievalLabelBytes()
       Optional. The matched retrieval label of this LLM call.
       
      string matched_retrieval_label = 14 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getMatchedRetrievalLabelBytes in interface LlmCall.RetrievedExampleOrBuilder
      Returns:
      The bytes for matchedRetrievalLabel.
    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage
    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessage
      Throws:
      IOException
    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessage
    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage
    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static LlmCall.RetrievedExample parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException
    • parseDelimitedFrom

      public static LlmCall.RetrievedExample parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException
    • parseFrom

      public static LlmCall.RetrievedExample parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException
    • newBuilderForType

      public LlmCall.RetrievedExample.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite
    • newBuilder

      public static LlmCall.RetrievedExample.Builder newBuilder()
    • newBuilder

      public static LlmCall.RetrievedExample.Builder newBuilder(LlmCall.RetrievedExample prototype)
    • toBuilder

      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite
    • newBuilderForType

      protected LlmCall.RetrievedExample.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage
    • getDefaultInstance

      public static LlmCall.RetrievedExample getDefaultInstance()
    • parser

      public static com.google.protobuf.Parser<LlmCall.RetrievedExample> parser()
    • getParserForType

      public com.google.protobuf.Parser<LlmCall.RetrievedExample> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessage
    • getDefaultInstanceForType

      public LlmCall.RetrievedExample getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder