643 matches
25 actions
OpenAI
25 actions
- Answers the specified question using the provided documents and examples. The endpoint first [searches](/docs/api-reference/searches) 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 [completion](/docs/api-reference/completions). POSTv1.0.0
- Classifies if text violates OpenAI's Content PolicyPOSTv1.0.0
- Creates a completion for the chat messagePOSTv1.0.0
- Creates a completion for the provided prompt and parametersPOSTv1.0.0
- Creates 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. [Learn more about Fine-tuning](/docs/guides/fine-tuning) POSTv1.0.0
- Creates a new edit for the provided input, instruction, and parameters.POSTv1.0.0
- Creates a variation of a given image.POSTv1.0.0
- Creates an edited or extended image given an original image and a prompt.POSTv1.0.0
- Creates an embedding vector representing the input text.POSTv1.0.0
- Creates an image given a prompt.POSTv1.0.0
- Delete a file.DELETEv1.0.0
- Delete a fine-tuned model. You must have the Owner role in your organization.DELETEv1.0.0
- Get fine-grained status updates for a fine-tune job. GETv1.0.0
- Gets info about the fine-tune job. [Learn more about Fine-tuning](/docs/guides/fine-tuning) GETv1.0.0
- Immediately cancel a fine-tune job. POSTv1.0.0
- List your organization's fine-tuning jobs GETv1.0.0
- Lists the currently available (non-finetuned) models, and provides basic information about each one such as the owner and availability.GETv1.0.0
- Lists the currently available models, and provides basic information about each one such as the owner and availability.GETv1.0.0
- Retrieves a model instance, providing basic information about it such as the owner and availability.GETv1.0.0
- Retrieves a model instance, providing basic information about the model such as the owner and permissioning.GETv1.0.0
- Returns a list of files that belong to the user's organization.GETv1.0.0
- Returns information about a specific file.GETv1.0.0
- The 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 `file` is set, the search endpoint searches over all the documents in the given file and returns up to the `max_rerank` number 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. POSTv1.0.0
- Transcribes audio into the input language.POSTv1.0.0
- Translates audio into into English.POSTv1.0.0
AI & ML/OpenAI
Creates a completion for the provided prompt and parameters
v1.0.0Input
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
{
"type": "object",
"required": [
"model"
],
"properties": {
"best_of": {
"type": "integer",
"description": "Generates `best_of` completions server-side and returns the \"best\" (the one with the highest log probability per token). Results cannot be streamed.\n\nWhen used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n"
},
"echo": {
"type": "boolean",
"description": "Echo back the prompt in addition to the completion\n"
},
"frequency_penalty": {
"type": "number",
"description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim.\n\n[See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)\n"
},
"logit_bias": {
"type": "object",
"description": "Modify the likelihood of specified tokens appearing in the completion.\n\nAccepts a json object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. You can use this [tokenizer tool](/tokenizer?view=bpe) (which works for both GPT-2 and GPT-3) to convert text to token IDs. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.\n\nAs an example, you can pass `{\"50256\": -100}` to prevent the <|endoftext|> token from being generated.\n"
},
"logprobs": {
"type": "integer",
"description": "Include the log probabilities on the `logprobs` most likely tokens, as well the chosen tokens. For example, if `logprobs` is 5, the API will return a list of the 5 most likely tokens. The API will always return the `logprob` of the sampled token, so there may be up to `logprobs+1` elements in the response.\n\nThe maximum value for `logprobs` is 5. If you need more than this, please contact us through our [Help center](https://help.openai.com) and describe your use case.\n"
},
"max_tokens": {
"type": "integer",
"description": "The maximum number of [tokens](/tokenizer) to generate in the completion.\n\nThe token count of your prompt plus `max_tokens` cannot exceed the model's context length. Most models have a context length of 2048 tokens (except for the newest models, which support 4096).\n"
},
"model": {
"type": "string",
"description": "ID of the model to use. You can use the [List models](/docs/api-reference/models/list) API to see all of your available models, or see our [Model overview](/docs/models/overview) for descriptions of them."
},
"n": {
"type": "integer",
"description": "How many completions to generate for each prompt.\n\n**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`.\n"
},
"presence_penalty": {
"type": "number",
"description": "Number between -2.0 and 2.0. Positive values penalize new tokens based on whether they appear in the text so far, increasing the model's likelihood to talk about new topics.\n\n[See more information about frequency and presence penalties.](/docs/api-reference/parameter-details)\n"
},
"prompt": {
"description": "The prompt(s) to generate completions for, encoded as a string, array of strings, array of tokens, or array of token arrays.\n\nNote that <|endoftext|> is the document separator that the model sees during training, so if a prompt is not specified the model will generate as if from the beginning of a new document.\n",
"type": "object"
},
"stop": {
"description": "Up to 4 sequences where the API will stop generating further tokens. The returned text will not contain the stop sequence.\n",
"type": "object"
},
"stream": {
"type": "boolean",
"description": "Whether to stream back partial progress. If set, tokens will be sent as data-only [server-sent events](https://developer.mozilla.org/en-US/docs/Web/API/Server-sent_events/Using_server-sent_events#Event_stream_format) as they become available, with the stream terminated by a `data: [DONE]` message.\n"
},
"suffix": {
"type": "string",
"description": "The suffix that comes after a completion of inserted text."
},
"temperature": {
"type": "number",
"description": "What sampling temperature to use, between 0 and 2. Higher values like 0.8 will make the output more random, while lower values like 0.2 will make it more focused and deterministic.\n\nWe generally recommend altering this or `top_p` but not both.\n"
},
"top_p": {
"type": "number",
"description": "An alternative to sampling with temperature, called nucleus sampling, where the model considers the results of the tokens with top_p probability mass. So 0.1 means only the tokens comprising the top 10% probability mass are considered.\n\nWe generally recommend altering this or `temperature` but not both.\n"
},
"user": {
"type": "string",
"description": "A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. [Learn more](/docs/guides/safety-best-practices/end-user-ids).\n"
}
}
}Output
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
{
"type": "object",
"required": [
"choices",
"created",
"id",
"model",
"object"
],
"properties": {
"choices": {
"type": "array",
"items": {
"type": "object",
"properties": {
"finish_reason": {
"type": "string"
},
"index": {
"type": "integer"
},
"logprobs": {
"type": "object",
"properties": {
"text_offset": {
"type": "array",
"items": {
"type": "integer"
}
},
"token_logprobs": {
"type": "array",
"items": {
"type": "number"
}
},
"tokens": {
"type": "array",
"items": {
"type": "string"
}
},
"top_logprobs": {
"type": "array",
"items": {
"type": "object"
}
}
}
},
"text": {
"type": "string"
}
}
}
},
"created": {
"type": "integer"
},
"id": {
"type": "string"
},
"model": {
"type": "string"
},
"object": {
"type": "string"
},
"usage": {
"type": "object",
"required": [
"completion_tokens",
"prompt_tokens",
"total_tokens"
],
"properties": {
"completion_tokens": {
"type": "integer"
},
"prompt_tokens": {
"type": "integer"
},
"total_tokens": {
"type": "integer"
}
}
}
}
}