com.lzhpo.chatgpt

接口 OpenAiClient

所有已知实现类:

DefaultOpenAiClient

public interface OpenAiClient

作者:

lzhpo

方法概要

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

方法详细资料

moderations

ModerationResponse moderations(@Valid
                               @Valid ModerationRequest request)

Create moderation.

参数:

request - ModerationRequest

返回:

ModerationResponse

completions

@Deprecated
CompletionResponse completions(@Valid
                                           @Valid CompletionRequest request)

已过时。 This is a legacy from OpenAi, please use chatCompletions(com.lzhpo.chatgpt.entity.chat.ChatCompletionRequest) method.

Create completion.

参数:

request - CompletionRequest

返回:

CompletionResponse

streamCompletions

@Deprecated
void streamCompletions(@Valid
                                   @Valid CompletionRequest request,
                                   @NotNull
                                   @NotNull okhttp3.sse.EventSourceListener listener)

已过时。 This is a legacy from OpenAi, please use streamChatCompletions(com.lzhpo.chatgpt.entity.chat.ChatCompletionRequest, okhttp3.sse.EventSourceListener) method.

Create stream completion.

参数:

request - CompletionRequest

listener - EventSourceListener

edits

EditResponse edits(@Valid
                   @Valid EditRequest request)

Create edit.

参数:

request - EditRequest

返回:

EditResponse

chatCompletions

ChatCompletionResponse chatCompletions(@Valid
                                       @Valid ChatCompletionRequest request)

Create chat completion.

参数:

request - ChatCompletionRequest

返回:

ChatCompletionResponse

streamChatCompletions

void streamChatCompletions(@Valid
                           @Valid ChatCompletionRequest request,
                           @NotNull
                           @NotNull okhttp3.sse.EventSourceListener listener)

Create stream chat completion.

参数:

request - ChatCompletionRequest

listener - EventSourceListener

models

ListModelsResponse models()

List models.

返回:

ListModelsResponse

retrieveModel

RetrieveModelResponse retrieveModel(@NotBlank
                                    @NotBlank String modelId)

Retrieve model by modelId.

参数:

modelId - modelId

返回:

RetrieveModelResponse

embeddings

EmbeddingResponse embeddings(@Valid
                             @Valid EmbeddingRequest request)

Create embeddings.

参数:

request - EmbeddingRequest

返回:

EmbeddingResponse

listFiles

ListFileResponse listFiles()

List files.

返回:

ListFileResponse

uploadFile

UploadFileResponse uploadFile(@NotNull
                              @NotNull org.springframework.core.io.Resource fileResource,
                              @NotBlank
                              @NotBlank String purpose)

Upload file.

参数:

fileResource - Resource

purpose - purpose

返回:

UploadFileResponse

deleteFile

DeleteFileResponse deleteFile(@NotBlank
                              @NotBlank String fileId)

Delete file by fileId.

参数:

fileId - fileId

返回:

DeleteFileResponse

retrieveFile

RetrieveFileResponse retrieveFile(@NotBlank
                                  @NotBlank String fileId)

Retrieve file by fileId

参数:

fileId - fileId

返回:

RetrieveFileResponse

createFineTune

CreateFineTuneResponse createFineTune(@Valid
                                      @Valid CreateFineTuneRequest request)

Create fine-tune.

参数:

request - CreateFineTuneRequest

返回:

CreateFineTuneResponse

listFineTunes

ListFineTuneResponse listFineTunes()

List fine-tunes.

返回:

ListFineTuneResponse

retrieveFineTunes

RetrieveFineTuneResponse retrieveFineTunes(@NotBlank
                                           @NotBlank String fineTuneId)

Retrieve fine-tune.

参数:

fineTuneId - fineTuneId

返回:

RetrieveFineTuneResponse

cancelFineTune

CancelFineTuneResponse cancelFineTune(@NotBlank
                                      @NotBlank String fineTuneId)

Cancel fine-tune by fineTuneId.

参数:

fineTuneId - fineTuneId

返回:

CancelFineTuneResponse

listFineTuneEvents

ListFineTuneEventResponse listFineTuneEvents(@NotBlank
                                             @NotBlank String fineTuneId)

List fine-tune events.

参数:

fineTuneId - fineTuneId

返回:

ListFineTuneEventResponse

deleteFineTuneModel

DeleteFineTuneModelResponse deleteFineTuneModel(@NotBlank
                                                @NotBlank String model)

Delete fine-tune model.

参数:

model - model

返回:

DeleteFineTuneModelResponse

createTranscription

CreateAudioResponse createTranscription(@NotNull
                                        @NotNull org.springframework.core.io.Resource fileResource,
                                        @Valid
                                        @Valid CreateAudioRequest request)

Create transcription.

参数:

fileResource - The audio file to transcribe, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.

request - CreateAudioRequest

返回:

CreateAudioResponse

createTranslation

CreateAudioResponse createTranslation(@NotNull
                                      @NotNull org.springframework.core.io.Resource fileResource,
                                      @Valid
                                      @Valid CreateAudioRequest request)

Create translation.

参数:

fileResource - The audio file to translate, in one of these formats: mp3, mp4, mpeg, mpga, m4a, wav, or webm.

request - CreateAudioRequest

返回:

CreateAudioResponse

createImage

CreateImageResponse createImage(@Valid
                                @Valid CreateImageRequest request)

Create image.

参数:

request - CreateImageRequest

返回:

CreateImageResponse

createImageEdit

CreateImageResponse createImageEdit(@NotNull
                                    @NotNull org.springframework.core.io.Resource image,
                                    @NotNull
                                    @NotNull org.springframework.core.io.Resource mask,
                                    @Valid
                                    @Valid CreateImageRequest request)

Create image edit.

参数:

image - Resource

mask - Resource

request - CreateImageRequest

返回:

CreateImageResponse

createImageVariation

CreateImageResponse createImageVariation(@NotNull
                                         @NotNull org.springframework.core.io.Resource image,
                                         @Valid
                                         @Valid CreateImageVariationRequest request)

Create image variation.

参数:

image - Resource

request - CreateImageRequest

返回:

CreateImageResponse

billingCreditGrants

CreditGrantsResponse billingCreditGrants()

Query billing credit grants.

返回:

CreditGrantsResponse

users

UserResponse users(@NotBlank
                   @NotBlank String organizationId)

Get users.

参数:

organizationId - organizationId

返回:

UserResponse

billingSubscription

SubscriptionResponse billingSubscription()

Query billing subscription.

返回:

SubscriptionResponse

billingUsage

UsageResponse billingUsage(@NotBlank
                           @NotBlank String startDate,
                           @NotBlank
                           @NotBlank String endDate)

Query billing usage.

参数:

startDate - startDate

endDate - endDate

返回:

UsageResponse