Index (api 0.12.0 API)

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

A

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

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
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
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() - 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.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.finetune - package com.theokanning.openai.finetune
com.theokanning.openai.image - package com.theokanning.openai.image
com.theokanning.openai.model - package com.theokanning.openai.model
com.theokanning.openai.moderation - package com.theokanning.openai.moderation
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

D

data - Variable in class com.theokanning.openai.OpenAiResponse: A list containing the actual results
DeleteResult - Class in com.theokanning.openai: A response when deleting an object
DeleteResult() - Constructor for class com.theokanning.openai.DeleteResult

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
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

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
FineTuneEvent - Class in com.theokanning.openai.finetune: An object representing an event in the lifecycle of a fine-tuning job https://beta.openai.com/docs/api-reference/fine-tunes
FineTuneEvent() - Constructor for class com.theokanning.openai.finetune.FineTuneEvent
FineTuneRequest - Class in com.theokanning.openai.finetune: A request for OpenAi to create a fine-tuned model All fields except trainingFile are nullable.
FineTuneRequest() - Constructor for class com.theokanning.openai.finetune.FineTuneRequest
FineTuneResult - Class in com.theokanning.openai.finetune: An object describing a fine-tuned model.
FineTuneResult() - Constructor for class com.theokanning.openai.finetune.FineTuneResult
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

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

H

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.finetune: Fine-tuning job hyperparameters https://beta.openai.com/docs/api-reference/fine-tunes
HyperParameters() - Constructor for class com.theokanning.openai.finetune.HyperParameters

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
ImageResult - Class in com.theokanning.openai.image: An object with a list of image results.
ImageResult() - Constructor for class com.theokanning.openai.image.ImageResult
isBlocking - Variable in class com.theokanning.openai.model.Permission

L

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

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

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"
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
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: List of permissions for this model
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

R

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

Whether the engine is ready to process requests or not
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

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

T

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.completion.chat.ChatMessageRole: Returns the enum constant of this type with the specified name.
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.
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 C D E F G H I L M O P R S T U V