Skip to content

Commit

Permalink
Merge branch 'kavin/getting-started-docs' of https://github.com/micro…
Browse files Browse the repository at this point in the history
…soft/teams-ai into kavin/getting-started-docs
  • Loading branch information
singhk97 committed Jan 18, 2024
2 parents aa63e16 + ec6b789 commit b548705
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
2 changes: 1 addition & 1 deletion getting-started/CONCEPTS/ACTION-PLANNER.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ or create an AutoGPT style agent (monologue).

### Validations
Validators are used to validate the response returned by the LLM and can guarantee
that the parameters passed to an action mach a supplied schema. The validator used is automatically
that the parameters passed to an action match a supplied schema. The validator used is automatically
selected based on the augmentation being used. Validators also prevent hallucinated action names
making it impossible for the LLM to trigger an action that doesn't exist.

Expand Down
4 changes: 2 additions & 2 deletions getting-started/CONCEPTS/ACTIONS.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,14 +47,14 @@ The user can register custom actions or override default actions in the system.

| Action | Called when |
| --------------------- | ----------------------------------------------------------------------------------------------- |
| `___UnkownAction___` | An unknown action is predicted by the planner. |
| `___UnknownAction___` | An unknown action is predicted by the planner. |
| `___FlaggedInput___` | The input is flagged by the moderator. |
| `___FlaggedOutput___` | The output is flagged by the moderator. |
| `___HttpError___` | The planner encounters an HTTP response with status code >= `400` |
| `__TooManySteps__` | The planner task either executed too many steps or timed out. |
| `___PlanReady___` | The plan has been predicted by the planner and it has passed moderation. This can be overriden to mutate the plan before execution. |
| `___DO___` | The AI system is executing a plan with the DO command. Overriding this action will change how _all_ DO commands are handled. |
| `___SAY___` | The AI system is executing a plan wit the SAY command. Overriding this action will change how _all_ SAY commands are handled. By default this will send the `response` message back to the user. |
| `___SAY___` | The AI system is executing a plan with the SAY command. Overriding this action will change how _all_ SAY commands are handled. By default this will send the `response` message back to the user. |

> Detailed description of each action can be found in the codebase.
Expand Down
4 changes: 2 additions & 2 deletions getting-started/CONCEPTS/APPLICATION.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ The `Application` class encapsulates all the business logic for the application

## The Activity Handler System

The activity handler system is the primary way to implement bot or message extension applicaiton logic. It is a set of methods and configuration that allows you to register callbacks (known as route handlers) which will trigger based on the incomming activity. These can be in the form of a message, message reaction, or virtually any interaction with the Teams app.
The activity handler system is the primary way to implement bot or message extension application logic. It is a set of methods and configuration that allows you to register callbacks (known as route handlers) which will trigger based on the incomming activity. These can be in the form of a message, message reaction, or virtually any interaction with the Teams app.

Here's an example of registering a route handler that will run when the the user sends *"/login"* to the bot:

Expand Down Expand Up @@ -66,4 +66,4 @@ When an incoming activity reaches the server, the bot adapter handles the necess
> Note: To learn about what a *turn* is, see [TURNS](TURNS.md).
![the routing logic](../assets/routing-logic.png)
![the routing logic](../assets/routing-logic.png)
4 changes: 2 additions & 2 deletions getting-started/CONCEPTS/USER-AUTH.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The `text` property is the titie and the `text` property is the body of the sign

### Auto sign in

With this configuration, the bot will attempt to authenticate the user when they try to interact with it. To control when for which incomming activities the bot should authenticate the user, you can specify configure the auto sign in property in the options.
With this configuration, the bot will attempt to authenticate the user when they try to interact with it. To control when for which incoming activities the bot should authenticate the user, you can specify configure the auto sign in property in the options.

**C#**
```cs
Expand All @@ -70,7 +70,7 @@ options.AutoSignIn = (ITurnContext turnContext, CancellationToken cancellationTo
};
```

**Javascript**
**JavaScript**
```ts
.withAuthentication(adapter, {
// settings: {
Expand Down
2 changes: 1 addition & 1 deletion getting-started/MIGRATION/JS.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ const app = new ApplicationBuilder()<TurnState>

## 2. Replace the activity handler implementations with specific route registration methods

The `BotActivityHandler` class derives from the `ActivityHandler` class. Each method in the class corresponds to a specific route registration method in the `Application` object. Here's a simple example:
The `BotActivityHandler` class derives from the `ActivityHandler` class. Each method in the class corresponds to a specific route registration method (`handler`) in the `Application` object. Here's a simple example:

Given the `BotActivityHandler` implementation:

Expand Down

0 comments on commit b548705

Please sign in to comment.