ChatGptApiPost (fundebug-java-notifier 1.0.7 API)

java.lang.Object
- cn.jianwoo.openai.chatgptapi.service.impl.ChatGptApiPost

所有已实现的接口:

PostApiService
```
public class ChatGptApiPost
extends Object
implements PostApiService
```
ChatGpt API封装
(官网:https://platform.openai.com/docs/introduction)

作者:

gulihua

字段概要

字段
限定符和类型	字段和说明
`static String`	`AUTHORIZATION_ERROR`
`static String`	`AUTHORIZATION_ERROR_MSG`
`static String`	`BIZ_ERROR`
`static String`	`JSON_ERROR`
`static String`	`JSON_ERROR_MSG`
`static String`	`OTHER_ERROR`

构造器概要

构造器
构造器和说明

ChatGptApiPost(OpenAiAuth openAiAuth)

构造器
构造器和说明
`ChatGptApiPost(OpenAiAuth openAiAuth)`

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`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
`CreditGrantsRes`	`queryBillingCreditGrants()` Billing credit grants

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

- 字段详细资料
  - AUTHORIZATION_ERROR
```
public static final String AUTHORIZATION_ERROR
```
    另请参阅:
    
    常量字段值
  - JSON_ERROR
```
public static final String JSON_ERROR
```
    另请参阅:
    
    常量字段值
  - AUTHORIZATION_ERROR_MSG
```
public static final String AUTHORIZATION_ERROR_MSG
```
    另请参阅:
    
    常量字段值
  - JSON_ERROR_MSG
```
public static final String JSON_ERROR_MSG
```
    另请参阅:
    
    常量字段值
  - OTHER_ERROR
```
public static final String OTHER_ERROR
```
    另请参阅:
    
    常量字段值
  - BIZ_ERROR
```
public static final String BIZ_ERROR
```
    另请参阅:
    
    常量字段值
- 构造器详细资料
  - ChatGptApiPost
```
public ChatGptApiPost(OpenAiAuth openAiAuth)
```
- 方法详细资料
  - models
```
public ModelRes models()
                throws ApiException
```
    从接口复制的说明: PostApiService
    
    List models
    Lists the currently available models, and provides basic information about each one such as the owner and availability.
    
    指定者:
    
    models 在接口中 PostApiService
    
    返回:
    
    ModelRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - model
```
public ModelDataRes model(String modelName)
                   throws ApiException
```
    从接口复制的说明: PostApiService
    
    Retrieve model
    Retrieves a model instance, providing basic information about the model such as the owner and permissioning.
    
    指定者:
    
    model 在接口中 PostApiService
    
    参数:
    
    modelName - model
    
    返回:
    
    ModelDataRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - completions
```
public CompletionRes completions(CompletionReq req)
                          throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create completion
    Creates a completion for the provided prompt and parameters
    stream = false
    
    指定者:
    
    completions 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    CompletionRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - completionsStream
```
public void completionsStream(CompletionReq req,
                              Callback<CompletionRes> callback)
```
    从接口复制的说明: PostApiService
    
    Create completion
    Creates a completion for the provided prompt and parameters
    stream = true
    
    指定者:
    
    completionsStream 在接口中 PostApiService
    
    参数:
    
    req - req
    
    callback - callback funcation
  - completionsChat
```
public CompletionRes completionsChat(CompletionReq req)
                              throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create chat completion
    Creates a completion for the chat message
    stream = false
    
    指定者:
    
    completionsChat 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    CompletionRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - completionsChatStream
```
public void completionsChatStream(CompletionReq req,
                                  Callback<CompletionRes> callback)
```
    从接口复制的说明: PostApiService
    
    Create chat completion
    Creates a completion for the chat message
    stream = true
    
    指定者:
    
    completionsChatStream 在接口中 PostApiService
    
    参数:
    
    req - req
    
    callback - callback funcation
  - completionsEdit
```
public CompletionRes completionsEdit(CompletionReq req)
                              throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create edit
    Creates a new edit for the provided input, instruction, and parameters.
    
    指定者:
    
    completionsEdit 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    CompletionRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - imageCreate
```
public ImageRes imageCreate(ImageReq req)
                     throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create image
    Creates an image given a prompt.
    
    指定者:
    
    imageCreate 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    ImageRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - imageEdit
```
public ImageRes imageEdit(ImageReq req)
                   throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create image edit
    Creates an edited or extended image given an original image and a prompt.
    
    指定者:
    
    imageEdit 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    ImageRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - imageVariate
```
public ImageRes imageVariate(ImageReq req)
                      throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create image variation
    Creates a variation of a given image.
    
    指定者:
    
    imageVariate 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    ImageRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - embeddingsCreate
```
public EmbeddingsRes embeddingsCreate(EmbeddingsReq req)
                               throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create embeddings
    Creates an embedding vector representing the input text.
    
    指定者:
    
    embeddingsCreate 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    EmbeddingsRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - audioTranscribes
```
public AudioRes audioTranscribes(AudioReq req)
                          throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create transcription
    Transcribes audio into the input language.
    
    指定者:
    
    audioTranscribes 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    EmbeddingsRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - audioTranslates
```
public AudioRes audioTranslates(AudioReq req)
                         throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create translation
    Translates audio into into English.
    
    指定者:
    
    audioTranslates 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    EmbeddingsRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fileList
```
public FileListRes fileList()
                     throws ApiException
```
    从接口复制的说明: PostApiService
    
    List files
    Returns a list of files that belong to the user's organization.
    
    指定者:
    
    fileList 在接口中 PostApiService
    
    返回:
    
    FileListRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fileUpload
```
public FileDetRes fileUpload(FileReq req)
                      throws ApiException
```
    从接口复制的说明: PostApiService
    
    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.
    
    指定者:
    
    fileUpload 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    FileDetRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fileDelete
```
public ObjDelRes fileDelete(String fileId)
                     throws ApiException
```
    从接口复制的说明: PostApiService
    
    Delete file
    Delete a file.
    
    指定者:
    
    fileDelete 在接口中 PostApiService
    
    参数:
    
    fileId - The ID of the file to use for this request
    
    返回:
    
    ObjDelRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fileRetrieve
```
public FileDetRes fileRetrieve(String fileId)
                        throws ApiException
```
    从接口复制的说明: PostApiService
    
    Retrieve file
    Returns information about a specific file.
    
    指定者:
    
    fileRetrieve 在接口中 PostApiService
    
    参数:
    
    fileId - The ID of the file to use for this request
    
    返回:
    
    FileDetRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fileRetrieveContent
```
public String fileRetrieveContent(String fileId)
                           throws ApiException
```
    从接口复制的说明: PostApiService
    
    Retrieve file content
    Returns the contents of the specified file.
    
    指定者:
    
    fileRetrieveContent 在接口中 PostApiService
    
    参数:
    
    fileId - The ID of the file to use for this request
    
    返回:
    
    String
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fineTuneCreate
```
public FineTunesRes fineTuneCreate(FineTunesReq req)
                            throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create fine-tune
    Creates a job that fine-tunes a specified model from a given dataset.
    
    指定者:
    
    fineTuneCreate 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    FineTunesRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fineTuneList
```
public FineTuneListRes fineTuneList()
                             throws ApiException
```
    从接口复制的说明: PostApiService
    
    List fine-tunes
    List your organization's fine-tuning jobs.
    
    指定者:
    
    fineTuneList 在接口中 PostApiService
    
    返回:
    
    FineTuneListRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fineTuneRetrieve
```
public FineTunesRes fineTuneRetrieve(String fineTuneId)
                              throws ApiException
```
    从接口复制的说明: PostApiService
    
    Retrieve fine-tune
    Gets info about the fine-tune job.
    
    指定者:
    
    fineTuneRetrieve 在接口中 PostApiService
    
    参数:
    
    fineTuneId - The ID of the fine-tune job to get events for.
    
    返回:
    
    FineTunesRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fineTuneCancel
```
public FineTunesRes fineTuneCancel(String fineTuneId)
                            throws ApiException
```
    从接口复制的说明: PostApiService
    
    Cancel fine-tune
    Immediately cancel a fine-tune job.
    
    指定者:
    
    fineTuneCancel 在接口中 PostApiService
    
    参数:
    
    fineTuneId - The ID of the fine-tune job to get events for.
    
    返回:
    
    FineTunesRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fineTuneEventList
```
public EventListRes fineTuneEventList(String fineTuneId)
                               throws ApiException
```
    从接口复制的说明: PostApiService
    
    List fine-tune events
    Get fine-grained status updates for a fine-tune job.
    
    指定者:
    
    fineTuneEventList 在接口中 PostApiService
    
    参数:
    
    fineTuneId - The ID of the fine-tune job to get events for.
    
    返回:
    
    FineTunesRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - fineTuneDelete
```
public ObjDelRes fineTuneDelete(String model)
                         throws ApiException
```
    从接口复制的说明: PostApiService
    
    Delete fine-tune model
    Delete a fine-tuned model. You must have the Owner role in your organization.
    
    指定者:
    
    fineTuneDelete 在接口中 PostApiService
    
    参数:
    
    model - The model to delete
    
    返回:
    
    FineTunesRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - moderationsCreate
```
public ModerationsRes moderationsCreate(ModerationsReq req)
                                 throws ApiException
```
    从接口复制的说明: PostApiService
    
    Create moderation
    Classifies if text violates OpenAI's Content Policy
    
    指定者:
    
    moderationsCreate 在接口中 PostApiService
    
    参数:
    
    req - req
    
    返回:
    
    ModerationsRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - enginesList
```
public EnginesListRes enginesList()
                           throws ApiException
```
    从接口复制的说明: PostApiService
    
    List engines
    Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availability.
    
    指定者:
    
    enginesList 在接口中 PostApiService
    
    返回:
    
    EnginesListRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - enginesRetrieve
```
public EnginesDataRes enginesRetrieve(String engineId)
                               throws ApiException
```
    从接口复制的说明: PostApiService
    
    Retrieve engine
    Retrieves a model instance, providing basic information about it such as the owner and availability.
    
    指定者:
    
    enginesRetrieve 在接口中 PostApiService
    
    参数:
    
    engineId - The ID of the engine to use for this request
    
    返回:
    
    FineTunesRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误
  - queryBillingCreditGrants
```
public CreditGrantsRes queryBillingCreditGrants()
                                         throws ApiException
```
    从接口复制的说明: PostApiService
    
    Billing credit grants
    
    指定者:
    
    queryBillingCreditGrants 在接口中 PostApiService
    
    返回:
    
    FineTunesRes
    
    抛出:
    
    ApiException -
    --400001 未授权
    --500001 响应JSON错误
    --800001 业务错误
    --900001 其他错误

类 ChatGptApiPost

字段概要

构造器概要

方法概要

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

字段详细资料

AUTHORIZATION_ERROR

JSON_ERROR

AUTHORIZATION_ERROR_MSG

JSON_ERROR_MSG

OTHER_ERROR

BIZ_ERROR

构造器详细资料

ChatGptApiPost

方法详细资料

models

model

completions

completionsStream

completionsChat

completionsChatStream

completionsEdit

imageCreate

imageEdit

imageVariate

embeddingsCreate

audioTranscribes

audioTranslates

fileList

fileUpload

fileDelete

fileRetrieve

fileRetrieveContent

fineTuneCreate

fineTuneList

fineTuneRetrieve

fineTuneCancel

fineTuneEventList

fineTuneDelete

moderationsCreate

enginesList

enginesRetrieve

queryBillingCreditGrants