OpenAI.Net.Client 1.0.0

OpenAI.Net

OpenAI library for .NET

C# .NET library for use with the OpenAI API.

This is community-maintained library.

Getting started

Install package Nuget package

Install-Package OpenAI.Net.Client

Register services using the extension method

 services.AddOpenAIServices(apiKey);
 OR
 services.AddOpenAIServices(apiKey, organizationId);
 OR
 services.AddOpenAIServices(apiKey, organizationId, apiUrl);

N.B We recommened using environment variables, configuration files or secret file for storing the API key securely. See here for further details.

Inject the service where you need it.

e.g

    public class MyAwsomeService 
    {
        private readonly IOpenAIService _openAIService;
        private readonly ILogger<MyAwsomeService> _logger;

        public MyAwsomeService(IOpenAIService openAIService,ILogger<MyAwsomeService> logger)
        {
            _openAIService = openAIService;
            _logger = logger;
        }

        public async Task<TextCompletionResponse> Search()
        {
            var request = new TextCompletionRequest("text-davinci-003", "Say this is a test");
            var response = await _openAIService.TextCompletion.Get(request);
            if (response.IsSuccess)
            {
                return response.Result;
            }
            else
            {
                _logger.LogError(response.Exception, response.ErrorMessage, response.ErrorResponse);
            }

            return new TextCompletionResponse();
        }
    }

Full support of all current API's

• Models

  • List Models
  • Retrieve model

• Completions

  • Create completion
  • Create completion with streaming

• Edits

  • Create edit

• Images

  • Create image
  • Create image edit
  • Create image variation

• Embeddings

  • Create embeddings

• Files

  • List files
  • Upload file
  • Delete file
  • Retrieve file
  • Retrieve file content

• Fine-tunes

  • Create fine-tune
  • List fine-tunes
  • Retrieve fine-tune
  • Cancel fine-tune
  • List fine-tune events
  • Delete fine-tune model

• Moderations

  • Create moderation

Testing

This project has 100% code coverage with Unit tests and 100% pass rate with Stryker mutation testing.

See latest Stryker report here.

We also have Integration tests foreach service.

This should provide confidence in the library going forwards.

Contributions

Contributions are welcome.

Minimum requirements for any PR's.

• MUST include Unit tests and maintain 100% coverage.

• MUST pass Stryker mutation testing with 100%

• SHOULD have integration tests