delphi 调用OpenAI接口

# Delphi OpenAI API  ___      This repositorty contains Delphi implementation over [OpenAI](https://beta.openai.com/docs/api-reference/) public API. ❗*This is an unofficial library. OpenAI does not provide any official library for Delphi.* - [What is OpenAI](#what-is-openai) - [Installation](#installation) - [Usage](#usage) - [Initialization](#initialization) - [Models](#models) - [Completions](#completions) - [Chats](#chats) - [Images](#images) - [Errors](#errors) - [Exceptions](#exceptions) - [Usage proxy](#proxy) - [Examples](#examples) - [Requirements](#requirements) - [Links](#links) - [License](#license) <details> <summary> Coverage </summary> |API|Status| |---|---| |Models|🟢 Done| |Completions|🟢 Done| |Chat|🟢 Done| |Edits|🟢 Done| |Images|🟢 Done| |Embeddings|🟢 Done| |Audio|🟢 Done| |Files|🟢 Done| |Fine-tunes|🟢 Done| |Moderations|🟢 Done| |Engines (Depricated)|🟢 Done| </details> ## What is OpenAI OpenAI is a non-profit artificial intelligence research organization founded in San Francisco, California in 2015. It was created with the purpose of advancing digital intelligence in ways that benefit humanity as a whole and promote societal progress. The organization strives to develop AI (Artificial Intelligence) programs and systems that can think, act and adapt quickly on their own – autonomously. OpenAI's mission is to ensure safe and responsible use of AI for civic good, economic growth and other public benefits; this includes cutting-edge research into important topics such as general AI safety, natural language processing, applied reinforcement learning methods, machine vision algorithms etc. >The OpenAI API can be applied to virtually any task that involves understanding or generating natural language or code. We offer a spectrum of models with different levels of power suitable for different tasks, as well as the ability to fine-tune your own custom models. These models can be used for everything from content generation to semantic search and classification. This library provides access to the API of the [OpenAI service](https://openai.com/api/), on the basis of which [ChatGPT](https://openai.com/blog/chatgpt) works and, for example, the generation of images from text using `DALL-E`. ## Installation You can install the package from `GetIt` [directly](https://getitnow.embarcadero.com/openai-for-delphi) in the IDE. Or, to use the library, just add the `root` folder to the IDE library path, or your project source path. ## Usage ### Initialization To initialize API instance you need to [obtain](https://beta.openai.com/account/api-keys) API token from your Open AI organization. Once you have a token, you can initialize `TOpenAI` class, which is an entry point to the API. Due to the fact that there can be many parameters and not all of them are required, they are configured using an anonymous function. ```Pascal uses OpenAI; var OpenAI := TOpenAIComponent.Create(Self, API_TOKEN); ``` or ```Pascal uses OpenAI; var OpenAI: IOpenAI := TOpenAI.Create(API_TOKEN); ``` Once token you posses the token, and the instance is initialized you are ready to make requests. ### Models List and describe the various models available in the API. You can refer to the Models documentation to understand what models are available and the differences between them. ```Pascal var Models := OpenAI.Model.List(); try for var Model in Models.Data do MemoChat.Lines.Add(Model.Id); finally Models.Free; end; ``` Review [Models Documentation](https://platform.openai.com/docs/api-reference/models) for more info. ### Completions Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. ```Pascal var Completions := OpenAI.Completion.Create( procedure(Params: TCompletionParams) begin Params.Prompt(MemoPrompt.Text); Params.MaxTokens(2048); end); try for var Choice in Completions.Choices do MemoChat.Lines.Add(Choice.Index.ToString + ' ' + Choice.Text); finally Completions.Free; end; ``` Review [Completions Documentation](https://platform.openai.com/docs/api-reference/completions) for more info. ### Chats Given a chat conversation, the model will return a chat completion response. ChatGPT is powered by gpt-3.5-turbo, OpenAI’s most advanced language model. Using the OpenAI API, you can build your own applications with gpt-3.5-turbo to do things like: - Draft an email or other piece of writing - Write Python code - Answer questions about a set of documents - Create conversational agents - Give your software a natural language interface - Tutor in a range of subjects - Translate languages - Simulate characters for video games and much more This guide explains how to make an API call for chat-based language models and shares tips for getting good results. ```Pascal var Chat := OpenAI.Chat.Create( procedure(Params: TChatParams) begin Params.Messages([TChatMessageBuild.Create(TMessageRole.User, Text)]); Params.MaxTokens(1024); end); try for var Choice in Chat.Choices do MemoChat.Lines.Add(Choice.Message.Content); finally Chat.Free; end; ``` #### Stream mode ```Pascal OpenAI.Chat.CreateStream( procedure(Params: TChatParams) begin Params.Messages([TchatMessageBuild.User(Buf.Text)]); Params.MaxTokens(1024); Params.Stream; end, procedure(Chat: TChat; IsDone: Boolean; var Cancel: Boolean) begin if (not IsDone) and Assigned(Chat) then Writeln(Chat.Choices[0].Delta.Content) else if IsDone then Writeln('DONE!'); Writeln('-------'); Sleep(100); end); ``` Review [Chat Documentation](https://platform.openai.com/docs/api-reference/chat) for more info. ### Images Given a prompt and/or an input image, the model will generate a new image. ```Pascal var Images := OpenAI.Image.Create( procedure(Params: TImageCreateParams) begin Params.Prompt(MemoPrompt.Text); Params.ResponseFormat('url'); end); try for var Image in Images.Data do Image1.Bitmap.LoadFromUrl(Image.Url); finally Images.Free; end; ``` Review [Images Documentation](https://platform.openai.com/docs/api-reference/images) for more info. ### Errors ```Pascal try var Images := OpenAI.Image.Create(...); except on E: OpenAIExceptionRateLimitError do ShowError('OpenAI Limit Error: ' + E.Message); on E: OpenAIException do ShowError('OpenAI Error: ' + E.Message); end; ``` #### Exceptions * OpenAIExceptionAPI - errors of wrapper * OpenAIException - base exception * OpenAIExceptionInvalidRequestError * OpenAIExceptionRateLimitError * OpenAIExceptionAuthenticationError * OpenAIExceptionPermissionError * OpenAIExceptionTryAgain * OpenAIExceptionInvalidResponse - parse error ### Proxy ```Pascal OpenAI.API.Client.ProxySettings := TProxySettings.Create(ProxyHost, ProxyPort, ProxyUserName, ProxyPassword); ``` ## Examples |Source|Preview|Source|Preview| |---|---|---|---| |[Playground (FMX)](https://github.com/HemulGM/DelphiOpenAIPlayground)|<img src="https://github.com/HemulGM/DelphiOpenAIPlayground/blob/main/preview.png?raw=true" height="150" align="right">|[ChatGPT (FMX)](https://github.com/HemulGM/ChatGPT)|<img src="https://github.com/HemulGM/ChatGPT/raw/main/preview.png