twilio-agent-connect 1.0.3 → 2.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -13,15 +13,16 @@
13
13
 
14
14
  <div align="center">
15
15
  <a href="https://github.com/twilio/twilio-agent-connect-typescript"><img alt="Node.js" src="https://img.shields.io/badge/Node.js-22.13+-339933.svg"/></a>
16
- <a href="LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-green.svg"/></a>
16
+ <a href="https://github.com/twilio/twilio-agent-connect-typescript/blob/main/LICENSE"><img alt="License" src="https://img.shields.io/badge/license-MIT-green.svg"/></a>
17
17
  <a href="https://www.twilio.com/docs/conversations/agent-connect/quickstart"><img alt="Getting Started" src="https://img.shields.io/badge/Getting%20Started-Quickstart-F22F46.svg"/></a>
18
18
  </div>
19
19
 
20
20
  <p>
21
21
  <a href="https://www.twilio.com/docs/conversations/agent-connect">Documentation</a>
22
+ ◆ <a href="https://twilio.github.io/twilio-agent-connect-typescript/">API Reference</a>
22
23
  ◆ <a href="https://github.com/twilio/twilio-agent-connect-python">Python SDK</a>
23
24
  ◆ <a href="https://github.com/twilio/twilio-agent-connect-typescript">TypeScript SDK</a>
24
- ◆ <a href="getting_started/examples">Examples</a>
25
+ ◆ <a href="https://github.com/twilio/twilio-agent-connect-typescript/tree/main/getting_started/examples">Examples</a>
25
26
  </p>
26
27
  </div>
27
28
 
@@ -151,7 +152,7 @@ const server = new TACServer(tac);
151
152
  await server.start();
152
153
  ```
153
154
 
154
- > **Note**: See the [getting started guide](getting_started/README.md) for complete setup instructions and `.env` configuration details.
155
+ > **Note**: See the [getting started guide](https://github.com/twilio/twilio-agent-connect-typescript/blob/main/getting_started/README.md) for complete setup instructions and `.env` configuration details.
155
156
 
156
157
  **That's it!** The server automatically:
157
158
  - Creates Fastify app with `/twiml`, `/ws`, and `/webhook` endpoints
@@ -159,7 +160,7 @@ await server.start();
159
160
  - Routes responses to the appropriate channel
160
161
  - Provides conversation memory and user profile in the callback
161
162
 
162
- For configuration details and environment variables, see the [getting started guide](getting_started/README.md).
163
+ For configuration details and environment variables, see the [getting started guide](https://github.com/twilio/twilio-agent-connect-typescript/blob/main/getting_started/README.md).
163
164
 
164
165
  ## How It Works
165
166
 
@@ -173,17 +174,18 @@ TAC simplifies building AI agents by handling the integration between Twilio's c
173
174
  4. **Callback Invoked**: Your `onMessageReady` callback receives user message, context, and optional memory response
174
175
  5. **Response Handling**: Your callback returns a response string that TAC routes to the appropriate channel
175
176
 
176
- For detailed architecture and advanced usage, see [CLAUDE.md](CLAUDE.md).
177
+ For detailed architecture and advanced usage, see [CLAUDE.md](https://github.com/twilio/twilio-agent-connect-typescript/blob/main/CLAUDE.md).
177
178
 
178
179
  ## Learn More
179
180
 
180
181
  **Examples & Guides:**
181
- - **[Getting Started Guide](getting_started/)** - Examples and comprehensive documentation
182
- - **[OpenAI SDK Example](getting_started/examples/openai/)** - Complete multi-channel example with Voice, SMS, and Chat
183
- - **[WhatsApp Example](getting_started/examples/whatsapp/)** - WhatsApp channel with memory integration
184
- - **[Chat Example](getting_started/examples/chat/)** - Web chat integration example
185
- - **[ConversationRelay-Only Mode](getting_started/examples/relay-only/)** - Get started with voice using just ConversationRelay
186
- - **[Outbound Conversations](getting_started/examples/outbound/)** - Agent-initiated conversations example
182
+ - **[API Reference](https://twilio.github.io/twilio-agent-connect-typescript/)** - Full API documentation generated from the source
183
+ - **[Getting Started Guide](https://github.com/twilio/twilio-agent-connect-typescript/tree/main/getting_started/)** - Examples and comprehensive documentation
184
+ - **[OpenAI SDK Example](https://github.com/twilio/twilio-agent-connect-typescript/tree/main/getting_started/examples/openai/)** - Complete multi-channel example with Voice, SMS, and Chat
185
+ - **[WhatsApp Example](https://github.com/twilio/twilio-agent-connect-typescript/tree/main/getting_started/examples/whatsapp/)** - WhatsApp channel with memory integration
186
+ - **[Chat Example](https://github.com/twilio/twilio-agent-connect-typescript/tree/main/getting_started/examples/chat/)** - Web chat integration example
187
+ - **[ConversationRelay-Only Mode](https://github.com/twilio/twilio-agent-connect-typescript/tree/main/getting_started/examples/relay-only/)** - Get started with voice using just ConversationRelay
188
+ - **[Outbound Conversations](https://github.com/twilio/twilio-agent-connect-typescript/tree/main/getting_started/examples/outbound/)** - Agent-initiated conversations example
187
189
  - More examples coming soon
188
190
 
189
191
  **AWS and Microsoft connectors:**
@@ -191,8 +193,8 @@ For detailed architecture and advanced usage, see [CLAUDE.md](CLAUDE.md).
191
193
  - **[TAC for Microsoft](https://github.com/twilio/twilio-agent-connect-microsoft)** — `AgentFrameworkConnector` and `VoiceLiveConnector` for Microsoft Agent Framework, Azure AI Foundry (including Voice Live), and Azure OpenAI
192
194
 
193
195
  **Documentation:**
194
- - **[CLAUDE.md](CLAUDE.md)** - Architecture, development guide, and API reference
195
- - **[Getting Started Guide](getting_started/README.md)** - Setup instructions, environment variables, and troubleshooting
196
+ - **[CLAUDE.md](https://github.com/twilio/twilio-agent-connect-typescript/blob/main/CLAUDE.md)** - Architecture, development guide, and API reference
197
+ - **[Getting Started Guide](https://github.com/twilio/twilio-agent-connect-typescript/blob/main/getting_started/README.md)** - Setup instructions, environment variables, and troubleshooting
196
198
 
197
199
  ---
198
200