/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace TranscribeStreamingService { namespace Model { /** *

Contains set of transcription results from one or more audio segments, along * with additional information about the parameters included in your request. For * example, channel definitions, partial result stabilization, sentiment, and issue * detection.

See Also:

AWS * API Reference

*/ class UtteranceEvent { public: AWS_TRANSCRIBESTREAMINGSERVICE_API UtteranceEvent(); AWS_TRANSCRIBESTREAMINGSERVICE_API UtteranceEvent(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESTREAMINGSERVICE_API UtteranceEvent& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_TRANSCRIBESTREAMINGSERVICE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The unique identifier that is associated with the specified * UtteranceEvent.

*/ inline const Aws::String& GetUtteranceId() const{ return m_utteranceId; } /** *

The unique identifier that is associated with the specified * UtteranceEvent.

*/ inline bool UtteranceIdHasBeenSet() const { return m_utteranceIdHasBeenSet; } /** *

The unique identifier that is associated with the specified * UtteranceEvent.

*/ inline void SetUtteranceId(const Aws::String& value) { m_utteranceIdHasBeenSet = true; m_utteranceId = value; } /** *

The unique identifier that is associated with the specified * UtteranceEvent.

*/ inline void SetUtteranceId(Aws::String&& value) { m_utteranceIdHasBeenSet = true; m_utteranceId = std::move(value); } /** *

The unique identifier that is associated with the specified * UtteranceEvent.

*/ inline void SetUtteranceId(const char* value) { m_utteranceIdHasBeenSet = true; m_utteranceId.assign(value); } /** *

The unique identifier that is associated with the specified * UtteranceEvent.

*/ inline UtteranceEvent& WithUtteranceId(const Aws::String& value) { SetUtteranceId(value); return *this;} /** *

The unique identifier that is associated with the specified * UtteranceEvent.

*/ inline UtteranceEvent& WithUtteranceId(Aws::String&& value) { SetUtteranceId(std::move(value)); return *this;} /** *

The unique identifier that is associated with the specified * UtteranceEvent.

*/ inline UtteranceEvent& WithUtteranceId(const char* value) { SetUtteranceId(value); return *this;} /** *

Indicates whether the segment in the UtteranceEvent is complete * (FALSE) or partial (TRUE).

*/ inline bool GetIsPartial() const{ return m_isPartial; } /** *

Indicates whether the segment in the UtteranceEvent is complete * (FALSE) or partial (TRUE).

*/ inline bool IsPartialHasBeenSet() const { return m_isPartialHasBeenSet; } /** *

Indicates whether the segment in the UtteranceEvent is complete * (FALSE) or partial (TRUE).

*/ inline void SetIsPartial(bool value) { m_isPartialHasBeenSet = true; m_isPartial = value; } /** *

Indicates whether the segment in the UtteranceEvent is complete * (FALSE) or partial (TRUE).

*/ inline UtteranceEvent& WithIsPartial(bool value) { SetIsPartial(value); return *this;} /** *

Provides the role of the speaker for each audio channel, either * CUSTOMER or AGENT.

*/ inline const ParticipantRole& GetParticipantRole() const{ return m_participantRole; } /** *

Provides the role of the speaker for each audio channel, either * CUSTOMER or AGENT.

*/ inline bool ParticipantRoleHasBeenSet() const { return m_participantRoleHasBeenSet; } /** *

Provides the role of the speaker for each audio channel, either * CUSTOMER or AGENT.

*/ inline void SetParticipantRole(const ParticipantRole& value) { m_participantRoleHasBeenSet = true; m_participantRole = value; } /** *

Provides the role of the speaker for each audio channel, either * CUSTOMER or AGENT.

*/ inline void SetParticipantRole(ParticipantRole&& value) { m_participantRoleHasBeenSet = true; m_participantRole = std::move(value); } /** *

Provides the role of the speaker for each audio channel, either * CUSTOMER or AGENT.

*/ inline UtteranceEvent& WithParticipantRole(const ParticipantRole& value) { SetParticipantRole(value); return *this;} /** *

Provides the role of the speaker for each audio channel, either * CUSTOMER or AGENT.

*/ inline UtteranceEvent& WithParticipantRole(ParticipantRole&& value) { SetParticipantRole(std::move(value)); return *this;} /** *

The time, in milliseconds, from the beginning of the audio stream to the * start of the UtteranceEvent.

*/ inline long long GetBeginOffsetMillis() const{ return m_beginOffsetMillis; } /** *

The time, in milliseconds, from the beginning of the audio stream to the * start of the UtteranceEvent.

*/ inline bool BeginOffsetMillisHasBeenSet() const { return m_beginOffsetMillisHasBeenSet; } /** *

The time, in milliseconds, from the beginning of the audio stream to the * start of the UtteranceEvent.

*/ inline void SetBeginOffsetMillis(long long value) { m_beginOffsetMillisHasBeenSet = true; m_beginOffsetMillis = value; } /** *

The time, in milliseconds, from the beginning of the audio stream to the * start of the UtteranceEvent.

*/ inline UtteranceEvent& WithBeginOffsetMillis(long long value) { SetBeginOffsetMillis(value); return *this;} /** *

The time, in milliseconds, from the beginning of the audio stream to the * start of the UtteranceEvent.

*/ inline long long GetEndOffsetMillis() const{ return m_endOffsetMillis; } /** *

The time, in milliseconds, from the beginning of the audio stream to the * start of the UtteranceEvent.

*/ inline bool EndOffsetMillisHasBeenSet() const { return m_endOffsetMillisHasBeenSet; } /** *

The time, in milliseconds, from the beginning of the audio stream to the * start of the UtteranceEvent.

*/ inline void SetEndOffsetMillis(long long value) { m_endOffsetMillisHasBeenSet = true; m_endOffsetMillis = value; } /** *

The time, in milliseconds, from the beginning of the audio stream to the * start of the UtteranceEvent.

*/ inline UtteranceEvent& WithEndOffsetMillis(long long value) { SetEndOffsetMillis(value); return *this;} /** *

Contains transcribed text.

*/ inline const Aws::String& GetTranscript() const{ return m_transcript; } /** *

Contains transcribed text.

*/ inline bool TranscriptHasBeenSet() const { return m_transcriptHasBeenSet; } /** *

Contains transcribed text.

*/ inline void SetTranscript(const Aws::String& value) { m_transcriptHasBeenSet = true; m_transcript = value; } /** *

Contains transcribed text.

*/ inline void SetTranscript(Aws::String&& value) { m_transcriptHasBeenSet = true; m_transcript = std::move(value); } /** *

Contains transcribed text.

*/ inline void SetTranscript(const char* value) { m_transcriptHasBeenSet = true; m_transcript.assign(value); } /** *

Contains transcribed text.

*/ inline UtteranceEvent& WithTranscript(const Aws::String& value) { SetTranscript(value); return *this;} /** *

Contains transcribed text.

*/ inline UtteranceEvent& WithTranscript(Aws::String&& value) { SetTranscript(std::move(value)); return *this;} /** *

Contains transcribed text.

*/ inline UtteranceEvent& WithTranscript(const char* value) { SetTranscript(value); return *this;} /** *

Contains words, phrases, or punctuation marks that are associated with the * specified UtteranceEvent.

*/ inline const Aws::Vector& GetItems() const{ return m_items; } /** *

Contains words, phrases, or punctuation marks that are associated with the * specified UtteranceEvent.

*/ inline bool ItemsHasBeenSet() const { return m_itemsHasBeenSet; } /** *

Contains words, phrases, or punctuation marks that are associated with the * specified UtteranceEvent.

*/ inline void SetItems(const Aws::Vector& value) { m_itemsHasBeenSet = true; m_items = value; } /** *

Contains words, phrases, or punctuation marks that are associated with the * specified UtteranceEvent.

*/ inline void SetItems(Aws::Vector&& value) { m_itemsHasBeenSet = true; m_items = std::move(value); } /** *

Contains words, phrases, or punctuation marks that are associated with the * specified UtteranceEvent.

*/ inline UtteranceEvent& WithItems(const Aws::Vector& value) { SetItems(value); return *this;} /** *

Contains words, phrases, or punctuation marks that are associated with the * specified UtteranceEvent.

*/ inline UtteranceEvent& WithItems(Aws::Vector&& value) { SetItems(std::move(value)); return *this;} /** *

Contains words, phrases, or punctuation marks that are associated with the * specified UtteranceEvent.

*/ inline UtteranceEvent& AddItems(const CallAnalyticsItem& value) { m_itemsHasBeenSet = true; m_items.push_back(value); return *this; } /** *

Contains words, phrases, or punctuation marks that are associated with the * specified UtteranceEvent.

*/ inline UtteranceEvent& AddItems(CallAnalyticsItem&& value) { m_itemsHasBeenSet = true; m_items.push_back(std::move(value)); return *this; } /** *

Contains entities identified as personally identifiable information (PII) in * your transcription output.

*/ inline const Aws::Vector& GetEntities() const{ return m_entities; } /** *

Contains entities identified as personally identifiable information (PII) in * your transcription output.

*/ inline bool EntitiesHasBeenSet() const { return m_entitiesHasBeenSet; } /** *

Contains entities identified as personally identifiable information (PII) in * your transcription output.

*/ inline void SetEntities(const Aws::Vector& value) { m_entitiesHasBeenSet = true; m_entities = value; } /** *

Contains entities identified as personally identifiable information (PII) in * your transcription output.

*/ inline void SetEntities(Aws::Vector&& value) { m_entitiesHasBeenSet = true; m_entities = std::move(value); } /** *

Contains entities identified as personally identifiable information (PII) in * your transcription output.

*/ inline UtteranceEvent& WithEntities(const Aws::Vector& value) { SetEntities(value); return *this;} /** *

Contains entities identified as personally identifiable information (PII) in * your transcription output.

*/ inline UtteranceEvent& WithEntities(Aws::Vector&& value) { SetEntities(std::move(value)); return *this;} /** *

Contains entities identified as personally identifiable information (PII) in * your transcription output.

*/ inline UtteranceEvent& AddEntities(const CallAnalyticsEntity& value) { m_entitiesHasBeenSet = true; m_entities.push_back(value); return *this; } /** *

Contains entities identified as personally identifiable information (PII) in * your transcription output.

*/ inline UtteranceEvent& AddEntities(CallAnalyticsEntity&& value) { m_entitiesHasBeenSet = true; m_entities.push_back(std::move(value)); return *this; } /** *

Provides the sentiment that was detected in the specified segment.

*/ inline const Sentiment& GetSentiment() const{ return m_sentiment; } /** *

Provides the sentiment that was detected in the specified segment.

*/ inline bool SentimentHasBeenSet() const { return m_sentimentHasBeenSet; } /** *

Provides the sentiment that was detected in the specified segment.

*/ inline void SetSentiment(const Sentiment& value) { m_sentimentHasBeenSet = true; m_sentiment = value; } /** *

Provides the sentiment that was detected in the specified segment.

*/ inline void SetSentiment(Sentiment&& value) { m_sentimentHasBeenSet = true; m_sentiment = std::move(value); } /** *

Provides the sentiment that was detected in the specified segment.

*/ inline UtteranceEvent& WithSentiment(const Sentiment& value) { SetSentiment(value); return *this;} /** *

Provides the sentiment that was detected in the specified segment.

*/ inline UtteranceEvent& WithSentiment(Sentiment&& value) { SetSentiment(std::move(value)); return *this;} /** *

Provides the issue that was detected in the specified segment.

*/ inline const Aws::Vector& GetIssuesDetected() const{ return m_issuesDetected; } /** *

Provides the issue that was detected in the specified segment.

*/ inline bool IssuesDetectedHasBeenSet() const { return m_issuesDetectedHasBeenSet; } /** *

Provides the issue that was detected in the specified segment.

*/ inline void SetIssuesDetected(const Aws::Vector& value) { m_issuesDetectedHasBeenSet = true; m_issuesDetected = value; } /** *

Provides the issue that was detected in the specified segment.

*/ inline void SetIssuesDetected(Aws::Vector&& value) { m_issuesDetectedHasBeenSet = true; m_issuesDetected = std::move(value); } /** *

Provides the issue that was detected in the specified segment.

*/ inline UtteranceEvent& WithIssuesDetected(const Aws::Vector& value) { SetIssuesDetected(value); return *this;} /** *

Provides the issue that was detected in the specified segment.

*/ inline UtteranceEvent& WithIssuesDetected(Aws::Vector&& value) { SetIssuesDetected(std::move(value)); return *this;} /** *

Provides the issue that was detected in the specified segment.

*/ inline UtteranceEvent& AddIssuesDetected(const IssueDetected& value) { m_issuesDetectedHasBeenSet = true; m_issuesDetected.push_back(value); return *this; } /** *

Provides the issue that was detected in the specified segment.

*/ inline UtteranceEvent& AddIssuesDetected(IssueDetected&& value) { m_issuesDetectedHasBeenSet = true; m_issuesDetected.push_back(std::move(value)); return *this; } private: Aws::String m_utteranceId; bool m_utteranceIdHasBeenSet = false; bool m_isPartial; bool m_isPartialHasBeenSet = false; ParticipantRole m_participantRole; bool m_participantRoleHasBeenSet = false; long long m_beginOffsetMillis; bool m_beginOffsetMillisHasBeenSet = false; long long m_endOffsetMillis; bool m_endOffsetMillisHasBeenSet = false; Aws::String m_transcript; bool m_transcriptHasBeenSet = false; Aws::Vector m_items; bool m_itemsHasBeenSet = false; Aws::Vector m_entities; bool m_entitiesHasBeenSet = false; Sentiment m_sentiment; bool m_sentimentHasBeenSet = false; Aws::Vector m_issuesDetected; bool m_issuesDetectedHasBeenSet = false; }; } // namespace Model } // namespace TranscribeStreamingService } // namespace Aws