chatPlatform | unknown | Yes | read-only (server-generated); one of: slack, msTeams, direct | Identifies one of the supported chat platforms that this AI Assistant instance is integrated with. |
createdAt | string | No | read-only (server-generated); format: date-time | Instance creation timestamp. |
description | string | No | | Additional information about AI Assistant. |
directConfig | object | No | | This field is required if chatPlatform is 'direct' and contains necessary configuration of a direct chatbot. |
Properties of directConfig| Property | Type | Required | Constraints | Description |
|---|
defaultEntityAccessRule | object | Yes | | Default rule of access to entities and their data. | Properties of defaultEntityAccessRule| Property | Type | Required | Constraints | Description |
|---|
entityIds | array<string> | No | | List of entity instances that are accessible. The instances' descendants are also included. | | defaultQaRule | object | Yes | | Default rule of access to Question-Answering data files. | Properties of defaultQaRule| Property | Type | Required | Constraints | Description |
|---|
files | object | No | | Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. | Properties of files| Property | Type | Required | Constraints | Description |
|---|
tag | string | No | | The tag assigned to project files or entity files meant for QA indexing. | | | domainId | string | Yes | | domainID connected to Assistant instance. | entityAccessRules | array<object> | No | | Entity access rules applied to specific channels. These override the default rule. | Properties of entityAccessRules| Property | Type | Required | Constraints | Description |
|---|
channel | string | No | | RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM. | entityIds | array<string> | No | | List of entity instances that are accessible. The instances' descendants are also included. | | qaRules | array<object> | No | | QA files access rules applied to specific channels. These override the default rule. | Properties of qaRules| Property | Type | Required | Constraints | Description |
|---|
channel | string | No | | RoomID of a room or 'PAIR'. 'PAIR' means pair talk, it is like DM. | files | object | No | | Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. | Properties of files| Property | Type | Required | Constraints | Description |
|---|
tag | string | No | | The tag assigned to project files or entity files meant for QA indexing. | | | |
entityID | string | No | read-only (server-generated) | Optional. If present, this identifies the entity instane associated with the AI Assistant instance. |
id | integer | Yes | read-only (server-generated) | The unique identifier for the AI assistant instance. |
msTeamsConfig | object | No | | This field is required if chatPlatform is 'msTeams' and contains necessary configuration of a MS Teams chatbot. |
Properties of msTeamsConfig| Property | Type | Required | Constraints | Description |
|---|
defaultEntityAccessRule | object | Yes | | Default rule of access to entities and their data. | Properties of defaultEntityAccessRule| Property | Type | Required | Constraints | Description |
|---|
entityIds | array<string> | No | | List of entity instances that are accessible. The instances' descendants are also included. | | defaultQaRule | object | Yes | | Default rule of access to Question-Answering data files. | Properties of defaultQaRule| Property | Type | Required | Constraints | Description |
|---|
files | object | No | | Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. | Properties of files| Property | Type | Required | Constraints | Description |
|---|
tag | string | No | | The tag assigned to project files or entity files meant for QA indexing. | | | entityAccessRules | array<object> | No | | Entity access rules applied to specific channels. These override the default rule. | Properties of entityAccessRules| Property | Type | Required | Constraints | Description |
|---|
channel | string | No | | ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'. | entityIds | array<string> | No | | List of entity instances that are accessible. The instances' descendants are also included. | | qaRules | array<object> | No | | QA files access rules applied to specific channels. These override the default rule. | Properties of qaRules| Property | Type | Required | Constraints | Description |
|---|
channel | string | No | | ChannelID of a channel or 'PERSONAL' or 'GROUP_CHAT'. | files | object | No | | Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. | Properties of files| Property | Type | Required | Constraints | Description |
|---|
tag | string | No | | The tag assigned to project files or entity files meant for QA indexing. | | | tenantId | string | Yes | | tenantID connected to Assistant instance. | |
name | string | Yes | | Display name of AI Assistant. |
projectId | integer | Yes | read-only (server-generated) | The unique identifier for the project the AI Assistant instance belongs to. |
slackConfig | object | No | | This field is required if chatPlatform is 'slack' and contains necessary configuration of a Slack chatbot. |
Properties of slackConfig| Property | Type | Required | Constraints | Description |
|---|
defaultEntityAccessRule | object | Yes | | Default rule of access to entities and their data. | Properties of defaultEntityAccessRule| Property | Type | Required | Constraints | Description |
|---|
entityIds | array<string> | No | | List of entity instances that are accessible. The instances' descendants are also inlcuded. | | defaultQaRule | object | Yes | | Default rule of access to Question-Answering data files. | Properties of defaultQaRule| Property | Type | Required | Constraints | Description |
|---|
files | object | No | | Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. | Properties of files| Property | Type | Required | Constraints | Description |
|---|
tag | string | No | | The tag assigned to project files or entity files meant for QA indexing. | | | entityAccessRules | array<object> | No | | Entity access rules applied to specific Slack channels. These override the default rule. | Properties of entityAccessRules| Property | Type | Required | Constraints | Description |
|---|
channel | string | No | | ChannelID of a channel or 'DM'. | entityIds | array<string> | No | | List of entity instances that are accessible. The instances' descendants are also included. | | qaRules | array<object> | No | | QA files access rules applied to specific Slack channels. These override the default rule. | Properties of qaRules| Property | Type | Required | Constraints | Description |
|---|
channel | string | No | | ChannelID of a channel or 'DM'. | files | object | No | | Specification of how source files for QA indexer should be obtained. If this is null or undefined, it means QA feature is disabled. | Properties of files| Property | Type | Required | Constraints | Description |
|---|
tag | string | No | | The tag assigned to project files or entity files meant for QA indexing. | | | tokenState | unknown | Yes | one of: unissued, valid, revoked | Current state of athentication token issued by Slack to Assistant instance. | workspaceId | string | Yes | | ID of Slack workspace connected to Assistant instance. | |
updatedAt | string | No | read-only (server-generated); format: date-time | Timestamp of last update. |