Package com.google.cloud.dialogflow.v2

Interface FaqAnswerOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
FaqAnswer, FaqAnswer.Builder
@Generated public interface FaqAnswerOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsMetadata(String key)
    A map that contains metadata about the answer and the document from which it originates.
    String
    getAnswer()
    The piece of text from the `source` knowledge base document.
    com.google.protobuf.ByteString
    getAnswerBytes()
    The piece of text from the `source` knowledge base document.
    String
    getAnswerRecord()
    The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"
    com.google.protobuf.ByteString
    getAnswerRecordBytes()
    The name of answer record, in the format of "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record ID>"
    float
    getConfidence()
    The system's confidence score that this Knowledge answer is a good match for this conversational query, range from 0.0 (completely uncertain) to 1.0 (completely certain).
    Map<String,String>
    getMetadata()
    Deprecated.
    int
    getMetadataCount()
    A map that contains metadata about the answer and the document from which it originates.
    Map<String,String>
    getMetadataMap()
    A map that contains metadata about the answer and the document from which it originates.
    String
    getMetadataOrDefault(String key, String defaultValue)
    A map that contains metadata about the answer and the document from which it originates.
    String
    getMetadataOrThrow(String key)
    A map that contains metadata about the answer and the document from which it originates.
    String
    getQuestion()
    The corresponding FAQ question.
    com.google.protobuf.ByteString
    getQuestionBytes()
    The corresponding FAQ question.
    String
    getSource()
    Indicates which Knowledge Document this answer was extracted from.
    com.google.protobuf.ByteString
    getSourceBytes()
    Indicates which Knowledge Document this answer was extracted from.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getAnswer

      String getAnswer()
       The piece of text from the `source` knowledge base document.
      string answer = 1;
      Returns:
      The answer.

    • getAnswerBytes

      com.google.protobuf.ByteString getAnswerBytes()
       The piece of text from the `source` knowledge base document.
      string answer = 1;
      Returns:
      The bytes for answer.

    • getConfidence

      float getConfidence()
       The system's confidence score that this Knowledge answer is a good match
 for this conversational query, range from 0.0 (completely uncertain)
 to 1.0 (completely certain).
      float confidence = 2;
      Returns:
      The confidence.

    • getQuestion

      String getQuestion()
       The corresponding FAQ question.
      string question = 3;
      Returns:
      The question.

    • getQuestionBytes

      com.google.protobuf.ByteString getQuestionBytes()
       The corresponding FAQ question.
      string question = 3;
      Returns:
      The bytes for question.

    • getSource

      String getSource()
       Indicates which Knowledge Document this answer was extracted
 from.
 Format: `projects/<Project ID>/locations/<Location
 ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
      string source = 4;
      Returns:
      The source.

    • getSourceBytes

      com.google.protobuf.ByteString getSourceBytes()
       Indicates which Knowledge Document this answer was extracted
 from.
 Format: `projects/<Project ID>/locations/<Location
 ID>/agent/knowledgeBases/<Knowledge Base ID>/documents/<Document ID>`.
      string source = 4;
      Returns:
      The bytes for source.

    • getMetadataCount

      int getMetadataCount()
       A map that contains metadata about the answer and the
 document from which it originates.
      map<string, string> metadata = 5;

    • containsMetadata

      boolean containsMetadata(String key)
       A map that contains metadata about the answer and the
 document from which it originates.
      map<string, string> metadata = 5;

    • getMetadata

      @Deprecated Map<String,String> getMetadata()
      Deprecated.
      Use getMetadataMap() instead.

    • getMetadataMap

      Map<String,String> getMetadataMap()
       A map that contains metadata about the answer and the
 document from which it originates.
      map<string, string> metadata = 5;

    • getMetadataOrDefault

      String getMetadataOrDefault(String key, String defaultValue)
       A map that contains metadata about the answer and the
 document from which it originates.
      map<string, string> metadata = 5;

    • getMetadataOrThrow

      String getMetadataOrThrow(String key)
       A map that contains metadata about the answer and the
 document from which it originates.
      map<string, string> metadata = 5;

    • getAnswerRecord

      String getAnswerRecord()
       The name of answer record, in the format of
 "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record
 ID>"
      string answer_record = 6;
      Returns:
      The answerRecord.

    • getAnswerRecordBytes

      com.google.protobuf.ByteString getAnswerRecordBytes()
       The name of answer record, in the format of
 "projects/<Project ID>/locations/<Location ID>/answerRecords/<Answer Record
 ID>"
      string answer_record = 6;
      Returns:
      The bytes for answerRecord.