Skip to content

Commit daff6d2

Browse files
rido-minRidoCopilot
authored
Rev version to 0.6 (#439)
* Set version to '0.6-alpha' * version 0.6 * docs: update README to clarify usage instructions for Azure Blob Storage * Update packages/agents-copilotstudio-client/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> * docs: update README to include NPM version badges for packages --------- Co-authored-by: Rido <nouser@gh.com> Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
1 parent c1e2ea1 commit daff6d2

File tree

4 files changed

+34
-15
lines changed

4 files changed

+34
-15
lines changed

‎README.md‎

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Microsoft 365 Agents SDK - NodeJS /TypeScript
22

3+
![Build Status](https://github.com/microsoft/Agents-for-js/actions/workflows/ci.yml/badge.svg)
4+
![NPM Downloads](https://img.shields.io/npm/dw/%40microsoft%2Fagents-activity)
5+
6+
37
The Microsoft 365 Agent SDK simplifies building full stack, multichannel, trusted agents for platforms including M365, Teams, Copilot Studio, and Webchat. We also offer integrations with 3rd parties such as Facebook Messenger, Slack, or Twilio. The SDK provides developers with the building blocks to create agents that handle user interactions, orchestrate requests, reason responses, and collaborate with other agents.
48

59
The M365 Agent SDK is a comprehensive framework for building enterprise-grade agents, enabling developers to integrate components from the Azure AI Foundry SDK, Semantic Kernel, as well as AI components from other vendors.
@@ -14,22 +18,22 @@ The best to way to get started with these packages is to look at the samples ava
1418

1519
We offer the following NPM packages to create conversational experiences based on Agents:
1620

17-
| Package Name | Description | Replaces|
18-
|--------------|-------------|---------|
19-
| `@microsoft/agents-activity` | Types and validators implementing the Activity protocol spec. | `botframework-schema` |
20-
| `@microsoft/agents-hosting` | Provides classes to host an Agent in express. | `botbuilder` |
21-
| `@microsoft/agents-hosting-express` | Configures express to run the Agent. | N/A |
22-
| `@microsoft/agents-hosting-dialogs` | Provides classes to host an Agent in express. | `botbuilder-dialogs` |
23-
| `@microsoft/agents-hosting-extensions-teams` | Provides classes to make use of Teams specific features. | `teams ai` |
24-
| `@microsoft/agents-hosting-storage-blob` | Extension to use Azure Blob as storage. | `botbuilder-azure` |
25-
| `@microsoft/agents-hosting-storage-cosmos` | Extension to use CosmosDB as storage. | `botbuilder-azure` |
21+
| Package Name | NPM Version | Description | Replaces|
22+
|--------------|-------------|-------------|---------|
23+
| `@microsoft/agents-activity` | [![npm](https://img.shields.io/npm/v/@microsoft/agents-activity)](https://www.npmjs.com/package/@microsoft/agents-activity) | Types and validators implementing the Activity protocol spec. | `botframework-schema` |
24+
| `@microsoft/agents-hosting` | [![npm](https://img.shields.io/npm/v/@microsoft/agents-hosting)](https://www.npmjs.com/package/@microsoft/agents-hosting) | Provides classes to host an Agent in express. | `botbuilder` |
25+
| `@microsoft/agents-hosting-express` | [![npm](https://img.shields.io/npm/v/@microsoft/agents-hosting-express)](https://www.npmjs.com/package/@microsoft/agents-hosting-express) | Configures express to run the Agent. | N/A |
26+
| `@microsoft/agents-hosting-dialogs` | [![npm](https://img.shields.io/npm/v/@microsoft/agents-hosting-dialogs)](https://www.npmjs.com/package/@microsoft/agents-hosting-dialogs) | Provides classes to host an Agent in express. | `botbuilder-dialogs` |
27+
| `@microsoft/agents-hosting-extensions-teams` | [![npm](https://img.shields.io/npm/v/@microsoft/agents-hosting-extensions-teams)](https://www.npmjs.com/package/@microsoft/agents-hosting-extensions-teams) | Provides classes to make use of Teams specific features. | `teams ai` |
28+
| `@microsoft/agents-hosting-storage-blob` | [![npm](https://img.shields.io/npm/v/@microsoft/agents-hosting-storage-blob)](https://www.npmjs.com/package/@microsoft/agents-hosting-storage-blob) | Extension to use Azure Blob as storage. | `botbuilder-azure` |
29+
| `@microsoft/agents-hosting-storage-cosmos` | [![npm](https://img.shields.io/npm/v/@microsoft/agents-hosting-storage-cosmos)](https://www.npmjs.com/package/@microsoft/agents-hosting-storage-cosmos) | Extension to use CosmosDB as storage. | `botbuilder-azure` |
2630

2731

2832
Additionally we provide a Copilot Studio Client, to interact with Agents created in CopilotStudio
2933

30-
| Package Name | Description |
31-
|--------------|-------------|
32-
| `@microsoft/agents-copilotstudio-client`| Direct to Engine client to interact with Agents created in CopilotStudio
34+
| Package Name | NPM Version | Description |
35+
|--------------|-------------|-------------|
36+
| `@microsoft/agents-copilotstudio-client` | [![npm](https://img.shields.io/npm/v/@microsoft/agents-copilotstudio-client)](https://www.npmjs.com/package/@microsoft/agents-copilotstudio-client) | Direct to Engine client to interact with Agents created in CopilotStudio
3337

3438
### Environment requirements
3539

‎packages/agents-copilotstudio-client/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
The `@microsoft/agents-copilotstudio-client` package allows you to interact with Copilot Studio Agents using the Direct Engine Protocol. This client library is designed to facilitate communication with agents, enabling seamless integration and interaction within your JavaScript or TypeScript applications.
66

7+
This package provides exports for CommonJS and ES6 modules, and also a bundle to be used in the browser.
8+
79
> [!NOTE]
810
> The Client needs to be initialized with a valid JWT Token.
911

‎packages/agents-hosting-storage-blob/README.md‎

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,23 @@
44

55
This package allows to configure Azure Blob Storage as the backend for Agents conversation State
66

7-
## Usage
7+
## Usage with connectionStrings
88

99
```ts
10-
const blobStorage = new AzureBlobStorage(process.env.BLOB_STORAGE_CONNECTION_STRING!, process.env.BLOB_CONTAINER_ID!)
10+
const blobStorage = new BlobStorage(process.env.BLOB_STORAGE_CONNECTION_STRING!, process.env.BLOB_CONTAINER_ID!)
1111
const conversationState = new ConversationState(blobStorage)
1212
const userState = new UserState(blobStorage)
13+
```
14+
15+
16+
## Usage with EntraID authentication
17+
18+
>note: you must assign RBAC permissions to your storage account
19+
20+
```ts
21+
const echo = new AgentApplication<TurnState>({
22+
storage: new BlobsStorage('', undefined, undefined,
23+
'https://agentsstate.blob.core.windows.net/nodejs-conversations',
24+
new MsalTokenCredential(loadAuthConfigFromEnv()))
25+
})
1326
```

‎version.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"$schema": "https://raw.githubusercontent.com/dotnet/Nerdbank.GitVersioning/main/src/NerdBank.GitVersioning/version.schema.json",
3-
"version": "0.5",
3+
"version": "0.6",
44
"publicReleaseRefSpec": [
55
"^refs/heads/main$",
66
"^refs/tags/v\\d+\\.\\d+"

0 commit comments

Comments
 (0)