A B C D E F G H I L M N O P R S T U V

A

addProperty(ChatFunctionProperty) - Method in class com.theokanning.openai.completion.chat.ChatFunctionDynamic.Builder

addProperty(ChatFunctionProperty) - Method in class com.theokanning.openai.completion.chat.ChatFunctionParameters

allowCreateEngine - Variable in class com.theokanning.openai.model.Permission

allowFineTuning - Variable in class com.theokanning.openai.model.Permission

allowLogProbs - Variable in class com.theokanning.openai.model.Permission

allowSampling - Variable in class com.theokanning.openai.model.Permission

allowSearchIndices - Variable in class com.theokanning.openai.model.Permission

allowView - Variable in class com.theokanning.openai.model.Permission

Annotation - Class in com.theokanning.openai.messages.content

An annotation for a text Message

Annotation() - Constructor for class com.theokanning.openai.messages.content.Annotation

Assistant - Class in com.theokanning.openai.assistants

Assistant() - Constructor for class com.theokanning.openai.assistants.Assistant

AssistantFile - Class in com.theokanning.openai.assistants

AssistantFile() - Constructor for class com.theokanning.openai.assistants.AssistantFile

AssistantFileRequest - Class in com.theokanning.openai.assistants

AssistantFileRequest() - Constructor for class com.theokanning.openai.assistants.AssistantFileRequest

AssistantFunction - Class in com.theokanning.openai.assistants

AssistantFunction() - Constructor for class com.theokanning.openai.assistants.AssistantFunction

AssistantRequest - Class in com.theokanning.openai.assistants

AssistantRequest() - Constructor for class com.theokanning.openai.assistants.AssistantRequest

AssistantSortOrder - Enum in com.theokanning.openai.assistants

AssistantToolsEnum - Enum in com.theokanning.openai.assistants

B

BillingUsage - Class in com.theokanning.openai.billing

Amount consumption information

BillingUsage() - Constructor for class com.theokanning.openai.billing.BillingUsage

build() - Method in class com.theokanning.openai.completion.chat.ChatFunction.Builder

build() - Method in class com.theokanning.openai.completion.chat.ChatFunctionDynamic.Builder

builder() - Static method in class com.theokanning.openai.completion.chat.ChatFunction

Builder() - Constructor for class com.theokanning.openai.completion.chat.ChatFunction.Builder

builder() - Static method in class com.theokanning.openai.completion.chat.ChatFunctionDynamic

Builder() - Constructor for class com.theokanning.openai.completion.chat.ChatFunctionDynamic.Builder

C

categories - Variable in class com.theokanning.openai.moderation.Moderation

Object containing per-category binary content policy violation flags.

categoryScores - Variable in class com.theokanning.openai.moderation.Moderation

Object containing per-category raw scores output by the model, denoting the model's confidence that the input violates the OpenAI's policy for the category.

ChatCompletionChoice - Class in com.theokanning.openai.completion.chat

A chat completion generated by OpenAI

ChatCompletionChoice() - Constructor for class com.theokanning.openai.completion.chat.ChatCompletionChoice

ChatCompletionChunk - Class in com.theokanning.openai.completion.chat

Object containing a response chunk from the chat completions streaming api.

ChatCompletionChunk() - Constructor for class com.theokanning.openai.completion.chat.ChatCompletionChunk

ChatCompletionRequest - Class in com.theokanning.openai.completion.chat

ChatCompletionRequest() - Constructor for class com.theokanning.openai.completion.chat.ChatCompletionRequest

ChatCompletionRequest.ChatCompletionRequestFunctionCall - Class in com.theokanning.openai.completion.chat

ChatCompletionRequestFunctionCall() - Constructor for class com.theokanning.openai.completion.chat.ChatCompletionRequest.ChatCompletionRequestFunctionCall

ChatCompletionResult - Class in com.theokanning.openai.completion.chat

Object containing a response from the chat completions api.

ChatCompletionResult() - Constructor for class com.theokanning.openai.completion.chat.ChatCompletionResult

ChatFunction - Class in com.theokanning.openai.completion.chat

ChatFunction() - Constructor for class com.theokanning.openai.completion.chat.ChatFunction

ChatFunction.Builder - Class in com.theokanning.openai.completion.chat

ChatFunctionCall - Class in com.theokanning.openai.completion.chat

ChatFunctionCall() - Constructor for class com.theokanning.openai.completion.chat.ChatFunctionCall

ChatFunctionDynamic - Class in com.theokanning.openai.completion.chat

ChatFunctionDynamic() - Constructor for class com.theokanning.openai.completion.chat.ChatFunctionDynamic

ChatFunctionDynamic.Builder - Class in com.theokanning.openai.completion.chat

ChatFunctionParameters - Class in com.theokanning.openai.completion.chat

ChatFunctionParameters() - Constructor for class com.theokanning.openai.completion.chat.ChatFunctionParameters

ChatFunctionProperty - Class in com.theokanning.openai.completion.chat

ChatFunctionProperty() - Constructor for class com.theokanning.openai.completion.chat.ChatFunctionProperty

ChatMessage - Class in com.theokanning.openai.completion.chat

Each object has a role (either "system", "user", or "assistant") and content (the content of the message).

ChatMessage(String, String) - Constructor for class com.theokanning.openai.completion.chat.ChatMessage

ChatMessage(String, String, String) - Constructor for class com.theokanning.openai.completion.chat.ChatMessage

ChatMessageRole - Enum in com.theokanning.openai.completion.chat

see ChatMessage documentation.

choices - Variable in class com.theokanning.openai.edit.EditResult

A list of generated edits.

code - Variable in exception com.theokanning.openai.OpenAiHttpException

OpenAI error code, for example "invalid_api_key"

com.theokanning.openai - package com.theokanning.openai

com.theokanning.openai.assistants - package com.theokanning.openai.assistants

com.theokanning.openai.audio - package com.theokanning.openai.audio

com.theokanning.openai.billing - package com.theokanning.openai.billing

com.theokanning.openai.common - package com.theokanning.openai.common

com.theokanning.openai.completion - package com.theokanning.openai.completion

com.theokanning.openai.completion.chat - package com.theokanning.openai.completion.chat

com.theokanning.openai.edit - package com.theokanning.openai.edit

com.theokanning.openai.embedding - package com.theokanning.openai.embedding

com.theokanning.openai.engine - package com.theokanning.openai.engine

com.theokanning.openai.file - package com.theokanning.openai.file

com.theokanning.openai.fine_tuning - package com.theokanning.openai.fine_tuning

com.theokanning.openai.finetune - package com.theokanning.openai.finetune

com.theokanning.openai.image - package com.theokanning.openai.image

com.theokanning.openai.messages - package com.theokanning.openai.messages

com.theokanning.openai.messages.content - package com.theokanning.openai.messages.content

com.theokanning.openai.model - package com.theokanning.openai.model

com.theokanning.openai.moderation - package com.theokanning.openai.moderation

com.theokanning.openai.runs - package com.theokanning.openai.runs

com.theokanning.openai.threads - package com.theokanning.openai.threads

com.theokanning.openai.utils - package com.theokanning.openai.utils

CompletionChoice - Class in com.theokanning.openai.completion

A completion generated by OpenAI https://beta.openai.com/docs/api-reference/completions/create

CompletionChoice() - Constructor for class com.theokanning.openai.completion.CompletionChoice

CompletionChunk - Class in com.theokanning.openai.completion

Object containing a response chunk from the completions streaming api.

CompletionChunk() - Constructor for class com.theokanning.openai.completion.CompletionChunk

CompletionRequest - Class in com.theokanning.openai.completion

A request for OpenAi to generate a predicted completion for a prompt.

CompletionRequest() - Constructor for class com.theokanning.openai.completion.CompletionRequest

CompletionResult - Class in com.theokanning.openai.completion

An object containing a response from the completion api https://beta.openai.com/docs/api-reference/completions/create

CompletionResult() - Constructor for class com.theokanning.openai.completion.CompletionResult

created - Variable in class com.theokanning.openai.edit.EditResult

The creation time in epoch milliseconds.

created - Variable in class com.theokanning.openai.model.Permission

The creation time in epoch seconds.

CreateImageEditRequest - Class in com.theokanning.openai.image

A request for OpenAi to edit an image based on a prompt All fields except prompt are optional https://beta.openai.com/docs/api-reference/images/create-edit

CreateImageEditRequest() - Constructor for class com.theokanning.openai.image.CreateImageEditRequest

CreateImageRequest - Class in com.theokanning.openai.image

A request for OpenAi to create an image based on a prompt All fields except prompt are optional https://beta.openai.com/docs/api-reference/images/create

CreateImageRequest() - Constructor for class com.theokanning.openai.image.CreateImageRequest

CreateImageVariationRequest - Class in com.theokanning.openai.image

A request for OpenAi to create a variation of an image All fields are optional https://beta.openai.com/docs/api-reference/images/create-variation

CreateImageVariationRequest() - Constructor for class com.theokanning.openai.image.CreateImageVariationRequest

CreateSpeechRequest - Class in com.theokanning.openai.audio

CreateSpeechRequest() - Constructor for class com.theokanning.openai.audio.CreateSpeechRequest

CreateThreadAndRunRequest - Class in com.theokanning.openai.runs

CreateThreadAndRunRequest() - Constructor for class com.theokanning.openai.runs.CreateThreadAndRunRequest

CreateTranscriptionRequest - Class in com.theokanning.openai.audio

A request for OpenAi to create transcription based on an audio file All fields except model are optional https://platform.openai.com/docs/api-reference/audio/create

CreateTranscriptionRequest() - Constructor for class com.theokanning.openai.audio.CreateTranscriptionRequest

CreateTranslationRequest - Class in com.theokanning.openai.audio

A request for OpenAi to create English translation based on an audio file All fields except model are optional https://platform.openai.com/docs/api-reference/audio/create

CreateTranslationRequest() - Constructor for class com.theokanning.openai.audio.CreateTranslationRequest

CreditGrantsResponse - Class in com.theokanning.openai.billing

Return value of balance inquiry interface

CreditGrantsResponse() - Constructor for class com.theokanning.openai.billing.CreditGrantsResponse

D

DailyCost - Class in com.theokanning.openai.billing

List of amount consumption

DailyCost() - Constructor for class com.theokanning.openai.billing.DailyCost

data - Variable in class com.theokanning.openai.OpenAiResponse

A list containing the actual results

Datum - Class in com.theokanning.openai.billing

Datum() - Constructor for class com.theokanning.openai.billing.Datum

decode(Encoding, List<Integer>) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Reverse calculate text information through Encoding and encoded array

decode(EncodingType, List<Integer>) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Reverse the encoded array to get the string text using EncodingType and the encoded array.

decode(String, List<Integer>) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Reverse the string text through the model name and the encoded array.

DeleteResult - Class in com.theokanning.openai

A response when deleting an object

DeleteResult() - Constructor for class com.theokanning.openai.DeleteResult

description(String) - Method in class com.theokanning.openai.completion.chat.ChatFunction.Builder

description(String) - Method in class com.theokanning.openai.completion.chat.ChatFunctionDynamic.Builder

E

EditChoice - Class in com.theokanning.openai.edit

An edit generated by OpenAi https://beta.openai.com/docs/api-reference/edits/create

EditChoice() - Constructor for class com.theokanning.openai.edit.EditChoice

EditRequest - Class in com.theokanning.openai.edit

Given a prompt and an instruction, OpenAi will return an edited version of the prompt https://beta.openai.com/docs/api-reference/edits/create

EditRequest() - Constructor for class com.theokanning.openai.edit.EditRequest

EditResult - Class in com.theokanning.openai.edit

A list of edits generated by OpenAI https://beta.openai.com/docs/api-reference/edits/create

EditResult() - Constructor for class com.theokanning.openai.edit.EditResult

EditUsage - Class in com.theokanning.openai.edit

Deprecated.

EditUsage() - Constructor for class com.theokanning.openai.edit.EditUsage

Deprecated.

Embedding - Class in com.theokanning.openai.embedding

Represents an embedding returned by the embedding api https://beta.openai.com/docs/api-reference/classifications/create

Embedding() - Constructor for class com.theokanning.openai.embedding.Embedding

EmbeddingRequest - Class in com.theokanning.openai.embedding

Creates an embedding vector representing the input text.

EmbeddingRequest() - Constructor for class com.theokanning.openai.embedding.EmbeddingRequest

EmbeddingResult - Class in com.theokanning.openai.embedding

An object containing a response from the answer api https://beta.openai.com/docs/api-reference/embeddings/create

EmbeddingResult() - Constructor for class com.theokanning.openai.embedding.EmbeddingResult

encode(Encoding, String) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Get encoding array through Encoding and text.

encode(EncodingType, String) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Obtain the encoding array by encoding;

encode(String, String) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Get the encoded array by model name using encode.

Engine - Class in com.theokanning.openai.engine

Deprecated.

Engine() - Constructor for class com.theokanning.openai.engine.Engine

Deprecated.

error - Variable in class com.theokanning.openai.OpenAiError

executor(Class<T>, Function<T, Object>) - Method in class com.theokanning.openai.completion.chat.ChatFunction.Builder

F

File - Class in com.theokanning.openai.file

A file uploaded to OpenAi https://beta.openai.com/docs/api-reference/files

File() - Constructor for class com.theokanning.openai.file.File

FileCitation - Class in com.theokanning.openai.messages.content

A citation within the message that points to a specific quote from a specific File associated with the assistant or the message.

FileCitation() - Constructor for class com.theokanning.openai.messages.content.FileCitation

FilePath - Class in com.theokanning.openai.messages.content

A URL for the file that's generated when the assistant used the code_interpreter tool to generate a file.

FilePath() - Constructor for class com.theokanning.openai.messages.content.FilePath

FineTuneEvent - Class in com.theokanning.openai.finetune

Deprecated.

FineTuneEvent() - Constructor for class com.theokanning.openai.finetune.FineTuneEvent

Deprecated.

FineTuneRequest - Class in com.theokanning.openai.finetune

Deprecated.

FineTuneRequest() - Constructor for class com.theokanning.openai.finetune.FineTuneRequest

Deprecated.

FineTuneResult - Class in com.theokanning.openai.finetune

Deprecated.

FineTuneResult() - Constructor for class com.theokanning.openai.finetune.FineTuneResult

Deprecated.

FineTuningEvent - Class in com.theokanning.openai.fine_tuning

An object representing an event in the lifecycle of a fine-tuning job https://platform.openai.com/docs/api-reference/fine-tuning/list-events

FineTuningEvent() - Constructor for class com.theokanning.openai.fine_tuning.FineTuningEvent

FineTuningJob - Class in com.theokanning.openai.fine_tuning

Fine-tuning job https://platform.openai.com/docs/api-reference/fine-tuning/object

FineTuningJob() - Constructor for class com.theokanning.openai.fine_tuning.FineTuningJob

FineTuningJobRequest - Class in com.theokanning.openai.fine_tuning

Request to create a fine tuning job https://platform.openai.com/docs/api-reference/fine-tuning/create

FineTuningJobRequest() - Constructor for class com.theokanning.openai.fine_tuning.FineTuningJobRequest

firstId - Variable in class com.theokanning.openai.OpenAiResponse

The first id included

flagged - Variable in class com.theokanning.openai.moderation.Moderation

Set to true if the model classifies the content as violating OpenAI's content policy, false otherwise

G

getEncoding(EncodingType) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Get an Encoding object by Encoding type

getEncoding(String) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Get an Encoding object by model name.

getModelTypeByName(String) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Obtain the modelType.

Grants - Class in com.theokanning.openai.billing

Grants() - Constructor for class com.theokanning.openai.billing.Grants

group - Variable in class com.theokanning.openai.model.Permission

H

hasMore - Variable in class com.theokanning.openai.OpenAiResponse

True if there are objects after lastId

hate - Variable in class com.theokanning.openai.moderation.ModerationCategories

hate - Variable in class com.theokanning.openai.moderation.ModerationCategoryScores

hateThreatening - Variable in class com.theokanning.openai.moderation.ModerationCategories

hateThreatening - Variable in class com.theokanning.openai.moderation.ModerationCategoryScores

Hyperparameters - Class in com.theokanning.openai.fine_tuning

Hyperparameters for a fine-tuning job https://platform.openai.com/docs/api-reference/fine-tuning/object#hyperparameters

Hyperparameters() - Constructor for class com.theokanning.openai.fine_tuning.Hyperparameters

HyperParameters - Class in com.theokanning.openai.finetune

Deprecated.

HyperParameters() - Constructor for class com.theokanning.openai.finetune.HyperParameters

Deprecated.

I

id - Variable in class com.theokanning.openai.engine.Engine

Deprecated.

An identifier for this engine, used to specify an engine for completions or searching.

id - Variable in class com.theokanning.openai.model.Model

An identifier for this model, used to specify the model when making completions, etc

id - Variable in class com.theokanning.openai.model.Permission

An identifier for this model permission

id - Variable in class com.theokanning.openai.moderation.ModerationResult

A unique id assigned to this moderation.

Image - Class in com.theokanning.openai.image

An object containing either a URL or a base 64 encoded image.

Image() - Constructor for class com.theokanning.openai.image.Image

ImageFile - Class in com.theokanning.openai.messages.content

References an image File int eh content of a message.

ImageFile() - Constructor for class com.theokanning.openai.messages.content.ImageFile

ImageResult - Class in com.theokanning.openai.image

An object with a list of image results.

ImageResult() - Constructor for class com.theokanning.openai.image.ImageResult

isBlank(CharSequence) - Static method in class com.theokanning.openai.utils.TikTokensUtil

isBlankChar(int) - Static method in class com.theokanning.openai.utils.TikTokensUtil

isBlankChar(char) - Static method in class com.theokanning.openai.utils.TikTokensUtil

isBlocking - Variable in class com.theokanning.openai.model.Permission

isNotBlank(CharSequence) - Static method in class com.theokanning.openai.utils.TikTokensUtil

L

LastError - Class in com.theokanning.openai.common

LastError() - Constructor for class com.theokanning.openai.common.LastError

lastId - Variable in class com.theokanning.openai.OpenAiResponse

The last id included

LineItem - Class in com.theokanning.openai.billing

List of amount consumption

LineItem() - Constructor for class com.theokanning.openai.billing.LineItem

ListSearchParameters - Class in com.theokanning.openai

Common options when getting a list of objects

ListSearchParameters() - Constructor for class com.theokanning.openai.ListSearchParameters

ListSearchParameters.Order - Enum in com.theokanning.openai

LogProbResult - Class in com.theokanning.openai.completion

Log probabilities of different token options Returned if CompletionRequest.logprobs is greater than zero https://beta.openai.com/docs/api-reference/create-completion

LogProbResult() - Constructor for class com.theokanning.openai.completion.LogProbResult

M

Message - Class in com.theokanning.openai.messages

Represents a Message within a thread.

Message() - Constructor for class com.theokanning.openai.messages.Message

MessageContent - Class in com.theokanning.openai.messages

Represents the content of a message

MessageContent() - Constructor for class com.theokanning.openai.messages.MessageContent

MessageCreation - Class in com.theokanning.openai.runs

MessageCreation() - Constructor for class com.theokanning.openai.runs.MessageCreation

MessageFile - Class in com.theokanning.openai.messages

A list of files attached to a Message

MessageFile() - Constructor for class com.theokanning.openai.messages.MessageFile

MessageRequest - Class in com.theokanning.openai.messages

Creates a Message

MessageRequest() - Constructor for class com.theokanning.openai.messages.MessageRequest

Model - Class in com.theokanning.openai.model

GPT model details https://beta.openai.com/docs/api-reference/models

Model() - Constructor for class com.theokanning.openai.model.Model

model - Variable in class com.theokanning.openai.moderation.ModerationResult

The model used.

Moderation - Class in com.theokanning.openai.moderation

An object containing the moderation data for a single input string https://beta.openai.com/docs/api-reference/moderations/create

Moderation() - Constructor for class com.theokanning.openai.moderation.Moderation

ModerationCategories - Class in com.theokanning.openai.moderation

An object containing the flags for each moderation category https://beta.openai.com/docs/api-reference/moderations/create

ModerationCategories() - Constructor for class com.theokanning.openai.moderation.ModerationCategories

ModerationCategoryScores - Class in com.theokanning.openai.moderation

An object containing the scores for each moderation category https://beta.openai.com/docs/api-reference/moderations/create

ModerationCategoryScores() - Constructor for class com.theokanning.openai.moderation.ModerationCategoryScores

ModerationRequest - Class in com.theokanning.openai.moderation

A request for OpenAi to detect if text violates OpenAi's content policy.

ModerationRequest() - Constructor for class com.theokanning.openai.moderation.ModerationRequest

ModerationResult - Class in com.theokanning.openai.moderation

An object containing a response from the moderation api https://beta.openai.com/docs/api-reference/moderations/create

ModerationResult() - Constructor for class com.theokanning.openai.moderation.ModerationResult

ModifyAssistantRequest - Class in com.theokanning.openai.assistants

ModifyAssistantRequest() - Constructor for class com.theokanning.openai.assistants.ModifyAssistantRequest

ModifyMessageRequest - Class in com.theokanning.openai.messages

Modifies a Message

ModifyMessageRequest() - Constructor for class com.theokanning.openai.messages.ModifyMessageRequest

N

name(String) - Method in class com.theokanning.openai.completion.chat.ChatFunction.Builder

name(String) - Method in class com.theokanning.openai.completion.chat.ChatFunctionDynamic.Builder

O

object - Variable in class com.theokanning.openai.edit.EditResult

The type of object returned, should be "edit"

object - Variable in class com.theokanning.openai.engine.Engine

Deprecated.

The type of object returned, should be "engine"

object - Variable in class com.theokanning.openai.model.Model

The type of object returned, should be "model"

object - Variable in class com.theokanning.openai.model.Permission

The type of object returned, should be "model_permission"

object - Variable in class com.theokanning.openai.OpenAiResponse

The type of object returned, should be "list"

of(String) - Static method in class com.theokanning.openai.completion.chat.ChatCompletionRequest.ChatCompletionRequestFunctionCall

OpenAiError - Class in com.theokanning.openai

Represents the error body when an OpenAI request fails

OpenAiError() - Constructor for class com.theokanning.openai.OpenAiError

OpenAiError.OpenAiErrorDetails - Class in com.theokanning.openai

OpenAiErrorDetails() - Constructor for class com.theokanning.openai.OpenAiError.OpenAiErrorDetails

OpenAiHttpException - Exception in com.theokanning.openai

OpenAiHttpException(OpenAiError, Exception, int) - Constructor for exception com.theokanning.openai.OpenAiHttpException

OpenAiResponse<T> - Class in com.theokanning.openai

A wrapper class to fit the OpenAI engine and search endpoints

OpenAiResponse() - Constructor for class com.theokanning.openai.OpenAiResponse

organization - Variable in class com.theokanning.openai.model.Permission

ownedBy - Variable in class com.theokanning.openai.model.Model

The owner of the model, typically "openai"

owner - Variable in class com.theokanning.openai.engine.Engine

Deprecated.

The owner of the GPT-3 engine, typically "openai"

P

param - Variable in exception com.theokanning.openai.OpenAiHttpException

parameters(ChatFunctionParameters) - Method in class com.theokanning.openai.completion.chat.ChatFunctionDynamic.Builder

parent - Variable in class com.theokanning.openai.model.Model

The parent model that this is based on

permission - Variable in class com.theokanning.openai.model.Model

Deprecated.

Permission - Class in com.theokanning.openai.model

Model permissions I couldn't find documentation for the specific permissions, and I've elected to leave them undocumented rather than write something incorrect.

Permission() - Constructor for class com.theokanning.openai.model.Permission

Plan - Class in com.theokanning.openai.billing

Plan() - Constructor for class com.theokanning.openai.billing.Plan

R

ready - Variable in class com.theokanning.openai.engine.Engine

Deprecated.

Whether the engine is ready to process requests or not

RequiredAction - Class in com.theokanning.openai.runs

RequiredAction() - Constructor for class com.theokanning.openai.runs.RequiredAction

results - Variable in class com.theokanning.openai.moderation.ModerationResult

A list of moderation scores.

root - Variable in class com.theokanning.openai.model.Model

The root model that this and its parent (if applicable) are based on

Run - Class in com.theokanning.openai.runs

Run() - Constructor for class com.theokanning.openai.runs.Run

RunCreateRequest - Class in com.theokanning.openai.runs

RunCreateRequest() - Constructor for class com.theokanning.openai.runs.RunCreateRequest

RunImage - Class in com.theokanning.openai.runs

RunImage() - Constructor for class com.theokanning.openai.runs.RunImage

RunStep - Class in com.theokanning.openai.runs

RunStep() - Constructor for class com.theokanning.openai.runs.RunStep

S

selfHarm - Variable in class com.theokanning.openai.moderation.ModerationCategories

selfHarm - Variable in class com.theokanning.openai.moderation.ModerationCategoryScores

sexual - Variable in class com.theokanning.openai.moderation.ModerationCategories

sexual - Variable in class com.theokanning.openai.moderation.ModerationCategoryScores

sexualMinors - Variable in class com.theokanning.openai.moderation.ModerationCategories

sexualMinors - Variable in class com.theokanning.openai.moderation.ModerationCategoryScores

statusCode - Variable in exception com.theokanning.openai.OpenAiHttpException

HTTP status code

StepDetails - Class in com.theokanning.openai.runs

StepDetails() - Constructor for class com.theokanning.openai.runs.StepDetails

SubmitToolOutputRequestItem - Class in com.theokanning.openai.runs

SubmitToolOutputRequestItem() - Constructor for class com.theokanning.openai.runs.SubmitToolOutputRequestItem

SubmitToolOutputs - Class in com.theokanning.openai.runs

SubmitToolOutputs() - Constructor for class com.theokanning.openai.runs.SubmitToolOutputs

SubmitToolOutputsRequest - Class in com.theokanning.openai.runs

SubmitToolOutputsRequest() - Constructor for class com.theokanning.openai.runs.SubmitToolOutputsRequest

Subscription - Class in com.theokanning.openai.billing

Account information

Subscription() - Constructor for class com.theokanning.openai.billing.Subscription

T

Text - Class in com.theokanning.openai.messages.content

The text content that is part of a message

Text() - Constructor for class com.theokanning.openai.messages.content.Text

Thread - Class in com.theokanning.openai.threads

Represents a Thread with an assistant

Thread() - Constructor for class com.theokanning.openai.threads.Thread

ThreadRequest - Class in com.theokanning.openai.threads

Creates a thread

ThreadRequest() - Constructor for class com.theokanning.openai.threads.ThreadRequest

TikTokensUtil - Class in com.theokanning.openai.utils

Token calculation tool class

TikTokensUtil() - Constructor for class com.theokanning.openai.utils.TikTokensUtil

TikTokensUtil.ModelEnum - Enum in com.theokanning.openai.utils

tokens(Encoding, String) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Calculate tokens of text information through Encoding.

tokens(EncodingType, String) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Compute the tokens of the specified string through EncodingType.

tokens(String, String) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Calculate the tokens of a specified string by model name.

tokens(String, List<ChatMessage>) - Static method in class com.theokanning.openai.utils.TikTokensUtil

Calculate the encoded array for messages by model name.

Tool - Class in com.theokanning.openai.assistants

Tool() - Constructor for class com.theokanning.openai.assistants.Tool

ToolCall - Class in com.theokanning.openai.runs

ToolCall() - Constructor for class com.theokanning.openai.runs.ToolCall

ToolCallCodeInterpreter - Class in com.theokanning.openai.runs

ToolCallCodeInterpreter() - Constructor for class com.theokanning.openai.runs.ToolCallCodeInterpreter

ToolCallCodeInterpreterOutput - Class in com.theokanning.openai.runs

ToolCallCodeInterpreterOutput() - Constructor for class com.theokanning.openai.runs.ToolCallCodeInterpreterOutput

ToolCallFunction - Class in com.theokanning.openai.runs

ToolCallFunction() - Constructor for class com.theokanning.openai.runs.ToolCallFunction

TranscriptionResult - Class in com.theokanning.openai.audio

An object with the text transcription https://platform.openai.com/docs/api-reference/audio/create

TranscriptionResult() - Constructor for class com.theokanning.openai.audio.TranscriptionResult

TranscriptionSegment - Class in com.theokanning.openai.audio

An object represents transcription segment https://platform.openai.com/docs/api-reference/audio/create

TranscriptionSegment() - Constructor for class com.theokanning.openai.audio.TranscriptionSegment

TranslationResult - Class in com.theokanning.openai.audio

An object with the English transcription https://platform.openai.com/docs/api-reference/audio/create

TranslationResult() - Constructor for class com.theokanning.openai.audio.TranslationResult

type - Variable in exception com.theokanning.openai.OpenAiHttpException

OpenAI error type, for example "invalid_request_error" https://platform.openai.com/docs/guides/error-codes/python-library-error-types

U

usage - Variable in class com.theokanning.openai.edit.EditResult

The API usage for this request

Usage - Class in com.theokanning.openai

The OpenAI resources used by a request

Usage() - Constructor for class com.theokanning.openai.Usage

V

value() - Method in enum com.theokanning.openai.completion.chat.ChatMessageRole

valueOf(String) - Static method in enum com.theokanning.openai.assistants.AssistantSortOrder

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.theokanning.openai.assistants.AssistantToolsEnum

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.theokanning.openai.completion.chat.ChatMessageRole

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.theokanning.openai.ListSearchParameters.Order

Returns the enum constant of this type with the specified name.

valueOf(String) - Static method in enum com.theokanning.openai.utils.TikTokensUtil.ModelEnum

Returns the enum constant of this type with the specified name.

values() - Static method in enum com.theokanning.openai.assistants.AssistantSortOrder

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.theokanning.openai.assistants.AssistantToolsEnum

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.theokanning.openai.completion.chat.ChatMessageRole

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.theokanning.openai.ListSearchParameters.Order

Returns an array containing the constants of this enum type, in the order they are declared.

values() - Static method in enum com.theokanning.openai.utils.TikTokensUtil.ModelEnum

Returns an array containing the constants of this enum type, in the order they are declared.

violence - Variable in class com.theokanning.openai.moderation.ModerationCategories

violence - Variable in class com.theokanning.openai.moderation.ModerationCategoryScores

violenceGraphic - Variable in class com.theokanning.openai.moderation.ModerationCategories

violenceGraphic - Variable in class com.theokanning.openai.moderation.ModerationCategoryScores

A B C D E F G H I L M N O P R S T U V