com.google.cloud.dialogflow.cx.v3beta1.StreamingDetectIntentRequestOrBuilder 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/session.proto

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

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

  /**
   *
   *
   *    * The name of the session this query is sent to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
   * or
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
   * If `Environment ID` is not specified, we assume default 'draft'
   *  environment.
   *  It's up to the API caller to choose an appropriate `Session ID`. It can be
   *  a random number or some type of session identifiers (preferably hashed).
   *  The length of the `Session ID` must not exceed 36 characters.
   *  Note: session must be set in the first request.
   *
   *  For more information, see the [sessions
   *  guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
   *
   *  Note: Always use agent versions for production traffic.
   *  See [Versions and
   *  environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
   * 
   *
   * string session = 1 [(.google.api.resource_reference) = { ... }
   *
   * @return The session.
   */
  java.lang.String getSession();
  /**
   *
   *
   *    * The name of the session this query is sent to.
   * Format:
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/sessions/<SessionID>`
   * or
   * `projects/<ProjectID>/locations/<LocationID>/agents/<AgentID>/environments/<EnvironmentID>/sessions/<SessionID>`.
   * If `Environment ID` is not specified, we assume default 'draft'
   *  environment.
   *  It's up to the API caller to choose an appropriate `Session ID`. It can be
   *  a random number or some type of session identifiers (preferably hashed).
   *  The length of the `Session ID` must not exceed 36 characters.
   *  Note: session must be set in the first request.
   *
   *  For more information, see the [sessions
   *  guide](https://cloud.google.com/dialogflow/cx/docs/concept/session).
   *
   *  Note: Always use agent versions for production traffic.
   *  See [Versions and
   *  environments](https://cloud.google.com/dialogflow/cx/docs/concept/version).
   * 
   *
   * string session = 1 [(.google.api.resource_reference) = { ... }
   *
   * @return The bytes for session.
   */
  com.google.protobuf.ByteString getSessionBytes();

  /**
   *
   *
   *    * The parameters of this query.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
   *
   * @return Whether the queryParams field is set.
   */
  boolean hasQueryParams();
  /**
   *
   *
   *    * The parameters of this query.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
   *
   * @return The queryParams.
   */
  com.google.cloud.dialogflow.cx.v3beta1.QueryParameters getQueryParams();
  /**
   *
   *
   *    * The parameters of this query.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.QueryParameters query_params = 2;
   */
  com.google.cloud.dialogflow.cx.v3beta1.QueryParametersOrBuilder getQueryParamsOrBuilder();

  /**
   *
   *
   *    * Required. The input specification.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return Whether the queryInput field is set.
   */
  boolean hasQueryInput();
  /**
   *
   *
   *    * Required. The input specification.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   *
   * @return The queryInput.
   */
  com.google.cloud.dialogflow.cx.v3beta1.QueryInput getQueryInput();
  /**
   *
   *
   *    * Required. The input specification.
   * 
   *
   * 
   * .google.cloud.dialogflow.cx.v3beta1.QueryInput query_input = 3 [(.google.api.field_behavior) = REQUIRED];
   * 
   */
  com.google.cloud.dialogflow.cx.v3beta1.QueryInputOrBuilder getQueryInputOrBuilder();

  /**
   *
   *
   *    * Instructs the speech synthesizer how to generate the output audio.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
   *
   * @return Whether the outputAudioConfig field is set.
   */
  boolean hasOutputAudioConfig();
  /**
   *
   *
   *    * Instructs the speech synthesizer how to generate the output audio.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
   *
   * @return The outputAudioConfig.
   */
  com.google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig getOutputAudioConfig();
  /**
   *
   *
   *    * Instructs the speech synthesizer how to generate the output audio.
   * 
   *
   * .google.cloud.dialogflow.cx.v3beta1.OutputAudioConfig output_audio_config = 4;
   */
  com.google.cloud.dialogflow.cx.v3beta1.OutputAudioConfigOrBuilder getOutputAudioConfigOrBuilder();

  /**
   *
   *
   *    * Enable partial detect intent response. If this flag is not enabled,
   * response stream still contains only one final `DetectIntentResponse` even
   * if some `Fulfillment`s in the agent have been configured to return partial
   * responses.
   * 
   *
   * bool enable_partial_response = 5;
   *
   * @return The enablePartialResponse.
   */
  boolean getEnablePartialResponse();

  /**
   *
   *
   *    * If true, `StreamingDetectIntentResponse.debugging_info` will get populated.
   * 
   *
   * bool enable_debugging_info = 8;
   *
   * @return The enableDebuggingInfo.
   */
  boolean getEnableDebuggingInfo();
}