|
1 | 1 | # OpenAI .NET API library |
2 | 2 |
|
3 | | -[](https://www.nuget.org/packages/OpenAI/) |
| 3 | +[](https://www.nuget.org/packages/OpenAI/) |
4 | 4 |
|
5 | 5 | The OpenAI .NET library provides convenient access to the OpenAI REST API from .NET applications. |
6 | 6 |
|
7 | 7 | It is generated from our [OpenAPI specification](https://github.com/openai/openai-openapi) in collaboration with Microsoft. |
8 | 8 |
|
| 9 | +## Table of Contents |
| 10 | + |
| 11 | +- [Getting started](#getting-started) |
| 12 | + - [Prerequisites](#prerequisites) |
| 13 | + - [Install the NuGet package](#install-the-nuget-package) |
| 14 | +- [Using the client library](#using-the-client-library) |
| 15 | + - [Namespace organization](#namespace-organization) |
| 16 | + - [Using the async API](#using-the-async-api) |
| 17 | + - [Using the `OpenAIClient` class](#using-the-openaiclient-class) |
| 18 | +- [How to use chat completions with streaming](#how-to-use-chat-completions-with-streaming) |
| 19 | +- [How to use chat completions with tools and function calling](#how-to-use-chat-completions-with-tools-and-function-calling) |
| 20 | +- [How to generate text embeddings](#how-to-generate-text-embeddings) |
| 21 | +- [How to generate images](#how-to-generate-images) |
| 22 | +- [How to transcribe audio](#how-to-transcribe-audio) |
| 23 | +- [How to use assistants with retrieval augmented generation (RAG)](#how-to-use-assistants-with-retrieval-augmented-generation-rag) |
| 24 | +- [How to use streaming and GPT-4o vision with assistants](#how-to-use-streaming-and-gpt-4o-vision-with-assistants) |
| 25 | +- [How to work with Azure OpenAI](#how-to-work-with-azure-openai) |
| 26 | +- [Advanced scenarios](#advanced-scenarios) |
| 27 | + - [Using protocol methods](#using-protocol-methods) |
| 28 | + - [Automatically retrying errors](#automatically-retrying-errors) |
| 29 | + |
9 | 30 | ## Getting started |
10 | 31 |
|
11 | 32 | ### Prerequisites |
@@ -720,4 +741,4 @@ By default, the client classes will automatically retry the following errors up |
720 | 741 | - 500 Internal Server Error |
721 | 742 | - 502 Bad Gateway |
722 | 743 | - 503 Service Unavailable |
723 | | -- 504 Gateway Timeout |
| 744 | +- 504 Gateway Timeout |
0 commit comments