com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignalsOrBuilder Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-dialogflow-cx-v3beta1 Show documentation
PROTO library for proto-google-cloud-dialogflow-cx-v3beta1
The newest version!
/*
 * Copyright 2024 Google LLC
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
// Generated by the protocol buffer compiler.  DO NOT EDIT!
// source: google/cloud/dialogflow/cx/v3beta1/data_store_connection.proto

// Protobuf Java Version: 3.25.5
package com.google.cloud.dialogflow.cx.v3beta1;

public interface DataStoreConnectionSignalsOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   *    * 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];
   * 
   *
   * @return Whether the rewriterModelCallSignals field is set.
   */
  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];
   * 
   *
   * @return The rewriterModelCallSignals.
   */
  com.google.cloud.dialogflow.cx.v3beta1.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];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals
          .RewriterModelCallSignalsOrBuilder
      getRewriterModelCallSignalsOrBuilder();

  /**
   *
   *
   *    * Optional. Rewritten string query used for search.
   * 
   *
   * string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The rewrittenQuery.
   */
  java.lang.String getRewrittenQuery();
  /**
   *
   *
   *    * Optional. Rewritten string query used for search.
   * 
   *
   * string rewritten_query = 2 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for rewrittenQuery.
   */
  com.google.protobuf.ByteString getRewrittenQueryBytes();

  /**
   *
   *
   *    * 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];
   * 
   */
  java.util.List
      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];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.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];
   * 
   */
  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];
   * 
   */
  java.util.List<
          ? extends
              com.google.cloud.dialogflow.cx.v3beta1.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];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SearchSnippetOrBuilder
      getSearchSnippetsOrBuilder(int index);

  /**
   *
   *
   *    * 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];
   * 
   *
   * @return Whether the answerGenerationModelCallSignals field is set.
   */
  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];
   * 
   *
   * @return The answerGenerationModelCallSignals.
   */
  com.google.cloud.dialogflow.cx.v3beta1.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];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals
          .AnswerGenerationModelCallSignalsOrBuilder
      getAnswerGenerationModelCallSignalsOrBuilder();

  /**
   *
   *
   *    * Optional. The final compiled answer.
   * 
   *
   * string answer = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The answer.
   */
  java.lang.String getAnswer();
  /**
   *
   *
   *    * Optional. The final compiled answer.
   * 
   *
   * string answer = 5 [(.google.api.field_behavior) = OPTIONAL];
   *
   * @return The bytes for answer.
   */
  com.google.protobuf.ByteString getAnswerBytes();

  /**
   *
   *
   *    * 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];
   * 
   */
  java.util.List
      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];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.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];
   * 
   */
  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];
   * 
   */
  java.util.List<
          ? extends
              com.google.cloud.dialogflow.cx.v3beta1.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];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.AnswerPartOrBuilder
      getAnswerPartsOrBuilder(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];
   * 
   */
  java.util.List
      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];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.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];
   * 
   */
  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];
   * 
   */
  java.util.List<
          ? extends
              com.google.cloud.dialogflow.cx.v3beta1.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];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.CitedSnippetOrBuilder
      getCitedSnippetsOrBuilder(int index);

  /**
   *
   *
   *    * Optional. Grounding signals.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the groundingSignals field is set.
   */
  boolean hasGroundingSignals();
  /**
   *
   *
   *    * Optional. Grounding signals.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The groundingSignals.
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.GroundingSignals
      getGroundingSignals();
  /**
   *
   *
   *    * Optional. Grounding signals.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.GroundingSignals grounding_signals = 8 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.GroundingSignalsOrBuilder
      getGroundingSignalsOrBuilder();

  /**
   *
   *
   *    * Optional. Safety check result.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return Whether the safetySignals field is set.
   */
  boolean hasSafetySignals();
  /**
   *
   *
   *    * Optional. Safety check result.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
   * 
   *
   * @return The safetySignals.
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SafetySignals
      getSafetySignals();
  /**
   *
   *
   *    * Optional. Safety check result.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SafetySignals safety_signals = 9 [(.google.api.field_behavior) = OPTIONAL];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.DataStoreConnectionSignals.SafetySignalsOrBuilder
      getSafetySignalsOrBuilder();
}