Skip to content

Commit 6779885

Browse files
committed
.NET READMEs: link fixes
1 parent dcb80b0 commit 6779885

File tree

3 files changed

+11
-4
lines changed

3 files changed

+11
-4
lines changed

dotnet/README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# OpenAI /realtime -- .NET
2+
3+
This folder contains resources to get started using OpenAI `/realtime` capabilities using the preview `RealtimeConversationClient` first introduced in the `2.1.0-beta.1` of the official OpenAI .NET library (https://github.com/openai/openai-dotnet).
4+
5+
Since `/realtime` is already present in the official library (c.f. Python and JS, where official library support is listed in [the "What's next" of the official announcement](https://openai.com/index/introducing-the-realtime-api/#whats_next)), no standalone library implementation is featured here.

dotnet/samples/console-from-file/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
# OpenAI .NET: /realtime basic console app
1+
# OpenAI .NET: /realtime basic console app (file-based)
22

33
This short application demonstrates a simple two-turn use of the `/realtime` endpoint, applying audio input from a file and a single call to a function tool.
44

55
## Usage
66

77
1. Set the `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_API_KEY` environment variables to match your `/realtime`-enabled Azure OpenAI resource
8-
- Alternatively, if your Azure OpenAI Service resource is configured for managed identity, you can modify the `useEntraAuthenticationForAzure` value in the application to use `DefaultAzureCredential`
8+
- Alternatively, if your Azure OpenAI Service resource is configured for managed identity, you can set the `AZURE_OPENAI_USE_ENTRA` environment variable to `true` to employ `DefaultAzureCredential` token-based authentication
9+
- If you'd like to use the non-Azure OpenAI v1 endpoint, don't set `AZURE_OPENAI_ENDPOINT` and use `OPENAI_API_KEY` as the source for authentication, instead
910
2. `dotnet run` (or build/run from `RealtimeConsoleApp.csproj`)
1011

1112
Example output:

dotnet/samples/console-from-mic/README.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ This short console application demonstrates an interactive experience using the
55
## Usage
66

77
1. Set the `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_API_KEY` environment variables to match your `/realtime`-enabled Azure OpenAI resource
8-
- Alternatively, if your Azure OpenAI Service resource is configured for managed identity, you can modify the `useEntraAuthenticationForAzure` value in the application to use `DefaultAzureCredential`
8+
- Alternatively, if your Azure OpenAI Service resource is configured for managed identity, you can set the `AZURE_OPENAI_USE_ENTRA` environment variable to `true` to employ `DefaultAzureCredential` token-based authentication
9+
- If you'd like to use the non-Azure OpenAI v1 endpoint, don't set `AZURE_OPENAI_ENDPOINT` and use `OPENAI_API_KEY` as the source for authentication, instead
910
2. `dotnet run` (or build/run from `RealtimeInteractiveConsole.csproj`)
1011

1112
Example output:
@@ -36,7 +37,7 @@ Because they make up everything! 😄
3637

3738
## Code explanation/walkthrough
3839

39-
For a more detailed walkthrough of core concepts, please see [the README for the file-based sample](../console-from-file/README>md). This README will focus on the interactive components.
40+
For a more detailed walkthrough of core concepts, please see [the README for the file-based sample](../console-from-file/README.md). This README will focus on the interactive components.
4041

4142
This sample uses two rudimentary multimedia abstractions built atop the `NAudio` library:
4243
- `MicrophoneAudioStream`, which presents `pcm16` (24 KHz, 16-bit mono PCM) audio from the system default capture device as a `Stream`

0 commit comments

Comments
 (0)