/*
 * Copyright 2020 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/contactcenterinsights/v1/resources.proto

package com.google.cloud.contactcenterinsights.v1;

public interface ConversationSummarizationSuggestionDataOrBuilder
    extends
    // @@protoc_insertion_point(interface_extends:google.cloud.contactcenterinsights.v1.ConversationSummarizationSuggestionData)
    com.google.protobuf.MessageOrBuilder {

  /**
   *
   *
   * <pre>
   * The summarization content that is concatenated into one string.
   * </pre>
   *
   * <code>string text = 1;</code>
   *
   * @return The text.
   */
  java.lang.String getText();
  /**
   *
   *
   * <pre>
   * The summarization content that is concatenated into one string.
   * </pre>
   *
   * <code>string text = 1;</code>
   *
   * @return The bytes for text.
   */
  com.google.protobuf.ByteString getTextBytes();

  /**
   *
   *
   * <pre>
   * The summarization content that is divided into sections. The key is the
   * section's name and the value is the section's content. There is no
   * specific format for the key or value.
   * </pre>
   *
   * <code>map&lt;string, string&gt; text_sections = 5;</code>
   */
  int getTextSectionsCount();
  /**
   *
   *
   * <pre>
   * The summarization content that is divided into sections. The key is the
   * section's name and the value is the section's content. There is no
   * specific format for the key or value.
   * </pre>
   *
   * <code>map&lt;string, string&gt; text_sections = 5;</code>
   */
  boolean containsTextSections(java.lang.String key);
  /** Use {@link #getTextSectionsMap()} instead. */
  @java.lang.Deprecated
  java.util.Map<java.lang.String, java.lang.String> getTextSections();
  /**
   *
   *
   * <pre>
   * The summarization content that is divided into sections. The key is the
   * section's name and the value is the section's content. There is no
   * specific format for the key or value.
   * </pre>
   *
   * <code>map&lt;string, string&gt; text_sections = 5;</code>
   */
  java.util.Map<java.lang.String, java.lang.String> getTextSectionsMap();
  /**
   *
   *
   * <pre>
   * The summarization content that is divided into sections. The key is the
   * section's name and the value is the section's content. There is no
   * specific format for the key or value.
   * </pre>
   *
   * <code>map&lt;string, string&gt; text_sections = 5;</code>
   */
  /* nullable */
  java.lang.String getTextSectionsOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   * <pre>
   * The summarization content that is divided into sections. The key is the
   * section's name and the value is the section's content. There is no
   * specific format for the key or value.
   * </pre>
   *
   * <code>map&lt;string, string&gt; text_sections = 5;</code>
   */
  java.lang.String getTextSectionsOrThrow(java.lang.String key);

  /**
   *
   *
   * <pre>
   * The confidence score of the summarization.
   * </pre>
   *
   * <code>float confidence = 2;</code>
   *
   * @return The confidence.
   */
  float getConfidence();

  /**
   *
   *
   * <pre>
   * A map that contains metadata about the summarization and the document
   * from which it originates.
   * </pre>
   *
   * <code>map&lt;string, string&gt; metadata = 3;</code>
   */
  int getMetadataCount();
  /**
   *
   *
   * <pre>
   * A map that contains metadata about the summarization and the document
   * from which it originates.
   * </pre>
   *
   * <code>map&lt;string, string&gt; metadata = 3;</code>
   */
  boolean containsMetadata(java.lang.String key);
  /** Use {@link #getMetadataMap()} instead. */
  @java.lang.Deprecated
  java.util.Map<java.lang.String, java.lang.String> getMetadata();
  /**
   *
   *
   * <pre>
   * A map that contains metadata about the summarization and the document
   * from which it originates.
   * </pre>
   *
   * <code>map&lt;string, string&gt; metadata = 3;</code>
   */
  java.util.Map<java.lang.String, java.lang.String> getMetadataMap();
  /**
   *
   *
   * <pre>
   * A map that contains metadata about the summarization and the document
   * from which it originates.
   * </pre>
   *
   * <code>map&lt;string, string&gt; metadata = 3;</code>
   */
  /* nullable */
  java.lang.String getMetadataOrDefault(
      java.lang.String key,
      /* nullable */
      java.lang.String defaultValue);
  /**
   *
   *
   * <pre>
   * A map that contains metadata about the summarization and the document
   * from which it originates.
   * </pre>
   *
   * <code>map&lt;string, string&gt; metadata = 3;</code>
   */
  java.lang.String getMetadataOrThrow(java.lang.String key);

  /**
   *
   *
   * <pre>
   * The name of the answer record.
   * Format:
   * projects/{project}/locations/{location}/answerRecords/{answer_record}
   * </pre>
   *
   * <code>string answer_record = 4;</code>
   *
   * @return The answerRecord.
   */
  java.lang.String getAnswerRecord();
  /**
   *
   *
   * <pre>
   * The name of the answer record.
   * Format:
   * projects/{project}/locations/{location}/answerRecords/{answer_record}
   * </pre>
   *
   * <code>string answer_record = 4;</code>
   *
   * @return The bytes for answerRecord.
   */
  com.google.protobuf.ByteString getAnswerRecordBytes();

  /**
   *
   *
   * <pre>
   * The name of the model that generates this summary.
   * Format:
   * projects/{project}/locations/{location}/conversationModels/{conversation_model}
   * </pre>
   *
   * <code>string conversation_model = 6;</code>
   *
   * @return The conversationModel.
   */
  java.lang.String getConversationModel();
  /**
   *
   *
   * <pre>
   * The name of the model that generates this summary.
   * Format:
   * projects/{project}/locations/{location}/conversationModels/{conversation_model}
   * </pre>
   *
   * <code>string conversation_model = 6;</code>
   *
   * @return The bytes for conversationModel.
   */
  com.google.protobuf.ByteString getConversationModelBytes();
}
