IngestConversationsMetadata

JSON representation
IngestConversationsRequest
- JSON representation
GcsSource
- JSON representation
TranscriptObjectConfig
- JSON representation
ConversationConfig
- JSON representation
IngestConversationsStats
- JSON representation

The metadata for an IngestConversations operation.

JSON representation

JSON representation
{ "createTime": string, "endTime": string, "request": { object (`IngestConversationsRequest`) }, "partialErrors": [ { object (`Status`) } ], "ingestConversationsStats": { object (`IngestConversationsStats`) }, "sampledConversations": [ string ] }

{
  "createTime": string,
  "endTime": string,
  "request": {
    object (IngestConversationsRequest)
  },
  "partialErrors": [
    {
      object (Status)
    }
  ],
  "ingestConversationsStats": {
    object (IngestConversationsStats)
  },
  "sampledConversations": [
    string
  ]
}

Fields
`createTime`	`string (Timestamp format)` Output only. The time the operation was created. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`endTime`	`string (Timestamp format)` Output only. The time the operation finished running. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: `"2014-10-02T15:01:23Z"` and `"2014-10-02T15:01:23.045123456Z"`.
`request`	`object (IngestConversationsRequest)` Output only. The original request for ingest.
`partialErrors[]`	`object (Status)` Output only. Partial errors during ingest operation that might cause the operation output to be incomplete.
`ingestConversationsStats`	`object (IngestConversationsStats)` Output only. Statistics for IngestConversations operation.
`sampledConversations[]`	`string` Output only. Stores the conversation resources produced by ingest sampling operations.

IngestConversationsRequest

The request to ingest conversations.

JSON representation

JSON representation
{ "parent": string, "conversationConfig": { object (`ConversationConfig`) }, "redactionConfig": { object (`RedactionConfig`) }, "speechConfig": { object (`SpeechConfig`) }, // Union field `source` can be only one of the following: "gcsSource": { object (`GcsSource`) } // End of list of possible types for union field `source`. // Union field `object_config` can be only one of the following: "transcriptObjectConfig": { object (`TranscriptObjectConfig`) } // End of list of possible types for union field `object_config`. "sampleSize": integer }

{
  "parent": string,
  "conversationConfig": {
    object (ConversationConfig)
  },
  "redactionConfig": {
    object (RedactionConfig)
  },
  "speechConfig": {
    object (SpeechConfig)
  },

  // Union field source can be only one of the following:
  "gcsSource": {
    object (GcsSource)
  }
  // End of list of possible types for union field source.

  // Union field object_config can be only one of the following:
  "transcriptObjectConfig": {
    object (TranscriptObjectConfig)
  }
  // End of list of possible types for union field object_config.
  "sampleSize": integer
}

Fields
`parent`	`string` Required. The parent resource for new conversations.
`conversationConfig`	`object (ConversationConfig)` Configuration that applies to all conversations.
`redactionConfig`	`object (RedactionConfig)` Optional. DLP settings for transcript redaction. Optional, will default to the config specified in Settings.
`speechConfig`	`object (SpeechConfig)` Optional. Default Speech-to-Text configuration. Optional, will default to the config specified in Settings.
Union field `source`. Configuration for an external data store containing objects that will be converted to conversations. `source` can be only one of the following:
`gcsSource`	`object (GcsSource)` A cloud storage bucket source. Note that any previously ingested objects from the source will be skipped to avoid duplication.
Union field `object_config`. Configuration for converting individual `source` objects to conversations. `object_config` can be only one of the following:
`transcriptObjectConfig`	`object (TranscriptObjectConfig)` Configuration for when `source` contains conversation transcripts.
`sampleSize`	`integer` 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.

GcsSource

Configuration for Cloud Storage bucket sources.

JSON representation
{ "bucketUri": string, "bucketObjectType": enum (`BucketObjectType`), "customMetadataKeys": [ string ], "metadataBucketUri": string }

Fields
`bucketUri`	`string` Required. The Cloud Storage bucket containing source objects.
`bucketObjectType`	`enum (BucketObjectType)` Optional. Specifies the type of the objects in `bucketUri`.
`customMetadataKeys[]`	`string` Optional. Custom keys to extract as conversation labels from metadata files in `metadataBucketUri`. Keys not included in this field will be ignored. Note that there is a limit of 20 labels per conversation.
`metadataBucketUri`	`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`.

TranscriptObjectConfig

Configuration for processing transcript objects.

JSON representation
{ "medium": enum (`Medium`) }

Fields

Fields
`medium`	`enum (Medium)` Required. The medium transcript objects represent.

medium

enum (Medium)

Required. The medium transcript objects represent.

ConversationConfig

Configuration that applies to all conversations.

JSON representation
{ "agentId": string, "agentChannel": integer, "customerChannel": integer }

Fields

Fields
`agentId`	`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 `metadataBucketUri`.
`agentChannel`	`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.
`customerChannel`	`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.

agentId

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 metadataBucketUri.

agentChannel

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.

customerChannel

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.

IngestConversationsStats

Statistics for IngestConversations operation.

JSON representation
{ "processedObjectCount": integer, "duplicatesSkippedCount": integer, "successfulIngestCount": integer, "failedIngestCount": integer }

Fields
`processedObjectCount`	`integer` Output only. The number of objects processed during the ingest operation.
`duplicatesSkippedCount`	`integer` Output only. The number of objects skipped because another conversation with the same transcript uri had already been ingested.
`successfulIngestCount`	`integer` Output only. The number of new conversations added during this ingest operation.
`failedIngestCount`	`integer` Output only. The number of objects which were unable to be ingested due to errors. The errors are populated in the partialErrors field.