Azure AI Bot Service

https://learn.microsoft.com/en-us/azure/bot-service/
Admin
Azure AI Bot Service provides an integrated environment for building, testing, deploying, and...
Tokens:342,284
Snippets:4,041
Trust Score:10
Update:2 months ago
Show doc for...
Tokens:
Raw
### Start Python bot

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-manage-test-webchat

Commands to navigate to the directory, install dependencies, and launch the application.

```Console
cd echo_bot
```

```Console
pip install -r requirements.txt 
```

```Console
python app.py
```

--------------------------------

### Install dependencies

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-expire-conversation

Run the package manager install command.

```bash
npm install
```

--------------------------------

### all Function Examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples demonstrating how to check if all elements in a sequence satisfy a condition.

```text
all(createArray(1, 'cool'), item, isInteger(item))
all(createArray(1, 2), item => isInteger(item))
```

--------------------------------

### Install Dependencies

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-expire-conversation

Install the required packages using pip.

```bash
pip install -r requirements.txt
```

--------------------------------

### any Function Examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples demonstrating how to check if any elements in a sequence satisfy a condition.

```text
any(createArray(1, 'cool'), item, isInteger(item))
any(createArray('first', 'cool'), item => isInteger(item))
```

--------------------------------

### Start JavaScript bot

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-manage-test-webchat

Navigate to the project directory and start the bot using npm.

```Console
cd my-chat-bot
npm start
```

--------------------------------

### Start a conversation request example

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-send-and-receive-messages

Example of a POST request to start a conversation, including authorization headers and the JSON body structure.

```HTTP
POST https://smba.trafficmanager.net/teams/v3/conversations 
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
```

```JSON
{
    "bot": {
        "id": "12345678",
        "name": "bot's name"
    },
    "isGroup": false,
    "members": [
        {
            "id": "1234abcd",
            "name": "recipient's name"
        }
    ],
    "topicName": "News Alert"
}
```

--------------------------------

### Install Bot Framework CLI

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-tutorial-orchestrator

Global installation of npm and the Bot Framework CLI tool.

```bash
npm i -g npm
npm i -g @microsoft/botframework-cli
```

--------------------------------

### List Installed Templates

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-manage-test-webchat

Verify that the Bot Framework templates have been installed correctly.

```Console
dotnet new --list
```

--------------------------------

### addToTime Examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples demonstrating adding time units to a timestamp.

```text
addToTime('2018-01-01T00:00:00.000Z', 1, 'Day')
```

```text
addToTime('2018-01-01T00:00:00.000Z', 2, 'Week', 'MM-DD-YY')
```

--------------------------------

### Install Windows Build Tools

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-manage-test-webchat

Optional global installation for Windows users to resolve node-gyp errors.

```bash
npm install -g windows-build-tools
```

--------------------------------

### and Function Examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples demonstrating logical AND operations with boolean values and expressions.

```text
and(true, true)
and(false, true)
and(false, false)
```

```text
and(equals(1, 1), equals(2, 2))
and(equals(1, 1), equals(1, 2))
and(equals(1, 2), equals(1, 3))
```

--------------------------------

### Install Bot Framework C# Templates

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-manage-test-webchat

Install the echo, core, and empty bot templates for C# development.

```Console
dotnet new -i Microsoft.Bot.Framework.CSharp.EchoBot
dotnet new -i Microsoft.Bot.Framework.CSharp.CoreBot
dotnet new -i Microsoft.Bot.Framework.CSharp.EmptyBot
```

--------------------------------

### formatTicks Examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples demonstrating how to convert ticks into specific formats and locales.

```text
formatTicks(637243624200000000, 'yyyy-MM-ddTHH:mm:ss.fffZ')
```

```text
formatTicks(637243624200000000, '', 'de-DE')
```

--------------------------------

### Define question and answer examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/file-format/bot-builder-qna-file-format

Examples of question and answer definitions using the .qna syntax.

```markdown
> # QnA Definitions
### ? who is the ceo?
```
You can change the default message if you use the QnAMakerDialog.
For details, see [Azure AI Bot Service documentation](/articles/adaptive-dialog/adaptive-dialog-prebuilt-actions.md).
```


### ? How do I programmatically update my KB?
```
You can use our REST apis to manage your KB.
\#1. See here for details: https://westus.dev.cognitive.microsoft.com/docs/services/58994a073d9e04097c7ba6fe/operations/58994a073d9e041ad42d9baa
```
```

--------------------------------

### formatEpoch usage examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples of converting Unix epoch timestamps to formatted strings.

```text
formatEpoch(1521118800, 'yyyy-MM-ddTHH:mm:ss.fffZ)'
formatEpoch(1521118800, '', 'de-DE')
```

--------------------------------

### Install Yeoman and Bot Framework Generator

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-manage-test-webchat

Global installation of npm, Yeoman, and the Bot Framework generator.

```bash
npm install -g npm
npm install -g yo
```

```bash
npm install -g generator-botbuilder
```

--------------------------------

### Implement Cosmos DB in C# Startup

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-v4-storage

Reference the library and register the storage service in Startup.cs.

```C#
using Microsoft.Bot.Builder.Azure;
```

```C#
// Use partitioned CosmosDB for storage, instead of in-memory storage.
services.AddSingleton<IStorage>(
    new CosmosDbPartitionedStorage(
        new CosmosDbPartitionedStorageOptions
        {
            CosmosDbEndpoint = Configuration.GetValue<string>("CosmosDbEndpoint"),
            AuthKey = Configuration.GetValue<string>("CosmosDbAuthKey"),
            DatabaseId = Configuration.GetValue<string>("CosmosDbDatabaseId"),
            ContainerId = Configuration.GetValue<string>("CosmosDbContainerId"),
            CompatibilityMode = false,
        }));
```

--------------------------------

### Configure C# appsettings.json

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-tutorial-orchestrator

Example structure for adding LUIS and QnA Maker credentials to the C# configuration file.

```json
"QnAKnowledgebaseId": "<knowledge-base-id>",
"QnAEndpointKey": "<qna-maker-resource-key>",
"QnAEndpointHostName": "<your-hostname>",

"LuisHomeAutomationAppId": "<app-id-for-home-automation-app>",
"LuisWeatherAppId": "<app-id-for-weather-app>",
"LuisAPIKey": "<your-luis-endpoint-key>",
"LuisAPIHostName": "<your-dispatch-app-region>",
```

--------------------------------

### Reconnect Request Example

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-direct-line-3-0-reconnect-to-conversation

An example of a GET request to reconnect to a specific conversation with a watermark.

```HTTP
GET https://directline.botframework.com/v3/directline/conversations/abc123?watermark=0000a-42
Authorization: Bearer RCurR_XV9ZA.cwA.BKA.iaJrC8xpy8qbOF5xnR2vtCX7CZj0LdjAPGfiCpg4Fv0y8qbOF5xPGfiCpg4Fv0y8qqbOF5x8qbOF5xn
```

--------------------------------

### Initialize Skill Client in Python

Source: https://learn.microsoft.com/en-us/azure/bot-service/skill-implement-consumer

Set up the credential provider and skill HTTP client for the bot.

```python
CREDENTIAL_PROVIDER = SimpleCredentialProvider(CONFIG.APP_ID, CONFIG.APP_PASSWORD)
CLIENT = SkillHttpClient(CREDENTIAL_PROVIDER, ID_FACTORY)

    ADAPTER, BOT, ID_FACTORY, CREDENTIAL_PROVIDER, AUTH_CONFIG
)
```

--------------------------------

### substring function example

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Demonstrates extracting a specific number of characters from a string starting at a given index.

```text
substring('hello world', 6, 5)
```

--------------------------------

### Get Conversation Activities Response

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-direct-line-3-0-receive-activities

Example of the HTTP response headers and the JSON body containing the activity set and the updated watermark.

```HTTP
HTTP/1.1 200 OK
[other headers]
```

```JSON
{
    "activities": [
        {
            "type": "message",
            "channelId": "directline",
            "conversation": {
                "id": "abc123"
            },
            "id": "abc123|0000",
            "from": {
                "id": "user1"
            },
            "text": "hello"
        }, 
        {
            "type": "message",
            "channelId": "directline",
            "conversation": {
                "id": "abc123"
            },
            "id": "abc123|0001",
            "from": {
                "id": "bot1"
            },
            "text": "Nice to see you, user1!"
        }
    ],
    "watermark": "0001a-95"
}
```

--------------------------------

### GET /v3/directline/conversations/{conversationId}/activities

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-direct-line-3-0-receive-activities

Retrieves a list of activities for a specific conversation. Clients can use the watermark parameter to fetch activities starting from a specific point in the conversation history.

```APIDOC
## GET /v3/directline/conversations/{conversationId}/activities

### Description
Retrieves activities for a specific conversation. Clients should use the watermark parameter to page through available activities.

### Method
GET

### Endpoint
https://directline.botframework.com/v3/directline/conversations/{conversationId}/activities

### Parameters
#### Path Parameters
- **conversationId** (string) - Required - The unique identifier for the conversation.

#### Query Parameters
- **watermark** (string) - Optional - The identifier indicating the most recent message seen by the client.

### Request Example
GET https://directline.botframework.com/v3/directline/conversations/abc123/activities?watermark=0001a-94
Authorization: Bearer <token>

### Response
#### Success Response (200)
- **activities** (array) - A list of activity objects.
- **watermark** (string) - The updated watermark value for subsequent requests.

#### Response Example
{
    "activities": [
        {
            "type": "message",
            "channelId": "directline",
            "conversation": {
                "id": "abc123"
            },
            "id": "abc123|0000",
            "from": {
                "id": "user1"
            },
            "text": "hello"
        }
    ],
    "watermark": "0001a-95"
}
```

--------------------------------

### Install Yeoman

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-manage-test-webchat

Install the Yeoman scaffolding tool globally.

```Console
npm install -g yo
```

--------------------------------

### Configure parser and KB settings

Source: https://learn.microsoft.com/en-us/azure/bot-service/file-format/bot-builder-qna-file-format

Specific examples of setting the parser version, KB name, and source metadata.

```markdown
> Parser instruction - this is optional; unless specified, the parser will default to the latest version.
> !# @version = 1.0

> QnA Maker KB description
> !# @kb.name = my qna maker kb name

> Source for a specific QnA pair
> !# @qna.pair.source = <source value>
```

--------------------------------

### Initialize Bot and Server in JavaScript

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-send-welcome-message

Creates the bot instance with user state and sets up the Restify server.

```JavaScript
// Create the main dialog.
const bot = new WelcomeBot(userState);

// Create HTTP server
const server = restify.createServer();
server.use(restify.plugins.bodyParser());

server.listen(process.env.port || process.env.PORT || 3978, function() {
```

--------------------------------

### Initialize and Query Knowledge Base in JavaScript

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-answer-questions

Configure the client in the constructor and handle the response in the onMessage method.

```javascript
try {
    this.qnaMaker = new CustomQuestionAnswering({
        knowledgeBaseId: process.env.ProjectName ?? '',
        endpointKey: process.env.LanguageEndpointKey ?? '',
```

```javascript
} else {
    console.log('Calling CQA');
```

--------------------------------

### GET /v3/conversations

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference

Gets a list of conversations the bot has participated in.

```APIDOC
## GET /v3/conversations

### Description
Gets a list of conversations the bot has participated in.

### Method
GET

### Endpoint
/v3/conversations?continuationToken={continuationToken}

### Parameters
#### Query Parameters
- **continuationToken** (string) - Optional - Token for pagination

### Response
#### Success Response (200)
- **ConversationsResult** (object) - A ConversationsResult object
```

--------------------------------

### GET /v3/conversations/{conversationId}/members

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference

Gets the members of the specified conversation.

```APIDOC
## GET /v3/conversations/{conversationId}/members

### Description
Gets the members of the specified conversation.

### Method
GET

### Endpoint
/v3/conversations/{conversationId}/members

### Parameters
#### Path Parameters
- **conversationId** (string) - Required - The ID of the conversation

### Response
#### Success Response (200)
- **ChannelAccount[]** (array) - An array of ChannelAccount objects for the members.
```

--------------------------------

### Handle Streaming Upgrade Requests

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-telemetry-reference

Example of setting up a streaming adapter for WebSocket connections.

```JavaScript
// Listen for Upgrade requests for Streaming.
server.on('upgrade', async (req, socket, head) => {
    // Create an adapter scoped to this WebSocket connection to allow storing session data.
    const streamingAdapter = new CloudAdapter(botFrameworkAuthentication);

    // Set onTurnError for the CloudAdapter created for each connection.
    streamingAdapter.onTurnError = onTurnErrorHandler;
```

--------------------------------

### Template Definition Example

Source: https://learn.microsoft.com/en-us/azure/bot-service/language-generation/functions-injected-from-language-generation

Example of a template definition that accepts a parameter.

```text
# welcome(userName)
- Hi ${userName}
- Hello ${userName}
- Hey ${userName}
```

--------------------------------

### Initialize Bot in JavaScript index.js

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-handle-user-interrupt

Create the bot instance and configure the HTTP server in index.js.

```javascript
const dialog = new MainDialog(luisRecognizer, bookingDialog);
const bot = new DialogAndWelcomeBot(conversationState, userState, dialog);

// Create HTTP server
const server = restify.createServer();
server.use(restify.plugins.bodyParser());

server.listen(process.env.port || process.env.PORT || 3978, function() {
    console.log(`\n${ server.name } listening to ${ server.url }`);
    console.log('\nGet Bot Framework Emulator: https://aka.ms/botframework-emulator');
```

--------------------------------

### Single attachment request example

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-direct-line-3-0-send-activity

Example request for uploading a JPEG image.

```HTTP
POST https://directline.botframework.com/v3/directline/conversations/abc123/upload?userId=user1
Authorization: Bearer RCurR_XV9ZA.cwA.BKA.iaJrC8xpy8qbOF5xnR2vtCX7CZj0LdjAPGfiCpg4Fv0
Content-Type: image/jpeg
Content-Disposition: name="file"; filename="badjokeeel.jpg"
[other headers]

[JPEG content]
```

--------------------------------

### join usage example

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Example of joining an array of characters with a period delimiter.

```text
join(createArray('a', 'b', 'c'), '.')
```

--------------------------------

### Initiate a SkillDialog in Python

Source: https://learn.microsoft.com/en-us/azure/bot-service/skill-use-skilldialog

Demonstrates how to create BeginSkillDialogOptions and start a skill dialog instance based on user selection.

```python
async def _call_skill_action_step(
    self, step_context: WaterfallStepContext
) -> DialogTurnResult:
    """
    Starts the SkillDialog based on the user's selections.
    """

    selected_skill: BotFrameworkSkill = step_context.values[
        self._selected_skill_key
    ]

    if selected_skill.id == "DialogSkillBot":
        skill_activity = self._create_dialog_skill_bot_activity(
            step_context.result.value, step_context.context
        )
    else:
        raise Exception(f"Unknown target skill id: {selected_skill.id}.")

    # Create the BeginSkillDialogOptions and assign the activity to send.
    skill_dialog_args = BeginSkillDialogOptions(skill_activity)

    # Save active skill in state.
    await self._active_skill_property.set(step_context.context, selected_skill)

    # Start the skillDialog instance with the arguments.
    return await step_context.begin_dialog(selected_skill.id, skill_dialog_args)
```

--------------------------------

### isTimeRange usage examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples demonstrating validation of time range inputs.

```text
isTimeRange('PT30M')
isTimeRange(validTimeRange)
```

--------------------------------

### Configure QnA Maker settings in .env

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-qna

Add the knowledge base credentials to the JavaScript environment file.

```text
QnAKnowledgebaseId=<knowledge-base-id>
QnAEndpointKey=<your-endpoint-key>
QnAEndpointHostName=<your-host-url>
```

--------------------------------

### formatNumber usage examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples of formatting numbers to specific precision and locales.

```text
formatNumber(10.333, 2)
formatNumber(12.123, 2, 'en-US')
formatNumber(1.551, 2, 'en-US')
formatNumber(12.123, 4, 'en-US')
```

--------------------------------

### Configure QnA Maker settings in appsettings.json

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-qna

Add the knowledge base credentials to the C# configuration file.

```json
{
  "QnAKnowledgebaseId": "<knowledge-base-id>",
  "QnAEndpointKey": "<your-endpoint-key>",
  "QnAEndpointHostName": "<your-host-url>"
}
```

--------------------------------

### Start a Python bot

Source: https://learn.microsoft.com/en-us/azure/bot-service/java/bot-builder-java-quickstart

Commands to prepare the environment and launch the Python application.

```bash
cd echo_bot
```

```bash
pip install -r requirements.txt
```

```bash
python app.py
```

--------------------------------

### formatDateTime usage examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples of formatting timestamps with custom patterns and locales.

```text
formatDateTime('03/15/2018 12:00:00', 'yyyy-MM-ddTHH:mm:ss')
formatDateTime('2018-03-15', '', 'de-DE')
```

--------------------------------

### Configure JavaScript .env file

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-tutorial-orchestrator

Example structure for adding service connection values to the environment configuration file.

```ini
QnAKnowledgebaseId="<knowledge-base-id>"
QnAEndpointKey="<qna-maker-resource-key>"
QnAEndpointHostName="<your-hostname>"

WeatherLuisAppId=<app-id-for-weather-app>
HomeAutomationLuisAppId=<app-id-for-home-automation-app>
LuisAPIKey=<your-luis-endpoint-key>
LuisAPIHostName=<your-dispatch-app-region>
```

--------------------------------

### foreach array example

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Example of using foreach to increment values in an array.

```text
foreach(createArray(0, 1, 2, 3), x, x + 1)
```

--------------------------------

### Create CosmosDbStorageInitializerHostedService

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-expire-conversation

Implement an IHostedService to initialize the Cosmos DB container with the specified TTL before the bot starts.

```csharp
// Add required using statements...

public class CosmosDbStorageInitializerHostedService : IHostedService
{
    readonly CosmosDbPartitionedStorageOptions _storageOptions;
    readonly int _cosmosDbTimeToLive;

    public CosmosDbStorageInitializerHostedService(IConfiguration config)
    {
        _storageOptions = new CosmosDbPartitionedStorageOptions()
        {
            CosmosDbEndpoint = config["CosmosDbEndpoint"],
            AuthKey = config["CosmosDbAuthKey"],
            DatabaseId = config["CosmosDbDatabaseId"],
            ContainerId = config["CosmosDbConversationStateContainerId"]
        };

        _cosmosDbTimeToLive = config.GetValue<int>("CosmosDbTimeToLive");
    }

    public async Task StartAsync(CancellationToken cancellationToken)
    {
        using (var client = new CosmosClient(
            _storageOptions.CosmosDbEndpoint,
            _storageOptions.AuthKey,
            _storageOptions.CosmosClientOptions ?? new CosmosClientOptions()))
        {
            // Create the contaier with the provided TTL
            var containerResponse = await client
                .GetDatabase(_storageOptions.DatabaseId)
                .DefineContainer(_storageOptions.ContainerId, "/id")
                .WithDefaultTimeToLive(_cosmosDbTimeToLive)
                .WithIndexingPolicy().WithAutomaticIndexing(false).Attach()
                .CreateIfNotExistsAsync(_storageOptions.ContainerThroughput)
                .ConfigureAwait(false);
        }
    }

    public Task StopAsync(CancellationToken cancellationToken) => Task.CompletedTask;
}
```

--------------------------------

### Initialize Cloud Adapter in JavaScript

Source: https://learn.microsoft.com/en-us/azure/bot-service/how-to-deploy-china-cloud

Create the authentication and adapter instances in the index.js file using environment variables.

```javascript
const botFrameworkAuthentication = new ConfigurationBotFrameworkAuthentication(process.env);

const adapter = new CloudAdapter(botFrameworkAuthentication);
```

--------------------------------

### Install Bot Builder Generator

Source: https://learn.microsoft.com/en-us/azure/bot-service/java/bot-builder-java-quickstart

Install the Yeoman generator for Bot Framework v4.

```Console
npm install -g generator-botbuilder
```

--------------------------------

### getFutureTime Examples

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Examples showing how to add time units to a current timestamp with optional formatting and locale settings.

```text
getFutureTime(2, 'Week')
```

```text
getFutureTime(5, 'Day', 'MM-DD-YY')
```

```text
getFutureTime(1,'Day', '', 'de-DE')
```

--------------------------------

### Install npm and Yeoman

Source: https://learn.microsoft.com/en-us/azure/bot-service/java/bot-builder-java-quickstart

Update npm and install the Yeoman scaffolding tool globally.

```Console
npm install -g npm
npm install -g yo
```

--------------------------------

### Initialize Bot Services in JavaScript index.js

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-dialog-manage-conversation-flow

Sets up state storage, dialogs, and the HTTP server for a Node.js bot.

```javascript
    // This check writes out errors to console log .vs. app insights.
    // NOTE: In production environment, you should consider logging this to Azure
    //       application insights. See https://aka.ms/bottelemetry for telemetry
    //       configuration instructions.
    console.error(`\n [onTurnError] unhandled error: ${ error }`);

    // Send a trace activity, which will be displayed in Bot Framework Emulator
    await context.sendTraceActivity(
        'OnTurnError Trace',
        `${ error }`,
        'https://www.botframework.com/schemas/error',
        'TurnError'
    );

    // Send a message to the user
    await context.sendActivity('The bot encountered an error or bug.');
    await context.sendActivity('To continue to run this bot, please fix the bot source code.');
    // Clear out state
    await conversationState.delete(context);
};

// Define the state store for your bot.
// See https://aka.ms/about-bot-state to learn more about using MemoryStorage.
// A bot requires a state storage system to persist the dialog and user state between messages.
const memoryStorage = new MemoryStorage();

// Create conversation state with in-memory storage provider.
const conversationState = new ConversationState(memoryStorage);
const userState = new UserState(memoryStorage);

// Create the main dialog.
const dialog = new UserProfileDialog(userState);
const bot = new DialogBot(conversationState, userState, dialog);

// Create HTTP server.
const server = restify.createServer();
server.use(restify.plugins.bodyParser());

server.listen(process.env.port || process.env.PORT || 3978, function() {
```

--------------------------------

### GET /v3/conversations/{conversationId}/members/{memberId}

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference

Gets details about a specific member of a conversation.

```APIDOC
## GET /v3/conversations/{conversationId}/members/{memberId}

### Description
Gets details about a specific member of a specific conversation.

### Method
GET

### Endpoint
/v3/conversations/{conversationId}/members/{memberId}

### Parameters
#### Path Parameters
- **conversationId** (string) - Required - The ID of the conversation
- **memberId** (string) - Required - The ID of the member

### Response
#### Success Response (200)
- **ChannelAccount** (object) - A ChannelAccount object for the member.
```

--------------------------------

### Configure QnA Maker settings in config.py

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-qna

Add the knowledge base credentials to the Python configuration file.

```python
QNA_KNOWLEDGEBASE_ID = "<knowledge-base-id>"
QNA_ENDPOINT_KEY = "<your-endpoint-key>"
QNA_ENDPOINT_HOST_NAME = "<your-host-url>"
```

--------------------------------

### GET /v3/conversations/{conversationId}/activities/{activityId}/members

Source: https://learn.microsoft.com/en-us/azure/bot-service/rest-api/bot-framework-rest-connector-api-reference

Gets the members of the specified activity.

```APIDOC
## GET /v3/conversations/{conversationId}/activities/{activityId}/members

### Description
Gets the members of the specified activity within the specified conversation.

### Method
GET

### Endpoint
/v3/conversations/{conversationId}/activities/{activityId}/members

### Parameters
#### Path Parameters
- **conversationId** (string) - Required - The ID of the conversation
- **activityId** (string) - Required - The ID of the activity

### Response
#### Success Response (200)
- **ChannelAccount[]** (array) - An array of ChannelAccount objects
```

--------------------------------

### Initialize Bot in Python

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-send-welcome-message

Instantiates the WelcomeUserBot with the global USER_STATE object.

```Python
# Create the Bot
BOT = WelcomeUserBot(USER_STATE)


# Listen for incoming requests on /api/messages.
```

--------------------------------

### xPath XML Data Example

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

The XML string used as input for the xPath example.

```xml
"<?xml version="1.0"?> <produce> <item> <name>Gala</name> <type>apple</type> <count>20</count> </item> <item> <name>Honeycrisp</name> <type>apple</type> <count>10</count> </item> </produce>"
```

--------------------------------

### Configure Azure Blob Storage in C#

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-v4-state

Example of initializing BlobsStorage for state management in a C# bot.

```csharp
// {
//     TypeNameHandling = TypeNameHandling.All,
// var storage = new BlobsStorage("<blob-storage-connection-string>", "bot-state");

// With a custom JSON SERIALIZER, use this instead.
// var storage = new BlobsStorage("<blob-storage-connection-string>", "bot-state", jsonSerializer);

/* END AZURE BLOB STORAGE */

```

--------------------------------

### Import Microsoft.Bot.Builder.Integration.AspNet.Core namespace

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-service-channel-directline-extension-net-bot

Add this using directive to your Startup.cs file to access the required integration classes.

```C#
using Microsoft.Bot.Builder.Integration.AspNet.Core;
```

--------------------------------

### jPath JavaScript example JSON

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Sample JSON structure for the JavaScript jPath example.

```json
{
    "automobiles": [
        {
            "maker": "Nissan",
            "model": "Teana",
            "year": 2011
        },
        {
            "maker": "Honda",
            "model": "Jazz",
            "year": 2010
        },
        {
            "maker": "Honda",
            "model": "Civic",
            "year": 2007
        },
        {
            "maker": "Toyota",
            "model": "Yaris",
            "year": 2008
        },
        {
            "maker": "Honda",
            "model": "Accord",
            "year": 2011
        }
    ],
    "motorcycles": [
        {
            "maker": "Honda",
            "model": "ST1300",
            "year": 2012
        }
    ]
}
```

--------------------------------

### Reference Blobs Library in Startup.cs (C#)

Source: https://learn.microsoft.com/en-us/azure/bot-service/bot-builder-howto-v4-storage

Add the required namespace to your Startup.cs file.

```csharp
using Microsoft.Bot.Builder.Azure.Blobs;
```

--------------------------------

### jPath C# example JSON

Source: https://learn.microsoft.com/en-us/azure/bot-service/adaptive-expressions/adaptive-expressions-prebuilt-functions

Sample JSON structure for the C# jPath example.

```json
{
    "Stores": [
        "Lambton Quay",
        "Willis Street"
    ],
    "Manufacturers": [
        {
            "Name": "Acme Co",
            "Products": [
                {
                    "Name": "Anvil",
                    "Price": 50
                }
            ]
        },
        {
            "Name": "Contoso",
            "Products": [
                {
                    "Name": "Elbow Grease",
                    "Price": 99.95
                },
                {
                    "Name": "Headlight Fluid",
                    "Price": 4
                }
            ]
        }
    ]
}
```
Tokens:
Raw