Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #181

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #181

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Original file line number Diff line number Diff line change
@@ -119,7 +119,7 @@ foreach (ChatMessage msg in chat.Messages)

#### Streaming

Streaming allows you to get results are they are generated, which can help your application feel more responsive.
Streaming allows you to retrieve generated results, which can help your application feel more responsive.

Using the new C# 8.0 async iterators:
```csharp
@@ -144,7 +144,7 @@ await chat.StreamResponseFromChatbotAsync(res =>
```

### Chat Endpoint Requests
You can access full control of the Chat API by using the `OpenAIAPI.Chat.CreateChatCompletionAsync()` and related methods.
You can have full-access control of Chat API by using the `OpenAIAPI.Chat.CreateChatCompletionAsync()` and related methods.

```csharp
async Task<ChatResult> CreateChatCompletionAsync(ChatRequest request);
@@ -187,7 +187,7 @@ var result = await api.Completions.CreateCompletionAsync("One Two Three One Two"
You can create your `CompletionRequest` ahead of time or use one of the helper overloads for convenience. It returns a `CompletionResult` which is mostly metadata, so use its `.ToString()` method to get the text if all you want is the completion.

#### Streaming
Streaming allows you to get results are they are generated, which can help your application feel more responsive, especially on slow models like Davinci.
Streaming allows you to retrieve generated results, which can help your application feel more responsive, especially on slow models like Davinci.

Using the new C# 8.0 async iterators:
```csharp
@@ -290,7 +290,7 @@ Image edits and variations are not yet implemented.

## Azure

For using the Azure OpenAI Service, you need to specify the name of your Azure OpenAI resource as well as your model deployment id.
To use Azure OpenAI Service, you need to specify the name of your Azure OpenAI resource as well as your model deployment id.

_I do not have access to the Microsoft Azure OpenAI service, so I am unable to test this functionality. If you have access and can test, please submit an issue describing your results. A PR with integration tests would also be greatly appreciated. Specifically, it is unclear to me that specifying models works the same way with Azure._