Index
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form
A
- AuthenticationInterceptor - Class in xyz.felh.openai.interceptor
-
OkHttp Interceptor that adds an authorization token header
- AuthenticationInterceptor(String, String) - Constructor for class xyz.felh.openai.interceptor.AuthenticationInterceptor
-
Constructor
B
- BASE_URL - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
- buildApi(String, Duration) - Static method in class xyz.felh.openai.OpenAiService
C
- cancelFineTuningJob(String) - Method in interface xyz.felh.openai.OpenAiApi
-
Cancel fine-tuning
- cancelFineTuningJob(String) - Method in class xyz.felh.openai.OpenAiService
-
Immediately cancel a fine-tune job.
- cancelThreadRun(String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/cancel
- cancelThreadRun(String, String) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/cancel
- close() - Method in class xyz.felh.openai.StreamChatCompletionListener
-
cancel eventSource
- createAssistant(CreateAssistantRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants
- createAssistant(CreateAssistantRequest) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/assistants
- createAssistantFile(String, CreateAssistantFileRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants/{assistant_id}/files
- createAssistantFile(String, CreateAssistantFileRequest) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/assistants/{assistant_id}/files
- createAudioTranscription(RequestBody) - Method in interface xyz.felh.openai.OpenAiApi
-
Create transcriptionBeta Transcribes audio into the input language.
- createAudioTranscription(CreateAudioTranscriptionRequest) - Method in class xyz.felh.openai.OpenAiService
-
whisper-1
- createAudioTranslation(RequestBody) - Method in interface xyz.felh.openai.OpenAiApi
-
Create translationBeta Translates audio into English.
- createAudioTranslation(CreateAudioTranslationRequest) - Method in class xyz.felh.openai.OpenAiService
-
whisper-1
- createChatCompletion(CreateChatCompletionRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
Create chat completionBeta Creates a completion for the chat message
- createChatCompletion(CreateChatCompletionRequest) - Method in class xyz.felh.openai.OpenAiService
-
gpt-4, gpt-4-0314, gpt-4-32k, gpt-4-32k-0314, gpt-3.5-turbo, gpt-3.5-turbo-0301 gpt-3.5-turbo-1006, gpt-4-1106-preview
- createEmbedding(CreateEmbeddingRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
Create embeddings Creates an embedding vector representing the input text.
- createEmbeddings(CreateEmbeddingRequest) - Method in class xyz.felh.openai.OpenAiService
-
text-embedding-ada-002, text-search-ada-doc-001
- createFineTuningJob(CreateFineTuningJobRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
Create fine-tuning job
- createFineTuningJob(CreateFineTuningJobRequest) - Method in class xyz.felh.openai.OpenAiService
-
Creates a job that fine-tunes a specified model from a given dataset.
- createImage(CreateImageRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
Create image Beta Creates an image given a prompt.
- createImage(CreateImageRequest) - Method in class xyz.felh.openai.OpenAiService
- createImageEdit(RequestBody) - Method in interface xyz.felh.openai.OpenAiApi
-
Create image editBeta Creates an edited or extended image given an original image and a prompt.
- createImageEdit(CreateEditRequest) - Method in class xyz.felh.openai.OpenAiService
- createImageVariation(RequestBody) - Method in interface xyz.felh.openai.OpenAiApi
-
Create image variationBeta Creates a variation of a given image.
- createImageVariation(CreateVariationRequest) - Method in class xyz.felh.openai.OpenAiService
- createModeration(CreateModerationRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
Create moderation Classifies if text violates OpenAI's Content Policy
- createModeration(CreateModerationRequest) - Method in class xyz.felh.openai.OpenAiService
-
text-moderation-stable, text-moderation-latest
- createSpeech(CreateSpeechRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
Generates audio from the input text.
- createSpeech(CreateSpeechRequest) - Method in class xyz.felh.openai.OpenAiService
-
Generates audio from the input text.
- createSteamChatCompletion(String, CreateChatCompletionRequest, StreamChatCompletionListener) - Method in class xyz.felh.openai.OpenAiService
-
create chat completion by stream
- createThread(CreateThreadRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads
- createThread(CreateThreadRequest) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/threads
- createThreadAndRun(CreateThreadAndRunRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/runs
- createThreadAndRun(CreateThreadAndRunRequest) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/threads/runs
- createThreadMessage(String, CreateMessageRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/messages
- createThreadMessage(String, CreateMessageRequest) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/threads/{thread_id}/messages
- createThreadRun(String, CreateRunRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/runs
- createThreadRun(String, CreateRunRequest) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/threads/{thread_id}/runs
D
- defaultClient(String, String, Duration) - Static method in class xyz.felh.openai.OpenAiService
- defaultClient(String, Duration) - Static method in class xyz.felh.openai.OpenAiService
- defaultObjectMapper() - Static method in class xyz.felh.openai.OpenAiService
- defaultRetrofit(OkHttpClient, ObjectMapper) - Static method in class xyz.felh.openai.OpenAiService
- deleteAssistant(String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants/{assistant_id}
- deleteAssistant(String) - Method in class xyz.felh.openai.OpenAiService
-
DELETE https://api.openai.com/v1/assistants/{assistant_id}
- deleteAssistantFile(String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants/{assistant_id}/files/{file_id}
- deleteAssistantFile(String, String) - Method in class xyz.felh.openai.OpenAiService
-
DELETE https://api.openai.com/v1/assistants/{assistant_id}/files/{file_id}
- deleteFile(String) - Method in interface xyz.felh.openai.OpenAiApi
-
Delete file
- deleteFile(String) - Method in class xyz.felh.openai.OpenAiService
- deleteThread(String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}
- deleteThread(String) - Method in class xyz.felh.openai.OpenAiService
-
DELETE https://api.openai.com/v1/threads/{thread_id}
E
- execute(Single<T>) - Static method in class xyz.felh.openai.OpenAiService
-
Calls the Open AI api, returns the response, and parses error messages if the request fails
- ExtractHeaderInterceptor - Class in xyz.felh.openai.interceptor
-
interceptor to get headers from response
- ExtractHeaderInterceptor(Consumer<ResponseHeaders>) - Constructor for class xyz.felh.openai.interceptor.ExtractHeaderInterceptor
G
- getModel(String) - Method in interface xyz.felh.openai.OpenAiApi
-
Retrieve model
- getModel(String) - Method in class xyz.felh.openai.OpenAiService
H
- HEADER_OPENAI_MODEL - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
-
headers' name from response
- HEADER_OPENAI_ORGANIZATION - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
- HEADER_OPENAI_PROCESSING_MS - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
- HEADER_OPENAI_VERSION - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
- HEADER_X_RATELIMIT_LIMIT_REQUESTS - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
-
The maximum number of requests that are permitted before exhausting the rate limit.
- HEADER_X_RATELIMIT_LIMIT_TOKENS - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
-
The maximum number of tokens that are permitted before exhausting the rate limit.
- HEADER_X_RATELIMIT_REMAINING_REQUESTS - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
-
The remaining number of requests that are permitted before exhausting the rate limit.
- HEADER_X_RATELIMIT_REMAINING_TOKENS - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
-
The remaining number of tokens that are permitted before exhausting the rate limit.
- HEADER_X_RATELIMIT_RESET_REQUESTS - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
-
The time until the rate limit (based on requests) resets to its initial state.
- HEADER_X_RATELIMIT_RESET_TOKENS - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
-
The time until the rate limit (based on tokens) resets to its initial state.
- HEADER_X_REQUEST_ID - Static variable in interface xyz.felh.openai.constant.OpenAiConstants
I
- intercept(Interceptor.Chain) - Method in class xyz.felh.openai.interceptor.AuthenticationInterceptor
- intercept(Interceptor.Chain) - Method in class xyz.felh.openai.interceptor.ExtractHeaderInterceptor
L
- listAssistantFiles(String) - Method in class xyz.felh.openai.OpenAiService
- listAssistantFiles(String, Integer, String, String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants/{assistant_id}/files
- listAssistantFiles(String, Integer, String, String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/assistants/{assistant_id}/files
- listAssistants() - Method in class xyz.felh.openai.OpenAiService
- listAssistants(Integer, String, String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants
- listAssistants(Integer, String, String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/assistants
- listFiles() - Method in interface xyz.felh.openai.OpenAiApi
-
List files
- listFiles() - Method in class xyz.felh.openai.OpenAiService
- listFineTuningEvents(String, String, Integer) - Method in interface xyz.felh.openai.OpenAiApi
-
List fine-tuning events
- listFineTuningEvents(String, String, Integer) - Method in class xyz.felh.openai.OpenAiService
-
Get status updates for a fine-tuning job.
- listModels() - Method in interface xyz.felh.openai.OpenAiApi
-
List models
- listModels() - Method in class xyz.felh.openai.OpenAiService
- listThreadMessageFiles(String, String) - Method in class xyz.felh.openai.OpenAiService
- listThreadMessageFiles(String, String, Integer, String, String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files
- listThreadMessageFiles(String, String, Integer, String, String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files
- listThreadMessages(String) - Method in class xyz.felh.openai.OpenAiService
- listThreadMessages(String, Integer, String, String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/messages
- listThreadMessages(String, Integer, String, String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/messages
- listThreadRuns(String) - Method in class xyz.felh.openai.OpenAiService
- listThreadRuns(String, Integer, String, String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/runs
- listThreadRuns(String, Integer, String, String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/runs
- listThreadRunSteps(String, String) - Method in class xyz.felh.openai.OpenAiService
- listThreadRunSteps(String, String, Integer, String, String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps
- listThreadRunSteps(String, String, Integer, String, String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps
M
- modifyAssistant(String, ModifyAssistantRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants/{assistant_id}
- modifyAssistant(String, ModifyAssistantRequest) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/assistants/{assistant_id}
- modifyThread(String, ModifyThreadRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}
- modifyThread(String, ModifyThreadRequest) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}
- modifyThreadMessage(String, String, ModifyMessageRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}
- modifyThreadMessage(String, String, ModifyMessageRequest) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}
- modifyThreadRun(String, String, ModifyRunRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}
- modifyThreadRun(String, String, ModifyRunRequest) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}
O
- onClosed(String) - Method in class xyz.felh.openai.StreamChatCompletionListener
-
No further calls to this listener will be made.
- onEvent(String, ChatCompletion) - Method in class xyz.felh.openai.StreamChatCompletionListener
-
event line
- onEventDone(String) - Method in class xyz.felh.openai.StreamChatCompletionListener
-
event message finished, get payload [DONE]
- onFailure(String, Throwable, Response) - Method in class xyz.felh.openai.StreamChatCompletionListener
-
Invoked when an event source has been closed due to an error reading from or writing to the network.
- onOpen(String, Response) - Method in class xyz.felh.openai.StreamChatCompletionListener
-
Invoked when an event source has been accepted by the remote peer and may begin transmitting events.
- OpenAiApi - Interface in xyz.felh.openai
-
Retrofit2 API interface
- OpenAiConstants - Interface in xyz.felh.openai.constant
-
OpenAI constants
- OpenAiService - Class in xyz.felh.openai
-
OpenAi Service Class
- OpenAiService(String) - Constructor for class xyz.felh.openai.OpenAiService
-
Creates a new OpenAiService that wraps OpenAiApi
- OpenAiService(String, Duration) - Constructor for class xyz.felh.openai.OpenAiService
-
Creates a new OpenAiService that wraps OpenAiApi
- OpenAiService(OpenAiApi, OkHttpClient) - Constructor for class xyz.felh.openai.OpenAiService
-
Creates a new OpenAiService that wraps OpenAiApi.
R
- ResponseHeaders - Class in xyz.felh.openai.bean
- ResponseHeaders() - Constructor for class xyz.felh.openai.bean.ResponseHeaders
- retrieveAssistant(String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants/{assistant_id}
- retrieveAssistant(String) - Method in class xyz.felh.openai.OpenAiService
-
Retrieves an assistant.
- retrieveAssistantFile(String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/assistants/{assistant_id}/files/{file_id}
- retrieveAssistantFile(String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/assistants/{assistant_id}/files/{file_id}
- retrieveFile(String) - Method in interface xyz.felh.openai.OpenAiApi
-
Retrieve file
- retrieveFile(String) - Method in class xyz.felh.openai.OpenAiService
- retrieveFileContent(String) - Method in interface xyz.felh.openai.OpenAiApi
-
Retrieve file content
- retrieveFileContent(String) - Method in class xyz.felh.openai.OpenAiService
- retrieveFineTuningJob(String) - Method in interface xyz.felh.openai.OpenAiApi
-
Retrieve fine-tuning job
- retrieveFineTuningJob(String) - Method in class xyz.felh.openai.OpenAiService
-
Get info about a fine-tuning job.
- retrieveThread(String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}
- retrieveThread(String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}
- retrieveThreadMessage(String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}
- retrieveThreadMessage(String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}
- retrieveThreadMessageFile(String, String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files/{file_id}
- retrieveThreadMessageFile(String, String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/messages/{message_id}/files/{file_id}
- retrieveThreadRun(String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}
- retrieveThreadRun(String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}
- retrieveThreadRunStep(String, String, String) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}
- retrieveThreadRunStep(String, String, String) - Method in class xyz.felh.openai.OpenAiService
-
GET https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/steps/{step_id}
S
- setEventSource(EventSource) - Method in class xyz.felh.openai.StreamChatCompletionListener
- StreamChatCompletionListener - Class in xyz.felh.openai
- StreamChatCompletionListener() - Constructor for class xyz.felh.openai.StreamChatCompletionListener
- submitToolOutputs(String, String, SubmitToolOutputsRequest) - Method in interface xyz.felh.openai.OpenAiApi
-
https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs
- submitToolOutputs(String, String, SubmitToolOutputsRequest) - Method in class xyz.felh.openai.OpenAiService
-
POST https://api.openai.com/v1/threads/{thread_id}/runs/{run_id}/submit_tool_outputs
U
- uploadFile(File, File.Purpose) - Method in class xyz.felh.openai.OpenAiService
- uploadFile(String, File.Purpose) - Method in class xyz.felh.openai.OpenAiService
- uploadFile(MultipartBody.Part, RequestBody) - Method in interface xyz.felh.openai.OpenAiApi
-
Upload file
X
- xyz.felh.openai - package xyz.felh.openai
- xyz.felh.openai.bean - package xyz.felh.openai.bean
- xyz.felh.openai.constant - package xyz.felh.openai.constant
- xyz.felh.openai.interceptor - package xyz.felh.openai.interceptor
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form