Reference documentation and code samples for the Contact Center AI Insights V1 API class Google::Cloud::ContactCenterInsights::V1::Conversation.
The conversation resource.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#agent_id
def agent_id() -> ::String
Returns
- (::String) — An opaque, user-specified string representing the human agent who handled the conversation.
#agent_id=
def agent_id=(value) -> ::String
Parameter
- value (::String) — An opaque, user-specified string representing the human agent who handled the conversation.
Returns
- (::String) — An opaque, user-specified string representing the human agent who handled the conversation.
#call_metadata
def call_metadata() -> ::Google::Cloud::ContactCenterInsights::V1::Conversation::CallMetadata
Returns
- (::Google::Cloud::ContactCenterInsights::V1::Conversation::CallMetadata) — Call-specific metadata.
#call_metadata=
def call_metadata=(value) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation::CallMetadata
Parameter
- value (::Google::Cloud::ContactCenterInsights::V1::Conversation::CallMetadata) — Call-specific metadata.
Returns
- (::Google::Cloud::ContactCenterInsights::V1::Conversation::CallMetadata) — Call-specific metadata.
#create_time
def create_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The time at which the conversation was created.
#data_source
def data_source() -> ::Google::Cloud::ContactCenterInsights::V1::ConversationDataSource
Returns
- (::Google::Cloud::ContactCenterInsights::V1::ConversationDataSource) — The source of the audio and transcription for the conversation.
#data_source=
def data_source=(value) -> ::Google::Cloud::ContactCenterInsights::V1::ConversationDataSource
Parameter
- value (::Google::Cloud::ContactCenterInsights::V1::ConversationDataSource) — The source of the audio and transcription for the conversation.
Returns
- (::Google::Cloud::ContactCenterInsights::V1::ConversationDataSource) — The source of the audio and transcription for the conversation.
#dialogflow_intents
def dialogflow_intents() -> ::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::DialogflowIntent}
Returns
- (::Google::Protobuf::Map{::String => ::Google::Cloud::ContactCenterInsights::V1::DialogflowIntent}) — Output only. All the matched Dialogflow intents in the call. The key corresponds to a Dialogflow intent, format: projects/{project}/agent/{agent}/intents/{intent}
#duration
def duration() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — Output only. The duration of the conversation.
#expire_time
def expire_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
#expire_time=
def expire_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
Returns
- (::Google::Protobuf::Timestamp) — The time at which this conversation should expire. After this time, the conversation data and any associated analyses will be deleted.
#labels
def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
- (::Google::Protobuf::Map{::String => ::String}) — A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.
#labels=
def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
- value (::Google::Protobuf::Map{::String => ::String}) — A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.
Returns
- (::Google::Protobuf::Map{::String => ::String}) — A map for the user to specify any custom fields. A maximum of 100 labels per conversation is allowed, with a maximum of 256 characters per entry.
#language_code
def language_code() -> ::String
Returns
- (::String) — A user-specified language code for the conversation.
#language_code=
def language_code=(value) -> ::String
Parameter
- value (::String) — A user-specified language code for the conversation.
Returns
- (::String) — A user-specified language code for the conversation.
#latest_analysis
def latest_analysis() -> ::Google::Cloud::ContactCenterInsights::V1::Analysis
Returns
- (::Google::Cloud::ContactCenterInsights::V1::Analysis) — Output only. The conversation's latest analysis, if one exists.
#latest_summary
def latest_summary() -> ::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData
Returns
- (::Google::Cloud::ContactCenterInsights::V1::ConversationSummarizationSuggestionData) — Output only. Latest summary of the conversation.
#medium
def medium() -> ::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium
Returns
- (::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium) — Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
#medium=
def medium=(value) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium
Parameter
- value (::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium) — Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
Returns
- (::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium) — Immutable. The conversation medium, if unspecified will default to PHONE_CALL.
#metadata_json
def metadata_json() -> ::String
Returns
- (::String) — Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
#metadata_json=
def metadata_json=(value) -> ::String
Parameter
- value (::String) — Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
Returns
- (::String) — Input only. JSON metadata encoded as a string. This field is primarily used by Insights integrations with various telphony systems and must be in one of Insight's supported formats.
#name
def name() -> ::String
Returns
- (::String) — Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
#name=
def name=(value) -> ::String
Parameter
- value (::String) — Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
Returns
- (::String) — Immutable. The resource name of the conversation. Format: projects/{project}/locations/{location}/conversations/{conversation}
#obfuscated_user_id
def obfuscated_user_id() -> ::String
Returns
- (::String) — Obfuscated user ID which the customer sent to us.
#obfuscated_user_id=
def obfuscated_user_id=(value) -> ::String
Parameter
- value (::String) — Obfuscated user ID which the customer sent to us.
Returns
- (::String) — Obfuscated user ID which the customer sent to us.
#quality_metadata
def quality_metadata() -> ::Google::Cloud::ContactCenterInsights::V1::Conversation::QualityMetadata
Returns
- (::Google::Cloud::ContactCenterInsights::V1::Conversation::QualityMetadata) — Conversation metadata related to quality management.
#quality_metadata=
def quality_metadata=(value) -> ::Google::Cloud::ContactCenterInsights::V1::Conversation::QualityMetadata
Parameter
- value (::Google::Cloud::ContactCenterInsights::V1::Conversation::QualityMetadata) — Conversation metadata related to quality management.
Returns
- (::Google::Cloud::ContactCenterInsights::V1::Conversation::QualityMetadata) — Conversation metadata related to quality management.
#runtime_annotations
def runtime_annotations() -> ::Array<::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation>
Returns
- (::Array<::Google::Cloud::ContactCenterInsights::V1::RuntimeAnnotation>) — Output only. The annotations that were generated during the customer and agent interaction.
#start_time
def start_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — The time at which the conversation started.
#start_time=
def start_time=(value) -> ::Google::Protobuf::Timestamp
Parameter
- value (::Google::Protobuf::Timestamp) — The time at which the conversation started.
Returns
- (::Google::Protobuf::Timestamp) — The time at which the conversation started.
#transcript
def transcript() -> ::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript
Returns
- (::Google::Cloud::ContactCenterInsights::V1::Conversation::Transcript) — Output only. The conversation transcript.
#ttl
def ttl() -> ::Google::Protobuf::Duration
Returns
- (::Google::Protobuf::Duration) — Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
#ttl=
def ttl=(value) -> ::Google::Protobuf::Duration
Parameter
- value (::Google::Protobuf::Duration) — Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
Returns
- (::Google::Protobuf::Duration) — Input only. The TTL for this resource. If specified, then this TTL will be used to calculate the expire time.
#turn_count
def turn_count() -> ::Integer
Returns
- (::Integer) — Output only. The number of turns in the conversation.
#update_time
def update_time() -> ::Google::Protobuf::Timestamp
Returns
- (::Google::Protobuf::Timestamp) — Output only. The most recent time at which the conversation was updated.