openai webflux java下载 - openai webflux java源码下载

反应式 OpenAI API 客户端库。

这是 Reactive OpenAI 客户端库。

它是使用 WebFlux 和 Spring Boot 编写的。该库还包含预配置的 Spring Boot 启动器，以方便使用。

该图书馆是非官方的，由社区维护。欢迎加入开发。

支持的API

模特服务
竣工服务
聊天服务
编辑服务
图片服务
嵌入服务
音频服务
文件服务
微调服务
审核服务

安装

通过Maven导入依赖项：

< dependency >
    < groupId >io.github.reactiveclown</ groupId >
    < artifactId >openai-webflux-client-spring-boot-starter</ artifactId >
    < version >0.9.1</ version >
</ dependency >

通过Gradle导入依赖项：

implementation 'io.github.reactiveclown:openai-webflux-client-spring-boot-starter:0.9.1'

添加依赖项后，请记住将您的 OpenAI api 密钥添加到 application.properties。

 com.github.reactiveclown.openai.apiKey =OPENAI_API_KEY

您还可以通过提供下一个配置变量来添加组织 ID 并更改 baseUrl。但这一步不是强制性的。

 com.github.reactiveclown.openai.organizationId =OPENAI_ORGANIZATION_ID
com.github.reactiveclown.openai.baseUrl =OPENAI_CUSTOM_BASE_URL

用法

在这里您可以找到一些使用示例。另外，请使用官方文档以获得有关参数的更多信息。

模特服务

OpenAI 模型文档

模型服务用于检索模型列表或有关特定模型的信息。

 @ Service
public class ExampleService {

    private final ModelsService service ;

    public ExampleService ( ModelsService service ) {
        this . service = service ;
    }

    public Mono < ListModelsResponse > listModels () {
        return service . listModels ();
    }

    public Mono < RetrieveModelResponse > retrieveModel ( String modelName ) {
        return service . retrieveModel ( modelName );
    }
}

竣工服务

OpenAI 完成文档

Completions 服务用于完成文本。可以自由地使用构建器参数。

 @ Service
public class ExampleService {

    private final CompletionsService service ;

    public ExampleService ( CompletionsService service ) {
        this . service = service ;
    }

    public Mono < CreateCompletionResponse > createCompletion () {
        return service . createCompletion (
                CreateCompletionRequest
                        . builder ( "babbage" )
                        . n ( 2 )
                        . bestOf ( 1 )
                        . build ());
    }
}

聊天服务

OpenAI 聊天文档

聊天服务用于与聊天模型聊天。可以自由地使用构建器参数。

 @ Service
public class ExampleService {

    private final ChatService service ;

    public ExampleService ( ChatService service ) {
        this . service = service ;
    }

    public Mono < CreateChatCompletionResponse > createChatCompletion () {
        return service . createChatCompletion (
                CreateChatCompletionRequest
                        . builder ( "gpt-3.5-turbo" , List . of ( new MessageData ( "user" , "do something" )))
                        . n ( 3 )
                        . build ());
    }
}

编辑服务

OpenAI 编辑文档

编辑服务用于对提供的输入进行编辑。可以自由地使用构建器参数。

 @ Service
public class ExampleService {

    private final EditsService service ;

    public ExampleService ( EditsService service ) {
        this . service = service ;
    }

    public Mono < CreateEditResponse > createEdit () {
        return service . createEdit (
                CreateEditRequest
                        . builder ( "babbage" , "Add one digit after every word" )
                        . input ( "One Two Three" )
                        . build ());
    }
}

图片服务

OpenAI 图像文档

图像服务用于生成不同的图像及其转换。

️就目前而言，需要图像的方法是阻塞的。在不久的将来，计划添加异步 FilePart 实现。

 @ Service
public class ExampleService {

    private final ImagesService service ;

    public ExampleService ( ImagesService service ) {
        this . service = service ;
    }

    //Non-blocking
    public Mono < CreateImageResponse > createImage () {
        return service . createImage (
                CreateImageRequest
                        . builder ( "Generate a digital art of Ukraine" )
                        . build ());
    }

    //Blocking
    public Mono < CreateImageVariationResponse > createImageVariation () {
        return service . createImageVariation (
                CreateImageVariationRequest
                        . builder ( "src/main/resources/exampleImage.png" )
                        . size ( "512x512" )
                        . build ());
    }

    //Blocking
    public Mono < CreateImageEditResponse > createImageEdit () {
        return service . createImageEdit (
                CreateImageEditRequest
                        . builder ( "src/main/resources/exampleImage.png" , "Generate a green fields" )
                        . mask ( "src/main/resources/exampleMask.png" )
                        . build ());
    }
}

嵌入服务

OpenAI 嵌入文档

嵌入服务用于创建嵌入。可以自由地使用构建器参数。

 @ Service
public class ExampleService {

    private final EmbeddingsService service ;

    public ExampleService ( EmbeddingsService service ) {
        this . service = service ;
    }

    public Mono < CreateEmbeddingsResponse > createEmbeddings (){
        return service . createEmbeddings (
                CreateEmbeddingsRequest
                        . builder ( "babbage" , "example input" )
                        . build ());
    }
}

音频服务

OpenAI 音频文档

音频服务用于将音频转换为文本，也可将其翻译成英语。可以自由地使用构建器参数。

️就目前而言，需要音频文件的方法正在被阻塞。在不久的将来，计划添加异步 FilePart 实现。

 @ Service
public class ExampleService {

    private final AudioService service ;

    public ExampleService ( AudioService service ) {
        this . service = service ;
    }

    //Blocking
    public Mono < CreateTranscriptionResponse > createTranscription () {
        return service . createTranscription (
                CreateTranscriptionRequest
                        . builder ( "src/main/resources/exampleAudio.mp3" , "whisper-1" )
                        . build ());
    }

    //Blocking
    public Mono < CreateTranslationResponse > createTranslation (){
        return service . createTranslation ( CreateTranslationRequest
                . builder ( "src/main/resources/exampleAudio.mp3" , "whisper-1" )
                . build ());
    }
}

文件服务

OpenAI 文件文档

文件服务用于上传和处理文件。可以自由地使用构建器参数。

️就目前而言，需要文件的方法是阻塞的。在不久的将来，计划添加异步 FilePart 实现。

 @ Service
public class ExampleService {

    private final FilesService service ;

    public ExampleService ( FilesService service ) {
        this . service = service ;
    }

    public Mono < ListFilesResponse > listFilesResponse () {
        return service . listFiles ();
    }
    
    //Blocking
    public Mono < UploadFileResponse > uploadFile () {
        return service . uploadFile (
                UploadFileRequest
                        . builder ( "src/main/resources/exampleFile.jsonl" , "finetune" )
                        . build ());
    }

    public Mono < DeleteFileResponse > deleteFile () {
        return service . deleteFile ( "fileId" );
    }

    public Mono < RetrieveFileResponse > retrieveFile () {
        return service . retrieveFile ( "fileId" );
    }

    public Mono < String > retrieveFileContent () {
        return service . retrieveFileContent ( "fileId" );
    }
}

微调服务

OpenAI 微调文档

微调服务用于微调文件和模型。可以自由地使用构建器参数。

 @ Service
public class ExampleService {

    private final FineTunesService service ;

    public ExampleService ( FineTunesService service ) {
        this . service = service ;
    }

    public Mono < CreateFineTuneResponse > createFineTune (){
        return service . createFineTune (
                CreateFineTuneRequest
                        . builder ( "trainingFileId" )
                        . build ());
    }

    public Mono < ListFineTunesResponse > listFineTunes (){
        return service . listFineTunes ();
    }

    public Mono < RetrieveFineTuneResponse > retrieveFineTune (){
        return service . retrieveFineTunes ( "fineTuneId" );
    }

    public Mono < CancelFineTuneResponse > cancelFineTune (){
        return service . cancelFineTune ( "fineTuneId" );
    }

    public Mono < ListFineTuneEventsResponse > listFineTuneEvents (){
        return service . listFineTuneEvents ( "fineTuneId" );
    }

    public Mono < DeleteFineTuneModelResponse > deleteFineTuneModel (){
        return service . deleteFineTuneModel ( "modelId" );
    }
}

审核服务

OpenAI 审核文档

审核服务用于检查审核违规情况。可以自由地使用构建器参数。

 @ Service
public class ExampleService {

    private final ModerationsService service ;

    public ExampleService ( ModerationsService service ) {
        this . service = service ;
    }

    public Mono < CreateModerationResponse > createModeration () {
        return service . createModeration (
                CreateModerationRequest . builder ( "violating input" ). build ());
    }
}

我能提供什么帮助吗？

这是开源库，任何帮助将不胜感激。如果您发现有一种方法可以改进代码或功能，请填写问题或针对您的更改提出拉取请求。如果您有解决方案，也可以随意查看已解决的问题并提交拉取请求。

执照

 MIT License

Copyright (c) 2023 Maksym Volkov

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

展开