DefaultOpenAiClient (chatgpt-spring-boot-starter 1.1.2 API)

java.lang.Object
- com.lzhpo.chatgpt.DefaultOpenAiClient

所有已实现的接口:: OpenAiClient

@Validated
public class DefaultOpenAiClient
extends Object
implements OpenAiClient

作者:: lzhpo

构造器概要

构造器
构造器和说明

DefaultOpenAiClient()

构造器
构造器和说明
`DefaultOpenAiClient()`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`CreditGrantsResponse`	`billingCreditGrants()` Query billing credit grants.
`SubscriptionResponse`	`billingSubscription()` Query billing subscription.
`UsageResponse`	`billingUsage(String startDate, String endDate)` Query billing usage.
`CancelFineTuneResponse`	`cancelFineTune(String fineTuneId)` Cancel fine-tune by `fineTuneId`.
`ChatCompletionResponse`	`chatCompletions(ChatCompletionRequest request)` Create chat completion.
`CompletionResponse`	`completions(CompletionRequest request)` Create completion.
`CreateFineTuneResponse`	`createFineTune(CreateFineTuneRequest request)` Create fine-tune.
`CreateImageResponse`	`createImage(CreateImageRequest request)` Create image.
`CreateImageResponse`	`createImageEdit(org.springframework.core.io.Resource image, org.springframework.core.io.Resource mask, CreateImageRequest request)` Create image edit.
`CreateImageResponse`	`createImageVariation(org.springframework.core.io.Resource image, CreateImageVariationRequest request)` Create image variation.
`CreateAudioResponse`	`createTranscription(org.springframework.core.io.Resource fileResource, CreateAudioRequest request)` Create transcription.
`CreateAudioResponse`	`createTranslation(org.springframework.core.io.Resource fileResource, CreateAudioRequest request)` Create translation.
`DeleteFileResponse`	`deleteFile(String fileId)` Delete file by `fileId`.
`DeleteFineTuneModelResponse`	`deleteFineTuneModel(String model)` Delete fine-tune model.
`EditResponse`	`edits(EditRequest request)` Create edit.
`EmbeddingResponse`	`embeddings(EmbeddingRequest request)` Create embeddings.
`ListFileResponse`	`listFiles()` List files.
`ListFineTuneEventResponse`	`listFineTuneEvents(String fineTuneId)` List fine-tune events.
`ListFineTuneResponse`	`listFineTunes()` List fine-tunes.
`ListModelsResponse`	`models()` List models.
`ModerationResponse`	`moderations(ModerationRequest request)` Create moderation.
`RetrieveFileResponse`	`retrieveFile(String fileId)` Retrieve file by `fileId`
`RetrieveFineTuneResponse`	`retrieveFineTunes(String fineTuneId)` Retrieve fine-tune.
`RetrieveModelResponse`	`retrieveModel(String modelId)` Retrieve model by `modelId`.
`void`	`streamChatCompletions(ChatCompletionRequest request, okhttp3.sse.EventSourceListener listener)` Create stream chat completion.
`void`	`streamCompletions(CompletionRequest request, okhttp3.sse.EventSourceListener listener)` Create stream completion.
`UploadFileResponse`	`uploadFile(org.springframework.core.io.Resource fileResource, String purpose)` Upload file.
`UserResponse`	`users(String organizationId)` Get users.

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 构造器详细资料
  - DefaultOpenAiClient
```
public DefaultOpenAiClient()
```
- 方法详细资料
  - moderations
```
public ModerationResponse moderations(ModerationRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create moderation.
    
    指定者:
    
    moderations 在接口中 OpenAiClient
    
    参数:
    
    request - ModerationRequest
    
    返回:
    
    ModerationResponse
  - completions
```
public CompletionResponse completions(CompletionRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create completion.
    
    指定者:
    
    completions 在接口中 OpenAiClient
    
    参数:
    
    request - CompletionRequest
    
    返回:
    
    CompletionResponse
  - streamCompletions
```
public void streamCompletions(CompletionRequest request,
                              okhttp3.sse.EventSourceListener listener)
```
    从接口复制的说明: OpenAiClient
    
    Create stream completion.
    
    指定者:
    
    streamCompletions 在接口中 OpenAiClient
    
    参数:
    
    request - CompletionRequest
    
    listener - EventSourceListener
  - edits
```
public EditResponse edits(EditRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create edit.
    
    指定者:
    
    edits 在接口中 OpenAiClient
    
    参数:
    
    request - EditRequest
    
    返回:
    
    EditResponse
  - chatCompletions
```
public ChatCompletionResponse chatCompletions(ChatCompletionRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create chat completion.
    
    指定者:
    
    chatCompletions 在接口中 OpenAiClient
    
    参数:
    
    request - ChatCompletionRequest
    
    返回:
    
    ChatCompletionResponse
  - streamChatCompletions
```
public void streamChatCompletions(ChatCompletionRequest request,
                                  okhttp3.sse.EventSourceListener listener)
```
    从接口复制的说明: OpenAiClient
    
    Create stream chat completion.
    
    指定者:
    
    streamChatCompletions 在接口中 OpenAiClient
    
    参数:
    
    request - ChatCompletionRequest
    
    listener - EventSourceListener
  - models
```
public ListModelsResponse models()
```
    从接口复制的说明: OpenAiClient
    
    List models.
    
    指定者:
    
    models 在接口中 OpenAiClient
    
    返回:
    
    ListModelsResponse
  - retrieveModel
```
public RetrieveModelResponse retrieveModel(String modelId)
```
    从接口复制的说明: OpenAiClient
    
    Retrieve model by modelId.
    
    指定者:
    
    retrieveModel 在接口中 OpenAiClient
    
    参数:
    
    modelId - modelId
    
    返回:
    
    RetrieveModelResponse
  - embeddings
```
public EmbeddingResponse embeddings(EmbeddingRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create embeddings.
    
    指定者:
    
    embeddings 在接口中 OpenAiClient
    
    参数:
    
    request - EmbeddingRequest
    
    返回:
    
    EmbeddingResponse
  - listFiles
```
public ListFileResponse listFiles()
```
    从接口复制的说明: OpenAiClient
    
    List files.
    
    指定者:
    
    listFiles 在接口中 OpenAiClient
    
    返回:
    
    ListFileResponse
  - uploadFile
```
public UploadFileResponse uploadFile(org.springframework.core.io.Resource fileResource,
                                     String purpose)
```
    从接口复制的说明: OpenAiClient
    
    Upload file.
    
    指定者:
    
    uploadFile 在接口中 OpenAiClient
    
    参数:
    
    fileResource - Resource
    
    purpose - purpose
    
    返回:
    
    UploadFileResponse
  - deleteFile
```
public DeleteFileResponse deleteFile(String fileId)
```
    从接口复制的说明: OpenAiClient
    
    Delete file by fileId.
    
    指定者:
    
    deleteFile 在接口中 OpenAiClient
    
    参数:
    
    fileId - fileId
    
    返回:
    
    DeleteFileResponse
  - retrieveFile
```
public RetrieveFileResponse retrieveFile(String fileId)
```
    从接口复制的说明: OpenAiClient
    
    Retrieve file by fileId
    
    指定者:
    
    retrieveFile 在接口中 OpenAiClient
    
    参数:
    
    fileId - fileId
    
    返回:
    
    RetrieveFileResponse
  - createFineTune
```
public CreateFineTuneResponse createFineTune(CreateFineTuneRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create fine-tune.
    
    指定者:
    
    createFineTune 在接口中 OpenAiClient
    
    参数:
    
    request - CreateFineTuneRequest
    
    返回:
    
    CreateFineTuneResponse
  - listFineTunes
```
public ListFineTuneResponse listFineTunes()
```
    从接口复制的说明: OpenAiClient
    
    List fine-tunes.
    
    指定者:
    
    listFineTunes 在接口中 OpenAiClient
    
    返回:
    
    ListFineTuneResponse
  - retrieveFineTunes
```
public RetrieveFineTuneResponse retrieveFineTunes(String fineTuneId)
```
    从接口复制的说明: OpenAiClient
    
    Retrieve fine-tune.
    
    指定者:
    
    retrieveFineTunes 在接口中 OpenAiClient
    
    参数:
    
    fineTuneId - fineTuneId
    
    返回:
    
    RetrieveFineTuneResponse
  - cancelFineTune
```
public CancelFineTuneResponse cancelFineTune(String fineTuneId)
```
    从接口复制的说明: OpenAiClient
    
    Cancel fine-tune by fineTuneId.
    
    指定者:
    
    cancelFineTune 在接口中 OpenAiClient
    
    参数:
    
    fineTuneId - fineTuneId
    
    返回:
    
    CancelFineTuneResponse
  - listFineTuneEvents
```
public ListFineTuneEventResponse listFineTuneEvents(String fineTuneId)
```
    从接口复制的说明: OpenAiClient
    
    List fine-tune events.
    
    指定者:
    
    listFineTuneEvents 在接口中 OpenAiClient
    
    参数:
    
    fineTuneId - fineTuneId
    
    返回:
    
    ListFineTuneEventResponse
  - deleteFineTuneModel
```
public DeleteFineTuneModelResponse deleteFineTuneModel(String model)
```
    从接口复制的说明: OpenAiClient
    
    Delete fine-tune model.
    
    指定者:
    
    deleteFineTuneModel 在接口中 OpenAiClient
    
    参数:
    
    model - model
    
    返回:
    
    DeleteFineTuneModelResponse
  - createTranscription
```
public CreateAudioResponse createTranscription(org.springframework.core.io.Resource fileResource,
                                               CreateAudioRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create transcription.
    
    指定者:
    
    createTranscription 在接口中 OpenAiClient
    
    参数:
    
    fileResource - The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
    
    request - CreateAudioRequest
    
    返回:
    
    CreateAudioResponse
  - createTranslation
```
public CreateAudioResponse createTranslation(org.springframework.core.io.Resource fileResource,
                                             CreateAudioRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create translation.
    
    指定者:
    
    createTranslation 在接口中 OpenAiClient
    
    参数:
    
    fileResource - The audio file to translate, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.
    
    request - CreateAudioRequest
    
    返回:
    
    CreateAudioResponse
  - createImage
```
public CreateImageResponse createImage(CreateImageRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create image.
    
    指定者:
    
    createImage 在接口中 OpenAiClient
    
    参数:
    
    request - CreateImageRequest
    
    返回:
    
    CreateImageResponse
  - createImageEdit
```
public CreateImageResponse createImageEdit(org.springframework.core.io.Resource image,
                                           org.springframework.core.io.Resource mask,
                                           CreateImageRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create image edit.
    
    指定者:
    
    createImageEdit 在接口中 OpenAiClient
    
    参数:
    
    image - Resource
    
    mask - Resource
    
    request - CreateImageRequest
    
    返回:
    
    CreateImageResponse
  - createImageVariation
```
public CreateImageResponse createImageVariation(org.springframework.core.io.Resource image,
                                                CreateImageVariationRequest request)
```
    从接口复制的说明: OpenAiClient
    
    Create image variation.
    
    指定者:
    
    createImageVariation 在接口中 OpenAiClient
    
    参数:
    
    image - Resource
    
    request - CreateImageRequest
    
    返回:
    
    CreateImageResponse
  - billingCreditGrants
```
public CreditGrantsResponse billingCreditGrants()
```
    从接口复制的说明: OpenAiClient
    
    Query billing credit grants.
    
    指定者:
    
    billingCreditGrants 在接口中 OpenAiClient
    
    返回:
    
    CreditGrantsResponse
  - users
```
public UserResponse users(String organizationId)
```
    从接口复制的说明: OpenAiClient
    
    Get users.
    
    指定者:
    
    users 在接口中 OpenAiClient
    
    参数:
    
    organizationId - organizationId
    
    返回:
    
    UserResponse
  - billingSubscription
```
public SubscriptionResponse billingSubscription()
```
    从接口复制的说明: OpenAiClient
    
    Query billing subscription.
    
    指定者:
    
    billingSubscription 在接口中 OpenAiClient
    
    返回:
    
    SubscriptionResponse
  - billingUsage
```
public UsageResponse billingUsage(String startDate,
                                  String endDate)
```
    从接口复制的说明: OpenAiClient
    
    Query billing usage.
    
    指定者:
    
    billingUsage 在接口中 OpenAiClient
    
    参数:
    
    startDate - startDate
    
    endDate - endDate
    
    返回:
    
    UsageResponse

类 DefaultOpenAiClient

构造器概要

方法概要

从类继承的方法 java.lang.Object

构造器详细资料

DefaultOpenAiClient

方法详细资料

moderations

completions

streamCompletions

edits

chatCompletions

streamChatCompletions

models

retrieveModel

embeddings

listFiles

uploadFile

deleteFile

retrieveFile

createFineTune

listFineTunes

retrieveFineTunes

cancelFineTune

listFineTuneEvents

deleteFineTuneModel

createTranscription

createTranslation

createImage

createImageEdit

createImageVariation

billingCreditGrants

users

billingSubscription

billingUsage