Ask bot

POST 
/api/bots/:botId/ask

Ask a question to your bot passing the BotId and optionally a ConversationID to continue the same conversation. Sample request:

POST api/bots/d07c3908-95ae-4bb8-b123-c4251784ce6b/ask?conversationId=1234
{        
  "query": "Hello",
  "language": "en"
}

Request

Path Parameters

botId uuidrequired

Query Parameters

conversationId string
snapshotId uuid

application/json;odata.metadata=minimal;odata.streaming=true

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.metadata=minimal;odata.streaming=false

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.metadata=minimal

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.metadata=full;odata.streaming=true

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.metadata=full;odata.streaming=false

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.metadata=full

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.metadata=none;odata.streaming=true

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.metadata=none;odata.streaming=false

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.metadata=none

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.streaming=true

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json;odata.streaming=false

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/json

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/xml

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

text/plain

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

text/json

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

application/*+json

Body

identity stringnullable
query stringnullable
audience string[]nullable
language stringnullable
topK int32nullable
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable

Responses

200

Success

application/json;odata.metadata=minimal;odata.streaming=true

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.467Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.467Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.metadata=minimal;odata.streaming=false

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.468Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.468Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.metadata=minimal

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.469Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.469Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.metadata=full;odata.streaming=true

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.470Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.470Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.metadata=full;odata.streaming=false

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.470Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.470Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.metadata=full

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.471Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.471Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.metadata=none;odata.streaming=true

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.472Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.472Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.metadata=none;odata.streaming=false

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.473Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.473Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.metadata=none

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.473Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.473Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.streaming=true

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.474Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.474Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json;odata.streaming=false

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.475Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.475Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/json

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.475Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.475Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/xml

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

<root>
  <identity>
    <name>string</name>
    <displayName>string</displayName>
    <preferredLanguage>string</preferredLanguage>
    <audience>string</audience>
  </identity>
  <context>
    <conversationId>string</conversationId>
    <identity>
      <name>string</name>
      <displayName>string</displayName>
      <preferredLanguage>string</preferredLanguage>
      <audience>string</audience>
    </identity>
    <language>string</language>
    <container>string</container>
    <preferences>
      <temperature>0</temperature>
      <searchSkills>string</searchSkills>
      <searchLanguages>string</searchLanguages>
      <allowInternetAccess>true</allowInternetAccess>
    </preferences>
    <variables/>
    <entities/>
    <messages>
      <role>Assistant</role>
      <content>
        <type>Plain</type>
      </content>
      <text>string</text>
      <properties/>
      <score>0</score>
      <sentiment>0</sentiment>
      <toxic>0</toxic>
      <skillId>3fa85f64-5717-4562-b3fc-2c963f66afa6</skillId>
      <skillType>Dialog</skillType>
      <skillSnapshotId>3fa85f64-5717-4562-b3fc-2c963f66afa6</skillSnapshotId>
      <action>
        <title>string</title>
        <type>None</type>
        <sticky>true</sticky>
        <properties/>
      </action>
      <actions>
        <title>string</title>
        <type>None</type>
        <sticky>true</sticky>
        <properties/>
      </actions>
      <timestamp>2023-12-10T11:07:29.477Z</timestamp>
      <media>
        <documentId>3fa85f64-5717-4562-b3fc-2c963f66afa6</documentId>
        <snapshotId>3fa85f64-5717-4562-b3fc-2c963f66afa6</snapshotId>
        <title>string</title>
      </media>
    </messages>
    <activeSkills>
      <id>3fa85f64-5717-4562-b3fc-2c963f66afa6</id>
      <snapshotId>3fa85f64-5717-4562-b3fc-2c963f66afa6</snapshotId>
      <type>Dialog</type>
      <properties/>
    </activeSkills>
  </context>
  <messages>
    <role>Assistant</role>
    <content>
      <type>Plain</type>
    </content>
    <text>string</text>
    <properties/>
    <score>0</score>
    <sentiment>0</sentiment>
    <toxic>0</toxic>
    <skillId>3fa85f64-5717-4562-b3fc-2c963f66afa6</skillId>
    <skillType>Dialog</skillType>
    <skillSnapshotId>3fa85f64-5717-4562-b3fc-2c963f66afa6</skillSnapshotId>
    <action>
      <title>string</title>
      <type>None</type>
      <sticky>true</sticky>
      <properties/>
    </action>
    <actions>
      <title>string</title>
      <type>None</type>
      <sticky>true</sticky>
      <properties/>
    </actions>
    <timestamp>2023-12-10T11:07:29.477Z</timestamp>
    <media>
      <documentId>3fa85f64-5717-4562-b3fc-2c963f66afa6</documentId>
      <snapshotId>3fa85f64-5717-4562-b3fc-2c963f66afa6</snapshotId>
      <title>string</title>
    </media>
  </messages>
  <properties/>
</root>

text/plain

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.480Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.480Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

application/octet-stream

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.480Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.480Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

text/json

Schema

Schema

identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
context object
conversationId stringrequired
Possible values: non-empty
identity object
name stringnullable
displayName stringnullable
preferredLanguage stringnullable
audience string[]nullable
language stringnullable
container stringnullable
preferences object
temperature floatnullable
searchSkills string[]nullable
searchLanguages string[]nullable
allowInternetAccess booleannullable
variables objectnullable
entities objectnullable
property name* object[]nullable
Array [
label stringnullable
unit stringnullable
literal stringnullable
value stringnullable
value2 stringnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
activeSkills object[]nullable
Array [
id uuid
snapshotId uuid
type SkillType
Possible values: [Dialog, Search]
properties objectnullable
]
messages object[]nullable
Array [
role MessageRole
Possible values: [Assistant, User, System, Function, Event]
content object
type MessageType
Possible values: [Plain, Document, FunctionCall, FunctionResult, Event]
text stringnullable
properties objectnullable
score doublenullable
sentiment doublenullable
toxic doublenullable
skillId uuidnullable
skillType SkillType
Possible values: [Dialog, Search]
skillSnapshotId uuidnullable
action object
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
actions object[]nullable
Array [
title stringnullable
type ActionType
Possible values: [None, MessageBack, OpenUrl]
sticky boolean
properties objectnullable
]
timestamp date-time
media object[]nullable
Array [
documentId uuid
snapshotId uuidnullable
title stringnullable
]
]
properties objectnullable

Example (from schema)

{
  "identity": {
    "name": "string",
    "displayName": "string",
    "preferredLanguage": "string",
    "audience": [
      "string"
    ]
  },
  "context": {
    "conversationId": "string",
    "identity": {
      "name": "string",
      "displayName": "string",
      "preferredLanguage": "string",
      "audience": [
        "string"
      ]
    },
    "language": "string",
    "container": "string",
    "preferences": {
      "temperature": 0,
      "searchSkills": [
        "string"
      ],
      "searchLanguages": [
        "string"
      ],
      "allowInternetAccess": true
    },
    "variables": {},
    "entities": {},
    "messages": [
      {
        "role": "Assistant",
        "content": {
          "type": "Plain"
        },
        "text": "string",
        "properties": {},
        "score": 0,
        "sentiment": 0,
        "toxic": 0,
        "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "skillType": "Dialog",
        "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "action": {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        },
        "actions": [
          {
            "title": "string",
            "type": "None",
            "sticky": true,
            "properties": {}
          }
        ],
        "timestamp": "2023-12-10T11:07:29.481Z",
        "media": [
          {
            "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
            "title": "string"
          }
        ]
      }
    ],
    "activeSkills": [
      {
        "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "type": "Dialog",
        "properties": {}
      }
    ]
  },
  "messages": [
    {
      "role": "Assistant",
      "content": {
        "type": "Plain"
      },
      "text": "string",
      "properties": {},
      "score": 0,
      "sentiment": 0,
      "toxic": 0,
      "skillId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "skillType": "Dialog",
      "skillSnapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "action": {
        "title": "string",
        "type": "None",
        "sticky": true,
        "properties": {}
      },
      "actions": [
        {
          "title": "string",
          "type": "None",
          "sticky": true,
          "properties": {}
        }
      ],
      "timestamp": "2023-12-10T11:07:29.481Z",
      "media": [
        {
          "documentId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "snapshotId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "title": "string"
        }
      ]
    }
  ],
  "properties": {}
}

Loading...