Microsoft.Extensions.AI - OpenAI Examples

This project contains a set of samples that show how to use the OpenAI reference implementation in the Microsoft.Extensions.AI.OpenAI NuGet package.

Prerequisites

• .NET 8 SDK
• Visual Studio or VS Code
• An Open AI API key. For more details, see the OpenAI documentation.

Setup

1. Create an environment variable OPENAI_API_KEY and set its value to your Open AI API key.

Quick Start

Visual Studio

1. Open the OpenAIExamples.sln solution
2. Set OpenAIExamples as the startup project.
3. Press F5.

Visual Studio Code

1. Open your terminal

2. Navigate to the OpenAIExamples project directory

3. Run the application using dotnet run

   dotnet run
   

Test your application

1. When the application starts, select Choose sample.
2. Select one of the samples from the dropdown to run it.
3. After the selected sample runs, you can choose to run another sample or select Quit to stop the application.

Examples

Example	Description
Chat	Use IChatClient to send and receive chat messages
Chat + Conversation History	Use IChatClient alongside conversation history to send and receive chat messages
Streaming	Use IChatClient to send and receive a stream of chat messages
Caching	Use prompt caching middleware
OpenTelemetry	Use OpenTelemetry middleware
Tool Calling	Use tool calling middleware
Middleware	Use prompt caching, OpenTelemetry and tool calling middleware
Dependency Injection	Register an IChatClient and middleware using Dependency Injection
Text Embedding	Use text embedding generator
Text Embedding + Caching	Use text embedding generator with caching middleware