Merge branch 'master' into develop

Author: OkGoDoIt

OpenAI_API/OpenAI_API.csproj

@@ -15,28 +15,35 @@
 		<Title>OpenAI API</Title>
 		<PackageReleaseNotes>Updated to work with the current API as of February 3, 2023.  Added Files and Embedding endpoints. Removed the Search endpoint as OpenAI has removed that API.  Potentially breaking change with v1.4:  The various endpoints (Completions, Models, etc) and related classes have each moved into their own namespaces, for example `OpenAI_API.Completions.CompletionRequest` and `OpenAI_API.Models.Model.DavinciText`.  You may need to add `using`s or fully qualify names in exisitng code.</PackageReleaseNotes>
 		<PackageId>OpenAI</PackageId>
-		<Version>1.4.0</Version>
-		<AssemblyVersion>1.4.0.0</AssemblyVersion>
-		<FileVersion>1.4.0.0</FileVersion>
+		<Version>1.4.1</Version>
+		<AssemblyVersion>1.4.1.0</AssemblyVersion>
+		<FileVersion>1.4.1.0</FileVersion>
 		<GenerateDocumentationFile>True</GenerateDocumentationFile>
 		<PackageReadmeFile>README.md</PackageReadmeFile>
 		<ProduceReferenceAssembly>True</ProduceReferenceAssembly>
 		<RepositoryType>git</RepositoryType>
-		<IncludeSymbols>True</IncludeSymbols>
+
+		<!-- Optional: Publish the repository URL in the built .nupkg (in the NuSpec <Repository> element) -->
+		<PublishRepositoryUrl>true</PublishRepositoryUrl>
+		<!-- Optional: Build symbol package (.snupkg) to distribute the PDB containing Source Link -->
+		<IncludeSymbols>true</IncludeSymbols>
 		<SymbolPackageFormat>snupkg</SymbolPackageFormat>
+
 		<Deterministic>true</Deterministic>
+
 	</PropertyGroup>
 
 	<ItemGroup>
-	  <None Include="..\README.md">
-	    <Pack>True</Pack>
-	    <PackagePath>\</PackagePath>
-	  </None>
+		<None Include="..\README.md">
+			<Pack>True</Pack>
+			<PackagePath>\</PackagePath>
+		</None>
 	</ItemGroup>
 
 	<ItemGroup>
 		<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="1.1.1" />
 		<PackageReference Include="Newtonsoft.Json" Version="13.0.2" />
+		<PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1" PrivateAssets="All" />
 	</ItemGroup>
 
 </Project>

README.md

@@ -2,23 +2,35 @@
 
 A simple C# .NET wrapper library to use with OpenAI's GPT-3 API.  More context [on my blog](https://rogerpincombe.com/openai-dotnet-api).
 
-## Status
-Updated to work with the current API as of February 2, 2023.  Added Files and Embedding endpoints. Removed the Search endpoint as OpenAI has removed that API.
-Potentially breaking change with v1.4:  The various endpoints (Completions, Models, etc) and related classes have each moved into their own namespaces, for example `OpenAI_API.Completions.CompletionRequest` and `OpenAI_API.Models.Model.DavinciText`.  You may need to add `using`s or fully qualify names in exisitng code.
-Now also works with the Azure OpenAI Service. See Azure section for further details.
-
-Thank you [@GotMike](https://github.com/gotmike), [@gmilano](https://github.com/gmilano), [@metjuperry](https://github.com/metjuperry), and [@Alexei000](https://github.com/Alexei000) for your contributions!
-
 ## Quick Example
 
 ```csharp
-var api = new OpenAI_API.OpenAIAPI();
-
+var api = new OpenAI_API.OpenAIAPI("YOUR_API_KEY");
 var result = await api.Completions.GetCompletion("One Two Three One Two");
 Console.WriteLine(result);
 // should print something starting with "Three"
 ```
 
+## Readme
+
+ * [Status](#Status)
+ * [Requirements](#requirements)
+ * [Installation](#install-from-nuget)
+ * [Authentication](#authentication)
+ * [Completions API](#completions)
+	* [Streaming completion results](#streaming)
+ * [Embeddings API](#embeddings)
+ * [Files API](#files-for-fine-tuning)
+ * [Additonal Documentation](#documentation)
+ * [License](#license)
+
+## Status
+Updated to work with the current API as of February 2, 2023.  Added Files and Embedding endpoints. Removed the Search endpoint as OpenAI has removed that API.
+Potentially breaking change with v1.4:  The various endpoints (Completions, Models, etc) and related classes have each moved into their own namespaces, for example `OpenAI_API.Completions.CompletionRequest` and `OpenAI_API.Models.Model.DavinciText`.  You may need to add `using`s or fully qualify names in existing code.
+
+Now also works with the Azure OpenAI Service. See [Azure](#azure) section for further details.
+
+Thank you [@GotMike](https://github.com/gotmike), [@gmilano](https://github.com/gmilano), [@metjuperry](https://github.com/metjuperry), and [@Alexei000](https://github.com/Alexei000) for your contributions!
 
 ## Requirements
 
@@ -111,7 +123,7 @@ async Task<EmbeddingResult> CreateEmbeddingAsync(EmbeddingRequest request);
 // for example
 var result = await api.Embeddings.CreateEmbeddingAsync(new EmbeddingRequest("A test text for embedding", model: Model.AdaTextEmbedding));
 // or
-var result = await api.Completions.CreateCompletionAsync("A test text for embedding");
+var result = await api.Embeddings.CreateEmbeddingAsync("A test text for embedding");
 ```
 
 The embedding result contains a lot of metadata, the actual vector of floats is in result.Data[].Embedding.
@@ -155,7 +167,6 @@ Additionally you need to specify the BaseUrl to your API. The Url should look so
 https://{your-resource-name}.openai.azure.com/openai/deployments/{deployment-id}
 ```
 
-
 Configuration should look something like this for the Azure service:
 
 ```csharp