OpenAI API
APIs for sampling from and fine-tuning language models
- Homepage
- https://api.apis.guru/v2/specs/openai.com/1.2.0.json
- Provider
- openai.com
- OpenAPI version
- 3.0.0
- Spec (JSON)
- https://api.apis.guru/v2/specs/openai.com/1.2.0/openapi.json
- Spec (YAML)
- https://api.apis.guru/v2/specs/openai.com/1.2.0/openapi.yaml
Tools (30)
Extracted live via the executor SDK.
-
openAi.cancelFineTuneImmediately cancel a fine-tune job.
-
openAi.createAnswerAnswers the specified question using the provided documents and examples.
The endpoint first over provided documents or files to find relevant context. The relevant context is combined with the provided examples and question to create the prompt for .
-
openAi.createChatCompletionCreates a completion for the chat message
-
openAi.createClassificationClassifies the specified
queryusing provided examples.The endpoint first over the labeled examples to select the ones most relevant for the particular query. Then, the relevant examples are combined with the query to construct a prompt to produce the final label via the endpoint.
Labeled examples can be provided via an uploaded
file, or explicitly listed in the request using theexamplesparameter for quick tests and small scale use cases. -
openAi.createCompletionCreates a completion for the provided prompt and parameters
-
openAi.createEditCreates a new edit for the provided input, instruction, and parameters.
-
openAi.createEmbeddingCreates an embedding vector representing the input text.
-
openAi.createFileUpload 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.
-
openAi.createFineTuneCreates 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.
-
openAi.createImageCreates an image given a prompt.
-
openAi.createImageEditCreates an edited or extended image given an original image and a prompt.
-
openAi.createImageVariationCreates a variation of a given image.
-
openAi.createModerationClassifies if text violates OpenAI's Content Policy
-
openAi.createSearchThe search endpoint computes similarity scores between provided query and documents. Documents can be passed directly to the API if there are no more than 200 of them.
To go beyond the 200 document limit, documents can be processed offline and then used for efficient retrieval at query time. When
fileis set, the search endpoint searches over all the documents in the given file and returns up to themax_reranknumber of documents. These documents will be returned along with their search scores.The similarity score is a positive score that usually ranges from 0 to 300 (but can sometimes go higher), where a score above 200 usually means the document is semantically similar to the query.
-
openAi.createTranscriptionTranscribes audio into the input language.
-
openAi.createTranslationTranslates audio into into English.
-
openAi.deleteFileDelete a file.
-
openAi.deleteModelDelete a fine-tuned model. You must have the Owner role in your organization.
-
openAi.downloadFileReturns the contents of the specified file
-
openAi.listEnginesLists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availability.
-
openAi.listFilesReturns a list of files that belong to the user's organization.
-
openAi.listFineTuneEventsGet fine-grained status updates for a fine-tune job.
-
openAi.listFineTunesList your organization's fine-tuning jobs
-
openAi.listModelsLists the currently available models, and provides basic information about each one such as the owner and availability.
-
openAi.retrieveEngineRetrieves a model instance, providing basic information about it such as the owner and availability.
-
openAi.retrieveFileReturns information about a specific file.
-
openAi.retrieveFineTuneGets info about the fine-tune job.
-
openAi.retrieveModelRetrieves a model instance, providing basic information about the model such as the owner and permissioning.
-
openapi.previewSpecPreview an OpenAPI document before adding it as a source
-
openapi.addSourceAdd an OpenAPI source and register its operations as tools