Class: Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest

Inherits:
Object
  • Object
show all
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

Instance Attribute Details

#conversation_config ⇒ ::Google::Cloud::ContactCenterInsights::V1::IngestConversationsRequest::ConversationConfig

Returns Configuration that applies to all conversations.

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 327

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`.
  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]
  #     An opaque, user-specified string representing the human agent who handled
  #     the conversations.
  # @!attribute [rw] agent_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the agent. Note that this must be set for
  #     audio conversations to be properly displayed and analyzed.
  # @!attribute [rw] customer_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the customer. Note that this must be set for
  #     audio 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.

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 327

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`.
  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]
  #     An opaque, user-specified string representing the human agent who handled
  #     the conversations.
  # @!attribute [rw] agent_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the agent. Note that this must be set for
  #     audio conversations to be properly displayed and analyzed.
  # @!attribute [rw] customer_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the customer. Note that this must be set for
  #     audio 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.

Returns:

  • (::String) —

    Required. The parent resource for new conversations.



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 327

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`.
  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]
  #     An opaque, user-specified string representing the human agent who handled
  #     the conversations.
  # @!attribute [rw] agent_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the agent. Note that this must be set for
  #     audio conversations to be properly displayed and analyzed.
  # @!attribute [rw] customer_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the customer. Note that this must be set for
  #     audio 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.

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 327

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`.
  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]
  #     An opaque, user-specified string representing the human agent who handled
  #     the conversations.
  # @!attribute [rw] agent_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the agent. Note that this must be set for
  #     audio conversations to be properly displayed and analyzed.
  # @!attribute [rw] customer_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the customer. Note that this must be set for
  #     audio 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.

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 327

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`.
  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]
  #     An opaque, user-specified string representing the human agent who handled
  #     the conversations.
  # @!attribute [rw] agent_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the agent. Note that this must be set for
  #     audio conversations to be properly displayed and analyzed.
  # @!attribute [rw] customer_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the customer. Note that this must be set for
  #     audio 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.

Returns:



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
 
# File 'proto_docs/google/cloud/contactcenterinsights/v1/contact_center_insights.rb', line 327

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`.
  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]
  #     An opaque, user-specified string representing the human agent who handled
  #     the conversations.
  # @!attribute [rw] agent_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the agent. Note that this must be set for
  #     audio conversations to be properly displayed and analyzed.
  # @!attribute [rw] customer_channel
  #   @return [::Integer]
  #     Optional. For audio conversations, this field indicates which of the
  #     channels, 1 or 2, contains the customer. Note that this must be set for
  #     audio conversations to be properly displayed and analyzed.
  class ConversationConfig
    include ::Google::Protobuf::MessageExts
    extend ::Google::Protobuf::MessageExts::ClassMethods
  end
end