UNPKG

openai

Version:

The official TypeScript library for the OpenAI API

1,774 lines (1,773 loc) 34.3 kB
{ "pkg": "openai", "githubRepo": "https://github.com/openai/openai-node", "clientClass": "OpenAI", "methods": [ { "base": "chat.completions", "name": "delete", "oldName": "del" }, { "base": "chat.completions", "name": "stream", "oldBase": "beta.chat.completions" }, { "base": "chat.completions", "name": "parse", "oldBase": "beta.chat.completions" }, { "base": "chat.completions", "name": "runTools", "oldBase": "beta.chat.completions" }, { "base": "files", "name": "delete", "oldName": "del" }, { "base": "models", "name": "delete", "oldName": "del" }, { "base": "fineTuning.checkpoints.permissions", "name": "delete", "params": [ { "type": "param", "key": "permission_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldName": "del", "oldParams": [ { "type": "param", "key": "fine_tuned_model_checkpoint", "location": "path" }, { "type": "param", "key": "permission_id", "location": "path" }, { "type": "options" } ] }, { "base": "vectorStores", "name": "delete", "oldName": "del" }, { "base": "vectorStores.files", "name": "retrieve", "params": [ { "type": "param", "key": "file_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "vector_store_id", "location": "path" }, { "type": "param", "key": "file_id", "location": "path" }, { "type": "options" } ] }, { "base": "vectorStores.files", "name": "update", "params": [ { "type": "param", "key": "file_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "vector_store_id", "location": "path" }, { "type": "param", "key": "file_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "vectorStores.files", "name": "delete", "params": [ { "type": "param", "key": "file_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldName": "del", "oldParams": [ { "type": "param", "key": "vector_store_id", "location": "path" }, { "type": "param", "key": "file_id", "location": "path" }, { "type": "options" } ] }, { "base": "vectorStores.files", "name": "content", "params": [ { "type": "param", "key": "file_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "vector_store_id", "location": "path" }, { "type": "param", "key": "file_id", "location": "path" }, { "type": "options" } ] }, { "base": "vectorStores.fileBatches", "name": "retrieve", "params": [ { "type": "param", "key": "batch_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "vector_store_id", "location": "path" }, { "type": "param", "key": "batch_id", "location": "path" }, { "type": "options" } ] }, { "base": "vectorStores.fileBatches", "name": "cancel", "params": [ { "type": "param", "key": "batch_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "vector_store_id", "location": "path" }, { "type": "param", "key": "batch_id", "location": "path" }, { "type": "options" } ] }, { "base": "vectorStores.fileBatches", "name": "listFiles", "params": [ { "type": "param", "key": "batch_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "vector_store_id", "location": "path" }, { "type": "param", "key": "batch_id", "location": "path" }, { "type": "params", "maybeOverload": true }, { "type": "options" } ] }, { "base": "beta.assistants", "name": "delete", "oldName": "del" }, { "base": "beta.threads", "name": "delete", "oldName": "del" }, { "base": "beta.threads.runs", "name": "retrieve", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "options" } ] }, { "base": "beta.threads.runs", "name": "update", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "beta.threads.runs", "name": "cancel", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "options" } ] }, { "base": "beta.threads.runs", "name": "submitToolOutputs", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "beta.threads.runs.steps", "name": "retrieve", "params": [ { "type": "param", "key": "step_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "param", "key": "step_id", "location": "path" }, { "type": "params", "maybeOverload": true }, { "type": "options" } ] }, { "base": "beta.threads.runs.steps", "name": "list", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": true }, { "type": "options" } ] }, { "base": "beta.threads.messages", "name": "retrieve", "params": [ { "type": "param", "key": "message_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "message_id", "location": "path" }, { "type": "options" } ] }, { "base": "beta.threads.messages", "name": "update", "params": [ { "type": "param", "key": "message_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "message_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "beta.threads.messages", "name": "delete", "params": [ { "type": "param", "key": "message_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldName": "del", "oldParams": [ { "type": "param", "key": "thread_id", "location": "path" }, { "type": "param", "key": "message_id", "location": "path" }, { "type": "options" } ] }, { "base": "responses", "name": "delete", "oldName": "del" }, { "base": "admin.organization.users.roles", "name": "delete", "params": [ { "type": "param", "key": "role_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "user_id", "location": "path" }, { "type": "param", "key": "role_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.groups.users", "name": "delete", "params": [ { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "group_id", "location": "path" }, { "type": "param", "key": "user_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.groups.roles", "name": "delete", "params": [ { "type": "param", "key": "role_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "group_id", "location": "path" }, { "type": "param", "key": "role_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.users", "name": "retrieve", "params": [ { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "user_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.users", "name": "update", "params": [ { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "admin.organization.projects.users", "name": "delete", "params": [ { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "user_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.users.roles", "name": "create", "params": [ { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "admin.organization.projects.users.roles", "name": "list", "params": [ { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "user_id", "location": "path" }, { "type": "params", "maybeOverload": true }, { "type": "options" } ] }, { "base": "admin.organization.projects.users.roles", "name": "delete", "params": [ { "type": "param", "key": "role_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "user_id", "location": "path" }, { "type": "param", "key": "role_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.serviceAccounts", "name": "retrieve", "params": [ { "type": "param", "key": "service_account_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "service_account_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.serviceAccounts", "name": "delete", "params": [ { "type": "param", "key": "service_account_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "service_account_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.apiKeys", "name": "retrieve", "params": [ { "type": "param", "key": "api_key_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "api_key_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.apiKeys", "name": "delete", "params": [ { "type": "param", "key": "api_key_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "api_key_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.rateLimits", "name": "updateRateLimit", "params": [ { "type": "param", "key": "rate_limit_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "rate_limit_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "admin.organization.projects.groups", "name": "delete", "params": [ { "type": "param", "key": "group_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "group_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.groups.roles", "name": "create", "params": [ { "type": "param", "key": "group_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "group_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "admin.organization.projects.groups.roles", "name": "list", "params": [ { "type": "param", "key": "group_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "group_id", "location": "path" }, { "type": "params", "maybeOverload": true }, { "type": "options" } ] }, { "base": "admin.organization.projects.groups.roles", "name": "delete", "params": [ { "type": "param", "key": "role_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "group_id", "location": "path" }, { "type": "param", "key": "role_id", "location": "path" }, { "type": "options" } ] }, { "base": "admin.organization.projects.roles", "name": "update", "params": [ { "type": "param", "key": "role_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "role_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ] }, { "base": "admin.organization.projects.roles", "name": "delete", "params": [ { "type": "param", "key": "role_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "project_id", "location": "path" }, { "type": "param", "key": "role_id", "location": "path" }, { "type": "options" } ] }, { "base": "conversations.items", "name": "retrieve", "params": [ { "type": "param", "key": "item_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "conversation_id", "location": "path" }, { "type": "param", "key": "item_id", "location": "path" }, { "type": "params", "maybeOverload": true }, { "type": "options" } ] }, { "base": "evals", "name": "delete", "oldName": "del" }, { "base": "evals.runs", "name": "retrieve", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "eval_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "options" } ] }, { "base": "evals.runs", "name": "delete", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldName": "del", "oldParams": [ { "type": "param", "key": "eval_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "options" } ] }, { "base": "evals.runs", "name": "cancel", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "eval_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "options" } ] }, { "base": "evals.runs.outputItems", "name": "retrieve", "params": [ { "type": "param", "key": "output_item_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "eval_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "param", "key": "output_item_id", "location": "path" }, { "type": "options" } ] }, { "base": "evals.runs.outputItems", "name": "list", "params": [ { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "eval_id", "location": "path" }, { "type": "param", "key": "run_id", "location": "path" }, { "type": "params", "maybeOverload": true }, { "type": "options" } ] }, { "base": "containers", "name": "delete", "oldName": "del" }, { "base": "containers.files", "name": "retrieve", "params": [ { "type": "param", "key": "file_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "container_id", "location": "path" }, { "type": "param", "key": "file_id", "location": "path" }, { "type": "options" } ] }, { "base": "containers.files", "name": "delete", "params": [ { "type": "param", "key": "file_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldName": "del", "oldParams": [ { "type": "param", "key": "container_id", "location": "path" }, { "type": "param", "key": "file_id", "location": "path" }, { "type": "options" } ] }, { "base": "containers.files.content", "name": "retrieve", "params": [ { "type": "param", "key": "file_id", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "container_id", "location": "path" }, { "type": "param", "key": "file_id", "location": "path" }, { "type": "options" } ] }, { "base": "skills.versions", "name": "retrieve", "params": [ { "type": "param", "key": "version", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "skill_id", "location": "path" }, { "type": "param", "key": "version", "location": "path" }, { "type": "options" } ] }, { "base": "skills.versions", "name": "delete", "params": [ { "type": "param", "key": "version", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "skill_id", "location": "path" }, { "type": "param", "key": "version", "location": "path" }, { "type": "options" } ] }, { "base": "skills.versions.content", "name": "retrieve", "params": [ { "type": "param", "key": "version", "location": "path" }, { "type": "params", "maybeOverload": false }, { "type": "options" } ], "oldParams": [ { "type": "param", "key": "skill_id", "location": "path" }, { "type": "param", "key": "version", "location": "path" }, { "type": "options" } ] } ] }