REST Resource: projects.conversationDatasets

Resource: ConversationDataset

Represents a conversation dataset that a user imports raw data into. The data inside ConversationDataset can not be changed after conversationDatasets.importConversationData finishes (and calling conversationDatasets.importConversationData on a dataset that already has data is not allowed).

JSON representation
{
  "name": string,
  "displayName": string,
  "description": string,
  "createTime": string,
  "inputConfig": {
    object (InputConfig)
  },
  "conversationInfo": {
    object (ConversationInfo)
  },
  "conversationCount": string,
  "satisfiesPzi": boolean,
  "satisfiesPzs": boolean
}
Fields
name

string

Output only. ConversationDataset resource name. Format: projects/<Project ID>/locations/<Location ID>/conversationDatasets/<Conversation Dataset ID>

displayName

string

Required. The display name of the dataset. Maximum of 64 bytes.

description

string

Optional. The description of the dataset. Maximum of 10000 bytes.

createTime

string (Timestamp format)

Output only. Creation time of this dataset.

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

inputConfig

object (InputConfig)

Output only. Input configurations set during conversation data import.

conversationInfo

object (ConversationInfo)

Output only. Metadata set during conversation data import.

conversationCount

string (int64 format)

Output only. The number of conversations this conversation dataset contains.

satisfiesPzi

boolean

Output only. A read only boolean field reflecting Zone Isolation status of the dataset.

satisfiesPzs

boolean

Output only. A read only boolean field reflecting Zone Separation status of the dataset.

InputConfig

Represents the configuration of importing a set of conversation files in Google Cloud Storage.

JSON representation
{

  // Union field source can be only one of the following:
  "gcsSource": {
    object (GcsSources)
  }
  // End of list of possible types for union field source.
}
Fields
Union field source. Required. Where the data is from. source can be only one of the following:
gcsSource

object (GcsSources)

The Cloud Storage URI has the form gs:////agent*.json. Wildcards are allowed and will be expanded into all matched JSON files, which will be read as one conversation per file.

GcsSources

Google Cloud Storage location for the inputs.

JSON representation
{
  "uris": [
    string
  ]
}
Fields
uris[]

string

Required. Google Cloud Storage URIs for the inputs. A URI is of the form: gs://bucket/object-prefix-or-name Whether a prefix or name is used depends on the use case.

ConversationInfo

Represents metadata of a conversation.

JSON representation
{
  "languageCode": string
}
Fields
languageCode

string

Optional. The language code of the conversation data within this dataset. See https://cloud.google.com/apis/design/standard_fields for more information. Supports all UTF-8 languages.

Methods

get

Retrieves the specified conversation dataset.

importConversationData

Import data into the specified conversation dataset.

list

Returns the list of all conversation datasets in the specified project and location.