Schemas
The Mix.api endpoints use the following schemas.
mix.api.ASRBody
Message that defines an ASR build.
Properties
| Name | Type | Description |
|---|---|---|
| notes | string | Notes specified when starting the build. |
| dataSources | [mix.api.DataSource] | Data sources in the model, if applicable. |
Schema
{
"notes": "string",
"dataSources": [
{
"locale": "string",
"names": [
"string"
]
}
]
}
mix.api.AnaphoraType
Type of anaphora entity.
- ANAPHORA_NOT_SET: No anaphora type defined
- ANAPHORA_REF_MOMENT: References a time
- ANAPHORA_REF_PERSON: References a person
- ANAPHORA_REF_PLACE: References a place
- ANAPHORA_REF_THING: References a thing
Schema
"ANAPHORA_NOT_SET"
mix.api.AppConfigDeployment
Message that defines a deployment for an application configuration.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the deployment. |
| status | mix.api.DeploymentFlowStatus | Status of the deployment. |
| createTime | string (date-time) | Date and time the deployment was created. |
| updateTime | string (date-time) | Date and time the deployment was last updated. |
| envGeographyDeployments | [mix.api.EnvironmentGeographyAppConfigDeployment] | List of environment geographies where the application configuration was deployed. |
Schema
{
"id": "string",
"status": "STATUS_UNSPECIFIED",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"envGeographyDeployments": [
{
"id": "string",
"envGeography": {
"id": "string",
"geography": {
"id": "string",
"displayName": "string"
},
"envType": "EST_TYPE_UNSPECIFIED",
"envHost": "string",
"envName": "string"
},
"status": "STATUS_UNSPECIFIED",
"deploymentResult": "string",
"isOverridden": true,
"requestedBy": {
"id": "string",
"email": "string",
"createTime": "2019-08-24T14:15:22Z",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string"
},
"approvedBy": {
"id": "string",
"email": "string",
"createTime": "2019-08-24T14:15:22Z",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string"
},
"dataHosts": [
{
"id": "string",
"alias_id": "string",
"alias": "string",
"value": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"approvalRequired": true,
"environmentConfigurations": [
{
"label": "ECL_UNSPECIFIED",
"value": "string"
}
]
}
]
}
mix.api.AppCredential
Message that defines credentials.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the credentials. |
| appId | string | Credentials name (that is, the runtime app ID). |
| createTime | string (date-time) | Date and time the credentials were created. |
| updateTime | string (date-time) | Date and time the credentials were last updated. |
| clients | [mix.api.AppCredentialClient] | List of clients. |
Schema
{
"id": "string",
"appId": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"clients": [
{
"id": "string",
"clientId": "string",
"clientName": "string",
"oauthScopes": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z"
}
]
}
mix.api.AppCredentialClient
Message that defines defines a client.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique numeric ID identifying the client. |
| clientId | string | Client ID used for authorization. |
| clientName | string | Client name. |
| oauthScopes | string | List of scopes granted to this client. |
| createTime | string (date-time) | Date and time the client was created. |
| updateTime | string (date-time) | Date and time the client was last updated. |
Schema
{
"id": "string",
"clientId": "string",
"clientName": "string",
"oauthScopes": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z"
}
mix.api.AppCredentialView
Input field that specifies the application credentials information returned.
- ACV_VIEW_UNSPECIFIED: Returns credentials details without including clients
- ACV_FULL: Returns all credentials details, including list of clients
Schema
"ACV_VIEW_UNSPECIFIED"
mix.api.Application
Message that defines a Mix application.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the application in the organization. |
| applicationName | string | Name of the application. |
| createTime | string (date-time) | Date and time the application was created. |
| configs | [mix.api.ApplicationConfig] | List of application configurations. |
Schema
{
"id": "string",
"applicationName": "string",
"createTime": "2019-08-24T14:15:22Z",
"configs": [
{
"id": "string",
"tag": "string",
"createTime": "2019-08-24T14:15:22Z",
"deployments": [
{
"id": "string",
"status": "STATUS_UNSPECIFIED",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"envGeographyDeployments": [
{}
]
}
],
"parentId": "string",
"deploymentFlowId": 0,
"builds": {
"asr": {
"builds": [
null
],
"projectId": "string"
},
"nlu": {
"builds": [
null
],
"projectId": "string"
},
"dialog": {
"projectId": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {}
}
},
"projectDetails": {
"projectId": "string",
"projectName": "string",
"isChildDataCompliant": true,
"projectDescription": "string"
}
}
]
}
mix.api.ApplicationConfig
Message that defines an application configuration.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the application configuration. |
| tag | string | Context tag for the application configuration. |
| createTime | string (date-time) | Date and time the application configuration was created. |
| deployments | [mix.api.AppConfigDeployment] | List of deployments for this application configuration. |
| parentId | string | ID of the parent application configuration, when an application configuration was overridden. |
| deploymentFlowId | integer (int32) | ID of the configuration’s deployment flow. |
| builds | mix.api.ModelsContent | List of builds for this application configuration. |
| projectDetails | mix.api.ProjectDetails | Project details. |
Schema
{
"id": "string",
"tag": "string",
"createTime": "2019-08-24T14:15:22Z",
"deployments": [
{
"id": "string",
"status": "STATUS_UNSPECIFIED",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"envGeographyDeployments": [
{
"id": "string",
"envGeography": {
"id": null,
"geography": null,
"envType": null,
"envHost": null,
"envName": null
},
"status": "STATUS_UNSPECIFIED",
"deploymentResult": "string",
"isOverridden": true,
"requestedBy": {
"id": null,
"email": null,
"createTime": null,
"lastLoginTime": null,
"name": null
},
"approvedBy": {
"id": null,
"email": null,
"createTime": null,
"lastLoginTime": null,
"name": null
},
"dataHosts": [
{}
],
"createdAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"approvalRequired": true,
"environmentConfigurations": [
{}
]
}
]
}
],
"parentId": "string",
"deploymentFlowId": 0,
"builds": {
"asr": {
"builds": [
{
"locale": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {}
}
],
"projectId": "string"
},
"nlu": {
"builds": [
{
"locale": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {}
}
],
"projectId": "string"
},
"dialog": {
"projectId": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {
"errors": [
{}
]
}
}
},
"projectDetails": {
"projectId": "string",
"projectName": "string",
"isChildDataCompliant": true,
"projectDescription": "string"
}
}
mix.api.ApplicationConfigContent
Message that defines the application configuration to create.
Properties
| Name | Type | Description |
|---|---|---|
| dataHosts | [mix.api.DataHost] | List of data hosts to use for this application configuration. |
| deploymentFlowId | string | ID of the deployment flow to use for this application configuration. |
| tag | string | Application configuration context tag. |
| requestBuilds | mix.api.RequestModelsContent | List of models for this application configuration. |
| environmentConfigurations | [mix.api.EnvironmentConfiguration] | List of environment configurations to use for this application configuration. |
Schema
{
"dataHosts": [
{
"id": "string",
"alias": "string",
"environmentId": "string",
"environmentGeographyId": "string",
"value": "string"
}
],
"deploymentFlowId": "string",
"tag": "string",
"requestBuilds": {
"asr": [
{
"buildLabel": "string",
"locale": "string"
}
],
"nlu": [
{
"buildLabel": "string",
"locale": "string"
}
],
"dialog": {
"buildLabel": "string"
}
},
"environmentConfigurations": [
{
"label": "ECL_UNSPECIFIED",
"value": "string",
"environmentId": "string",
"environmentGeographyId": "string"
}
]
}
mix.api.ApplicationConfigDeployment
Message that defines an application configuration deployment.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Deployment ID. |
| configId | string | ID of application configuration. |
| approved | boolean | Approval status. |
| comment | string | Notes about the deployment, if any. |
| createTime | string (date-time) | Date and time the deployment was created. |
| updateTime | string (date-time) | Date and time the deployment was last updated. |
| promotionFlowStepId | string | Deployment flow step ID for this deployment. |
| code | integer (int32) | Deployment status gRPC code. See Status codes and their use in gRPC for a list of valid codes. |
Schema
{
"id": "string",
"configId": "string",
"approved": true,
"comment": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"promotionFlowStepId": "string",
"code": 0
}
mix.api.ApplicationConfigUndeployment
Message that defines an application configuration that was undeployed.
Properties
| Name | Type | Description |
|---|---|---|
| configId | string | ID of application configuration that was undeployed. |
| applicationConfigDeploymentId | string | Deployment ID. |
| environmentGeographyId | string | ID of the environment geography from which the application configuration was undeployed. |
| code | integer (int32) | Undeployment status code. |
| message | string | Undeployment status message. |
Schema
{
"configId": "string",
"applicationConfigDeploymentId": "string",
"environmentGeographyId": "string",
"code": 0,
"message": "string"
}
mix.api.ApplicationCredential
Message that defines a list of credentials for an application.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the list of credentials for an application. |
| createTime | string (date-time) | Date and time the list of credentials was created. |
| updateTime | string (date-time) | Date and time the list of credentials was last updated. |
| credential | mix.api.AppCredential | List of credentials for the application. |
| geographies | [mix.api.EnvironmentGeography] | List of environment geographies for the application. |
Schema
{
"id": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"credential": {
"id": "string",
"appId": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"clients": [
{
"id": "string",
"clientId": "string",
"clientName": "string",
"oauthScopes": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z"
}
]
},
"geographies": [
{
"id": "string",
"geography": {
"id": "string",
"displayName": "string"
},
"envType": "EST_TYPE_UNSPECIFIED",
"envHost": "string",
"envName": "string"
}
]
}
mix.api.ApplicationView
Input field that specifies the application information returned.
- AV_VIEW_UNSPECIFIED: Returns application details without including application configurations
- AV_FULL: Returns all application details, including the list of application configurations
- AV_FULL_AVAILABLE_CONFIGS: Returns all application details, omitting configs that are overridden
- AV_FULL_LIVE_CONFIGS: Returns all application configs that are deployed
Schema
"AV_VIEW_UNSPECIFIED"
mix.api.AssignVersionToSnapshotRequestPayload
Object used to assign a version.
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Version name. |
| description | string | Version description. |
Schema
{
"name": "string",
"description": "string"
}
mix.api.BaseBuildContent
Message that defines the content of an ASR or NLU build.
Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Build locale. |
| buildVersion | string | Build version. |
| buildLabel | string | Build label. |
| createTime | string (date-time) | Date and time the build was created. |
| buildStatus | mix.api.BuildStatusType | Build status. |
| buildErrors | mix.api.Errors | Build errors, if applicable. |
Schema
{
"locale": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {
"errors": [
{
"message": "string",
"code": "string"
}
]
}
}
mix.api.BaseEntity
Type for entities that are included by default with any NLU project. These are read-only.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | UUID of the entity. |
| name | string | Entity name. |
| dataType | mix.api.DataType | Data type for the entity. |
Schema
{
"id": "string",
"name": "string",
"dataType": "NOT_SET"
}
mix.api.BaseModelContent
Message that defines an ASR or NLU model.
Properties
| Name | Type | Description |
|---|---|---|
| builds | [mix.api.BaseBuildContent] | List of builds. |
| projectId | string | ID of the project for these builds. |
Schema
{
"builds": [
{
"locale": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {
"errors": [
{
"message": null,
"code": null
}
]
}
}
],
"projectId": "string"
}
mix.api.BaseRequestModelContent
Message that defines a base request model.
Properties
| Name | Type | Description |
|---|---|---|
| buildLabel | string | Display name of the build. |
| locale | string | Build locale. |
Schema
{
"buildLabel": "string",
"locale": "string"
}
mix.api.Bot
Message that defines a bot.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the bot in the organization. |
| applicationName | string | Name of the bot. |
| createTime | string (date-time) | Date and time the bot was created. |
| configs | [mix.api.BotConfig] | List of application configurations for this bot. |
Schema
{
"id": "string",
"applicationName": "string",
"createTime": "2019-08-24T14:15:22Z",
"configs": [
{
"id": "string",
"tag": "string",
"createTime": "2019-08-24T14:15:22Z",
"deployments": [
{
"id": "string",
"status": "STATUS_UNSPECIFIED",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"envGeographyDeployments": [
{}
]
}
],
"parentId": "string",
"hasInterface": true,
"deploymentFlowId": 0
}
]
}
mix.api.BotConfig
Message that defines an application configuration for a bot.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the application configuration for the bot. |
| tag | string | Context tag for the application configuration. |
| createTime | string (date-time) | Date and time the application configuration was created. |
| deployments | [mix.api.AppConfigDeployment] | List of deployments for this application configuration. |
| parentId | string | ID of the parent application configuration, when an application configuration was overridden. |
| hasInterface | boolean | Boolean indicating whether the application configuration has a dialog interface. |
| deploymentFlowId | integer (int32) | ID of the configuration’s deployment flow. |
Schema
{
"id": "string",
"tag": "string",
"createTime": "2019-08-24T14:15:22Z",
"deployments": [
{
"id": "string",
"status": "STATUS_UNSPECIFIED",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"envGeographyDeployments": [
{
"id": "string",
"envGeography": {
"id": null,
"geography": null,
"envType": null,
"envHost": null,
"envName": null
},
"status": "STATUS_UNSPECIFIED",
"deploymentResult": "string",
"isOverridden": true,
"requestedBy": {
"id": null,
"email": null,
"createTime": null,
"lastLoginTime": null,
"name": null
},
"approvedBy": {
"id": null,
"email": null,
"createTime": null,
"lastLoginTime": null,
"name": null
},
"dataHosts": [
{}
],
"createdAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"approvalRequired": true,
"environmentConfigurations": [
{}
]
}
]
}
],
"parentId": "string",
"hasInterface": true,
"deploymentFlowId": 0
}
mix.api.BotConfigInterface
Message that defines a bot configuration interface.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the configuration interface. |
| version | integer (int32) | Version of the dialog build. |
| createTime | string (date-time) | Date and time the configuration interface was created. |
| languageTopic | string | Topic domain of the ASR data pack. |
| locales | [string] | List of locales in the bot. |
| channels | [mix.api.Channel] | List of channels in the bot. |
| variables | [mix.api.Variable] | List of variables in the bot. |
| transferNodes | [mix.api.TransferNode] | List of transfer nodes in the bot. |
Schema
{
"id": "string",
"version": 0,
"createTime": "2019-08-24T14:15:22Z",
"languageTopic": "string",
"locales": [
"string"
],
"channels": [
{
"id": "string",
"displayName": "string",
"codeName": "string",
"modes": [
"MODE_UNSPECIFIED"
],
"color": "COLOR_UNSPECIFIED"
}
],
"variables": [
{
"id": "string",
"displayName": "string",
"description": "string",
"isReserved": true,
"simpleVariableType": "VT_TYPE_UNSPECIFIED",
"complexVariableTypeId": "string",
"simpleGenericType": "VT_TYPE_UNSPECIFIED",
"complexGenericTypeId": "string"
}
],
"transferNodes": [
{
"id": "string",
"nodeName": "string",
"nodeType": "TNT_TYPE_UNSPECIFIED",
"description": "string",
"requestVariables": [
{
"id": "string",
"displayName": "string",
"description": "string",
"isReserved": true,
"simpleVariableType": "VT_TYPE_UNSPECIFIED",
"complexVariableTypeId": "string",
"simpleGenericType": "VT_TYPE_UNSPECIFIED",
"complexGenericTypeId": "string"
}
]
}
]
}
mix.api.BotCredential
Message that defines a list of credentials for a bot.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the list of credentials for a bot. |
| createTime | string (date-time) | Date and time the list of credentials was created. |
| updateTime | string (date-time) | Date and time the list of credentials was last updated. |
| credential | mix.api.AppCredential | List of credentials for the bot. |
| geographies | [mix.api.EnvironmentGeography] | List of environment geographies for the bot. |
Schema
{
"id": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"credential": {
"id": "string",
"appId": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"clients": [
{
"id": "string",
"clientId": "string",
"clientName": "string",
"oauthScopes": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z"
}
]
},
"geographies": [
{
"id": "string",
"geography": {
"id": "string",
"displayName": "string"
},
"envType": "EST_TYPE_UNSPECIFIED",
"envHost": "string",
"envName": "string"
}
]
}
mix.api.BotCredentialView
Input field that specifies the bot credentials information returned.
- BCV_VIEW_UNSPECIFIED: Returns credentials details without including clients
- BCV_FULL: Returns all credentials details, including list of clients
Schema
"BCV_VIEW_UNSPECIFIED"
mix.api.BotView
Input field that specifies the bot information returned.
- BV_VIEW_UNSPECIFIED: Returns bot details without including application configurations
- BV_FULL: Returns all bot details, including the list of application configurations
- BV_FULL_AVAILABLE_CONFIGS: Returns all bot details, omitting configs that are overridden
- BV_FULL_LIVE_CONFIGS: Returns all bot configs that are deployed
Schema
"BV_VIEW_UNSPECIFIED"
mix.api.BuildProjectModelBody
Message that defines the builds to start.
Properties
| Name | Type | Description |
|---|---|---|
| asr | mix.api.ASRBody | Message that defines an ASR build. |
| dialog | mix.api.DialogBody | Message that defines a dialog build. |
| nlu | mix.api.NLUBody | Message that defines an NLU build. |
| locales | [string] | List of locales for which to create builds. |
Schema
{
"asr": {
"notes": "string",
"dataSources": [
{
"locale": "string",
"names": [
"string"
]
}
]
},
"dialog": {
"notes": "string"
},
"nlu": {
"notes": "string",
"settings": {
"modelType": "LEGACY"
},
"dataSources": [
{
"locale": "string",
"names": [
"string"
]
}
]
},
"locales": [
"string"
]
}
mix.api.BuildStatusType
ENUM that defines the status of the build.
- BST_NONE: No status available
- BST_COMPLETED: Build has completed
- BST_FAILED: Build has failed
- BST_STARTED: Build has started
Schema
"BST_NONE"
mix.api.BuildType
ENUM that defines the build type.
- NLU: NLU build
- ASR: ASR build
- DIALOG: Dialog build
Schema
"NLU"
mix.api.ChangeEntityTypeRequest.ChangeEntityTypeData
Object that defines the new entity type.
Properties
| Name | Type | Description |
|---|---|---|
| newType | mix.api.ChangeEntityTypeRequest.EntityType | The type to update the entity to. |
| pattern | string | The regular expression pattern for a regex-based entity. Required for REGEX type; otherwise, it is ignored.Applies to all languages initially. If different patterns are needed for different languages, use the Update an entity endpoint. |
| isA | string | The name of the entity that this entity has an isA relationship with. Required for RELATIONAL type; otherwise, it is ignored. |
| hasA | mix.api.HasA | Names of the entities that this entity has a hasA relationship with. Required for RELATIONAL type; otherwise, it is ignored. |
| data | object | List entity data to be added; key is a valid project locale. If provided, used for LIST type; otherwise, it is ignored. |
| dataType | mix.api.DataType | Data type for the entity. |
Schema
{
"newType": "UNSPECIFIED",
"pattern": "string",
"isA": "string",
"hasA": {
"entities": [
"string"
]
},
"data": {
"property1": {
"entries": [
{
"meaning": "string",
"patterns": [
"string"
]
}
]
},
"property2": {
"entries": [
{
"meaning": "string",
"patterns": [
"string"
]
}
]
}
},
"dataType": "NOT_SET"
}
mix.api.ChangeEntityTypeRequest.EntityType
ENUM that defines the entity types.
- UNSPECIFIED: No type specified
- RELATIONAL: Relationship entity
- LIST: List entity
- FREEFORM: Freeform entity
- REGEX: Regex-based entity
- RULE_BASED: Rule-based entity
Schema
"UNSPECIFIED"
mix.api.ChangeEntityTypeResponse
Response object returned by the Change entity type request.
Properties
| Name | Type | Description |
|---|---|---|
| entity | mix.api.EntityResponse | Response object for an entity. Only one of baseEntity, relationalEntity,listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned. |
Schema
{
"entity": {
"freeformEntity": {
"id": "335134db-e2f1-48b5-8abe-6dd4c0c4f98c",
"name": "COFFEE_FLAVORS",
"settings": {
"isSensitive": true,
"canonicalize": true
}
}
}
}
mix.api.Channel
Message that defines a channel.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | UUID of the channel. |
| displayName | string | Name of the channel. |
| codeName | string | Code name of the channel to use when invoking DLGaaS. |
| modes | [mix.api.Modality] | List of modalities available for messages in this channel. |
| color | mix.api.ChannelColor | Color of the channel. |
Schema
{
"id": "string",
"displayName": "string",
"codeName": "string",
"modes": [
"MODE_UNSPECIFIED"
],
"color": "COLOR_UNSPECIFIED"
}
mix.api.ChannelColor
ENUM that defines the possible colors for a channel.
- COLOR_UNSPECIFIED: No color specified
- PURPLE: Set channel color to purple, Hex code #871699
- LIGHT_ORANGE: Set channel color to light orange, Hex code #F59E47
- GREEN: Set channel color to green, Hex code #31B96E
- CORN_FLOWER: Set channel color to corn flower, Hex code #7894F2
- PINK: Set channel color to pink, Hex code #DA2B7F
- YELLOW: Set channel color to yellow, Hex code #F8DC4F
- TEAL: Set channel color to teal, Hex code #2EB8B5
- LIGHT_GREY: Set channel color to light grey, Hex code #BDCBDB
- SALMON: Set channel color to salmon, Hex code #FE6D6D
- BROWN: Set channel color to brown, Hex code #A86315
- SKY: Set channel color to sky, Hex code #5CBCF0
- GREY: Set channel color to grey, Hex code #6D7E97
- LIGHT_PURPLE: Set channel color to light purple, Hex code #B58AF5
- RUBY: Set channel color to ruby, Hex code #C51F10
- LIGHT_GREEN: Set channel color to light green, Hex code #65DC93
- BLUE: Set channel color to blue, Hex code #2980D6
- LIGHT_PINK: Set channel color to light pink, Hex code #F67EB2
- ORANGE: Set channel color to orange, Hex code #E66819
- CYAN: Set channel color to cyan, Hex code #57DBCF
- INDIGO: Set channel color to indigo, Hex code #4E5ADA
Schema
"COLOR_UNSPECIFIED"
mix.api.ChannelRequest
Message that defines the channels to include in a new project.
Properties
| Name | Type | Description |
|---|---|---|
| displayName | string | Name of the channel. |
| modes | [mix.api.Modality] | List of modalities available for messages in this channel. |
| color | mix.api.ChannelColor | Color of the channel. |
Schema
{
"displayName": "string",
"modes": [
"MODE_UNSPECIFIED"
],
"color": "COLOR_UNSPECIFIED"
}
mix.api.ChannelTarget
Message that defines a channel in a project.
Properties
| Name | Type | Description |
|---|---|---|
| channel | mix.api.Channel | Project channel. |
| isActive | boolean | When set to true, indicates that the channel is active. |
Schema
{
"channel": {
"id": "string",
"displayName": "string",
"codeName": "string",
"modes": [
"MODE_UNSPECIFIED"
],
"color": "COLOR_UNSPECIFIED"
},
"isActive": true
}
mix.api.ChildDataCompliant
Properties
| Name | Type | Description |
|---|---|---|
| isAccepted | boolean | When set to true, indicates the child data compliance policy was accepted for this project. |
| createTime | string (date-time) | Date and time the child data compliance policy was created. |
| updateTime | string (date-time) | Date and time the child data compliance policy was last updated. |
| projectDescription | string | Child data compliance policy description for this project. |
Schema
{
"isAccepted": true,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"projectDescription": "string"
}
mix.api.CompatibleEntityType
Message that defines the compatible entity type.
Properties
| Name | Type | Description |
|---|---|---|
| name | mix.api.ListEntitiesRequest.EntityType | Entity type name. |
| default | boolean | If set to true, specifies the default entity type for this data type. |
| initializer | object | Initializer. |
Schema
{
"name": "UNSPECIFIED",
"default": true,
"initializer": {}
}
mix.api.CoreDatapack
Message that defines an ASR core data pack.
Properties
| Name | Type | Description |
|---|---|---|
| isActive | boolean | When set to true, indicates that the locale/data pack is active. |
| displayName | string | Locale name. |
| version | string | Locale version. |
| isDefault | boolean | When set to true, indicates that the locale/data pack is the default one. |
Schema
{
"isActive": true,
"displayName": "string",
"version": "string",
"isDefault": true
}
mix.api.CreateApplicationConfigResponse
Response object returned by the Create application configuration request.
Properties
| Name | Type | Description |
|---|---|---|
| config | mix.api.ApplicationConfig | Application configuration. |
Schema
{
"config": {
"id": "2097",
"tag": "billing_application",
"deployments": [
{
"id": "38",
"status": "PENDING_REQUEST",
"envGeographyDeployments": []
}
],
"parentId": "null",
"deploymentFlowId": 38,
"createTime": "2021-04-21T19:45:44.809Z"
}
}
mix.api.CreateEntityPayload
Message that defines the entity to create. Only one of relationalEntity, listEntity,
freeformEntity, regexEntity, or ruleBasedEntity can be defined.
Properties
| Name | Type | Description |
|---|---|---|
| relationalEntity | mix.api.RelationalEntityCreateRequest | Request object for creating a relational entity. At least one of isA or hasA must be specified. |
| listEntity | mix.api.ListEntityCreateRequest | Request object for creating a list entity. |
| freeformEntity | mix.api.FreeformEntityCreateRequest | Request object for creating a freeform entity. |
| regexEntity | mix.api.RegexEntityCreateRequest | Request object for creating a regex-based entity. |
| ruleBasedEntity | mix.api.RuleBasedEntityCreateRequest | Request object for creating a rule-based entity. |
Schema
{
"listEntity": {
"name": "BILL_PAID",
"isDynamic": false,
"settings": {
"isSensitive": false,
"canonicalize": true
},
"dataType": "YES_NO",
"data": {
"en-US": {
"entries": [
{
"meaning": "yes",
"patterns": [
"yes"
]
},
{
"meaning": "no",
"patterns": [
"no"
]
}
]
}
}
}
}
mix.api.CreateEntityResponse
Response object returned by the Create entity request.
Properties
| Name | Type | Description |
|---|---|---|
| entity | mix.api.EntityResponse | Response object for an entity. Only one of baseEntity, relationalEntity,listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned. |
Schema
{
"entity": {
"listEntity": {
"id": "deaacb09-80ad-4bb1-bf2d-352ec62e1e7c",
"name": "COFFEE_TOPPINGS",
"isDynamic": false,
"numLiterals": 0,
"settings": {
"isSensitive": false,
"canonicalize": true
}
}
}
}
mix.api.CreateIntentPayload
Message that defines the intent to create.
Properties
| Name | Type | Description |
|---|---|---|
| intentName | string | Intent name. |
Schema
{
"intentName": "string"
}
mix.api.CreateIntentResponse
Response object returned by the Create intent request.
Properties
| Name | Type | Description |
|---|---|---|
| intent | mix.api.IntentResponse | Intent object. |
Schema
{
"intent": {
"id": "be567689-7948-45db-ae9a-8c18f5dc4634",
"name": "PAY_COFFEE",
"isInBaseOntology": false,
"links": []
}
}
mix.api.CreateProjectChannelResponse
Response object returned by the Create project channel request.
Properties
| Name | Type | Description |
|---|---|---|
| channel | mix.api.Channel | Deprecated. Project channel. |
| isActive | boolean | When set to true, indicates that the channel is active. |
| extendedChannel | mix.api.ExtendedChannel | Message that defines a project channel. |
Schema
{
"channel": {
"id": "33849b2a-24f5-493e-b156-d91799d5186d",
"displayName": "Custom channel",
"codeName": "custom",
"modes": [
"RICH_TEXT"
],
"color": "INDIGO"
},
"isActive": true
}
mix.api.CreateProjectResponse
Response object returned by the Create project request.
Properties
| Name | Type | Description |
|---|---|---|
| project | mix.api.Project | Message that defines a project. |
Schema
{
"project": {
"id": "23977",
"displayName": "Quick Start",
"languageTopic": "gen",
"channels": [
{
"channel": {
"id": "34791",
"displayName": "Text VA",
"modes": [
"RICH_TEXT"
],
"color": "GREEN"
},
"isActive": true
}
],
"datapacks": [
{
"isActive": true,
"displayName": "en-US",
"version": "4.7.0",
"isDefault": true
},
{
"isActive": true,
"displayName": "fr-CA",
"version": "4.1.0",
"isDefault": true
}
],
"baseDatapack": "9.4.1.19",
"orgId": "2",
"createTime": "2021-03-02T20:18:09.281Z",
"updateTime": "2021-03-02T20:18:03Z"
}
}
mix.api.DataHost
Data host object.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | ID of the data host. |
| alias | string | Alias of the data host. |
| environmentId | string | ID of the environment. |
| environmentGeographyId | string | ID of the environment geography. |
| value | string | Data host URL. |
Schema
{
"id": "string",
"alias": "string",
"environmentId": "string",
"environmentGeographyId": "string",
"value": "string"
}
mix.api.DataPackUpdateRequest
Message that defines the locale and version to update.
Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Locale for which to update the Nuance data pack version; for example, en-US. |
| version | string | Version of the Nuance data pack to update to; for example, 4.7.0. |
Schema
{
"locale": "string",
"version": "string"
}
mix.api.DataSource
Message that defines the NLU data source (prebuilt domain).
Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Locale for which the specified NLU data sources will be used. |
| names | [string] | Names for the NLU data sources; for example, nuance_weather. |
Schema
{
"locale": "string",
"names": [
"string"
]
}
mix.api.DataType
ENUM that defines the available data types.
- NOT_SET: Nothing set.
- NO_FORMAT: No format.
- YES_NO: Literals mapped to the values “yes” and “no”.
- BOOLEAN: Literals mapped to the values “true” and “false”.
- NUMBER: Integers or decimal numbers.
- DIGITS: Numeric characters.
- DATE: The grammar must return a value with this format: YYYYMMDD.
- TIME: The grammar must return a value with this format: HHMM.
- ALPHANUM: Letters and numeric characters: A-Z, a-z, 0-9, or equivalent characters for the active language.
- AMOUNT: The grammar must return a JSON object literal with a number and a unit.
- DISTANCE: The grammar must return a JSON object literal with a number and a unit.
- TEMPERATURE: The grammar must return a JSON object literal with a number and a unit.
Schema
"NOT_SET"
mix.api.DataTypes
Message that defines the data types.
Properties
| Name | Type | Description |
|---|---|---|
| name | mix.api.DataType | Data type name. |
| schema | object | Data type schema. |
| compatibleEntityTypes | [mix.api.CompatibleEntityType] | Entity types that support this data type. |
Schema
{
"name": "NOT_SET",
"schema": {},
"compatibleEntityTypes": [
{
"name": "UNSPECIFIED",
"default": true,
"initializer": {}
}
]
}
mix.api.DeleteEnvironmentConfigurationResponse
Response object returned by the Delete environment configuration request.
Properties
None
Schema
{}
mix.api.DeleteProjectEnvironmentConfigurationResponse
Response object returned by the Delete project environment configuration request.
Properties
None
Schema
{}
mix.api.DeployApplicationConfigResponse
Response object returned by the Deploy application configuration response.
Properties
| Name | Type | Description |
|---|---|---|
| deployments | [mix.api.ApplicationConfigDeployment] | List of application configurations deployed. |
Schema
{
"deployments": [
{
"id": "1425",
"configId": "2101",
"approved": true,
"comment": "",
"promotionFlowStepId": "38",
"code": 0,
"createTime": "2021-04-22T18:37:38.806Z",
"updateTime": "2021-04-22T18:37:38.806Z"
}
]
}
mix.api.DeploymentFlow
Message that defines a deployment flow.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the deployment flow in the organization. |
| displayName | string | Name of the deployment flow. |
| steps | [mix.api.DeploymentFlowStep] | List of steps in the flow. |
Schema
{
"id": "string",
"displayName": "string",
"steps": [
{
"id": "string",
"step": 0,
"requiresApproval": true,
"environments": [
{
"id": "string",
"displayName": "string",
"geographies": [
{}
]
}
]
}
]
}
mix.api.DeploymentFlowStatus
ENUM that defines the possible status of a deployment in the flow.
- DEPLOYED: Application configuration was deployed in the environment geography. The deployment may or may not have been successful. See deploymentResult for details.
- PENDING_APPROVAL: Deployment is pending approval
- PENDING_REQUEST: Application configuration was created but not deployed
- OVERRIDDEN: Deployment was overridden
- REJECTED: Request for deployment approval was rejected
- UNDEPLOYED: Application configuration has not yet been deployed in a preceding environment geography in this flow
- ACCEPTED: Request for approval was accepted. Deployment is in progress.
Schema
"STATUS_UNSPECIFIED"
mix.api.DeploymentFlowStep
Message that defines a step within a deployment flow.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the deployment flow step. |
| step | integer (int32) | Position of the step within the flow. |
| requiresApproval | boolean | When set to true, indicates that the deployment step requires approval. |
| environments | [mix.api.Environment] | List of environments for this step. |
Schema
{
"id": "string",
"step": 0,
"requiresApproval": true,
"environments": [
{
"id": "string",
"displayName": "string",
"geographies": [
{
"id": "string",
"geography": {
"id": null,
"displayName": null
},
"envType": "EST_TYPE_UNSPECIFIED",
"envHost": "string",
"envName": "string"
}
]
}
]
}
mix.api.DialogBody
Message that defines a dialog build.
Properties
| Name | Type | Description |
|---|---|---|
| notes | string | Notes specified when starting the build. |
Schema
{
"notes": "string"
}
mix.api.DialogBuildContent
Message that defines a dialog build.
Properties
| Name | Type | Description |
|---|---|---|
| projectId | string | ID of the project for the build. |
| buildVersion | string | Build version. |
| buildLabel | string | Build label. |
| createTime | string (date-time) | Date and time the build was created. |
| buildStatus | mix.api.BuildStatusType | Build status. |
| buildErrors | mix.api.Errors | Build errors, if applicable. |
Schema
{
"projectId": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {
"errors": [
{
"message": "string",
"code": "string"
}
]
}
}
mix.api.DialogRequestModelContent
Message that defines a dialog request model content.
Properties
| Name | Type | Description |
|---|---|---|
| buildLabel | string | Display name of the build. |
Schema
{
"buildLabel": "string"
}
mix.api.EnginePack
Message that defines an engine pack.
Properties
| Name | Type | Description |
|---|---|---|
| enginePackId | string | UUID of the engine pack. |
| version | string | Version of the engine pack as displayed in the Mix dashboard. |
| dialogVersion | string | Version of the Dialog engine supported by this engine pack. |
| nluVersion | string | Version of the NLU engine supported by this engine pack. |
| asrVersion | string | Version of the ASR engine supported by this engine pack. |
| ttsVersion | string | Version of the TTS engine supported by this engine pack. |
| isDefault | boolean | When set to true, indicates that this is the default engine pack version used when creating projects. |
| topics | [mix.api.EnginePack.Topic] | List of language topics supported in this engine pack version. |
Schema
{
"enginePackId": "string",
"version": "string",
"dialogVersion": "string",
"nluVersion": "string",
"asrVersion": "string",
"ttsVersion": "string",
"isDefault": true,
"topics": {
"property1": {
"locales": {
"property1": {
"versions": [
{}
]
},
"property2": {
"versions": [
{}
]
}
}
},
"property2": {
"locales": {
"property1": {
"versions": [
{}
]
},
"property2": {
"versions": [
{}
]
}
}
}
}
}
mix.api.EnginePack.DataPackVersion
Message that defines a data pack version.
Properties
| Name | Type | Description |
|---|---|---|
| version | string | Data pack version. |
| isSupported | boolean | When set to true, indicates that the data pack version is supported. |
Schema
{
"version": "string",
"isSupported": true
}
mix.api.EnginePack.Locale
Message that defines a locale for a language topic.
Properties
| Name | Type | Description |
|---|---|---|
| versions | [mix.api.EnginePack.DataPackVersion] | The data pack versions available for this locale in this language topic. Ordered by decreasing semantic version number. |
Schema
{
"versions": [
{
"version": "string",
"isSupported": true
}
]
}
mix.api.EnginePack.Topic
Message that defines a language topic.
Properties
| Name | Type | Description |
|---|---|---|
| locales | [mix.api.EnginePack.Locale] | List of language topics supported in this engine pack version. |
Schema
{
"locales": {
"property1": {
"versions": [
{
"version": "string",
"isSupported": true
}
]
},
"property2": {
"versions": [
{
"version": "string",
"isSupported": true
}
]
}
}
}
mix.api.EntityPayload
Message that defines the content to update in an entity. Only one of relationalEntity, listEntity,
freeformEntity, regexEntity, or ruleBasedEntity can be defined.
Properties
| Name | Type | Description |
|---|---|---|
| relationalEntity | mix.api.RelationalEntityUpdateRequest | Request object for updating a relational entity. |
| listEntity | mix.api.ListEntityUpdateRequest | Request object for updating a list entity. |
| freeformEntity | mix.api.FreeformEntityUpdateRequest | Request object for updating a freeform entity. |
| regexEntity | mix.api.RegexEntityUpdateRequest | Request object for updating a regex-based entity. |
| ruleBasedEntity | mix.api.RuleBasedEntityUpdateRequest | Request object for updating a rule-based entity. |
Schema
{
"listEntity": {
"settings": {
"isSensitive": true
}
}
}
mix.api.EntityResponse
Response object for an entity. Only one of baseEntity, relationalEntity,
listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned.
Properties
| Name | Type | Description |
|---|---|---|
| baseEntity | mix.api.BaseEntity | Type for entities that are included by default with any NLU project. These are read-only. |
| relationalEntity | mix.api.RelationalEntity | Entity type that represents a relationship to one or more other entities. |
| listEntity | mix.api.ListEntity | Entity type used for recognizing a value from a list of finite literals. |
| freeformEntity | mix.api.FreeformEntity | Entity type used for recognizing any textual value. This is typically used for dictation. |
| regexEntity | mix.api.RegexEntity | Entity type used for pattern matching. |
| ruleBasedEntity | mix.api.RuleBasedEntity | Entity type used for recognizing a value based on a GrXML grammar file. |
Schema
{}
mix.api.EntitySettings
Message that defines the settings for an entity.
Properties
| Name | Type | Description |
|---|---|---|
| isSensitive | boolean | When set to true, indicates that the entity is sensitive. |
| canonicalize | boolean | When set to true, indicates that the entity is canonicalized. |
Schema
{
"isSensitive": true,
"canonicalize": true
}
mix.api.EntityTypes
Message that defines the entity types.
Properties
| Name | Type | Description |
|---|---|---|
| name | mix.api.ListEntitiesRequest.EntityType | Entity type name. |
| description | string | Entity type description. |
| initializer | object | Initializer. |
| compatibleDataTypes | [mix.api.DataType] | Data types supported by this entity type. |
Schema
{
"name": "UNSPECIFIED",
"description": "string",
"initializer": {},
"compatibleDataTypes": [
"NOT_SET"
]
}
mix.api.Environment
Message that defines an environment.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the environment in the organization. |
| displayName | string | Name of the environment. |
| geographies | [mix.api.EnvironmentGeography] | List of environment geographies. |
Schema
{
"id": "string",
"displayName": "string",
"geographies": [
{
"id": "string",
"geography": {
"id": "string",
"displayName": "string"
},
"envType": "EST_TYPE_UNSPECIFIED",
"envHost": "string",
"envName": "string"
}
]
}
mix.api.EnvironmentConfigLabel
Message that defines types of environment configurations.
- ECL_UNSPECIFIED: No type specified.
- GRAMMAR_BASE_PATH: Contains the base path to be prepended to all grammar URLs at runtime.
Schema
"ECL_UNSPECIFIED"
mix.api.EnvironmentConfiguration
Message that defines an environment configuration.
Properties
| Name | Type | Description |
|---|---|---|
| label | mix.api.EnvironmentConfigLabel | Label that identifies the type of environment configuration (for example, GRAMMAR_BASE_PATH). |
| value | string | Environment configuration value. |
| environmentId | string | ID of the environment where this configuration is defined. |
| environmentGeographyId | string | ID of the environment geography where this configuration is defined. |
Schema
{
"label": "ECL_UNSPECIFIED",
"value": "string",
"environmentId": "string",
"environmentGeographyId": "string"
}
mix.api.EnvironmentGeography
Message that defines an environment geography.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the environment geography. |
| geography | mix.api.Geography | Object defining the Nuance geography. |
| envType | mix.api.EnvironmentType | Type of environment. |
| envHost | string | Host of environment. |
| envName | string | Environment name. |
Schema
{
"id": "string",
"geography": {
"id": "string",
"displayName": "string"
},
"envType": "EST_TYPE_UNSPECIFIED",
"envHost": "string",
"envName": "string"
}
mix.api.EnvironmentGeographyAppConfigDeployment
Message that defines the list of environment geographies where the application configuration was deployed.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the deployment flow for an application configuration. |
| envGeography | mix.api.EnvironmentGeography | Environment geography where the application configuration was deployed. |
| status | mix.api.DeploymentFlowStatus | Indicates the status of the deployment in the flow (DEPLOYED, PENDING_REQUEST, and so on). |
| deploymentResult | string | Indicates the result of the deployment operation (success, stuck, and so on). |
| isOverridden | boolean | Boolean indicating whether this deployed application configuration was overridden. |
| requestedBy | mix.api.User | User that requested this deployment. |
| approvedBy | mix.api.User | User that approved this deployment (if approval was required). |
| dataHosts | [mix.api.EnvironmentGeography AppConfigDeployment. AppConfigDataHost] | List of data hosts assigned to this application configuration. |
| createdAt | string (date-time) | Date and time the deployment to this environment-geography was created. |
| approvedAt | string (date-time) | Date and time the deployment to this environment-geography was approved (if approval was required). |
| approvalRequired | boolean | When set to true, indicates that this environment-geography requires approval to deploy to it. |
| environmentConfigurations | [mix.api.EnvironmentGeographyAppConfigDeployment.AppConfigEnvironmentConfiguration] | List of environment configurations assigned to this application configuration. |
Schema
{
"id": "string",
"envGeography": {
"id": "string",
"geography": {
"id": "string",
"displayName": "string"
},
"envType": "EST_TYPE_UNSPECIFIED",
"envHost": "string",
"envName": "string"
},
"status": "STATUS_UNSPECIFIED",
"deploymentResult": "string",
"isOverridden": true,
"requestedBy": {
"id": "string",
"email": "string",
"createTime": "2019-08-24T14:15:22Z",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string"
},
"approvedBy": {
"id": "string",
"email": "string",
"createTime": "2019-08-24T14:15:22Z",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string"
},
"dataHosts": [
{
"id": "string",
"alias_id": "string",
"alias": "string",
"value": "string"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"approvedAt": "2019-08-24T14:15:22Z",
"approvalRequired": true,
"environmentConfigurations": [
{
"label": "ECL_UNSPECIFIED",
"value": "string"
}
]
}
mix.api.EnvironmentGeographyAppConfigDeployment.AppConfigDataHost
Properties
| Name | Type | Description |
|---|---|---|
| id | string | ID of the AppConfig data host. |
| alias_id | string | ID of the alias. |
| alias | string | Alias of the data host. |
| value | string | Value of the AppConfig data host. |
Schema
{
"id": "string",
"alias_id": "string",
"alias": "string",
"value": "string"
}
mix.api.EnvironmentGeographyAppConfigDeployment.AppConfigEnvironmentConfiguration
Object used to return each external resource configuration in an application configuration.
Properties
| Name | Type | Description |
|---|---|---|
| label | mix.api.EnvironmentConfigLabel | Environment configuration label. |
| value | string | Environment configuration value. |
Schema
{
"label": "ECL_UNSPECIFIED",
"value": "string"
}
mix.api.EnvironmentType
ENUM that defines the type of environment.
- EST_TYPE_UNSPECIFIED: Unspecified type
- SANDBOX: Sandbox environment
- PRODUCTION: Production environment
Schema
"EST_TYPE_UNSPECIFIED"
mix.api.Error
Message that defines an error.
Properties
| Name | Type | Description |
|---|---|---|
| message | string | Error message, if applicable. |
| code | string | Error code, if applicable. |
Schema
{
"message": "string",
"code": "string"
}
mix.api.Errors
Message that defines errors.
Properties
| Name | Type | Description |
|---|---|---|
| errors | [mix.api.Error] | List of build errors, if applicable. |
Schema
{
"errors": [
{
"message": "string",
"code": "string"
}
]
}
mix.api.ExtendedChannel
Message that defines an ExtendedChannel object, which provides an extended set of attributes about the channels available in a project.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | UUID of the channel. |
| displayName | string | Name of the channel. |
| codeName | string | Code name of the channel to use when invoking DLGaaS. |
| modes | [mix.api.ExtendedModality] | List of modalities available for messages in this channel. |
| color | mix.api.ChannelColor | Color of the channel. |
Schema
{
"id": "string",
"displayName": "string",
"codeName": "string",
"modes": [
{
"mode": "MODE_UNSPECIFIED",
"isActive": true
}
],
"color": "COLOR_UNSPECIFIED"
}
mix.api.ExtendedChannelTarget
Message that defines an ExtendedChannelTarget object, which provides an extended set of attributes about the channel targets available in a project.
Properties
| Name | Type | Description |
|---|---|---|
| channel | mix.api.ExtendedChannel | Project channel. |
| isActive | boolean | When set to true, indicates that the channel is active. |
Schema
{
"channel": {
"id": "string",
"displayName": "string",
"codeName": "string",
"modes": [
{
"mode": "MODE_UNSPECIFIED",
"isActive": true
}
],
"color": "COLOR_UNSPECIFIED"
},
"isActive": true
}
mix.api.ExtendedModality
Message that defines an ExtendedModality object, which provides an extended set of attributes about the modalities available in a project.
Properties
| Name | Type | Description |
|---|---|---|
| mode | mix.api.Modality | Modality name. |
| isActive | boolean | When set to true, indicates that the modality is active. |
Schema
{
"mode": "MODE_UNSPECIFIED",
"isActive": true
}
mix.api.ExtendedProject
Message that defines an ExtendedProject object.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the project. |
| displayName | string | Project name. |
| languageTopic | string | Project language topic. |
| createTime | string (date-time) | Date and time the project was created. |
| updateTime | string (date-time) | Date and time the project was last updated. |
| channels | [mix.api.ChannelTarget] | Deprecated. List of channels available in this project. |
| datapacks | [mix.api.CoreDatapack] | List of core data packs available in this project. |
| baseDatapack | string | QuickNLP data pack used in this project. |
| enginePackId | string | The ID of the engine pack associated with this project, if defined. |
| isFavorite | boolean | When set to true, indicates the project is in the user’s Favorites list. |
| orgId | string | ID identifying the organization for this project. |
| lastSavedTime | string (date-time) | Date and time the project was last saved. |
| lastUsedTime | string (date-time) | Date and time the project was last used. |
| lock | mix.api.ProjectLock | Project lock instance, if available. |
| orgDisplayName | string | Name identifying the organization for this project. |
| lastAsrModelCreateTime | string (date-time) | Date and time the last ASR model was created. |
| lastNluModelCreateTime | string (date-time) | Date and time the last NLU model was created. |
| lastDialogModelCreateTime | string (date-time) | Date and time the last Dialog model was created. |
| policy | mix.api.ChildDataCompliant | Child data compliancy policy. |
| extendedChannels | [mix.api.ExtendedChannelTarget] | List of ExtendedChannelTarget objects, which provide an extended set of attributes about the channel targets available in this project. |
| enginePackFeatures | [string] | List of features supported by this project’s engine pack. |
Schema
{
"id": "string",
"displayName": "string",
"languageTopic": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"channels": [
{
"channel": {
"id": "string",
"displayName": "string",
"codeName": "string",
"modes": [
"MODE_UNSPECIFIED"
],
"color": "COLOR_UNSPECIFIED"
},
"isActive": true
}
],
"datapacks": [
{
"isActive": true,
"displayName": "string",
"version": "string",
"isDefault": true
}
],
"baseDatapack": "string",
"enginePackId": "string",
"isFavorite": true,
"orgId": "string",
"lastSavedTime": "2019-08-24T14:15:22Z",
"lastUsedTime": "2019-08-24T14:15:22Z",
"lock": {
"lockId": "18",
"projectId": "2960",
"lockOwner": {
"id": "36",
"email": "alex.smith@company.com"
},
"notes": "Exporting model",
"createTime": "2021-11-10T15:33:35Z"
},
"orgDisplayName": "string",
"lastAsrModelCreateTime": "2019-08-24T14:15:22Z",
"lastNluModelCreateTime": "2019-08-24T14:15:22Z",
"lastDialogModelCreateTime": "2019-08-24T14:15:22Z",
"policy": {
"isAccepted": true,
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"projectDescription": "string"
},
"extendedChannels": [
{
"channel": {
"id": "string",
"displayName": "string",
"codeName": "string",
"modes": [
{
"mode": null,
"isActive": null
}
],
"color": "COLOR_UNSPECIFIED"
},
"isActive": true
}
],
"enginePackFeatures": [
"string"
]
}
mix.api.FreeformEntity
Entity type used for recognizing any textual value. This is typically used for dictation.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | UUID of the entity. |
| name | string | Entity name. |
| dataSource | string | Data source used for this entity. |
| settings | mix.api.EntitySettings | Settings defined for this entity. |
| dataType | mix.api.DataType | Data type for the entity. |
Schema
{
"id": "string",
"name": "string",
"dataSource": "string",
"settings": {
"isSensitive": true,
"canonicalize": true
},
"dataType": "NOT_SET"
}
mix.api.FreeformEntityCreateRequest
Request object for creating a freeform entity.
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Entity name. |
| settings | mix.api.EntitySettings | Settings defined for this entity. |
| dataType | mix.api.DataType | Data type for the entity. |
Schema
{
"name": "string",
"settings": {
"isSensitive": true,
"canonicalize": true
},
"dataType": "NOT_SET"
}
mix.api.FreeformEntityUpdateRequest
Request object for updating a freeform entity.
Properties
| Name | Type | Description |
|---|---|---|
| settings | mix.api.EntitySettings | Settings defined for this entity. |
| dataType | mix.api.DataType | Data type for the entity. |
Schema
{
"settings": {
"isSensitive": true,
"canonicalize": true
},
"dataType": "NOT_SET"
}
mix.api.GenericBuildReport
Message that defines a build report.
Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Locale used for the build, if applicable. |
| version | string | Build model version, if applicable. |
| errors | mix.api.Errors | Job errors, if applicable. |
| buildLabel | string | Build label, if applicable. |
| createTime | string (date-time) | Date and time the report was created. |
| status | string | Status of the task. |
Schema
{
"locale": "string",
"version": "string",
"errors": {
"errors": [
{
"message": "string",
"code": "string"
}
]
},
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"status": "string"
}
mix.api.GenericBuildReports
Message that defines a list of build reports.
Properties
| Name | Type | Description |
|---|---|---|
| reports | [mix.api.GenericBuildReport] | List of build reports. |
Schema
{
"reports": [
{
"locale": "string",
"version": "string",
"errors": {
"errors": [
{
"message": null,
"code": null
}
]
},
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"status": "string"
}
]
}
mix.api.GenericProjectReport
Message that defines a project report.
Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Project locale, if applicable. |
| errors | mix.api.Errors | Job errors, if applicable. |
| status | mix.api.JobStatusType | Status of the job. |
| intent | string | Target intent, if applicable. |
| entity | string | Target entity, if applicable. |
| createTime | string (date-time) | Date and time the report was created. |
Schema
{
"locale": "string",
"errors": {
"errors": [
{
"message": "string",
"code": "string"
}
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
mix.api.GenericProjectReports
Message that defines a list of project related reports.
Properties
| Name | Type | Description |
|---|---|---|
| reports | [mix.api.GenericProjectReport] | List of project reports. |
Schema
{
"reports": [
{
"locale": "string",
"errors": {
"errors": [
{
"message": null,
"code": null
}
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
}
mix.api.Geography
Message that defines a Nuance geography.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the Nuance geography. |
| displayName | string | Name of the Nuance geography (for example, US, Canada). |
Schema
{
"id": "string",
"displayName": "string"
}
mix.api.GetApplicationConfigResponse
Response object returned by the Get application configuration request.
Properties
| Name | Type | Description |
|---|---|---|
| config | mix.api.ApplicationConfig | Application configuration. |
Schema
{
"config": {
"id": "670",
"tag": "A35_C670",
"deployments": [
{
"id": "38",
"status": "DEPLOYED",
"envGeographyDeployments": [
{
"id": "645",
"envGeography": {
"id": "37",
"geography": {
"id": "1",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com",
"envName": "Sandbox"
},
"status": "DEPLOYED",
"deploymentResult": "success",
"isOverridden": false,
"dataHosts": []
}
]
}
],
"parentId": "",
"deploymentFlowId": 38,
"builds": {
"asr": {
"builds": [
{
"locale": "en-US",
"buildVersion": "2",
"buildLabel": "ASR_17100_2",
"createTime": "2020-07-16T20:40:25Z"
},
{
"locale": "fr-FR",
"buildVersion": "1",
"buildLabel": "ASR_17100_1",
"createTime": "2020-07-16T20:40:15Z"
}
],
"projectId": "17100"
},
"nlu": {
"builds": [
{
"locale": "en-US",
"buildVersion": "2",
"buildLabel": "NLU_17100_2",
"createTime": "2020-07-16T20:40:20Z"
},
{
"locale": "fr-FR",
"buildVersion": "1",
"buildLabel": "NLU_17100_1",
"createTime": "2020-07-16T20:40:11Z"
}
],
"projectId": "17100"
}
},
"projectDetails": {
"projectId": "17100",
"projectName": "CoffeeApp MultiLang",
"isChildDataCompliant": true,
"projectDescription": ""
},
"createTime": "2020-07-20T18:38:22Z"
}
}
mix.api.GetBotConfigInterfaceResponse
Response object returned by the Get Bot Config Interface request.
Properties
| Name | Type | Description |
|---|---|---|
| interface | mix.api.BotConfigInterface | Interface for the bot and application configuration specified. |
Schema
{
"interface": {
"id": "1159",
"version": 7,
"languageTopic": "gen",
"locales": [
"en-US"
],
"channels": [
{
"id": "8e432bd2-6512-4da3-8236-66a6f94b6e44",
"displayName": "Audio VA",
"codeName": "Audio VA",
"modes": [
"TTS"
],
"color": "COLOR_UNSPECIFIED"
},
{
"id": "88544ae0-9fe1-4a3b-b7eb-129614c3532a",
"displayName": "Text VA",
"codeName": "Text VA",
"modes": [
"RICH_TEXT"
],
"color": "COLOR_UNSPECIFIED"
},
{
"id": "bd47faf3-ec97-4f63-ac8d-53f7822c2d24",
"displayName": "IVR/Voice VA",
"codeName": "IVR/Voice VA",
"modes": [
"AUDIO_SCRIPT"
],
"color": "COLOR_UNSPECIFIED"
},
{
"id": "42dcfbf7-86b2-46f8-b495-0d3bf7907248",
"displayName": "Digital VA",
"codeName": "Digital VA",
"modes": [
"INTERACTIVITY",
"RICH_TEXT",
"TTS"
],
"color": "COLOR_UNSPECIFIED"
},
{
"id": "454bea86-0e77-49b4-b527-0188d46a52c2",
"displayName": "Omni Channel VA",
"codeName": "Omni Channel VA",
"modes": [
"AUDIO_SCRIPT",
"INTERACTIVITY",
"RICH_TEXT",
"TTS"
],
"color": "COLOR_UNSPECIFIED"
},
{
"id": "23371c6d-2760-4aed-af6e-13c75d86f3a6",
"displayName": "Default",
"codeName": "default",
"modes": [
"TTS",
"AUDIO_SCRIPT",
"RICH_TEXT",
"INTERACTIVITY"
],
"color": "COLOR_UNSPECIFIED"
}
],
"variables": [
{
"id": "f1718da9-1653-4f5e-a0c1-3d1f581231d6",
"displayName": "accountList",
"description": "",
"isReserved": false,
"simpleVariableType": "LIST_TYPE",
"complexGenericTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
},
{
"id": "a49808bf-4f4f-4e38-bb35-7e173547cb06",
"displayName": "language",
"description": "The current language; initially set to the default language of the project",
"isReserved": true,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "d2dc5ba3-98da-4292-8fe7-a619682d725a",
"displayName": "intentValue",
"description": "",
"isReserved": false,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "5cf039f0-c109-4243-971a-3f46f501f999",
"displayName": "date",
"description": "",
"isReserved": false,
"simpleVariableType": "DATE_TYPE"
},
{
"id": "34e222aa-5489-4870-934a-a7d7460110ca",
"displayName": "returnMessage",
"description": "The return message variable that describes the meaning of the returnCode variable",
"isReserved": true,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "dcb0e74f-1bd2-4f1f-a342-e3ccee4e5fad",
"displayName": "timezone",
"description": "",
"isReserved": false,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "f864ab5e-e951-402e-a9fb-c9f905e1d13a",
"displayName": "myAccount",
"description": "",
"isReserved": false,
"complexVariableTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
},
{
"id": "3cc3578f-7f41-4761-a15e-19e621d6b681",
"displayName": "userData",
"description": "The data collected from the end user.",
"isReserved": true,
"complexVariableTypeId": "c4ea5e93-fca4-40a8-99c9-bb442f6ec0cc"
},
{
"id": "e4f2b89b-9551-4ebb-8d6d-2e513d814d35",
"displayName": "lastConfirmationResultObject",
"description": "",
"isReserved": true,
"complexVariableTypeId": "21f00d74-95f7-4cbf-a20e-ea877ea72de1"
},
{
"id": "9cf698cd-445e-4dac-9fa7-620db10b654b",
"displayName": "channelIntegration",
"description": "The channel integration on the client-side.",
"isReserved": true,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "11ad45b4-f7ac-4b2e-832e-f32f6ad51da3",
"displayName": "randomInt",
"description": "",
"isReserved": false,
"simpleVariableType": "INTEGER_TYPE"
},
{
"id": "9422d27d-5b61-4e05-8701-c4cbf8352219",
"displayName": "payeeWordset",
"description": "",
"isReserved": false,
"simpleVariableType": "DYNAMIC_ENTITY_DATA"
},
{
"id": "2d0e7d7f-04b1-4403-9f07-9944df0a929f",
"displayName": "accountTypeWordset",
"description": "",
"isReserved": false,
"simpleVariableType": "DYNAMIC_ENTITY_DATA"
},
{
"id": "fb8a0614-1f3f-428c-97f5-e3d241723f5d",
"displayName": "nulString",
"description": "",
"isReserved": false,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "47bce83f-9d4a-4a79-a6b4-c36d605b59a4",
"displayName": "myMessageVar",
"description": "",
"isReserved": false,
"complexVariableTypeId": "a5133103-dfe2-4432-83ba-0a057ecbc05d"
},
{
"id": "d7ce400f-dc6f-4e7d-80e5-f0744b8a776e",
"displayName": "temp",
"description": "",
"isReserved": false,
"simpleVariableType": "AMOUNT_TYPE"
},
{
"id": "51b23544-6986-418b-beda-14486fd37656",
"displayName": "intentLiteral",
"description": "",
"isReserved": false,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "b2112948-d648-4f90-a3ef-02457b1776c4",
"displayName": "returnCode",
"description": "The return code variable for data access nodes",
"isReserved": true,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "b519fa46-c4bc-431d-b4c6-e846445c4af6",
"displayName": "confidenceScore",
"description": "",
"isReserved": false,
"simpleVariableType": "STRING_TYPE"
},
{
"id": "86b14181-5dcf-449a-b1b9-03f43a22bd80",
"displayName": "lastCollectionResultObject",
"description": "",
"isReserved": true,
"complexVariableTypeId": "21f00d74-95f7-4cbf-a20e-ea877ea72de1"
},
{
"id": "7f24bf8d-519f-4f47-9a31-e594b6d5d0be",
"displayName": "user",
"description": "",
"isReserved": false,
"complexVariableTypeId": "d6c03136-1c81-47ec-a0c4-e1d04415e3aa"
},
{
"id": "afaa4ea6-ecd8-42a6-bc30-cc5ded710cc0",
"displayName": "previousIntent",
"description": "",
"isReserved": false,
"simpleVariableType": "STRING_TYPE"
}
],
"transferNodes": [
{
"id": "5414ad73-0da7-47ae-9f4a-d870cc8f4e27",
"nodeName": "MainEnd",
"nodeType": "END",
"description": "",
"requestVariables": []
},
{
"id": "86880327-8fa6-4aba-b3d3-f9317215956f",
"nodeName": "EscalateAction",
"nodeType": "ESCALATE",
"description": "",
"requestVariables": [
{
"id": "f864ab5e-e951-402e-a9fb-c9f905e1d13a",
"displayName": "myAccount",
"description": "",
"isReserved": false,
"complexVariableTypeId": "d8101c7e-6d4c-4f55-bbee-0e23bd728cae"
},
{
"id": "7f24bf8d-519f-4f47-9a31-e594b6d5d0be",
"displayName": "user",
"description": "",
"isReserved": false,
"complexVariableTypeId": "d6c03136-1c81-47ec-a0c4-e1d04415e3aa"
},
{
"id": "51b23544-6986-418b-beda-14486fd37656",
"displayName": "intentLiteral",
"description": "",
"isReserved": false,
"simpleVariableType": "STRING_TYPE"
}
]
}
],
"createTime": "2021-01-28T01:19:03.468Z"
}
}
mix.api.GetBuildResponse
Response object returned by the Get build details request.
Properties
| Name | Type | Description |
|---|---|---|
| projectId | string | ID of the project. |
| buildLabel | string | Display name of the build. |
| buildId | string | ID of the build. |
| buildType | mix.api.BuildType | Type of build. |
| buildVersion | string | Model version. |
| status | mix.api.BuildStatusType | Build status of the model. |
| errors | mix.api.Errors | Build errors, if applicable. |
| createTime | string (date-time) | Date and time the model was created. |
| languageTopic | string | Language topic of the model, if applicable. |
| datapack | mix.api.CoreDatapack | Data pack used in the model, if applicable. |
| dynamicEntities | [object] | Dynamic entities in the model, if applicable. |
| notes | string | Model notes. |
| modelType | mix.api.NLUModelType | NLU Model type, if applicable. |
| dataSources | [object] | Data sources in the model, if applicable. |
| parentNLUBuildLabel | string | Parent NLU Build id, if applicable. |
Schema
{
"projectId": "11624",
"buildLabel": "NLU_11624_1",
"buildId": "463",
"buildType": "NLU",
"buildVersion": "1",
"status": "BST_COMPLETED",
"languageTopic": "gen",
"datapack": {
"displayName": "en-US",
"version": "4.5.0"
},
"notes": "",
"createTime": "2020-05-06T19:02:09.262Z",
"modelType": "LEGACY"
}
mix.api.GetEntityResponse
Response object returned by the Get entity details request.
Properties
| Name | Type | Description |
|---|---|---|
| entity | mix.api.EntityResponse | Response object for an entity. Only one of baseEntity, relationalEntity,listEntity, freeformEntity, regexEntity, or ruleBasedEntity can be returned. |
Schema
{
"entity": {
"listEntity": {
"id": "73cb7c26-fed5-4331-8701-6736d98c40d6",
"name": "COFFEE_TYPE",
"isDynamic": false,
"numLiterals": 9,
"settings": {
"isSensitive": false,
"canonicalize": true
},
"dataType": "NO_FORMAT"
}
}
}
mix.api.GetEnvironmentConfigurationsResponse
Response object returned by the Get environment configurations request.
Properties
| Name | Type | Description |
|---|---|---|
| projectDefaults | [mix.api.GetEnvironmentConfigurationsResponse.EnvironmentConfigurationLabelAndValue] | List of project-level default configuration values. |
| environments | [mix.api.GetEnvironmentConfigurationsResponse.Environment] | List of environments. |
Schema
{
"projectDefaults": [
{
"label": "ECL_UNSPECIFIED",
"value": "string"
}
],
"environments": [
{
"id": "string",
"name": "string",
"environmentGeographies": [
{
"id": "string",
"name": "string",
"environmentGeographyDefaults": [
{}
]
}
]
}
]
}
mix.api.GetEnvironmentConfigurationsResponse.Environment
Message that defines an environment, including its environment geographies with their default configuration values.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | ID of the environment. |
| name | string | Name of the environment. |
| environmentGeographies | [mix.api.GetEnvironmentConfigurationsResponse.Environment.EnvironmentGeography] | List of environment geographies. |
Schema
{
"id": "string",
"name": "string",
"environmentGeographies": [
{
"id": "string",
"name": "string",
"environmentGeographyDefaults": [
{
"label": "ECL_UNSPECIFIED",
"value": "string"
}
]
}
]
}
mix.api.GetEnvironmentConfigurationsResponse.Environment.EnvironmentGeography
Message that defines an environment geography, including its default configuration values.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | ID of the environment geography. |
| name | string | Name of the environment geography. |
| environmentGeographyDefaults | [mix.api.GetEnvironmentConfigurationsResponse.EnvironmentConfigurationLabelAndValue] | List of default configuration values for the environment geography. |
Schema
{
"id": "string",
"name": "string",
"environmentGeographyDefaults": [
{
"label": "ECL_UNSPECIFIED",
"value": "string"
}
]
}
mix.api.GetEnvironmentConfigurationsResponse.EnvironmentConfigurationLabelAndValue
Message that defines an environment configuration type and value.
Properties
| Name | Type | Description |
|---|---|---|
| label | mix.api.EnvironmentConfigLabel | Label that identifies the type of environment configuration (for example, GRAMMAR_BASE_PATH). |
| value | string | Environment configuration value. |
Schema
{
"label": "ECL_UNSPECIFIED",
"value": "string"
}
mix.api.GetIntentResponse
Response object returned by the Get intent details request.
Properties
| Name | Type | Description |
|---|---|---|
| intent | mix.api.IntentResponse | Details of the intent. |
Schema
{
"intent": {
"id": "a9e7428a-5c12-4ead-9aad-c6b7d8723ee7",
"name": "ORDER_COFFEE",
"isInBaseOntology": false,
"links": [
{
"entityRef": "COFFEE_SIZE"
},
{
"entityRef": "COFFEE_TYPE"
}
]
}
}
mix.api.GetProjectLockResponse
Response object returned by the Get project lock request.
Properties
| Name | Type | Description |
|---|---|---|
| lock | mix.api.ProjectLock | Project lock instance, if available. |
Schema
{
"lock": {
"lockId": "18",
"projectId": "2960",
"lockOwner": {
"id": "36",
"email": "alex.smith@company.com"
},
"notes": "Exporting model",
"createTime": "2021-11-10T15:33:35Z"
}
}
mix.api.GetProjectResponse
Response object returned by the Get project details request.
Properties
| Name | Type | Description |
|---|---|---|
| project | mix.api.Project | Details of the project. |
Schema
{
"project": {
"id": "23079",
"displayName": "GA Bank Demo",
"languageTopic": "gen",
"channels": [
{
"channel": {
"id": "33424",
"displayName": "Omni Channel VA",
"codeName": "Omni Channel VA",
"modes": [
"AUDIO_SCRIPT",
"DTMF",
"INTERACTIVITY",
"RICH_TEXT",
"TTS"
],
"color": "PURPLE"
},
"isActive": true
},
{
"channel": {
"id": "33425",
"displayName": "IVR/Voice VA",
"codeName": "IVR/Voice VA",
"modes": [
"AUDIO_SCRIPT",
"DTMF"
],
"color": "LIGHT_ORANGE"
},
"isActive": true
},
{
"channel": {
"id": "33426",
"displayName": "Digital VA",
"codeName": "Digital VA",
"modes": [
"INTERACTIVITY",
"RICH_TEXT",
"TTS"
],
"color": "GREEN"
},
"isActive": true
},
{
"channel": {
"id": "33427",
"displayName": "Text VA",
"codeName": "Text VA",
"modes": [
"RICH_TEXT"
],
"color": "CORN_FLOWER"
},
"isActive": true
},
{
"channel": {
"id": "33428",
"displayName": "Audio VA",
"codeName": "Audio VA",
"modes": [
"TTS"
],
"color": "PINK"
},
"isActive": true
}
],
"datapacks": [
{
"displayName": "fr-FR",
"version": "4.1.0",
"isActive": true,
"isDefault": true
},
{
"displayName": "en-US",
"version": "4.7.0",
"isActive": true,
"isDefault": true
}
],
"baseDatapack": "9.4.1.25",
"orgId": "2",
"createTime": "2021-01-18T16:44:58.947Z",
"updateTime": "2021-01-18T16:45:56Z"
}
}
mix.api.HasA
Message that defines a HasA object.
Properties
| Name | Type | Description |
|---|---|---|
| entities | [string] | Names of the entities that this entity has a hasA relationship with.Set entities to empty (that is, to []) in order to clear the values when using the Update an entity request. |
Schema
{
"entities": [
"string"
]
}
mix.api.IntentResponse
Message that defines an intent.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the intent. |
| name | string | Intent name. |
| isInBaseOntology | boolean | When set to true, indicates that this intent is in the base ontology. |
| links | [mix.api.Link] | List of entities linked to this intent. |
| dataSource | string | Data source used for this intent, if applicable. |
Schema
{
"id": "a9e7428a-5c12-4ead-9aad-c6b7d8723ee7",
"name": "ORDER_COFFEE",
"isInBaseOntology": false,
"links": [
{
"entityRef": "COFFEE_SIZE"
},
{
"entityRef": "COFFEE_TYPE"
}
]
}
mix.api.JobReport
Message that defines a job report.
Properties
| Name | Type | Description |
|---|---|---|
| nluBuildReports | mix.api.GenericBuildReports | NLU job reports, if applicable. |
| asrBuildReports | mix.api.GenericBuildReports | ASR job reports, if applicable. |
| dialogBuildReports | mix.api.GenericBuildReports | Dialog job reports, if applicable. |
| replaceProjectDialogReports | mix.api.GenericProjectReports | Replace project dialog job reports, if applicable. |
| replaceProjectContentReports | mix.api.GenericProjectReports | Replace project content job reports, if applicable. |
| replaceProjectPronunciationsReports | mix.api.GenericProjectReports | Replace project pronunciations job reports, if applicable. |
| replaceProjectTransformationsReports | mix.api.GenericProjectReports | Replace project transformations job reports, if applicable. |
| resetProjectReports | mix.api.GenericProjectReports | Reset project job reports, if applicable. |
| appendProjectOntologyReports | mix.api.GenericProjectReports | Append project ontology job reports, if applicable. |
| addProjectIntentSamplesReports | mix.api.GenericProjectReports | Add project intent samples job reports, if applicable. |
| removeProjectIntentSamplesReports | mix.api.GenericProjectReports | Remove project intent samples job reports, if applicable. |
| addEntityLiteralsReports | mix.api.GenericProjectReports | Add entity literals job reports, if applicable. |
| removeEntityLiteralsReports | mix.api.GenericProjectReports | Remove entity literals task reports, if applicable. |
| replaceProjectMetadataReports | mix.api.GenericProjectReports | Replace project metadata reports, if applicable.(Limited to project channels). |
| updateDatapackReports | mix.api.GenericProjectReports | Update NLU data pack reports, if applicable. |
Schema
{
"nluBuildReports": {
"reports": [
{
"locale": "string",
"version": "string",
"errors": {
"errors": [
null
]
},
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"status": "string"
}
]
},
"asrBuildReports": {
"reports": [
{
"locale": "string",
"version": "string",
"errors": {
"errors": [
null
]
},
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"status": "string"
}
]
},
"dialogBuildReports": {
"reports": [
{
"locale": "string",
"version": "string",
"errors": {
"errors": [
null
]
},
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"status": "string"
}
]
},
"replaceProjectDialogReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"replaceProjectContentReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"replaceProjectPronunciationsReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"replaceProjectTransformationsReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"resetProjectReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"appendProjectOntologyReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"addProjectIntentSamplesReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"removeProjectIntentSamplesReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"addEntityLiteralsReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"removeEntityLiteralsReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"replaceProjectMetadataReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"updateDatapackReports": {
"reports": [
{
"locale": "string",
"errors": {
"errors": [
null
]
},
"status": "RUNNING",
"intent": "string",
"entity": "string",
"createTime": "2019-08-24T14:15:22Z"
}
]
},
"applicationDeploymentReports": {
"reports": [
{
"status": "RUNNING",
"applicationId": "string",
"applicationConfigId": "string",
"powerPlatformBotId": "string",
"errors": {
"errors": [
null
]
},
"createTime": "2019-08-24T14:15:22Z"
}
]
}
}
mix.api.JobResponse
Response object returned by the Get job details request.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | ID of the job. |
| type | mix.api.JobType | Type of the job. |
| projectId | string | ID of the project for which the job was created. |
| status | mix.api.JobStatusType | Status of the job. |
| report | mix.api.JobReport | Job report, if applicable. |
| createTime | string (date-time) | Date and time the job was created. |
| updateTime | string (date-time) | Date and time the job was last updated. |
| duration | string | Duration for the current job state. |
Schema
{
"id": "430a4626-3b41-4fa2-bb8b-db1c7c2c7189",
"type": "APPEND_INTENT_SAMPLES",
"projectId": "2960",
"status": "COMPLETED",
"report": {
"addProjectIntentSamplesReports": {
"reports": [
{
"status": "COMPLETED",
"locale": "en-US",
"createTime": "2021-06-08T21:10:38.076Z"
}
]
}
},
"createTime": "2021-06-08T21:10:37.456Z",
"updateTime": "2021-06-08T21:10:52.052Z",
"duration": "14.596s"
}
mix.api.JobStatusType
ENUM that defines the status of a job.
- RUNNING: Job is currently running
- COMPLETED: Job has completed
- PARTIALLY_COMPLETED: Job has partially completed; for example, a build operation failed
- FAILED: Job has failed
- CANCELED: Job was cancelled
- TIMED_OUT: Job has timed out; this occurs when a job fails to complete in 6 hours
- STARTED: Job has started
Schema
"RUNNING"
mix.api.JobType
ENUM that defines the type of job.
- BUILD_MODELS: Build ASR, NLU, and dialog models
- REPLACE_PROJECT: Replace project
- APPEND_ONTOLOGY: Append ontology
- APPEND_INTENT_SAMPLES: Append samples to intent
- REPLACE_INTENT_SAMPLES: Replace intent samples
- APPEND_ENTITY_LITERALS: Append entity literals
- REPLACE_ENTITY_LITERALS: Replace entity literals
- UPDATE_DATAPACK: Update data pack
Schema
"BUILD_MODELS"
mix.api.LanguageTopic
Message that defines a language topic.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the language topic. |
| name | string | Name of the language topic. |
| locales | [mix.api.LanguageTopicLocale] | List of locales for a language topic. |
Schema
{
"id": "string",
"name": "string",
"locales": [
{
"locale": "string",
"language": "string",
"country": "string",
"displayLanguage": "string",
"displayCountry": "string",
"versions": [
"string"
]
}
]
}
mix.api.LanguageTopicLocale
Message that defines a locale for a language topic.
Properties
| Name | Type | Description |
|---|---|---|
| locale | string | Code of the locale. |
| language | string | Language code of this locale. |
| country | string | Country code of this locale. |
| displayLanguage | string | Display name of the language. |
| displayCountry | string | Display name of the country. |
| versions | [string] | The data pack versions available for this locale in this language topic. Ordered by decreasing semantic version number. |
Schema
{
"locale": "string",
"language": "string",
"country": "string",
"displayLanguage": "string",
"displayCountry": "string",
"versions": [
"string"
]
}
mix.api.Link
Message that defines an entity linked to an intent.
Properties
| Name | Type | Description |
|---|---|---|
| entityRef | string | Name of the linked entity. |
Schema
{
"entityRef": "string"
}
mix.api.ListApplicationConfigsResponse
Response object returned by the Get list of application configurations request.
Properties
| Name | Type | Description |
|---|---|---|
| configs | [mix.api.ApplicationConfig] | List of application configurations. |
| totalSize | integer (int32) | Total number of application configurations that match the request. |
Schema
{
"configs": [
{
"id": "670",
"tag": "A35_C670",
"deployments": [
{
"id": "38",
"status": "DEPLOYED",
"envGeographyDeployments": [
{
"id": "645",
"envGeography": {
"id": "37",
"geography": {
"id": "1",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com",
"envName": "Sandbox"
},
"status": "DEPLOYED",
"deploymentResult": "success",
"isOverridden": false,
"dataHosts": []
}
]
}
],
"parentId": "",
"deploymentFlowId": 38,
"builds": {
"asr": {
"builds": [
{
"locale": "fr-FR",
"buildVersion": "1",
"buildLabel": "ASR_17100_1",
"createTime": "2020-07-16T20:40:15Z"
},
{
"locale": "en-US",
"buildVersion": "2",
"buildLabel": "ASR_17100_2",
"createTime": "2020-07-16T20:40:25Z"
}
],
"projectId": "17100"
},
"nlu": {
"builds": [
{
"locale": "fr-FR",
"buildVersion": "1",
"buildLabel": "NLU_17100_1",
"createTime": "2020-07-16T20:40:11Z"
},
{
"locale": "en-US",
"buildVersion": "2",
"buildLabel": "NLU_17100_2",
"createTime": "2020-07-16T20:40:20Z"
}
],
"projectId": "17100"
}
},
"projectDetails": {
"projectId": "17100",
"projectName": "CoffeeApp MultiLang",
"isChildDataCompliant": true,
"projectDescription": ""
},
"createTime": "2020-07-20T18:38:22Z"
}
],
"totalSize": 1
}
mix.api.ListApplicationCredentialsResponse
Response object returned by the Get application credentials request.
Properties
| Name | Type | Description |
|---|---|---|
| credentials | [mix.api.ApplicationCredential] | List of credentials for the application. |
Schema
{
"credentials": [
{
"id": "35",
"credential": {
"id": "35",
"appId": "NMDPTRIAL_alex_smith_company_com_20200116T154425699927",
"clients": [
{
"id": "26",
"clientId": "appID:NMDPTRIAL_alex_smith_company_com_20200116T154425699927",
"clientName": "default",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2020-01-16T15:44:25.803Z",
"updateTime": "2020-02-06T17:15:36.682Z"
},
{
"id": "452",
"clientId": "appID:NMDPTRIAL_alex_smith_company_com_20200116T154425699927:geo:dev:clientName:mdc_dev",
"clientName": "mdc_dev",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2020-10-23T02:45:00.585Z",
"updateTime": "2020-10-23T02:45:00.694Z"
}
],
"createTime": "2020-01-16T15:44:25.803Z",
"updateTime": "2020-02-06T17:15:36.682Z"
},
"geographies": [
{
"id": "37",
"geography": {
"id": "1",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
],
"createTime": "2020-01-16T15:44:26.008Z",
"updateTime": "2020-10-23T02:44:57.157Z"
}
]
}
mix.api.ListApplicationsResponse
Response object returned by the Get list of applications request.
Properties
| Name | Type | Description |
|---|---|---|
| applications | [mix.api.Application] | List of Mix applications. |
| totalSize | integer (int32) | Total number of applications that match the request. |
Schema
{
"applications": [
{
"id": "48",
"applicationName": "Mix Sample App",
"configs": [
{
"id": "180",
"tag": "MyCoffeeApp",
"deployments": [
{
"id": "57",
"status": "DEPLOYED",
"envGeographyDeployments": [
{
"id": "170",
"envGeography": {
"id": "57",
"geography": {
"id": "1",
"displayName": "Azure East US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
},
"status": "STATUS_UNSPECIFIED",
"deploymentResult": "n/a",
"isOverridden": true
}
]
}
],
"parentId": "179",
"deploymentFlowId": 57,
"builds": {
"asr": {
"builds": [
{
"locale": "en-US",
"buildVersion": "3",
"buildLabel": "ASR_525_3",
"createTime": "2019-10-24T15:44:38.097Z"
}
],
"projectId": "525"
},
"nlu": {
"builds": [
{
"locale": "en-US",
"buildVersion": "3",
"buildLabel": "NLU_525_3",
"createTime": "2019-10-24T15:44:34.333Z"
}
],
"projectId": "525"
},
"dialog": {
"projectId": "525",
"buildVersion": "2",
"buildLabel": "DIALOG_525_2",
"createTime": "2019-10-24T16:26:50.750Z"
}
},
"createTime": "2019-10-24T16:27:20.473Z"
}
],
"createTime": "2020-12-10T19:00:27.226Z"
}
],
"totalSize": 1
}
mix.api.ListBotConfigsResponse
Response object returned by the Get Bot Configs request.
Properties
| Name | Type | Description |
|---|---|---|
| configs | [mix.api.BotConfig] | List of application configurations for the bot. |
Schema
{
"configs": [
{
"id": "1386",
"tag": "TestBotV3",
"deployments": [
{
"id": "339",
"status": "DEPLOYED",
"envGeographyDeployments": [
{
"id": "1159",
"envGeography": {
"id": "338",
"geography": {
"id": "1",
"displayName": "Sandbox US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
},
"status": "DEPLOYED",
"deploymentResult": "success",
"isOverridden": false
}
]
},
{
"id": "340",
"status": "DEPLOYED",
"envGeographyDeployments": [
{
"id": "1160",
"envGeography": {
"id": "339",
"geography": {
"id": "1",
"displayName": "Sandbox US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
},
"status": "DEPLOYED",
"deploymentResult": "success",
"isOverridden": false
}
]
},
{
"id": "341",
"status": "PENDING_REQUEST",
"envGeographyDeployments": []
},
{
"id": "342",
"status": "UNDEPLOYED",
"envGeographyDeployments": []
}
],
"parentId": "null",
"hasInterface": true,
"createTime": "2021-01-28T01:19:59.415Z"
}
]
}
mix.api.ListBotCredentialsResponse
Response object returned by the Get Bot Credentials request.
Properties
| Name | Type | Description |
|---|---|---|
| credentials | [mix.api.BotCredential] | List of credentials for the bot. |
Schema
{
"credentials": [
{
"id": "522",
"credential": {
"id": "272",
"appId": "mixapi-testbot-dev",
"clients": [
{
"id": "531",
"clientId": "appID:mixapi-testbot-dev:geo:dev:clientName:default",
"clientName": "default",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T16:39:13.178Z",
"updateTime": "2021-01-18T16:39:13.178Z"
},
{
"id": "535",
"clientId": "appID:mixapi-testbot-dev:geo:dev:clientName:logging",
"clientName": "logging",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T17:03:32.775Z",
"updateTime": "2021-01-18T17:03:32.775Z"
}
],
"createTime": "2021-01-18T16:39:13.175Z",
"updateTime": "2021-01-18T16:39:13.175Z"
},
"geographies": [
{
"id": "338",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
],
"createTime": "2021-01-18T16:39:49.151Z",
"updateTime": "2021-01-18T16:39:49.151Z"
},
{
"id": "523",
"credential": {
"id": "273",
"appId": "mixapi-testbot-qa",
"clients": [
{
"id": "532",
"clientId": "appID:mixapi-testbot-qa:geo:dev:clientName:default",
"clientName": "default",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T16:39:17.915Z",
"updateTime": "2021-01-18T16:39:17.915Z"
},
{
"id": "538",
"clientId": "appID:mixapi-testbot-qa:geo:dev:clientName:logging",
"clientName": "logging",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T17:04:21.761Z",
"updateTime": "2021-01-18T17:04:21.761Z"
}
],
"createTime": "2021-01-18T16:39:17.911Z",
"updateTime": "2021-01-18T16:39:17.911Z"
},
"geographies": [
{
"id": "339",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
],
"createTime": "2021-01-18T16:39:57.024Z",
"updateTime": "2021-01-18T16:39:57.024Z"
},
{
"id": "524",
"credential": {
"id": "274",
"appId": "mixapi-testbot-stage",
"clients": [
{
"id": "533",
"clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:default",
"clientName": "default",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T16:39:21.056Z",
"updateTime": "2021-01-18T16:39:21.056Z"
},
{
"id": "537",
"clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:logging",
"clientName": "logging",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T17:04:16.400Z",
"updateTime": "2021-01-18T17:04:16.400Z"
}
],
"createTime": "2021-01-18T16:39:21.053Z",
"updateTime": "2021-01-18T16:39:21.053Z"
},
"geographies": [
{
"id": "340",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
}
],
"createTime": "2021-01-18T16:40:02.936Z",
"updateTime": "2021-01-18T16:40:02.936Z"
},
{
"id": "525",
"credential": {
"id": "274",
"appId": "mixapi-testbot-stage",
"clients": [
{
"id": "533",
"clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:default",
"clientName": "default",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T16:39:21.056Z",
"updateTime": "2021-01-18T16:39:21.056Z"
},
{
"id": "537",
"clientId": "appID:mixapi-testbot-stage:geo:dev:clientName:logging",
"clientName": "logging",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T17:04:16.400Z",
"updateTime": "2021-01-18T17:04:16.400Z"
}
],
"createTime": "2021-01-18T16:39:21.053Z",
"updateTime": "2021-01-18T16:39:21.053Z"
},
"geographies": [
{
"id": "343",
"geography": {
"id": "16",
"displayName": "Canada"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
}
],
"createTime": "2021-01-18T16:40:07.748Z",
"updateTime": "2021-01-18T16:40:07.748Z"
},
{
"id": "526",
"credential": {
"id": "275",
"appId": "mixapi-testbot-prod",
"clients": [
{
"id": "534",
"clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:default",
"clientName": "default",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T16:39:25.297Z",
"updateTime": "2021-01-18T16:39:25.297Z"
},
{
"id": "536",
"clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:neap",
"clientName": "neap",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T17:03:39.865Z",
"updateTime": "2021-01-18T17:03:39.865Z"
}
],
"createTime": "2021-01-18T16:39:25.294Z",
"updateTime": "2021-01-18T16:39:25.294Z"
},
"geographies": [
{
"id": "341",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
}
],
"createTime": "2021-01-18T16:40:15.046Z",
"updateTime": "2021-01-18T16:40:15.046Z"
},
{
"id": "527",
"credential": {
"id": "275",
"appId": "mixapi-testbot-prod",
"clients": [
{
"id": "534",
"clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:default",
"clientName": "default",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T16:39:25.297Z",
"updateTime": "2021-01-18T16:39:25.297Z"
},
{
"id": "536",
"clientId": "appID:mixapi-testbot-prod:geo:dev:clientName:neap",
"clientName": "neap",
"oauthScopes": "asr dlg nlu tts log asr.wordset nlu.wordset",
"createTime": "2021-01-18T17:03:39.865Z",
"updateTime": "2021-01-18T17:03:39.865Z"
}
],
"createTime": "2021-01-18T16:39:25.294Z",
"updateTime": "2021-01-18T16:39:25.294Z"
},
"geographies": [
{
"id": "342",
"geography": {
"id": "16",
"displayName": "Canada"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
}
],
"createTime": "2021-01-18T16:40:36.728Z",
"updateTime": "2021-01-18T16:40:36.728Z"
}
]
}
mix.api.ListBotsResponse
Response object returned by the Get Bots list request.
Properties
| Name | Type | Description |
|---|---|---|
| bots | [mix.api.Bot] | List of bots. |
| totalSize | integer (int32) | Total number of bots that match the request. |
Schema
{
"bots": [
{
"id": "233",
"applicationName": "Mix.api Test Bot",
"configs": [
{
"id": "1386",
"tag": "TestBotV3",
"deployments": [
{
"id": "342",
"status": "PENDING_REQUEST",
"envGeographyDeployments": []
},
{
"id": "341",
"status": "UNDEPLOYED",
"envGeographyDeployments": []
},
{
"id": "340",
"status": "DEPLOYED",
"envGeographyDeployments": [
{
"id": "1160",
"envGeography": {
"id": "339",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com",
"envName": "QA"
},
"status": "DEPLOYED",
"deploymentResult": "success",
"isOverridden": false,
"dataHosts": []
}
]
},
{
"id": "339",
"status": "PENDING_REQUEST",
"envGeographyDeployments": []
}
],
"parentId": "",
"hasInterface": true,
"deploymentFlowId": 263,
"createTime": "2021-01-28T01:19:59Z"
}
],
"createTime": "2021-01-18T16:39:02Z"
}
],
"totalSize": 1
}
mix.api.ListBuildsResponse
Response object returned by the Get builds request.
Properties
| Name | Type | Description |
|---|---|---|
| projectId | string | ID of the project. |
| builds | [mix.api.GetBuildResponse] | Build details. |
| totalSize | integer (int32) | Total number of builds that match the request. |
| count | integer (int32) | Number of results returned. |
| limit | integer (int32) | Value of limit field specified in request. |
| offset | integer (int32) | Value of offset field specified in request. |
Schema
{
"projectId": "23079",
"builds": [
{
"projectId": "23079",
"buildLabel": "NLU_23079_1",
"buildId": "1955",
"buildType": "NLU",
"buildVersion": "1",
"status": "BST_COMPLETED",
"languageTopic": "gen",
"datapack": {
"displayName": "en-US",
"version": "4.7.0"
},
"notes": "First build",
"createTime": "2021-01-18T16:51:42.049Z",
"modelType": "LEGACY",
"dataSources": [
"nuance_custom_data"
]
},
{
"projectId": "23079",
"buildLabel": "NLU_23079_2",
"buildId": "1956",
"buildType": "NLU",
"buildVersion": "2",
"status": "BST_COMPLETED",
"languageTopic": "gen",
"datapack": {
"displayName": "en-US",
"version": "4.7.0"
},
"notes": "Update for ASR and NLU only",
"createTime": "2021-01-18T16:56:04.140Z",
"modelType": "LEGACY",
"dataSources": [
"nuance_custom_data"
]
}
],
"totalSize": 2,
"count": 2,
"limit": 10,
"offset": 0
}
mix.api.ListDataHostsResponse
Response object returned by the Get data hosts request.
Properties
| Name | Type | Description |
|---|---|---|
| dataHosts | [mix.api.DataHost] | List of data hosts. |
Schema
{
"dataHosts": [
{
"id": "200",
"alias": "COFFEE_APP",
"environmentId": "57",
"environmentGeographyId": "1",
"value": "https://coffee.app.com:443"
}
]
}
mix.api.ListDataTypesResponse
Response object returned by the Get data types request.
Properties
| Name | Type | Description |
|---|---|---|
| dataTypes | [mix.api.DataTypes] | List of data types. |
Schema
{
"dataTypes": [
{
"name": "BOOLEAN",
"schema": {
"$schema": "http://json-schema.org/draft-04/schema#",
"title": "BOOLEAN",
"type": "boolean",
"description": "Programmatic True or False",
"properties": {}
},
"compatibleEntityTypes": [
{
"type": "LIST",
"default": false,
"initializer": {
"literals": [
{
"meaning": "true",
"patterns": [
"true"
]
},
{
"meaning": "false",
"patterns": [
"false"
]
}
]
}
},
{
"type": "RULE_BASED",
"default": false
},
{
"type": "RELATIONAL",
"default": true,
"initializer": {
"name": "nuance_BOOLEAN",
"link": "isA"
}
}
]
}
]
}
mix.api.ListDeploymentFlowsResponse
Response object returned by the Get Deployment Flows list request.
Properties
| Name | Type | Description |
|---|---|---|
| flows | [mix.api.DeploymentFlow] | List of deployment flows. |
| totalSize | integer (int32) | Total number of deployment flows that match the request. |
| count | integer (int32) | Number of results returned. |
| limit | integer (int32) | Value of limit field specified in request. |
| offset | integer (int32) | Value of offset field specified in request. |
Schema
{
"flows": [
{
"id": "262",
"displayName": "Default Deployment Flow",
"steps": [
{
"id": "338",
"step": 1,
"requiresApproval": false,
"environments": [
{
"id": "300",
"displayName": "Sandbox",
"geographies": [
{
"id": "337",
"geography": {
"id": "9",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
]
}
]
}
]
},
{
"id": "263",
"displayName": "Multi-Stage Pipeline",
"steps": [
{
"id": "339",
"step": 1,
"requiresApproval": false,
"environments": [
{
"id": "301",
"displayName": "Development",
"geographies": [
{
"id": "338",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
]
}
]
},
{
"id": "340",
"step": 2,
"requiresApproval": false,
"environments": [
{
"id": "302",
"displayName": "QA",
"geographies": [
{
"id": "339",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
]
}
]
},
{
"id": "341",
"step": 3,
"requiresApproval": false,
"environments": [
{
"id": "303",
"displayName": "Staging",
"geographies": [
{
"id": "340",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
},
{
"id": "343",
"geography": {
"id": "16",
"displayName": "Canada"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
}
]
}
]
},
{
"id": "342",
"step": 4,
"requiresApproval": true,
"environments": [
{
"id": "304",
"displayName": "Production",
"geographies": [
{
"id": "341",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
},
{
"id": "342",
"geography": {
"id": "16",
"displayName": "Canada"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
}
]
}
]
}
]
}
],
"totalSize": 2,
"count": 2,
"limit": 10,
"offset": 0
}
mix.api.ListEnginePacksResponse
Response object returned by the Get engine packs request.
Properties
| Name | Type | Description |
|---|---|---|
| enginePacks | [mix.api.EnginePack] | [Message that defines an engine pack.] |
Schema
{
"enginePacks": [
{
"enginePackId": "d5262497-afa2-4cdf-9d3d-1a3fd70bc0c6",
"version": "hosted",
"dialogVersion": "1.0.0",
"nluVersion": "1.1.0",
"asrVersion": "1.2.4",
"ttsVersion": "1.2.0",
"isDefault": false,
"topics": {
"gen": {
"locales": {
"fr-CA": {
"versions": [
{
"version": "4.1.0",
"isSupported": true
},
{
"version": "4.0.0",
"isSupported": true
}
]
},
"id-ID": {
"versions": [
{
"version": "4.0.0",
"isSupported": true
}
]
},
"pt-BR": {
"versions": [
{
"version": "4.2.0",
"isSupported": true
}
]
},
"th-TH": {
"versions": [
{
"version": "4.0.0",
"isSupported": true
}
]
},
"fr-FR": {
"versions": [
{
"version": "4.1.0",
"isSupported": true
}
]
},
"en-US": {
"versions": [
{
"version": "4.7.0",
"isSupported": true
},
{
"version": "4.5.0",
"isSupported": true
},
{
"version": "4.4.0",
"isSupported": true
},
{
"version": "4.2.0",
"isSupported": true
}
]
}
}
}
}
}
]
}
mix.api.ListEntitiesRequest.EntityType
ENUM that defines the entity types.
- UNSPECIFIED: No type specified
- BASE: Base entity
- RELATIONAL: Relationship entity
- LIST: List entity
- FREEFORM: Freeform entity
- REGEX: Regex-based entity
- RULE_BASED: Rule-based entity
Schema
"UNSPECIFIED"
mix.api.ListEntitiesResponse
Response object returned by the List entities request.
Properties
| Name | Type | Description |
|---|---|---|
| entities | [mix.api.EntityResponse] | List of entities. |
Schema
{
"entities": [
{
"baseEntity": {
"id": "1d6ea576-1305-47b4-bfba-667ae1935b31",
"name": "AND",
"dataType": "NOT_SET"
}
},
{
"baseEntity": {
"id": "316009ea-f5a9-40d9-ab77-e2fc268a6f41",
"name": "NOT",
"dataType": "NOT_SET"
}
},
{
"baseEntity": {
"id": "ddd3faad-a26b-4a0a-839f-88b71c9fbc32",
"name": "OR",
"dataType": "NO_FORMAT"
}
},
{
"baseEntity": {
"id": "9bb99448-0400-4f3b-9edf-73ed13698ea4",
"name": "nuance_AMOUNT",
"dataType": "NOT_SET"
}
},
{
"listEntity": {
"id": "bc6c1470-a2a5-4d01-976a-b682a5af6f66",
"name": "COFFEE_SIZE",
"isDynamic": false,
"numLiterals": 5,
"settings": {
"isSensitive": false,
"canonicalize": true
},
"dataType": "NO_FORMAT"
}
},
{
"listEntity": {
"id": "73cb7c26-fed5-4331-8701-6736d98c40d6",
"name": "COFFEE_TYPE",
"isDynamic": false,
"numLiterals": 9,
"settings": {
"isSensitive": false,
"canonicalize": true
},
"dataType": "NO_FORMAT"
}
}
]
}
mix.api.ListEntity
Entity type used for recognizing a value from a list of finite literals.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | UUID of the entity. |
| name | string | Entity name. |
| isDynamic | boolean | When set to true, indicates that the entity is dynamic. |
| anaphora | mix.api.AnaphoraType | If set, specifies the referrer for this entity. |
| numLiterals | integer (int32) | Number of literals that exist for this entity. |
| dataSource | string | Data source used for this entity. |
| settings | mix.api.EntitySettings | Settings defined for this entity. |
| dataType | mix.api.DataType | Data type for the entity. |
Schema
{
"id": "string",
"name": "string",
"isDynamic": true,
"anaphora": "ANAPHORA_NOT_SET",
"numLiterals": 0,
"dataSource": "string",
"settings": {
"isSensitive": true,
"canonicalize": true
},
"dataType": "NOT_SET"
}
mix.api.ListEntityCreateRequest
Request object for creating a list entity.
Properties
| Name | Type | Description |
|---|---|---|
| name | string | Entity name. |
| isDynamic | boolean | When set to true, indicates that the entity is dynamic. |
| anaphora | mix.api.AnaphoraType | If set, specifies the referrer for this entity. |
| settings | mix.api.EntitySettings | Settings defined for this entity. |
| dataType | mix.api.DataType | Data type for the entity. |
| data | object | List entity initialization data; key is a valid project locale. |
Schema
{
"name": "string",
"isDynamic": true,
"anaphora": "ANAPHORA_NOT_SET",
"settings": {
"isSensitive": true,
"canonicalize": true
},
"dataType": "NOT_SET",
"data": {
"property1": {
"entries": [
{
"meaning": "string",
"patterns": [
"string"
]
}
]
},
"property2": {
"entries": [
{
"meaning": "string",
"patterns": [
"string"
]
}
]
}
}
}
mix.api.ListEntityData
List entity initialization data.
Properties
| Name | Type | Description |
|---|---|---|
| entries | [mix.api.ListEntityDataEntry] | List entity initialization data entry. |
Schema
{
"entries": [
{
"meaning": "string",
"patterns": [
"string"
]
}
]
}
mix.api.ListEntityDataEntry
List entity initialization data entry.
Properties
| Name | Type | Description |
|---|---|---|
| meaning | string | Entity meaning. |
| patterns | [string] | List of entity patterns. |
Schema
{
"meaning": "string",
"patterns": [
"string"
]
}
mix.api.ListEntityTypesResponse
Response object returned by the Get entity types request.
Properties
| Name | Type | Description |
|---|---|---|
| entityTypes | [mix.api.EntityTypes] | List of entity types. |
Schema
{
"entityTypes": [
{
"name": "BASE",
"description": "Predefined Nuance Entity",
"initializer": {},
"comaptibleDataTypes": [
"NO_FORMAT"
]
}
]
}
mix.api.ListEntityUpdateRequest
Request object for updating a list entity.
Properties
| Name | Type | Description |
|---|---|---|
| isDynamic | boolean | When set to true, indicates that the entity is dynamic. |
| anaphora | mix.api.AnaphoraType | If set, specifies the referrer for this entity. |
| settings | mix.api.EntitySettings | Settings defined for this entity. |
| dataType | mix.api.DataType | Data type for the entity. |
| data | object | List entity data to be added; key is a valid project locale. |
Schema
{
"isDynamic": true,
"anaphora": "ANAPHORA_NOT_SET",
"settings": {
"isSensitive": true,
"canonicalize": true
},
"dataType": "NOT_SET",
"data": {
"property1": {
"entries": [
{
"meaning": "string",
"patterns": [
"string"
]
}
]
},
"property2": {
"entries": [
{
"meaning": "string",
"patterns": [
"string"
]
}
]
}
}
}
mix.api.ListEnvironmentsResponse
Response object returned by the Get Environments list request.
Properties
| Name | Type | Description |
|---|---|---|
| environments | [mix.api.Environment] | List of environments. |
| totalSize | integer (int32) | Total number of environments that match the request. |
| count | integer (int32) | Number of results returned. |
| limit | integer (int32) | Value of limit field specified in request. |
| offset | integer (int32) | Value of offset field specified in request. |
Schema
{
"environments": [
{
"id": "300",
"displayName": "Sandbox",
"geographies": [
{
"id": "337",
"geography": {
"id": "1",
"displayName": "Sandbox US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
]
},
{
"id": "301",
"displayName": "Development",
"geographies": [
{
"id": "338",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
]
},
{
"id": "302",
"displayName": "QA",
"geographies": [
{
"id": "339",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "SANDBOX",
"envHost": "api.nuance.com"
}
]
},
{
"id": "303",
"displayName": "Staging",
"geographies": [
{
"id": "340",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
},
{
"id": "343",
"geography": {
"id": "16",
"displayName": "Canada"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
}
]
},
{
"id": "304",
"displayName": "Production",
"geographies": [
{
"id": "341",
"geography": {
"id": "14",
"displayName": "US"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
},
{
"id": "342",
"geography": {
"id": "16",
"displayName": "Canada"
},
"envType": "PRODUCTION",
"envHost": "api.nuance.com"
}
]
}
],
"totalSize": 5,
"count": 5,
"limit": 10,
"offset": 0
}
mix.api.ListExtendedProjectsResponse
Response object returned by the Get list of Mix projects request.
Properties
| Name | Type | Description |
|---|---|---|
| projects | [mix.api.ExtendedProject] | List of ExtendedProject objects, which provide an extended set of project attributes. |
| count | integer (int32) | Total number of projects in the result. |
| totalSize | integer (int32) | Total number of projects that match the request, if applicable. |
| limit | integer (int32) | Value of limit field specified in request, if applicable. |
| offset | integer (int32) | Value of offset field specified in request, if applicable. |
Schema
{
"projects": [
{
"id": "23079",
"displayName": "GA Bank Demo",
"languageTopic": "gen",
"channels": [
{
"channel": {
"id": "454bea86-0e77-49b4-b527-0188d46a52c2",
"displayName": "Omni Channel VA",
"codeName": "custom",
"modes": [
"INTERACTIVITY",
"AUDIO_SCRIPT",
"TTS",
"RICH_TEXT"
],
"color": "PURPLE"
},
"isActive": true
},
{
"channel": {
"id": "42dcfbf7-86b2-46f8-b495-0d3bf7907248",
"displayName": "Digital VA",
"codeName": "custom",
"modes": [
"RICH_TEXT",
"TTS",
"INTERACTIVITY"
],
"color": "GREEN"
},
"isActive": true
},
{
"channel": {
"id": "bd47faf3-ec97-4f63-ac8d-53f7822c2d24",
"displayName": "IVR Voice VA",
"codeName": "custom",
"modes": [
"AUDIO_SCRIPT"
],
"color": "LIGHT_ORANGE"
},
"isActive": true
},
{
"channel": {
"id": "23371c6d-2760-4aed-af6e-13c75d86f3a6",
"displayName": "Default",
"codeName": "default",
"modes": [
"INTERACTIVITY",
"RICH_TEXT",
"TTS",
"AUDIO_SCRIPT"
],
"color": "COLOR_UNSPECIFIED"
},
"isActive": true
},
{
"channel": {
"id": "88544ae0-9fe1-4a3b-b7eb-129614c3532a",
"displayName": "Text VA",
"codeName": "custom",
"modes": [
"RICH_TEXT"
],
"color": "CORN_FLOWER"
},
"isActive": true
},
{
"channel": {
"id": "8e432bd2-6512-4da3-8236-66a6f94b6e44",
"displayName": "Audio VA",
"codeName": "custom",
"modes": [
"TTS"
],
"color": "PINK"
},
"isActive": true
}
],
"datapacks": [
{
"displayName": "fr-FR",
"version": "4.1.0",
"isActive": true,
"isDefault": false
},
{
"displayName": "en-US",
"version": "4.7.0",
"isActive": true,
"isDefault": true
}
],
"isFavorite": false,
"orgId": "233",
"orgDisplayName": "Mix.api Test Organization",
"policy": {
"isAccepted": true,
"projectDescription": "",
"createTime": "2021-08-12T11:58:10Z",
"updateTime": "2021-08-12T11:58:10Z"
},
"createTime": "2021-01-18T16:44:58Z",
"updateTime": "2021-01-28T19:23:27Z",
"baseDatapack": "9.4.4",
"enginePackFeatures": [
"xmix-3458_spacing-flag",
"xmix-3774_qa-sensitive"
],
"lastSavedTime": "2021-08-16T13:04:12Z",
"lastUsedTime": "2021-08-16T11:59:08Z",
"lastAsrModelCreateTime": "2021-01-28T01:19:00Z",
"lastNluModelCreateTime": "2021-01-28T01:18:58Z",
"lastDialogModelCreateTime": "2021-01-28T01:19:03Z"
}
],
"count": 1,
"totalSize": 1,
"limit": 10,
"offset": 0
}
mix.api.ListGeographiesResponse
Response object returned by the Get Geographies list request.
Properties
| Name | Type | Description |
|---|---|---|
| geographies | [mix.api.Geography] | List of geographies. |
| totalSize | integer (int32) | Total number of geographies that match the request. |
| count | integer (int32) | Number of results returned. |
| limit | integer (int32) | Value of limit field specified in request. |
| offset | integer (int32) | Value of offset field specified in request. |
Schema
{
"geographies": [
{
"id": "1",
"displayName": "Sandbox US"
},
{
"id": "14",
"displayName": "US"
},
{
"id": "16",
"displayName": "Canada"
}
],
"totalSize": 3,
"count": 3,
"limit": 10,
"offset": 0
}
mix.api.ListIntentsResponse
Response object returned by the Get intents request.
Properties
| Name | Type | Description |
|---|---|---|
| intents | [mix.api.IntentResponse] | List of intents. |
Schema
{
"intents": [
{
"id": "416ceedc-a18d-4bb0-a0aa-d1abcdd69283",
"name": "NO_INTENT",
"isInBaseOntology": true,
"links": []
},
{
"id": "a9e7428a-5c12-4ead-9aad-c6b7d8723ee7",
"name": "ORDER_COFFEE",
"isInBaseOntology": false,
"links": [
{
"entityRef": "COFFEE_SIZE"
},
{
"entityRef": "COFFEE_TYPE"
}
]
},
{
"id": "1f9004f5-e0d1-4c23-98c0-49229a2c07da",
"name": "nuance_weather_query",
"isInBaseOntology": false,
"links": [
{
"entityRef": "nuance_common_datetime"
},
{
"entityRef": "nuance_common_location"
},
{
"entityRef": "nuance_common_relative_location"
},
{
"entityRef": "nuance_weather_condition"
}
],
"dataSource": "nuance_weather"
}
]
}
mix.api.ListLanguageTopicsResponse
Response object returned by the Get Language Topics list request.
Properties
| Name | Type | Description |
|---|---|---|
| languageTopics | [mix.api.LanguageTopic] | List of language topics. |
Schema
{
"languageTopics": [
{
"id": "1",
"name": "gen",
"locales": [
{
"locale": "fr-CA",
"language": "fr",
"country": "CA",
"displayLanguage": "French",
"displayCountry": "Canada"
},
{
"locale": "en-US",
"language": "en",
"country": "US",
"displayLanguage": "English",
"displayCountry": "United States",
"versions": [
"4.7.0",
"4.5.0",
"4.4.0",
"4.2.0"
]
}
]
}
]
}
mix.api.ListLatestBuildsResponse
Response object returned by the Get latest builds request.
Properties
| Name | Type | Description |
|---|---|---|
| models | mix.api.ModelsContent | List of build models. |
Schema
{
"models": {
"asr": {
"builds": [
{
"locale": "en-US",
"buildVersion": "6",
"buildLabel": "ASR_23079_6"
}
],
"projectId": "23079"
},
"nlu": {
"builds": [
{
"locale": "en-US",
"buildVersion": "6",
"buildLabel": "NLU_23079_6"
}
],
"projectId": "23079"
},
"dialog": {
"projectId": "23079",
"buildVersion": "7",
"buildLabel": "DIALOG_23079_7"
}
}
}
mix.api.ListLatestDataHostsResponse
Response object returned by the Get latest data hosts request.
Properties
| Name | Type | Description |
|---|---|---|
| dataHosts | [mix.api.DataHost] | List of latest data hosts. |
Schema
{
"dataHosts": [
{
"id": "200",
"alias": "COFFEE_APP",
"environmentId": "39",
"environmentGeographyId": "1",
"value": "https://coffee.app.com:443"
},
{
"id": "518",
"alias": "LOCAL",
"environmentId": "39",
"environmentGeographyId": "1",
"value": "http://dataaccess-examples.local/dataaccess-examples/"
}
]
}
mix.api.ListOrganizationsResponse
Response object returned by the Get Organizations list request.
Properties
| Name | Type | Description |
|---|---|---|
| organizations | [mix.api.Organization] | List of organizations. |
| totalSize | integer (int32) | Total number of organizations that match the request. |
| count | integer (int32) | Number of results returned. |
| limit | integer (int32) | Value of limit field specified in request. |
| offset | integer (int32) | Value of offset field specified in request. |
Schema
{
"organizations": [
{
"id": "233",
"displayName": "Mix.api Test Organization",
"type": "STANDARD",
"members": [
{
"member": {
"id": "36",
"email": "alex.smith@company.com",
"name": "Alex Smith",
"createTime": "2020-01-16T15:44:25.231Z",
"lastLoginTime": "2021-01-26T13:07:16.644Z"
},
"roles": [
{
"id": "2",
"displayName": "member",
"description": "Can see the organization details and collaborate on projects/applications."
}
]
}
],
"isDeepLearningModelEnabled": true,
"isEnginePacksEnabled": false,
"isDataPacksEnabled": false
},
{
"id": "37",
"displayName": "alex.smith@company.com",
"type": "PERSONAL",
"members": [
{
"member": {
"id": "36",
"email": "alex.smith@company.com",
"name": "Alex Smith",
"createTime": "2020-01-16T15:44:25.231Z",
"lastLoginTime": "2021-01-26T13:07:16.644Z"
},
"roles": [
{
"id": "1",
"displayName": "owner",
"description": "Can invite users, edit organization details, and create projects and applications."
}
]
}
],
"isDeepLearningModelEnabled": false,
"isEnginePacksEnabled": true,
"isDataPacksEnabled": false
}
],
"totalSize": 1,
"count": 1,
"limit": 0,
"offset": 0
}
mix.api.ListProjectJobsResponse
Response object returned by the Get jobs request.
Properties
| Name | Type | Description |
|---|---|---|
| jobs | [mix.api.JobResponse] | List of jobs for the project specified. |
| totalSize | integer (int32) | Total number of jobs that match the request. |
| count | integer (int32) | Number of results returned. |
| limit | integer (int32) | Value of limit field specified in request. |
| offset | integer (int32) | Value of offset field specified in request. |
Schema
{
"jobs": [
{
"id": "430a4626-3b41-4fa2-bb8b-db1c7c2c7189",
"type": "APPEND_INTENT_SAMPLES",
"projectId": "2960",
"status": "COMPLETED",
"createTime": "2021-06-08T21:10:37.456Z",
"updateTime": "2021-06-08T21:10:52.052Z",
"duration": "14.596s"
}
],
"totalSize": 1,
"count": 1,
"limit": 10,
"offset": 0
}
mix.api.ListProjectsLocksResponse
Response object returned by the Get project locks request.
Properties
| Name | Type | Description |
|---|---|---|
| locks | [mix.api.ProjectLock] | List of project locks. |
| totalSize | integer (int32) | Total number of locks that match the request. |
| count | integer (int32) | Number of results returned. |
| limit | integer (int32) | Value of limit field specified in request. |
| offset | integer (int32) | Value of offset field specified in request. |
Schema
{
"locks": [
{
"lockId": "2",
"projectId": "21647",
"lockOwner": {
"id": "1",
"email": "admin@company.com"
},
"notes": "Building models",
"createTime": "2021-11-04T14:55:36Z"
},
{
"lockId": "18",
"projectId": "2960",
"lockOwner": {
"id": "36",
"email": "alex.smith@company.com"
},
"notes": "Exporting model",
"createTime": "2021-11-10T15:33:35Z"
}
],
"totalSize": 2,
"count": 2,
"limit": 10,
"offset": 0
}
mix.api.ListProjectsResponse
Response object returned by the Get projects request.
Properties
| Name | Type | Description |
|---|---|---|
| projects | [mix.api.Project] | List of projects. |
Schema
{
"projects": [
{
"id": "23079",
"displayName": "GA Bank Demo",
"languageTopic": "gen",
"channels": [
{
"channel": {
"id": "33428",
"displayName": "Audio VA",
"codeName": "Audio VA",
"modes": [
"TTS"
],
"color": "PINK"
},
"isActive": true
},
{
"channel": {
"id": "33427",
"displayName": "Text VA",
"codeName": "Text VA",
"modes": [
"RICH_TEXT"
],
"color": "CORN_FLOWER"
},
"isActive": true
},
{
"channel": {
"id": "33426",
"displayName": "Digital VA",
"codeName": "Digital VA",
"modes": [
"INTERACTIVITY",
"RICH_TEXT",
"TTS"
],
"color": "GREEN"
},
"isActive": true
},
{
"channel": {
"id": "33425",
"displayName": "IVR/Voice VA",
"codeName": "IVR/Voice VA",
"modes": [
"AUDIO_SCRIPT",
"DTMF"
],
"color": "LIGHT_ORANGE"
},
"isActive": true
},
{
"channel": {
"id": "33424",
"displayName": "Omni Channel VA",
"codeName": "Omni Channel VA",
"modes": [
"AUDIO_SCRIPT",
"DTMF",
"INTERACTIVITY",
"RICH_TEXT",
"TTS"
],
"color": "PURPLE"
},
"isActive": true
}
],
"datapacks": [
{
"displayName": "fr-FR",
"version": "4.1.0",
"isActive": true
},
{
"displayName": "en-US",
"version": "4.7.0",
"isActive": true
}
],
"orgId": "2",
"createTime": "2021-01-18T16:44:58.947Z",
"updateTime": "2021-01-18T16:45:56Z"
}
]
}
mix.api.ListVoicesResponse
Response object returned by the Get voices request.
Properties
| Name | Type | Description |
|---|---|---|
| voices | [mix.api.Voice] | List of voices. |
Schema
{
"voices": [
{
"name": "Allison",
"restricted": false,
"gender": "FEMALE",
"model": "STANDARD",
"locale": "en-US",
"sampleRateHz": [
22050
],
"foreignLanguages": [],
"styles": []
},
{
"name": "Christina-Ml",
"restricted": true,
"gender": "FEMALE",
"model": "STANDARD",
"locale": "de-DE",
"sampleRateHz": [
22050
],
"foreignLanguages": [
"en-US",
"en-GB",
"fr-FR",
"es-ES",
"it-IT"
],
"styles": []
},
{
"name": "Erica",
"restricted": true,
"gender": "FEMALE",
"model": "STANDARD",
"locale": "en-US",
"sampleRateHz": [
22050,
8000
],
"foreignLanguages": [],
"styles": []
},
{
"name": "en-US-GuyNeural",
"restricted": false,
"gender": "MALE",
"model": "NEURAL",
"locale": "en-US",
"sampleRateHz": [
24000
],
"foreignLanguages": [],
"styles": [
"newscast",
"angry",
"cheerful",
"sad",
"excited",
"friendly",
"terrified",
"shouting",
"unfriendly",
"whispering",
"hopeful"
]
}
]
}
mix.api.LockProjectResponse
Response object returned by the Lock project request.
Properties
| Name | Type | Description |
|---|---|---|
| lock | mix.api.ProjectLock | Project lock instance, if available. |
Schema
{
"lock": {
"lockId": "18",
"projectId": "2960",
"lockOwner": {
"id": "36",
"email": "alex.smith@company.com"
},
"notes": "Exporting model",
"createTime": "2021-11-10T15:33:35Z"
}
}
mix.api.LockRequest
Message that defines the project lock notes.
Properties
| Name | Type | Description |
|---|---|---|
| notes | string | Project lock notes. |
Schema
{
"notes": "string"
}
mix.api.Modality
Enum that defines the input and output modalities in a channel.
- MODE_UNSPECIFIED: Unspecified mode.
- RICH_TEXT: Output modality. Used for text messages that can be displayed on any screen, such as SMS messages.
- TTS: Output modality. Used for text that can be spoken using speech synthesis.
- INTERACTIVITY: Input modality. Used to add interactive elements to a message, such as buttons and clickable links.
- AUDIO_SCRIPT: Output modality. Used to specify recorded audio files to play, as well as backup text to be rendered using TTS.
- DTMF: Input modality. Used to add support for Dual-Tone Multi-Frequency tones as user input.
- VOICE: Input modality. Used to add support for speech as user input.
- TEXT: Input modality. Used to add support for text as user input.
Schema
"MODE_UNSPECIFIED"
mix.api.ModelsContent
Message that defines a list of build models.
Properties
| Name | Type | Description |
|---|---|---|
| asr | mix.api.BaseModelContent | ASR model. |
| nlu | mix.api.BaseModelContent | NLU model. |
| dialog | mix.api.DialogBuildContent | Dialog model. |
Schema
{
"asr": {
"builds": [
{
"locale": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {
"errors": [
null
]
}
}
],
"projectId": "string"
},
"nlu": {
"builds": [
{
"locale": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {
"errors": [
null
]
}
}
],
"projectId": "string"
},
"dialog": {
"projectId": "string",
"buildVersion": "string",
"buildLabel": "string",
"createTime": "2019-08-24T14:15:22Z",
"buildStatus": "BST_NONE",
"buildErrors": {
"errors": [
{
"message": "string",
"code": "string"
}
]
}
}
}
mix.api.NLUBody
Message that defines an NLU build.
Properties
| Name | Type | Description |
|---|---|---|
| notes | string | Notes specified when starting the build. |
| settings | mix.api.NLUModelSettings | Message that defines settings for the NLU model. |
| dataSources | [mix.api.DataSource] | Data sources in the model, if applicable. |
Schema
{
"notes": "string",
"settings": {
"modelType": "LEGACY"
},
"dataSources": [
{
"locale": "string",
"names": [
"string"
]
}
]
}
mix.api.NLUModelSettings
Object defines the NLU model settings.
Properties
| Name | Type | Description |
|---|---|---|
| modelType | mix.api.NLUModelType | NLU model type. |
Schema
{
"modelType": "LEGACY"
}
mix.api.NLUModelType
ENUM that defines the type of NLU model to use when building.
- FAST: Deprecated. Renamed to LEGACY
- ACCURATE: Deprecated. Renamed to DEEP_LEARNING
Schema
"LEGACY"
mix.api.Organization
Message that defines an organization.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the organization. |
| displayName | string | Name of the organization. |
| type | mix.api.OrganizationType | Type of organization. |
| members | [mix.api.OrganizationMember] | List of members in the organization. |
| isDeepLearningModelEnabled | boolean | When set to true, DEEP_LEARNING model build is enabled. |
| isEnginePacksEnabled | boolean | When set to true, engine pack selection is enabled. |
| isDataPacksEnabled | boolean | When set to true, data pack selection is enabled. |
Schema
{
"id": "string",
"displayName": "string",
"type": "TYPE_UNSPECIFIED",
"members": [
{
"member": {
"id": "string",
"email": "string",
"createTime": "2019-08-24T14:15:22Z",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string"
},
"roles": [
{
"id": "string",
"displayName": "string",
"description": "string"
}
]
}
],
"isDeepLearningModelEnabled": true,
"isEnginePacksEnabled": true,
"isDataPacksEnabled": true
}
mix.api.OrganizationMember
Message that defines the roles assigned to a specific member.
Properties
| Name | Type | Description |
|---|---|---|
| member | mix.api.User | User that is a member of an organization. |
| roles | [mix.api.OrganizationRole] | List of roles assigned to this member. |
Schema
{
"member": {
"id": "string",
"email": "string",
"createTime": "2019-08-24T14:15:22Z",
"lastLoginTime": "2019-08-24T14:15:22Z",
"name": "string"
},
"roles": [
{
"id": "string",
"displayName": "string",
"description": "string"
}
]
}
mix.api.OrganizationRole
Message that defines the roles available in an organization.
Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique ID identifying the role. |
| displayName | string | Name of the role. |
| description | string | Description of the role. |
Schema
{
"id": "string",
"displayName": "string",
"description": "string"
}
mix.api.OrganizationType
Input field that specifies the type of organization.
- TYPE_UNSPECIFIED: All types of organizations
- PERSONAL: User’s personal organization, identified with the user’s email address
- STANDARD: Global organization, such as a company, that typically includes many members
Schema
"TYPE_UNSPECIFIED"
mix.api.OrganizationView
Input field that specifies the organization information returned.
- VIEW_UNSPECIFIED: Returns organization details without listing the organization members
- FULL: Returns all organization details, including the list of organization members
Schema
"VIEW_UNSPECIFIED"
mix.api.OverrideApplicationConfigContent
Message that defines the content used to override an existing application configuration.
Properties
| Name | Type | Description |
|---|---|---|
| dataHosts | [mix.api.DataHost] | List of data hosts. |
| requestModels | mix.api.RequestModelsContent | List of models for this application configuration. |
| environmentConfigurations | [mix.api.EnvironmentConfiguration] | List of environment configurations to use for this application configuration. |
Schema
{
"dataHosts": [
{
"id": "string",
"alias": "string",
"environmentId": "string",
"environmentGeographyId": "string",
"value": "string"
}
],
"requestModels": {
"asr": [
{
"buildLabel": "string",
"locale": "string"
}
],
"nlu": [
{
"buildLabel": "string",
"locale": "string"
}
],
"dialog": {
"buildLabel": "string"
}
},
"environmentConfigurations": [
{
"label": "ECL_UNSPECIFIED",
"value": "string",
"environmentId": "string",
"environmentGeographyId": "string"
}
]
}
mix.api.OverrideApplicationConfigResponse
Response object returned by the Override application configuration request.
Properties
| Name | Type | Description |
|---|---|---|
| config | mix.api.ApplicationConfig | Application configuration. |
Schema
{
"config": {
"id": "string",
"tag": "string",
"createTime": "2019-08-24T14:15:22Z",
"deployments": [
{
"id": "string",
"status": "STATUS_UNSPECIFIED",
"createTime": "2019-08-24T14:15:22Z",
"updateTime": "2019-08-24T14:15:22Z",
"envGeographyDeployments": [
{
"id": null,
"envGeography": null,
"status": null,
"deploymentResult": null,
"isOverridden": null,
"requestedBy": null,
"approvedBy": null,
"dataHosts": null,
"createdAt": null,
"approvedAt": null,
"approvalRequired": null,
"environmentConfigurations": null
}
]
}
],
"parentId": "string",
"deploymentFlowId": 0,
"builds"