mirror of https://github.com/microsoft/agent-framework.git synced 2026-06-16 21:04:09 +08:00

Files

T

Eduard van Valkenburg 390f93344c Python: Add samples syntax checking with pyright (#3710 )

* Add samples syntax checking with pyright

- Add pyrightconfig.samples.json with relaxed type checking but import validation
- Add samples-syntax poe task to check samples for syntax and import errors
- Add samples-syntax to check and pre-commit-check tasks
- Fix 78 sample errors:
  - Update workflow builder imports to use agent_framework_orchestrations
  - Change content type isinstance checks to content.type comparisons
  - Use Content factory methods instead of removed content type classes
  - Fix TypedDict access patterns for Annotation
  - Fix various API mismatches (normalize_messages, ChatMessage.text, role)

* fixed a bunch of samples and tweaks to pre-commit

* updated lock

* updated lock

* fixes

* added lint to samples

390f93344c · 2026-02-07 07:10:47 +00:00

History

azure_ai_chat_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

azure_assistants_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

azure_chat_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

azure_responses_client.py

Python: Add samples syntax checking with pyright (#3710 )

2026-02-07 07:10:47 +00:00

chat_response_cancellation.py

Agents + Chat Client Samples Doctsring Updates (#1028 )

2025-10-01 07:18:53 +00:00

custom_chat_client.py

Python: Add samples syntax checking with pyright (#3710 )

2026-02-07 07:10:47 +00:00

openai_assistants_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

openai_chat_client.py

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

openai_responses_client.py

Python: Add samples syntax checking with pyright (#3710 )

2026-02-07 07:10:47 +00:00

README.md

Python: [BREAKING] Moved to a single get_response and run API (#3379 )

2026-02-05 20:09:58 +00:00

README.md

Chat Client Examples

This folder contains simple examples demonstrating direct usage of various chat clients.

Examples

File	Description
`azure_assistants_client.py`	Direct usage of Azure Assistants Client for basic chat interactions with Azure OpenAI assistants.
`azure_chat_client.py`	Direct usage of Azure Chat Client for chat interactions with Azure OpenAI models.
`azure_responses_client.py`	Direct usage of Azure Responses Client for structured response generation with Azure OpenAI models.
`chat_response_cancellation.py`	Demonstrates how to cancel chat responses during streaming, showing proper cancellation handling and cleanup.
`azure_ai_chat_client.py`	Direct usage of Azure AI Chat Client for chat interactions with Azure AI models.
`openai_assistants_client.py`	Direct usage of OpenAI Assistants Client for basic chat interactions with OpenAI assistants.
`openai_chat_client.py`	Direct usage of OpenAI Chat Client for chat interactions with OpenAI models.
`openai_responses_client.py`	Direct usage of OpenAI Responses Client for structured response generation with OpenAI models.
`custom_chat_client.py`	Demonstrates how to create custom chat clients by extending the `BaseChatClient` class. Shows a `EchoingChatClient` implementation and how to integrate it with `ChatAgent` using the `as_agent()` method.

Environment Variables

Depending on which client you're using, set the appropriate environment variables:

For Azure clients:

AZURE_OPENAI_ENDPOINT: Your Azure OpenAI endpoint
AZURE_OPENAI_CHAT_DEPLOYMENT_NAME: The name of your Azure OpenAI chat deployment
AZURE_OPENAI_RESPONSES_DEPLOYMENT_NAME: The name of your Azure OpenAI responses deployment

For Azure AI client:

AZURE_AI_PROJECT_ENDPOINT: Your Azure AI project endpoint
AZURE_AI_MODEL_DEPLOYMENT_NAME: The name of your model deployment

For OpenAI clients:

OPENAI_API_KEY: Your OpenAI API key
OPENAI_CHAT_MODEL_ID: The OpenAI model to use for chat clients (e.g., gpt-4o, gpt-4o-mini, gpt-3.5-turbo)
OPENAI_RESPONSES_MODEL_ID: The OpenAI model to use for responses clients (e.g., gpt-4o, gpt-4o-mini, gpt-3.5-turbo)

For Ollama client:

OLLAMA_HOST: Your Ollama server URL (defaults to http://localhost:11434 if not set)
OLLAMA_MODEL_ID: The Ollama model to use for chat (e.g., llama3.2, llama2, codellama)

Note

: For Ollama, ensure you have Ollama installed and running locally with at least one model downloaded. Visit https://ollama.com/ for installation instructions.