cn.jianwoo.openai.chatgptapi.service

接口 PostApiService

所有已知实现类:

ChatGptApiPost

public interface PostApiService

ChatGpt API服务

作者:

gulihua

方法概要

限定符和类型	方法和说明
AudioRes	audioTranscribes(AudioReq req) Create transcription Transcribes audio into the input language.
AudioRes	audioTranslates(AudioReq req) Create translation Translates audio into into English.
CompletionRes	completions(CompletionReq req) Create completion Creates a completion for the provided prompt and parameters stream = false
CompletionRes	completionsChat(CompletionReq req) Create chat completion Creates a completion for the chat message stream = false
void	completionsChatStream(CompletionReq req, Callback<CompletionRes> callback) Create chat completion Creates a completion for the chat message stream = true
CompletionRes	completionsEdit(CompletionReq req) Create edit Creates a new edit for the provided input, instruction, and parameters.
void	completionsStream(CompletionReq req, Callback<CompletionRes> callback) Create completion Creates a completion for the provided prompt and parameters stream = true
EmbeddingsRes	embeddingsCreate(EmbeddingsReq req) Create embeddings Creates an embedding vector representing the input text.
EnginesListRes	enginesList() List engines Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availability.
EnginesDataRes	enginesRetrieve(String engineId) Retrieve engine Retrieves a model instance, providing basic information about it such as the owner and availability.
ObjDelRes	fileDelete(String fileId) Delete file Delete a file.
FileListRes	fileList() List files Returns a list of files that belong to the user's organization.
FileDetRes	fileRetrieve(String fileId) Retrieve file Returns information about a specific file.
String	fileRetrieveContent(String fileId) Retrieve file content Returns the contents of the specified file.
FileDetRes	fileUpload(FileReq req) Upload file Upload a file that contains document(s) to be used across various endpoints/features.
FineTunesRes	fineTuneCancel(String fineTuneId) Cancel fine-tune Immediately cancel a fine-tune job.
FineTunesRes	fineTuneCreate(FineTunesReq req) Create fine-tune Creates a job that fine-tunes a specified model from a given dataset.
ObjDelRes	fineTuneDelete(String model) Delete fine-tune model Delete a fine-tuned model.
EventListRes	fineTuneEventList(String fineTuneId) List fine-tune events Get fine-grained status updates for a fine-tune job.
FineTuneListRes	fineTuneList() List fine-tunes List your organization's fine-tuning jobs.
FineTunesRes	fineTuneRetrieve(String fineTuneId) Retrieve fine-tune Gets info about the fine-tune job.
ImageRes	imageCreate(ImageReq req) Create image Creates an image given a prompt.
ImageRes	imageEdit(ImageReq req) Create image edit Creates an edited or extended image given an original image and a prompt.
ImageRes	imageVariate(ImageReq req) Create image variation Creates a variation of a given image.
ModelDataRes	model(String modelName) Retrieve model Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
ModelRes	models() List models Lists the currently available models, and provides basic information about each one such as the owner and availability.
ModerationsRes	moderationsCreate(ModerationsReq req) Create moderation Classifies if text violates OpenAI's Content Policy

方法详细资料

models

ModelRes models()
         throws ApiException

List models
Lists the currently available models, and provides basic information about each one such as the owner and availability.

返回:

ModelRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

model

ModelDataRes model(String modelName)
            throws ApiException

Retrieve model
Retrieves a model instance, providing basic information about the model such as the owner and permissioning.

参数:

modelName - model

返回:

ModelDataRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

completions

CompletionRes completions(CompletionReq req)
                   throws ApiException

Create completion
Creates a completion for the provided prompt and parameters
stream = false

参数:

req - req

返回:

CompletionRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

completionsStream

void completionsStream(CompletionReq req,
                       Callback<CompletionRes> callback)
                throws ApiException

Create completion
Creates a completion for the provided prompt and parameters
stream = true

参数:

req - req

callback - callback funcation

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

completionsChat

CompletionRes completionsChat(CompletionReq req)
                       throws ApiException

Create chat completion
Creates a completion for the chat message
stream = false

参数:

req - req

返回:

CompletionRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

completionsChatStream

void completionsChatStream(CompletionReq req,
                           Callback<CompletionRes> callback)
                    throws ApiException

Create chat completion
Creates a completion for the chat message
stream = true

参数:

req - req

callback - callback funcation

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

completionsEdit

CompletionRes completionsEdit(CompletionReq req)
                       throws ApiException

Create edit
Creates a new edit for the provided input, instruction, and parameters.

参数:

req - req

返回:

CompletionRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

imageCreate

ImageRes imageCreate(ImageReq req)
              throws ApiException

Create image
Creates an image given a prompt.

参数:

req - req

返回:

ImageRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

imageEdit

ImageRes imageEdit(ImageReq req)
            throws ApiException

Create image edit
Creates an edited or extended image given an original image and a prompt.

参数:

req - req

返回:

ImageRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

imageVariate

ImageRes imageVariate(ImageReq req)
               throws ApiException

Create image variation
Creates a variation of a given image.

参数:

req - req

返回:

ImageRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

embeddingsCreate

EmbeddingsRes embeddingsCreate(EmbeddingsReq req)
                        throws ApiException

Create embeddings
Creates an embedding vector representing the input text.

参数:

req - req

返回:

EmbeddingsRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

audioTranscribes

AudioRes audioTranscribes(AudioReq req)
                   throws ApiException

Create transcription
Transcribes audio into the input language.

参数:

req - req

返回:

EmbeddingsRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

audioTranslates

AudioRes audioTranslates(AudioReq req)
                  throws ApiException

Create translation
Translates audio into into English.

参数:

req - req

返回:

EmbeddingsRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fileList

FileListRes fileList()
              throws ApiException

List files
Returns a list of files that belong to the user's organization.

返回:

FileListRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fileUpload

FileDetRes fileUpload(FileReq req)
               throws ApiException

Upload file
Upload a file that contains document(s) to be used across various endpoints/features. Currently, the size of all the files uploaded by one organization can be up to 1 GB. Please contact us if you need to increase the storage limit.

参数:

req - req

返回:

FileDetRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fileDelete

ObjDelRes fileDelete(String fileId)
              throws ApiException

Delete file
Delete a file.

参数:

fileId - The ID of the file to use for this request

返回:

ObjDelRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fileRetrieve

FileDetRes fileRetrieve(String fileId)
                 throws ApiException

Retrieve file
Returns information about a specific file.

参数:

fileId - The ID of the file to use for this request

返回:

FileDetRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fileRetrieveContent

String fileRetrieveContent(String fileId)
                    throws ApiException

Retrieve file content
Returns the contents of the specified file.

参数:

fileId - The ID of the file to use for this request

返回:

String

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fineTuneCreate

FineTunesRes fineTuneCreate(FineTunesReq req)
                     throws ApiException

Create fine-tune
Creates a job that fine-tunes a specified model from a given dataset.

参数:

req - req

返回:

FineTunesRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fineTuneList

FineTuneListRes fineTuneList()
                      throws ApiException

List fine-tunes
List your organization's fine-tuning jobs.

返回:

FineTuneListRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fineTuneRetrieve

FineTunesRes fineTuneRetrieve(String fineTuneId)
                       throws ApiException

Retrieve fine-tune
Gets info about the fine-tune job.

参数:

fineTuneId - The ID of the fine-tune job to get events for.

返回:

FineTunesRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fineTuneCancel

FineTunesRes fineTuneCancel(String fineTuneId)
                     throws ApiException

Cancel fine-tune
Immediately cancel a fine-tune job.

参数:

fineTuneId - The ID of the fine-tune job to get events for.

返回:

FineTunesRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fineTuneEventList

EventListRes fineTuneEventList(String fineTuneId)
                        throws ApiException

List fine-tune events
Get fine-grained status updates for a fine-tune job.

参数:

fineTuneId - The ID of the fine-tune job to get events for.

返回:

FineTunesRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

fineTuneDelete

ObjDelRes fineTuneDelete(String model)
                  throws ApiException

Delete fine-tune model
Delete a fine-tuned model. You must have the Owner role in your organization.

参数:

model - The model to delete

返回:

FineTunesRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

moderationsCreate

ModerationsRes moderationsCreate(ModerationsReq req)
                          throws ApiException

Create moderation
Classifies if text violates OpenAI's Content Policy

参数:

req - req

返回:

ModerationsRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

enginesList

EnginesListRes enginesList()
                    throws ApiException

List engines
Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availability.

返回:

EnginesListRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误

enginesRetrieve

EnginesDataRes enginesRetrieve(String engineId)
                        throws ApiException

Retrieve engine
Retrieves a model instance, providing basic information about it such as the owner and availability.

参数:

engineId - The ID of the engine to use for this request

返回:

FineTunesRes

抛出:

ApiException -
--400001 未授权
--500001 响应JSON错误
--800001 业务错误
--900001 其他错误