Open Dev Kit Documentation :: Open AI
OpenAI
Classes
- AI Base Options
- AI Token Bias
- AI Completion Options
- AI Chat Message
- AI Result Token Probability
- AI Result Output Log Probability
- AI Result Output
- AI Result
- AI Moderation Input
- AI Moderation Result Category
- AI Moderation Result Object
- AI Moderation Result
Enumerations
- AI Model Completions
- AI Model Image
- AI Model Image Quality
- AI Model Image Style
- AI Model Reasoning Effort
- AI Model Service Tier
- AI Moderation Type
Functions
- Request Completions ( Model AI Model Completions, Options AI Completion Options, Prompts String Array, Number Integer, Suffix String, Echo Boolean ) AI Result*
- Given a prompt, the model will return one or more predicted completions, and can also return the probabilities of alternative tokens at each position. Legacy function for using old base models.
- Request Chat Completions ( Model String, Options AI Completion Options, Messages AI Chat Message Array, Number Integer ) AI Result*
- Given a list of messages describing a conversation, the model will return a response.
- Request Responses ( Model String, Options AI Base Options, Previous Response ID String, Instructions String, Messages AI Chat Message Array ) AI Result*
- Creates a model response. Provide text inputs to generate text or JSON outputs.
- Request Image ( Model AI Model Image, Quality AI Model Image Quality, Style AI Model Image Style, Prompt String, Number Integer, Width Integer, Height Integer, Image Basis Image*, Image Mask Image* ) AI Result*
- Given a prompt and/or an input image, the model will generate a new image at the requested resolution.
- Request Moderation ( Inputs AI Moderation Input Array ) AI Moderation Result*
- Classifies if text and/or image inputs are potentially harmful.
Properties
- AI Models String Array
- OpenAI models
- AI User String
- A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse.
- AI Key Open AI String
- API key for authentication; should only be set on a server in production environments.
If you think anything is missing, please feel free to: submit documentation feedback on this page