Class: Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest
- Inherits:
-
Object
- Object
- Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest
- Extended by:
- Protobuf::MessageExts::ClassMethods
- Includes:
- Protobuf::MessageExts
- Defined in:
- proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb
Overview
The request to ingest conversations.
Defined Under Namespace
Classes: ConversationConfig, GcsSource, TranscriptObjectConfig
Instance Attribute Summary collapse
-
#conversation_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::ConversationConfig
Configuration that applies to all conversations.
-
#gcs_source ⇒ ::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource
A cloud storage bucket source.
-
#parent ⇒ ::String
Required.
-
#redaction_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::RedactionConfig
Optional.
-
#sample_size ⇒ ::Integer
Optional.
-
#speech_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::SpeechConfig
Optional.
-
#transcript_object_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::TranscriptObjectConfig
Configuration for when
source
contains conversation transcripts.
Instance Attribute Details
#conversation_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::ConversationConfig
Returns Configuration that applies to all conversations.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 364 class IngestConversationsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configuration for Cloud Storage bucket sources. # @!attribute [rw] bucket_uri # @return [::String] # Required. The Cloud Storage bucket containing source objects. # @!attribute [rw] bucket_object_type # @return [::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource::BucketObjectType] # Optional. Specifies the type of the objects in `bucket_uri`. # @!attribute [rw] metadata_bucket_uri # @return [::String] # Optional. The Cloud Storage path to the conversation metadata. Note that: # [1] Metadata files are expected to be in JSON format. # [2] Metadata and source files (transcripts or audio) must be in # separate buckets. # [3] A source file and its corresponding metadata file must share the same # name to # be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and # `gs://bucket/metadata/conversation1.json`. # @!attribute [rw] custom_metadata_keys # @return [::Array<::String>] # Optional. Custom keys to extract as conversation labels from metadata # files in `metadata_bucket_uri`. Keys not included in this field will be # ignored. Note that there is a limit of 20 labels per conversation. class GcsSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module BucketObjectType # The object type is unspecified and will default to `TRANSCRIPT`. BUCKET_OBJECT_TYPE_UNSPECIFIED = 0 # The object is a transcript. TRANSCRIPT = 1 # The object is an audio file. AUDIO = 2 end end # Configuration for processing transcript objects. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium] # Required. The medium transcript objects represent. class TranscriptObjectConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration that applies to all conversations. # @!attribute [rw] agent_id # @return [::String] # Optional. An opaque, user-specified string representing a human agent who # handled all conversations in the import. Note that this will be # overridden if per-conversation metadata is provided through the # `metadata_bucket_uri`. # @!attribute [rw] agent_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. # @!attribute [rw] customer_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. class ConversationConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#gcs_source ⇒ ::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource
Returns A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 364 class IngestConversationsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configuration for Cloud Storage bucket sources. # @!attribute [rw] bucket_uri # @return [::String] # Required. The Cloud Storage bucket containing source objects. # @!attribute [rw] bucket_object_type # @return [::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource::BucketObjectType] # Optional. Specifies the type of the objects in `bucket_uri`. # @!attribute [rw] metadata_bucket_uri # @return [::String] # Optional. The Cloud Storage path to the conversation metadata. Note that: # [1] Metadata files are expected to be in JSON format. # [2] Metadata and source files (transcripts or audio) must be in # separate buckets. # [3] A source file and its corresponding metadata file must share the same # name to # be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and # `gs://bucket/metadata/conversation1.json`. # @!attribute [rw] custom_metadata_keys # @return [::Array<::String>] # Optional. Custom keys to extract as conversation labels from metadata # files in `metadata_bucket_uri`. Keys not included in this field will be # ignored. Note that there is a limit of 20 labels per conversation. class GcsSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module BucketObjectType # The object type is unspecified and will default to `TRANSCRIPT`. BUCKET_OBJECT_TYPE_UNSPECIFIED = 0 # The object is a transcript. TRANSCRIPT = 1 # The object is an audio file. AUDIO = 2 end end # Configuration for processing transcript objects. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium] # Required. The medium transcript objects represent. class TranscriptObjectConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration that applies to all conversations. # @!attribute [rw] agent_id # @return [::String] # Optional. An opaque, user-specified string representing a human agent who # handled all conversations in the import. Note that this will be # overridden if per-conversation metadata is provided through the # `metadata_bucket_uri`. # @!attribute [rw] agent_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. # @!attribute [rw] customer_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. class ConversationConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#parent ⇒ ::String
Returns Required. The parent resource for new conversations.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 364 class IngestConversationsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configuration for Cloud Storage bucket sources. # @!attribute [rw] bucket_uri # @return [::String] # Required. The Cloud Storage bucket containing source objects. # @!attribute [rw] bucket_object_type # @return [::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource::BucketObjectType] # Optional. Specifies the type of the objects in `bucket_uri`. # @!attribute [rw] metadata_bucket_uri # @return [::String] # Optional. The Cloud Storage path to the conversation metadata. Note that: # [1] Metadata files are expected to be in JSON format. # [2] Metadata and source files (transcripts or audio) must be in # separate buckets. # [3] A source file and its corresponding metadata file must share the same # name to # be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and # `gs://bucket/metadata/conversation1.json`. # @!attribute [rw] custom_metadata_keys # @return [::Array<::String>] # Optional. Custom keys to extract as conversation labels from metadata # files in `metadata_bucket_uri`. Keys not included in this field will be # ignored. Note that there is a limit of 20 labels per conversation. class GcsSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module BucketObjectType # The object type is unspecified and will default to `TRANSCRIPT`. BUCKET_OBJECT_TYPE_UNSPECIFIED = 0 # The object is a transcript. TRANSCRIPT = 1 # The object is an audio file. AUDIO = 2 end end # Configuration for processing transcript objects. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium] # Required. The medium transcript objects represent. class TranscriptObjectConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration that applies to all conversations. # @!attribute [rw] agent_id # @return [::String] # Optional. An opaque, user-specified string representing a human agent who # handled all conversations in the import. Note that this will be # overridden if per-conversation metadata is provided through the # `metadata_bucket_uri`. # @!attribute [rw] agent_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. # @!attribute [rw] customer_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. class ConversationConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#redaction_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::RedactionConfig
Returns Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 364 class IngestConversationsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configuration for Cloud Storage bucket sources. # @!attribute [rw] bucket_uri # @return [::String] # Required. The Cloud Storage bucket containing source objects. # @!attribute [rw] bucket_object_type # @return [::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource::BucketObjectType] # Optional. Specifies the type of the objects in `bucket_uri`. # @!attribute [rw] metadata_bucket_uri # @return [::String] # Optional. The Cloud Storage path to the conversation metadata. Note that: # [1] Metadata files are expected to be in JSON format. # [2] Metadata and source files (transcripts or audio) must be in # separate buckets. # [3] A source file and its corresponding metadata file must share the same # name to # be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and # `gs://bucket/metadata/conversation1.json`. # @!attribute [rw] custom_metadata_keys # @return [::Array<::String>] # Optional. Custom keys to extract as conversation labels from metadata # files in `metadata_bucket_uri`. Keys not included in this field will be # ignored. Note that there is a limit of 20 labels per conversation. class GcsSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module BucketObjectType # The object type is unspecified and will default to `TRANSCRIPT`. BUCKET_OBJECT_TYPE_UNSPECIFIED = 0 # The object is a transcript. TRANSCRIPT = 1 # The object is an audio file. AUDIO = 2 end end # Configuration for processing transcript objects. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium] # Required. The medium transcript objects represent. class TranscriptObjectConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration that applies to all conversations. # @!attribute [rw] agent_id # @return [::String] # Optional. An opaque, user-specified string representing a human agent who # handled all conversations in the import. Note that this will be # overridden if per-conversation metadata is provided through the # `metadata_bucket_uri`. # @!attribute [rw] agent_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. # @!attribute [rw] customer_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. class ConversationConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#sample_size ⇒ ::Integer
Returns Optional. If set, this fields indicates the number of objects to ingest from the Cloud Storage bucket. If empty, the entire bucket will be ingested. Unless they are first deleted, conversations produced through sampling won't be ingested by subsequent ingest requests.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 364 class IngestConversationsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configuration for Cloud Storage bucket sources. # @!attribute [rw] bucket_uri # @return [::String] # Required. The Cloud Storage bucket containing source objects. # @!attribute [rw] bucket_object_type # @return [::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource::BucketObjectType] # Optional. Specifies the type of the objects in `bucket_uri`. # @!attribute [rw] metadata_bucket_uri # @return [::String] # Optional. The Cloud Storage path to the conversation metadata. Note that: # [1] Metadata files are expected to be in JSON format. # [2] Metadata and source files (transcripts or audio) must be in # separate buckets. # [3] A source file and its corresponding metadata file must share the same # name to # be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and # `gs://bucket/metadata/conversation1.json`. # @!attribute [rw] custom_metadata_keys # @return [::Array<::String>] # Optional. Custom keys to extract as conversation labels from metadata # files in `metadata_bucket_uri`. Keys not included in this field will be # ignored. Note that there is a limit of 20 labels per conversation. class GcsSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module BucketObjectType # The object type is unspecified and will default to `TRANSCRIPT`. BUCKET_OBJECT_TYPE_UNSPECIFIED = 0 # The object is a transcript. TRANSCRIPT = 1 # The object is an audio file. AUDIO = 2 end end # Configuration for processing transcript objects. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium] # Required. The medium transcript objects represent. class TranscriptObjectConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration that applies to all conversations. # @!attribute [rw] agent_id # @return [::String] # Optional. An opaque, user-specified string representing a human agent who # handled all conversations in the import. Note that this will be # overridden if per-conversation metadata is provided through the # `metadata_bucket_uri`. # @!attribute [rw] agent_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. # @!attribute [rw] customer_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. class ConversationConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#speech_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::SpeechConfig
Returns Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 364 class IngestConversationsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configuration for Cloud Storage bucket sources. # @!attribute [rw] bucket_uri # @return [::String] # Required. The Cloud Storage bucket containing source objects. # @!attribute [rw] bucket_object_type # @return [::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource::BucketObjectType] # Optional. Specifies the type of the objects in `bucket_uri`. # @!attribute [rw] metadata_bucket_uri # @return [::String] # Optional. The Cloud Storage path to the conversation metadata. Note that: # [1] Metadata files are expected to be in JSON format. # [2] Metadata and source files (transcripts or audio) must be in # separate buckets. # [3] A source file and its corresponding metadata file must share the same # name to # be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and # `gs://bucket/metadata/conversation1.json`. # @!attribute [rw] custom_metadata_keys # @return [::Array<::String>] # Optional. Custom keys to extract as conversation labels from metadata # files in `metadata_bucket_uri`. Keys not included in this field will be # ignored. Note that there is a limit of 20 labels per conversation. class GcsSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module BucketObjectType # The object type is unspecified and will default to `TRANSCRIPT`. BUCKET_OBJECT_TYPE_UNSPECIFIED = 0 # The object is a transcript. TRANSCRIPT = 1 # The object is an audio file. AUDIO = 2 end end # Configuration for processing transcript objects. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium] # Required. The medium transcript objects represent. class TranscriptObjectConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration that applies to all conversations. # @!attribute [rw] agent_id # @return [::String] # Optional. An opaque, user-specified string representing a human agent who # handled all conversations in the import. Note that this will be # overridden if per-conversation metadata is provided through the # `metadata_bucket_uri`. # @!attribute [rw] agent_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. # @!attribute [rw] customer_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. class ConversationConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |
#transcript_object_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::TranscriptObjectConfig
Returns Configuration for when source
contains conversation transcripts.
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 |
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 364 class IngestConversationsRequest include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods # Configuration for Cloud Storage bucket sources. # @!attribute [rw] bucket_uri # @return [::String] # Required. The Cloud Storage bucket containing source objects. # @!attribute [rw] bucket_object_type # @return [::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::GcsSource::BucketObjectType] # Optional. Specifies the type of the objects in `bucket_uri`. # @!attribute [rw] metadata_bucket_uri # @return [::String] # Optional. The Cloud Storage path to the conversation metadata. Note that: # [1] Metadata files are expected to be in JSON format. # [2] Metadata and source files (transcripts or audio) must be in # separate buckets. # [3] A source file and its corresponding metadata file must share the same # name to # be properly ingested, E.g. `gs://bucket/audio/conversation1.mp3` and # `gs://bucket/metadata/conversation1.json`. # @!attribute [rw] custom_metadata_keys # @return [::Array<::String>] # Optional. Custom keys to extract as conversation labels from metadata # files in `metadata_bucket_uri`. Keys not included in this field will be # ignored. Note that there is a limit of 20 labels per conversation. class GcsSource include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods module BucketObjectType # The object type is unspecified and will default to `TRANSCRIPT`. BUCKET_OBJECT_TYPE_UNSPECIFIED = 0 # The object is a transcript. TRANSCRIPT = 1 # The object is an audio file. AUDIO = 2 end end # Configuration for processing transcript objects. # @!attribute [rw] medium # @return [::Google::Cloud::ContactCenterInsights::V1::Conversation::Medium] # Required. The medium transcript objects represent. class TranscriptObjectConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end # Configuration that applies to all conversations. # @!attribute [rw] agent_id # @return [::String] # Optional. An opaque, user-specified string representing a human agent who # handled all conversations in the import. Note that this will be # overridden if per-conversation metadata is provided through the # `metadata_bucket_uri`. # @!attribute [rw] agent_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. # @!attribute [rw] customer_channel # @return [::Integer] # Optional. Indicates which of the channels, 1 or 2, contains the agent. # Note that this must be set for conversations to be properly displayed and # analyzed. class ConversationConfig include ::Google::Protobuf::MessageExts extend ::Google::Protobuf::MessageExts::ClassMethods end end |