创建图像编辑测试版

示例请求

• curl https://api.openai.com/v1/images/edits
• -H 'Authorization: Bearer YOUR_API_KEY'
• -F image='@otter.png'
• -F mask='@mask.png'
• -F prompt="A cute baby sea otter wearing a beret"
• -F n=2
• -F size="1024x1024"

• {
• "created": 1589478378,
• "data": [
• {
• "url": "https://..."
• },
• {
• "url": "https://..."
• }
• ]
• }

请求正文

用户

创建图像变体测试版

• curl https://api.openai.com/v1/images/variations
• -H 'Authorization: Bearer YOUR_API_KEY'
• -F image='@otter.png'
• -F n=2
• -F size="1024x1024"

• {
• "created": 1589478378,
• "data": [
• {
• "url": "https://..."
• },
• {
• "url": "https://..."
• }
• ]
• }

嵌入

创建嵌入

• curl https://api.openai.com/v1/embeddings
• -X POST
• -H "Authorization: Bearer YOUR_API_KEY"
• -H "Content-Type: application/json"
• -d '{"input": "The food was delicious and the waiter...",
• "model": "text-embedding-ada-002"}'

• {
• "model": "text-embedding-ada-002",
• "input": "The food was delicious and the waiter..."
• }

• {
• "object": "list",
• "data": [
• {
• "object": "embedding",
• "embedding": [
• 0.0023064255,
• -0.009327292,
• .... (1536 floats total for ada-002)
• -0.0028842222,
• ],
• "index": 0
• }
• ],
• "model": "text-embedding-ada-002",
• "usage": {
• "prompt_tokens": 8,
• "total_tokens": 8
• }
• }

声音的

创建转录测试版

请求正文

示例请求

• curl https://api.openai.com/v1/audio/transcriptions
• -X POST
• -H 'Authorization: Bearer TOKEN'
• -H 'Content-Type: multipart/form-data'
• -F file=@/path/to/file/audio.mp3
• -F model=whisper-1

• {
• "file": "audio.mp3",
• "model": "whisper-1"
• }

• {
• "text": "Imagine the wildest idea that you've ever had, and you're curious about how it might scale to something that's a 100, a 1,000 times bigger. This is a place where you can get to do that."
• }

创建翻译测试版

请求正文

示例请求

• curl https://api.openai.com/v1/audio/translations
• -X POST
• -H 'Authorization: Bearer TOKEN'
• -H 'Content-Type: multipart/form-data'
• -F file=@/path/to/file/german.m4a
• -F model=whisper-1

• {
• "file": "german.m4a",
• "model": "whisper-1"
• }

• {
• "text": "Hello, my name is Wolfgang and I come from Germany. Where are you heading today?"
• }

文件

列出文件

示例请求

• curl https://api.openai.com/v1/files
• -H 'Authorization: Bearer YOUR_API_KEY'

• {
• "data": [
• {
• "id": "file-ccdDZrC3iZVNiQVeEA6Z66wf",
• "object": "file",
• "bytes": 175,
• "created_at": 1613677385,
• "filename": "train.jsonl",
• "purpose": "search"
• },
• {
• "id": "file-XjGxS3KTG0uNmNOK362iJua3",
• "object": "file",
• "bytes": 140,
• "created_at": 1613779121,
• "filename": "puppy.jsonl",
• "purpose": "search"
• }
• ],
• "object": "list"
• }

上传文件

请求正文

示例请求

• curl https://api.openai.com/v1/files
• -H "Authorization: Bearer YOUR_API_KEY"
• -F purpose="fine-tune"
• -F file='@mydata.jsonl'

• {
• "id": "file-XjGxS3KTG0uNmNOK362iJua3",
• "object": "file",
• "bytes": 140,
• "created_at": 1613779121,
• "filename": "mydata.jsonl",
• "purpose": "fine-tune"
• }

删除文件

路径参数

• curl https://api.openai.com/v1/files/file-XjGxS3KTG0uNmNOK362iJua3
• -X DELETE
• -H 'Authorization: Bearer YOUR_API_KEY'

• {
• "id": "file-XjGxS3KTG0uNmNOK362iJua3",
• "object": "file",
• "deleted": true
• }

检索文件

路径参数

示例请求

• curl https://api.openai.com/v1/files/file-XjGxS3KTG0uNmNOK362iJua3
• -H 'Authorization: Bearer YOUR_API_KEY'

• {
• "id": "file-XjGxS3KTG0uNmNOK362iJua3",
• "object": "file",
• "bytes": 140,
• "created_at": 1613779657,
• "filename": "mydata.jsonl",
• "purpose": "fine-tune"
• }

检索文件内容

路径参数

示例请求

• curl https://api.openai.com/v1/files/file-XjGxS3KTG0uNmNOK362iJua3/content
• -H 'Authorization: Bearer YOUR_API_KEY' > file.jsonl

微调

创建微调

请求正文

示例请求

• curl https://api.openai.com/v1/fine-tunes
• -X POST
• -H "Content-Type: application/json"
• -H "Authorization: Bearer YOUR_API_KEY"
• -d '{
• "training_file": "file-XGinujblHPwGLSztz8cPS8XY"
• }'

• {
• "id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F",
• "object": "fine-tune",
• "model": "curie",
• "created_at": 1614807352,
• "events": [
• {
• "object": "fine-tune-event",
• "created_at": 1614807352,
• "level": "info",
• "message": "Job enqueued. Waiting for jobs ahead to complete. Queue number: 0."
• }
• ],
• "fine_tuned_model": null,
• "hyperparams": {
• "batch_size": 4,
• "learning_rate_multiplier": 0.1,
• "n_epochs": 4,
• "prompt_loss_weight": 0.1,
• },
• "organization_id": "org-...",
• "result_files": [],
• "status": "pending",
• "validation_files": [],
• "training_files": [
• {
• "id": "file-XGinujblHPwGLSztz8cPS8XY",
• "object": "file",
• "bytes": 1547276,
• "created_at": 1610062281,
• "filename": "my-data-train.jsonl",
• "purpose": "fine-tune-train"
• }
• ],
• "updated_at": 1614807352,
• }

列表微调

示例请求

• curl https://api.openai.com/v1/fine-tunes
• -H 'Authorization: Bearer YOUR_API_KEY'

• {
• "object": "list",
• "data": [
• {
• "id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F",
• "object": "fine-tune",
• "model": "curie",
• "created_at": 1614807352,
• "fine_tuned_model": null,
• "hyperparams": { ... },
• "organization_id": "org-...",
• "result_files": [],
• "status": "pending",
• "validation_files": [],
• "training_files": [ { ... } ],
• "updated_at": 1614807352,
• },
• { ... },
• { ... }
• ]
• }

检索微调

示例请求

• curl https://api.openai.com/v1/fine-tunes/ft-AF1WoRqd3aJAHsqc9NY7iL8F
• -H "Authorization: Bearer YOUR_API_KEY"

• {
• "id": "ft-AF1WoRqd3aJAHsqc9NY7iL8F",
• "object": "fine-tune",
• "model": "curie",
• "created_at": 1614807352,
• "events": [
• {
• "object": "fine-tune-event",
• "created_at": 1614807352,
• "level": "info",
• "message": "Job enqueued. Waiting for jobs ahead to complete. Queue number: 0."
• },
• {
• "object": "fine-tune-event",
• "created_at": 1614807356,
• "level": "info",
• "message": "Job started."
• },
• {
• "object": "fine-tune-event",
• "created_at": 1614807861,
• "level": "info",
• "message": "Uploaded snapshot: curie:ft-acmeco-2021-03-03-21-44-20."
• },
• {
• "object": "fine-tune-event",
• "created_at": 1614807864,
• "level": "info",
• "message": "Uploaded result files: file-QQm6ZpqdNwAaVC3aSz5sWwLT."
• },
• {
• "object": "fine-tune-event",
• "created_at": 1614807864,
• "level": "info",
• "message": "Job succeeded."
• }
• ],
• "fine_tuned_model": "curie:ft-acmeco-2021-03-03-21-44-20",
• "hyperparams": {
• "batch_size": 4,
• "learning_rate_multiplier": 0.1,
• "n_epochs": 4,
• "prompt_loss_weight": 0.1,
• },
• "organization_id": "org-...",
• "result_files": [
• {
• "id": "file-QQm6ZpqdNwAaVC3aSz5sWwLT",
• "object": "file",
• "bytes": 81509,
• "created_at": 1614807863,
• "filename": "compiled_results.csv",
• "purpose": "fine-tune-results"
• }
• ],
• "status": "succeeded",
• "validation_files": [],
• "training_files": [
• {
• "id": "file-XGinujblHPwGLSztz8cPS8XY",
• "object": "file",
• "bytes": 1547276,
• "created_at": 1610062281,
• "filename": "my-data-train.jsonl",
• "purpose": "fine-tune-train"
• }
• ],
• "updated_at": 1614807865,
• }

取消微调

路径参数

• curl https://api.openai.com/v1/fine-tunes/ft-AF1WoRqd3aJAHsqc9NY7iL8F/cancel
• -X POST
• -H "Authorization: Bearer YOUR_API_KEY"

• {
• "id": "ft-xhrpBbvVUzYGo8oUO1FY4nI7",
• "object": "fine-tune",
• "model": "curie",
• "created_at": 1614807770,
• "events": [ { ... } ],
• "fine_tuned_model": null,
• "hyperparams": { ... },
• "organization_id": "org-...",
• "result_files": [],
• "status": "cancelled",
• "validation_files": [],
• "training_files": [
• {
• "id": "file-XGinujblHPwGLSztz8cPS8XY",
• "object": "file",
• "bytes": 1547276,
• "created_at": 1610062281,
• "filename": "my-data-train.jsonl",
• "purpose": "fine-tune-train"
• }
• ],
• "updated_at": 1614807789,
• }

列出微调事件

路径参数

示例请求

• curl https://api.openai.com/v1/fine-tunes/ft-AF1WoRqd3aJAHsqc9NY7iL8F/events
• -H "Authorization: Bearer YOUR_API_KEY"

• {
• "object": "list",
• "data": [
• {
• "object": "fine-tune-event",
• "created_at": 1614807352,
• "level": "info",
• "message": "Job enqueued. Waiting for jobs ahead to complete. Queue number: 0."
• },
• {
• "object": "fine-tune-event",
• "created_at": 1614807356,
• "level": "info",
• "message": "Job started."
• },
• {
• "object": "fine-tune-event",
• "created_at": 1614807861,
• "level": "info",
• "message": "Uploaded snapshot: curie:ft-acmeco-2021-03-03-21-44-20."
• },
• {
• "object": "fine-tune-event",
• "created_at": 1614807864,
• "level": "info",
• "message": "Uploaded result files: file-QQm6ZpqdNwAaVC3aSz5sWwLT."
• },
• {
• "object": "fine-tune-event",
• "created_at": 1614807864,
• "level": "info",
• "message": "Job succeeded."
• }
• ]
• }

删除微调模型

路径参数

• curl https://api.openai.com/v1/models/curie:ft-acmeco-2021-03-03-21-44-20
• -X DELETE
• -H "Authorization: Bearer YOUR_API_KEY"

• {
• "id": "curie:ft-acmeco-2021-03-03-21-44-20",
• "object": "model",
• "deleted": true
• }

节制

创建适度

请求正文

示例请求

• curl https://api.openai.com/v1/moderations
• -H 'Content-Type: application/json'
• -H 'Authorization: Bearer YOUR_API_KEY'
• -d '{
• "input": "I want to kill them."
• }'

• {
• "input": "I want to kill them."
• }

• {
• "id": "modr-5MWoLO",
• "model": "text-moderation-001",
• "results": [
• {
• "categories": {
• "hate": false,
• "hate/threatening": true,
• "self-harm": false,
• "sexual": false,
• "sexual/minors": false,
• "violence": true,
• "violence/graphic": false
• },
• "category_scores": {
• "hate": 0.22714105248451233,
• "hate/threatening": 0.4132447838783264,
• "self-harm": 0.005232391878962517,
• "sexual": 0.01407341007143259,
• "sexual/minors": 0.0038522258400917053,
• "violence": 0.9223177433013916,
• "violence/graphic": 0.036865197122097015
• },
• "flagged": true
• }
• ]
• }

引擎

列出引擎弃用

示例请求

• curl https://api.openai.com/v1/engines
• -H 'Authorization: Bearer YOUR_API_KEY'

• {
• "data": [
• {
• "id": "engine-id-0",
• "object": "engine",
• "owner": "organization-owner",
• "ready": true
• },
• {
• "id": "engine-id-2",
• "object": "engine",
• "owner": "organization-owner",
• "ready": true
• },
• {
• "id": "engine-id-3",
• "object": "engine",
• "owner": "openai",
• "ready": false
• },
• ],
• "object": "list"
• }

检索引擎弃用

路径参数

示例请求

• curl https://api.openai.com/v1/engines/text-davinci-003
• -H 'Authorization: Bearer YOUR_API_KEY'

• {
• "id": "text-davinci-003",
• "object": "engine",
• "owner": "openai",
• "ready": true
• }

参数详情

• mu[j] -> mu[j] - c[j] * alpha_frequency - float(c[j] > 0) * alpha_presence

• mu[j]是第 j 个标记的对数
• c[j]是在当前位置之前对该令牌进行采样的频率
• float(c[j] > 0)如果为 1，c[j] > 0否则为 0
• alpha_frequency是频率惩罚系数
• alpha_presence是存在惩罚系数

如果目标只是稍微减少重复样本，则惩罚系数的合理值约为 0.1 到 1。如果目标是强烈抑制重复，那么可以将系数增加到 2，但这会显着降低样本质量。负值可用于增加重复的可能性。