Files
agent-framework/python/samples/getting_started/chat_client/README.md
Ren Finlayson 539852f81c
Some checks failed
CodeQL / Analyze (csharp) (push) Has been cancelled
CodeQL / Analyze (python) (push) Has been cancelled
dotnet-build-and-test / paths-filter (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test (Debug, windows-latest, net9.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test (Release, integration, true, ubuntu-latest, net10.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test (Release, integration, true, windows-latest, net472) (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test (Release, ubuntu-latest, net8.0) (push) Has been cancelled
dotnet-build-and-test / dotnet-build-and-test-check (push) Has been cancelled
Python - Merge - Tests / paths-filter (push) Has been cancelled
Python - Merge - Tests / Python Tests - Core (integration, ubuntu-latest, 3.10) (push) Has been cancelled
Python - Merge - Tests / Python Tests - Azure AI (integration, ubuntu-latest, 3.10) (push) Has been cancelled
Python - Merge - Tests / python-integration-tests-check (push) Has been cancelled
Python - Lab Tests / paths-filter (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (ubuntu-latest, 3.10) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (ubuntu-latest, 3.11) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (ubuntu-latest, 3.12) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (ubuntu-latest, 3.13) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (ubuntu-latest, 3.14) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (windows-latest, 3.10) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (windows-latest, 3.11) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (windows-latest, 3.12) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (windows-latest, 3.13) (push) Has been cancelled
Python - Lab Tests / Python Lab Tests (windows-latest, 3.14) (push) Has been cancelled
Check .md links / markdown-link-check (push) Has been cancelled
test
2026-01-24 03:05:12 +11:00

2.6 KiB

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.

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.