Package com.google.cloud.dialogflow.cx.v3beta1

Class DataStoreConnectionSignals

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals
All Implemented Interfaces:
DataStoreConnectionSignalsOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class DataStoreConnectionSignals extends com.google.protobuf.GeneratedMessage implements DataStoreConnectionSignalsOrBuilder
 Data store connection feature output signals.
 Might be only partially field if processing stop before the final answer.
 Reasons for this can be, but are not limited to: empty UCS search results,
 positive RAI check outcome, grounding failure, ...
Protobuf type google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals
See Also:

  • Field Details

    • REWRITER_MODEL_CALL_SIGNALS_FIELD_NUMBER

      public static final int REWRITER_MODEL_CALL_SIGNALS_FIELD_NUMBER
      See Also:

    • REWRITTEN_QUERY_FIELD_NUMBER

      public static final int REWRITTEN_QUERY_FIELD_NUMBER
      See Also:

    • SEARCH_SNIPPETS_FIELD_NUMBER

      public static final int SEARCH_SNIPPETS_FIELD_NUMBER
      See Also:

    • ANSWER_GENERATION_MODEL_CALL_SIGNALS_FIELD_NUMBER

      public static final int ANSWER_GENERATION_MODEL_CALL_SIGNALS_FIELD_NUMBER
      See Also:

    • ANSWER_FIELD_NUMBER

      public static final int ANSWER_FIELD_NUMBER
      See Also:

    • ANSWER_PARTS_FIELD_NUMBER

      public static final int ANSWER_PARTS_FIELD_NUMBER
      See Also:

    • CITED_SNIPPETS_FIELD_NUMBER

      public static final int CITED_SNIPPETS_FIELD_NUMBER
      See Also:

    • GROUNDING_SIGNALS_FIELD_NUMBER

      public static final int GROUNDING_SIGNALS_FIELD_NUMBER
      See Also:

    • SAFETY_SIGNALS_FIELD_NUMBER

      public static final int SAFETY_SIGNALS_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

    • hasRewriterModelCallSignals

      public boolean hasRewriterModelCallSignals()
       Optional. Diagnostic info related to the rewriter model call.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasRewriterModelCallSignals in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      Whether the rewriterModelCallSignals field is set.

    • getRewriterModelCallSignals

      public DataStoreConnectionSignals.RewriterModelCallSignals getRewriterModelCallSignals()
       Optional. Diagnostic info related to the rewriter model call.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRewriterModelCallSignals in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      The rewriterModelCallSignals.

    • getRewriterModelCallSignalsOrBuilder

      public DataStoreConnectionSignals.RewriterModelCallSignalsOrBuilder getRewriterModelCallSignalsOrBuilder()
       Optional. Diagnostic info related to the rewriter model call.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.RewriterModelCallSignals rewriter_model_call_signals = 1 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRewriterModelCallSignalsOrBuilder in interface DataStoreConnectionSignalsOrBuilder

    • getRewrittenQuery

      public String getRewrittenQuery()
       Optional. Rewritten string query used for search.
      string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRewrittenQuery in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      The rewrittenQuery.

    • getRewrittenQueryBytes

      public com.google.protobuf.ByteString getRewrittenQueryBytes()
       Optional. Rewritten string query used for search.
      string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getRewrittenQueryBytes in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      The bytes for rewrittenQuery.

    • getSearchSnippetsList

      public List<DataStoreConnectionSignals.SearchSnippet> getSearchSnippetsList()
       Optional. Search snippets included in the answer generation prompt.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchSnippetsList in interface DataStoreConnectionSignalsOrBuilder

    • getSearchSnippetsOrBuilderList

      public List<? extends DataStoreConnectionSignals.SearchSnippetOrBuilder> getSearchSnippetsOrBuilderList()
       Optional. Search snippets included in the answer generation prompt.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchSnippetsOrBuilderList in interface DataStoreConnectionSignalsOrBuilder

    • getSearchSnippetsCount

      public int getSearchSnippetsCount()
       Optional. Search snippets included in the answer generation prompt.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchSnippetsCount in interface DataStoreConnectionSignalsOrBuilder

    • getSearchSnippets

      public DataStoreConnectionSignals.SearchSnippet getSearchSnippets(int index)
       Optional. Search snippets included in the answer generation prompt.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchSnippets in interface DataStoreConnectionSignalsOrBuilder

    • getSearchSnippetsOrBuilder

      public DataStoreConnectionSignals.SearchSnippetOrBuilder getSearchSnippetsOrBuilder(int index)
       Optional. Search snippets included in the answer generation prompt.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SearchSnippet search_snippets = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSearchSnippetsOrBuilder in interface DataStoreConnectionSignalsOrBuilder

    • hasAnswerGenerationModelCallSignals

      public boolean hasAnswerGenerationModelCallSignals()
       Optional. Diagnostic info related to the answer generation model call.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasAnswerGenerationModelCallSignals in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      Whether the answerGenerationModelCallSignals field is set.

    • getAnswerGenerationModelCallSignals

      public DataStoreConnectionSignals.AnswerGenerationModelCallSignals getAnswerGenerationModelCallSignals()
       Optional. Diagnostic info related to the answer generation model call.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerGenerationModelCallSignals in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      The answerGenerationModelCallSignals.

    • getAnswerGenerationModelCallSignalsOrBuilder

      public DataStoreConnectionSignals.AnswerGenerationModelCallSignalsOrBuilder getAnswerGenerationModelCallSignalsOrBuilder()
       Optional. Diagnostic info related to the answer generation model call.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerGenerationModelCallSignals answer_generation_model_call_signals = 4 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerGenerationModelCallSignalsOrBuilder in interface DataStoreConnectionSignalsOrBuilder

    • getAnswer

      public String getAnswer()
       Optional. The final compiled answer.
      string answer = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswer in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      The answer.

    • getAnswerBytes

      public com.google.protobuf.ByteString getAnswerBytes()
       Optional. The final compiled answer.
      string answer = 5 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerBytes in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      The bytes for answer.

    • getAnswerPartsList

      public List<DataStoreConnectionSignals.AnswerPart> getAnswerPartsList()
       Optional. Answer parts with relevant citations.
 Concatenation of texts should add up the `answer` (not counting
 whitespaces).
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerPartsList in interface DataStoreConnectionSignalsOrBuilder

    • getAnswerPartsOrBuilderList

      public List<? extends DataStoreConnectionSignals.AnswerPartOrBuilder> getAnswerPartsOrBuilderList()
       Optional. Answer parts with relevant citations.
 Concatenation of texts should add up the `answer` (not counting
 whitespaces).
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerPartsOrBuilderList in interface DataStoreConnectionSignalsOrBuilder

    • getAnswerPartsCount

      public int getAnswerPartsCount()
       Optional. Answer parts with relevant citations.
 Concatenation of texts should add up the `answer` (not counting
 whitespaces).
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerPartsCount in interface DataStoreConnectionSignalsOrBuilder

    • getAnswerParts

      public DataStoreConnectionSignals.AnswerPart getAnswerParts(int index)
       Optional. Answer parts with relevant citations.
 Concatenation of texts should add up the `answer` (not counting
 whitespaces).
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerParts in interface DataStoreConnectionSignalsOrBuilder

    • getAnswerPartsOrBuilder

      public DataStoreConnectionSignals.AnswerPartOrBuilder getAnswerPartsOrBuilder(int index)
       Optional. Answer parts with relevant citations.
 Concatenation of texts should add up the `answer` (not counting
 whitespaces).
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerPart answer_parts = 6 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getAnswerPartsOrBuilder in interface DataStoreConnectionSignalsOrBuilder

    • getCitedSnippetsList

      public List<DataStoreConnectionSignals.CitedSnippet> getCitedSnippetsList()
       Optional. Snippets cited by the answer generation model from the most to
 least relevant.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCitedSnippetsList in interface DataStoreConnectionSignalsOrBuilder

    • getCitedSnippetsOrBuilderList

      public List<? extends DataStoreConnectionSignals.CitedSnippetOrBuilder> getCitedSnippetsOrBuilderList()
       Optional. Snippets cited by the answer generation model from the most to
 least relevant.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCitedSnippetsOrBuilderList in interface DataStoreConnectionSignalsOrBuilder

    • getCitedSnippetsCount

      public int getCitedSnippetsCount()
       Optional. Snippets cited by the answer generation model from the most to
 least relevant.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCitedSnippetsCount in interface DataStoreConnectionSignalsOrBuilder

    • getCitedSnippets

      public DataStoreConnectionSignals.CitedSnippet getCitedSnippets(int index)
       Optional. Snippets cited by the answer generation model from the most to
 least relevant.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCitedSnippets in interface DataStoreConnectionSignalsOrBuilder

    • getCitedSnippetsOrBuilder

      public DataStoreConnectionSignals.CitedSnippetOrBuilder getCitedSnippetsOrBuilder(int index)
       Optional. Snippets cited by the answer generation model from the most to
 least relevant.
      repeated .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.CitedSnippet cited_snippets = 7 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getCitedSnippetsOrBuilder in interface DataStoreConnectionSignalsOrBuilder

    • hasGroundingSignals

      public boolean hasGroundingSignals()
       Optional. Grounding signals.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasGroundingSignals in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      Whether the groundingSignals field is set.

    • getGroundingSignals

      public DataStoreConnectionSignals.GroundingSignals getGroundingSignals()
       Optional. Grounding signals.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingSignals in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      The groundingSignals.

    • getGroundingSignalsOrBuilder

      public DataStoreConnectionSignals.GroundingSignalsOrBuilder getGroundingSignalsOrBuilder()
       Optional. Grounding signals.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getGroundingSignalsOrBuilder in interface DataStoreConnectionSignalsOrBuilder

    • hasSafetySignals

      public boolean hasSafetySignals()
       Optional. Safety check result.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasSafetySignals in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      Whether the safetySignals field is set.

    • getSafetySignals

      public DataStoreConnectionSignals.SafetySignals getSafetySignals()
       Optional. Safety check result.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySignals in interface DataStoreConnectionSignalsOrBuilder
      Returns:
      The safetySignals.

    • getSafetySignalsOrBuilder

      public DataStoreConnectionSignals.SafetySignalsOrBuilder getSafetySignalsOrBuilder()
       Optional. Safety check result.
      .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getSafetySignalsOrBuilder in interface DataStoreConnectionSignalsOrBuilder

    • 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 DataStoreConnectionSignals parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static DataStoreConnectionSignals parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static DataStoreConnectionSignals parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataStoreConnectionSignals parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataStoreConnectionSignals parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static DataStoreConnectionSignals parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataStoreConnectionSignals parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static DataStoreConnectionSignals parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public DataStoreConnectionSignals.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static DataStoreConnectionSignals.Builder newBuilder()

    • newBuilder

      public static DataStoreConnectionSignals.Builder newBuilder(DataStoreConnectionSignals prototype)

    • toBuilder

      public DataStoreConnectionSignals.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected DataStoreConnectionSignals.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static DataStoreConnectionSignals getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<DataStoreConnectionSignals> parser()

    • getParserForType

      public com.google.protobuf.Parser<DataStoreConnectionSignals> 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 DataStoreConnectionSignals getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder