Package xyz.felh.openai

Interface OpenAiApi

public interface OpenAiApi
Retrofit2 API interface

  • Method Details

    • listModels

      @GET("/v1/models") io.reactivex.rxjava3.core.Single<OpenAiApiListResponse<Model>> listModels()
      List models
      Returns:
      Lists the currently available models, and provides basic information about each one such as the owner and availability.

    • getModel

      @GET("/v1/models/{model_id}") io.reactivex.rxjava3.core.Single<Model> getModel(@Path("model_id") String modelId)
      Retrieve model
      Parameters:
      modelId - model ID
      Returns:
      Retrieves a model instance, providing basic information about the model such as the owner and permission.

    • createCompletion

      @POST("/v1/completions") io.reactivex.rxjava3.core.Single<Completion> createCompletion(@Body CreateCompletionRequest request)
      Create completion Creates a completion for the provided prompt and parameters
      Parameters:
      request - Create completion request
      Returns:
      Completion detail information

    • createChatCompletion

      @POST("/v1/chat/completions") io.reactivex.rxjava3.core.Single<ChatCompletion> createChatCompletion(@Body CreateChatCompletionRequest request)
      Create chat completionBeta Creates a completion for the chat message
      Parameters:
      request - Create chat completion request
      Returns:
      Chat Completion information

    • createEdit

      @POST("/v1/edits") io.reactivex.rxjava3.core.Single<Edit> createEdit(@Body CreateEditRequest request)
      Create edit Creates a new edit for the provided input, instruction, and parameters.
      Parameters:
      request - create edit request
      Returns:
      Edit information

    • createImage

      @POST("/v1/images/generations") io.reactivex.rxjava3.core.Single<ImageResponse> createImage(@Body CreateImageRequest request)
      Create image Beta Creates an image given a prompt.
      Parameters:
      request - create image request
      Returns:
      Image Information Wrapper

    • createImageEdit

      @POST("/v1/images/edits") io.reactivex.rxjava3.core.Single<ImageResponse> createImageEdit(@Body okhttp3.RequestBody request)
      Create image editBeta Creates an edited or extended image given an original image and a prompt.
      Parameters:
      request - request body
      Returns:
      Image Information Wrapper

    • createImageVariation

      @POST("/v1/images/variations") io.reactivex.rxjava3.core.Single<ImageResponse> createImageVariation(@Body okhttp3.RequestBody request)
      Create image variationBeta Creates a variation of a given image.
      Parameters:
      request - request body
      Returns:
      Image Information Wrapper

    • createEmbedding

      @POST("/v1/embeddings") io.reactivex.rxjava3.core.Single<CreateEmbeddingResponse> createEmbedding(@Body CreateEmbeddingRequest request)
      Create embeddings Creates an embedding vector representing the input text.
      Parameters:
      request - create embedding request
      Returns:
      Embeddings

    • createAudioTranscription

      @POST("/v1/audio/transcriptions") io.reactivex.rxjava3.core.Single<AudioResponse> createAudioTranscription(@Body okhttp3.RequestBody request)
      Create transcriptionBeta Transcribes audio into the input language.
      Parameters:
      request - body
      Returns:
      Text of audio

    • createAudioTranslation

      @POST("/v1/audio/translations") io.reactivex.rxjava3.core.Single<AudioResponse> createAudioTranslation(@Body okhttp3.RequestBody request)
      Create translationBeta Translates audio into English.
      Parameters:
      request - body
      Returns:
      Text of audio

    • createModeration

      @POST("/v1/moderations") io.reactivex.rxjava3.core.Single<CreateModerationResponse> createModeration(@Body CreateModerationRequest request)
      Create moderation Classifies if text violates OpenAI's Content Policy
      Parameters:
      request - create moderation request
      Returns:
      Moderation

    • listFiles

      @GET("/v1/files") io.reactivex.rxjava3.core.Single<OpenAiApiListResponse<File>> listFiles()
      List files Returns a list of files that belong to the user's organization.
      Returns:
      File list

    • uploadFile

      @Multipart @POST("/v1/files") io.reactivex.rxjava3.core.Single<File> uploadFile(@Part okhttp3.MultipartBody.Part file, @Part("purpose") okhttp3.RequestBody purpose)
      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.
      Parameters:
      file - file
      purpose - request body
      Returns:
      File information

    • deleteFile

      @DELETE("/v1/files/{file_id}") io.reactivex.rxjava3.core.Single<DeleteResponse> deleteFile(@Path("file_id") String fileId)
      Delete file Delete a file.
      Parameters:
      fileId - fileId
      Returns:
      Delete file and status

    • retrieveFile

      @GET("/v1/files/{file_id}") io.reactivex.rxjava3.core.Single<File> retrieveFile(@Path("file_id") String fileId)
      Retrieve file
      Parameters:
      fileId - fileId
      Returns:
      information about a specific file.

    • retrieveFileContent

      @GET("/v1/files/{file_id}/content") io.reactivex.rxjava3.core.Single<RetrieveFileContentResponse> retrieveFileContent(@Path("file_id") String fileId)
      Retrieve file content
      Parameters:
      fileId - fileId
      Returns:
      the contents of the specified file

    • createFineTune

      @POST("/v1/fine-tunes") io.reactivex.rxjava3.core.Single<FineTune> createFineTune(@Body CreateFineTuneRequest request)
      Create fine-tune Creates a job that fine-tunes a specified model from a given dataset. Response includes details of the enqueued job including job status and the name of the fine-tuned models once complete.
      Parameters:
      request - create fine tune request
      Returns:
      Fine-tune information

    • listFineTunes

      @GET("/v1/fine-tunes") io.reactivex.rxjava3.core.Single<OpenAiApiListResponse<FineTune>> listFineTunes()
      List fine-tunes List your organization's fine-tuning jobs
      Returns:
      Fine-tune list

    • retrieveFineTune

      @GET("/v1/fine-tunes/{fine_tune_id}") io.reactivex.rxjava3.core.Single<FineTune> retrieveFineTune(@Path("fine_tune_id") String fineTuneId)
      Retrieve fine-tune Gets info about the fine-tune job.
      Parameters:
      fineTuneId - fineTuneId
      Returns:
      Fine-tune information

    • cancelFineTune

      @POST("/v1/fine-tunes/{fine_tune_id}/cancel") io.reactivex.rxjava3.core.Single<FineTune> cancelFineTune(@Path("fine_tune_id") String fineTuneId)
      Cancel fine-tune Immediately cancel a fine-tune job.
      Parameters:
      fineTuneId - fineTuneId
      Returns:
      Fine-tune information

    • listFineTuneEvents

      @GET("/v1/fine-tunes/{fine_tune_id}/events") io.reactivex.rxjava3.core.Single<OpenAiApiListResponse<FineTuneEvent>> listFineTuneEvents(@Path("fine_tune_id") String fineTuneId)
      List fine-tune events Get fine-grained status updates for a fine-tune job.
      Parameters:
      fineTuneId - fineTuneId
      Returns:
      Fine-tune event information

    • deleteFineTune

      @DELETE("/v1/models/{model_and_fine_tune_id}") io.reactivex.rxjava3.core.Single<DeleteResponse> deleteFineTune(@Path("model_and_fine_tune_id") String modelAndFineTuneId)
      Delete fine-tune model Delete a fine-tuned model. You must have the Owner role in your organization.
      Parameters:
      modelAndFineTuneId - model and fineTuneId
      Returns:
      Delete status