mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Eduard van Valkenburg
eaad042241
* Add AGENTS.md files and update coding standards for Python - Add root python/AGENTS.md with project structure and package links - Add AGENTS.md for each package describing purpose and main classes - Update .github/copilot-instructions.md with improved structure - Update python/CODING_STANDARD.md with API review guidance: - Future annotations convention (#3578) - TypeVar naming convention (#3594) - Mapping vs MutableMapping (#3577) - Avoid shadowing built-ins (#3583) - Explicit exports (#3605) - Exception documentation guidelines (#3410) - Simplify python/.github/instructions/python.instructions.md to reference AGENTS.md - Remove AGENTS.md from .gitignore * Fix purview import path in AGENTS.md * Address PR review comments and restructure instructions - Slim down .github/copilot-instructions.md to reference language-specific docs - Add ADR section explaining templates and purpose - Create dotnet/AGENTS.md with .NET-specific build commands, conventions, and sample guidance - Update Python build/test instructions for core vs isolated changes - Fix Microsoft.Extensions.AI package references - Update kwargs guidance per issue #3642 - Fix Python sample helper placement (top, not bottom) - Document new 'typing' poe task in DEV_SETUP.md * Add 'typing' poe task to run both pyright and mypy * Add kwargs guidelines from issue #3642 to CODING_STANDARD.md * Clarify that connector packages pull in core as dependency
28 lines
716 B
Markdown
28 lines
716 B
Markdown
# ChatKit Package (agent-framework-chatkit)
|
|
|
|
Integration with OpenAI ChatKit (Python) for building chat UIs.
|
|
|
|
## Main Classes
|
|
|
|
- **`ThreadItemConverter`** - Converts between Agent Framework and ChatKit types
|
|
- **`stream_agent_response()`** - Stream agent responses to ChatKit
|
|
- **`simple_to_agent_input()`** - Convert simple input to agent input format
|
|
|
|
## Usage
|
|
|
|
```python
|
|
from agent_framework.chatkit import stream_agent_response, ThreadItemConverter
|
|
|
|
async for event in stream_agent_response(agent, messages):
|
|
# Handle ChatKit events
|
|
pass
|
|
```
|
|
|
|
## Import Path
|
|
|
|
```python
|
|
from agent_framework.chatkit import stream_agent_response
|
|
# or directly:
|
|
from agent_framework_chatkit import stream_agent_response
|
|
```
|