Skip to content

chat_client

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History

chat_client

README.md

Chat Client Examples

This folder contains examples for direct chat client usage patterns.

Examples

File Description
built_in_chat_clients.py Consolidated sample for built-in chat clients. Uses get_client() to create the selected client and pass it to main().
chat_response_cancellation.py Demonstrates how to cancel chat responses during streaming, showing proper cancellation handling and cleanup.
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 Agent using the as_agent() method.
require_per_service_call_history_persistence.py Compares two otherwise identical FoundryChatClient agents with store=False; the only difference is whether require_per_service_call_history_persistence is enabled, and only the run without it stores the synthesized tool result when middleware terminates the loop early.

Selecting a built-in client

built_in_chat_clients.py starts with:

asyncio.run(main("openai_responses"))

Change the argument to pick a client:

  • openai_responses
  • openai_chat_completion
  • anthropic
  • ollama
  • bedrock
  • azure_openai_responses
  • azure_openai_chat_completion
  • foundry_chat

Example:

uv run samples/02-agents/chat_client/built_in_chat_clients.py

The require_per_service_call_history_persistence.py sample uses FoundryChatClient, so set the usual Foundry settings first and sign in with the Azure CLI:

export FOUNDRY_PROJECT_ENDPOINT="https://<your-project>.services.ai.azure.com/api/projects/<project-name>"
export FOUNDRY_MODEL="<your-model-deployment-name>"
az login
uv run samples/02-agents/chat_client/require_per_service_call_history_persistence.py

Environment Variables

Depending on the selected client, set the appropriate environment variables:

For Azure OpenAI clients (azure_openai_responses and azure_openai_chat_completion):

  • AZURE_OPENAI_ENDPOINT: Your Azure OpenAI endpoint
  • AZURE_OPENAI_MODEL: The Azure OpenAI deployment used by the sample
  • AZURE_OPENAI_API_VERSION (optional): Azure OpenAI API version override
  • AZURE_OPENAI_API_KEY (optional): Azure OpenAI API key if you are not using AzureCliCredential

For Foundry client (foundry_chat):

  • FOUNDRY_PROJECT_ENDPOINT: Your Azure AI Foundry project endpoint
  • FOUNDRY_MODEL: The Foundry deployment used by the sample

For OpenAI clients:

  • OPENAI_API_KEY: Your OpenAI API key
  • OPENAI_CHAT_MODEL: The OpenAI model for openai_chat_completion
  • OPENAI_RESPONSES_MODEL: The OpenAI model for openai_responses

For Anthropic client (anthropic):

  • ANTHROPIC_API_KEY: Your Anthropic API key
  • ANTHROPIC_CHAT_MODEL: The Anthropic model to use (for example, claude-sonnet-4-5)

For Ollama client (ollama):

  • OLLAMA_HOST: Ollama server URL (defaults to http://localhost:11434 if unset)
  • OLLAMA_MODEL: Ollama model name (for example, mistral, qwen2.5:8b)

For Bedrock client (bedrock):

  • BEDROCK_CHAT_MODEL: Bedrock model ID (for example, anthropic.claude-3-5-sonnet-20240620-v1:0)
  • BEDROCK_REGION: AWS region (defaults to us-east-1 if unset)
  • AWS credentials via standard environment variables (for example, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY)