Azure OpenAI in Microsoft Foundry Models REST API preview reference

この記事では、Azure OpenAI向けの推論REST APIエンドポイントについて詳細を提供します。

API specs

Azure OpenAIモデルやリソースの管理とやり取りは、主に3つのAPIサーフェスに分かれています。

• Control plane
• データプレーン - オーサリング
• データプレーン - 推論

各APIサーフェス/仕様は異なるAzure OpenAIの機能セットをカプセル化しています。 各APIは独自のプレビューおよび安定版/一般公開版(GA)APIリリースを持っています。 プレビューリリースは現在、月次のリリースリズムに従う傾向があります。

Authentication

Azure OpenAIは認証のために2つの方法を提供しています。 APIキーかMicrosoft Entra IDのどちらかを使うことができます。

• APIキー認証:この種の認証では、すべてのAPIリクエストに api-key HTTPヘッダーにAPIキーを含める必要があります。 クイックスタートは、この種の認証で通話する方法についてのガイダンスを提供します。

• Microsoft Entra ID authentication:Microsoft Entraトークンを使ってAPI呼び出しを認証できます。 認証トークンはリクエストの中には Authorization ヘッダーとして含まれています。 提供されるトークンの前に Bearerが必ず付き、例えば Bearer YOUR_AUTH_TOKEN。 Microsoft Entra ID<>でのauthenticating の使い方ガイドをお読みいただけます。

REST API バージョン管理

サービスAPIは api-version クエリパラメータを用いてバージョン管理されています。 すべてのバージョンはYYYY-MM-DD 日付構造に従っています。 For example:

POST https://YOUR_RESOURCE_NAME.openai.azure.com/openai/deployments/YOUR_DEPLOYMENT_NAME/chat/completions?api-version=2024-06-01

データプレーン推論

この記事の残りの部分では、Azure OpenAIデータプレーン推論仕様の2025-04-01-previewプレビューリリースについて扱っています。

最新のGA APIリリースに関するドキュメントをお探しの場合は、最新のGAデータプレーン推論APIを参照してください

完了 - 作成

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

提供されたプロンプト、パラメータ、選択したモデルに対して補完を作成します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

ステータスコード: デフォルト

説明:サービス利用不可

Examples

Example

提供されたプロンプト、パラメータ、選択したモデルに対して補完を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/completions?api-version=2025-04-01-preview

{
 "prompt": [
  "tell me a joke about mango"
 ],
 "max_tokens": 32,
 "temperature": 1.0,
 "n": 1
}

回答:ステータスコード:200

{
  "body": {
    "id": "cmpl-7QmVI15qgYVllxK0FtxVGG6ywfzaq",
    "created": 1686617332,
    "choices": [
      {
        "text": "es\n\nWhat do you call a mango who's in charge?\n\nThe head mango.",
        "index": 0,
        "finish_reason": "stop",
        "logprobs": null
      }
    ],
    "usage": {
      "completion_tokens": 20,
      "prompt_tokens": 6,
      "total_tokens": 26
    }
  }
}

埋め込み - 作成

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

機械学習モデルやアルゴリズムで簡単に処理できる、与えられた入力のベクトル表現を得ること。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

指定されたプロンプトに対して埋め込みを返します。

POST https://{endpoint}/openai/deployments/{deployment-id}/embeddings?api-version=2025-04-01-preview

{
 "input": [
  "this is a test"
 ]
}

回答:ステータスコード:200

{
  "body": {
    "data": [
      {
        "index": 0,
        "embedding": [
          -0.012838088,
          -0.007421397,
          -0.017617522,
          -0.028278312,
          -0.018666342,
          0.01737855,
          -0.01821495,
          -0.006950092,
          -0.009937238,
          -0.038580645,
          0.010674067,
          0.02412286,
          -0.013647936,
          0.013189907,
          0.0021125758,
          0.012406612,
          0.020790534,
          0.00074595667,
          0.008397198,
          -0.00535031,
          0.008968075,
          0.014351576,
          -0.014086051,
          0.015055214,
          -0.022211088,
          -0.025198232,
          0.0065186154,
          -0.036350243,
          0.009180495,
          -0.009698266,
          0.009446018,
          -0.008463579,
          -0.0020113448
        ]
      }
    ],
    "usage": {
      "prompt_tokens": 4,
      "total_tokens": 4
    }
  }
}

チャット完了 - 作成

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

チャットメッセージの完了を作成する

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

ステータスコード: デフォルト

説明:サービス利用不可

Examples

Example

提供されたプロンプト、パラメータ、選択したモデルに対して補完を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "system",
   "content": "you are a helpful assistant that talks like a pirate"
  },
  {
   "role": "user",
   "content": "can you tell me how to care for a parrot?"
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Ahoy matey! So ye be wantin' to care for a fine squawkin' parrot, eh? Well, shiver me timbers, let ol' Cap'n Assistant share some wisdom with ye! Here be the steps to keepin' yer parrot happy 'n healthy:\n\n1. Secure a sturdy cage: Yer parrot be needin' a comfortable place to lay anchor! Be sure ye get a sturdy cage, at least double the size of the bird's wingspan, with enough space to spread their wings, yarrrr!\n\n2. Perches 'n toys: Aye, parrots need perches of different sizes, shapes, 'n textures to keep their feet healthy. Also, a few toys be helpin' to keep them entertained 'n their minds stimulated, arrrh!\n\n3. Proper grub: Feed yer feathered friend a balanced diet of high-quality pellets, fruits, 'n veggies to keep 'em strong 'n healthy. Give 'em fresh water every day, or ye\u00e2\u20ac\u2122ll have a scurvy bird on yer hands!\n\n4. Cleanliness: Swab their cage deck! Clean their cage on a regular basis: fresh water 'n food daily, the floor every couple of days, 'n a thorough scrubbing ev'ry few weeks, so the bird be livin' in a tidy haven, arrhh!\n\n5. Socialize 'n train: Parrots be a sociable lot, arrr! Exercise 'n interact with 'em daily to create a bond 'n maintain their mental 'n physical health. Train 'em with positive reinforcement, treat 'em kindly, yarrr!\n\n6. Proper rest: Yer parrot be needin' \u00e2\u20ac\u2122bout 10-12 hours o' sleep each night. Cover their cage 'n let them slumber in a dim, quiet quarter for a proper night's rest, ye scallywag!\n\n7. Keep a weather eye open for illness: Birds be hidin' their ailments, arrr! Be watchful for signs of sickness, such as lethargy, loss of appetite, puffin' up, or change in droppings, and make haste to a vet if need be.\n\n8. Provide fresh air 'n avoid toxins: Parrots be sensitive to draft and pollutants. Keep yer quarters well ventilated, but no drafts, arrr! Be mindful of toxins like Teflon fumes, candles, or air fresheners.\n\nSo there ye have it, me hearty! With proper care 'n commitment, yer parrot will be squawkin' \"Yo-ho-ho\" for many years to come! Good luck, sailor, and may the wind be at yer back!"
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Azure Searchのデータとシステム割り当てのマネージデンティティに基づいて完了を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "authentication": {
     "type": "system_assigned_managed_identity"
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Azure Searchの画像ベクターデータに基づいて完了を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "index_name": "{index name}",
    "query_type": "vector",
    "fields_mapping": {
     "image_vector_fields": [
      "image_vector"
     ]
    },
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion."
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

Azure Searchのベクターデータ、過去のアシスタントメッセージ、ユーザー割り当てのマネージデンティティに基づいて完了を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a cat?"
  },
  {
   "role": "assistant",
   "content": "Content of the completion [doc1].",
   "context": {
    "intent": "cat care"
   }
  },
  {
   "role": "user",
   "content": "how about dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_search",
   "parameters": {
    "endpoint": "https://your-search-endpoint.search.windows.net/",
    "authentication": {
     "type": "user_assigned_managed_identity",
     "managed_identity_resource_id": "/subscriptions/{subscription-id}/resourceGroups/{resource-group}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{resource-name}"
    },
    "index_name": "{index name}",
    "query_type": "vector",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "in_scope": true,
    "top_n_documents": 5,
    "strictness": 3,
    "role_information": "You are an AI assistant that helps people find information.",
    "fields_mapping": {
     "content_fields_separator": "\\n",
     "content_fields": [
      "content"
     ],
     "filepath_field": "filepath",
     "title_field": "title",
     "url_field": "url",
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content 2.",
                "title": "Citation Title 2",
                "filepath": "contoso2.txt",
                "url": "https://contoso.blob.windows.net/container/contoso2.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

提供されたAzure Cosmos DBの完了を作成する。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "azure_cosmos_db",
   "parameters": {
    "authentication": {
     "type": "connection_string",
     "connection_string": "mongodb+srv://rawantest:{password}$@{cluster-name}.mongocluster.cosmos.azure.com/?tls=true&authMechanism=SCRAM-SHA-256&retrywrites=false&maxIdleTimeMS=120000"
    },
    "database_name": "vectordb",
    "container_name": "azuredocs",
    "index_name": "azuredocindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

提供されたMongoデータベースに対して完了を生成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "mongo_db",
   "parameters": {
    "authentication": {
     "type": "username_and_password",
     "username": "<username>",
     "password": "<password>"
    },
    "endpoint": "<endpoint_name>",
    "app_name": "<application name>",
    "database_name": "sampledb",
    "collection_name": "samplecollection",
    "index_name": "sampleindex",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "content_fields": [
      "content"
     ],
     "vector_fields": [
      "contentvector"
     ]
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

提供されたElasticsearchの完了処理を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "elasticsearch",
   "parameters": {
    "endpoint": "https://your-elasticsearch-endpoint.eastus.azurecontainer.io",
    "index_name": "{index name}",
    "authentication": {
     "type": "key_and_key_id",
     "key": "{key}",
     "key_id": "{key id}"
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

Example

提供されたPineconeリソースの完了を生成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version=2025-04-01-preview

{
 "messages": [
  {
   "role": "user",
   "content": "can you tell me how to care for a dog?"
  }
 ],
 "data_sources": [
  {
   "type": "pinecone",
   "parameters": {
    "authentication": {
     "type": "api_key",
     "key": "{api key}"
    },
    "environment": "{environment name}",
    "index_name": "{index name}",
    "embedding_dependency": {
     "type": "deployment_name",
     "deployment_name": "{embedding deployment name}"
    },
    "fields_mapping": {
     "title_field": "title",
     "url_field": "url",
     "filepath_field": "filepath",
     "content_fields": [
      "content"
     ],
     "content_fields_separator": "\n"
    }
   }
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "chatcmpl-7R1nGnsXO8n4oi9UPz2f3UHdgAYMn",
    "created": 1686676106,
    "choices": [
      {
        "index": 0,
        "finish_reason": "stop",
        "message": {
          "role": "assistant",
          "content": "Content of the completion [doc1].",
          "context": {
            "citations": [
              {
                "content": "Citation content.",
                "title": "Citation Title",
                "filepath": "contoso.txt",
                "url": "https://contoso.blob.windows.net/container/contoso.txt",
                "chunk_id": "0"
              }
            ],
            "intent": "dog care"
          }
        }
      }
    ],
    "usage": {
      "completion_tokens": 557,
      "prompt_tokens": 33,
      "total_tokens": 590
    }
  }
}

書き起こし - 作成

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

音声を入力言語に書き起こします。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: multipart/form-data

Responses

ステータスコード: 200

Description: OK

Examples

Example

提供された音声データから文字起こしテキストと関連メタデータを取得します。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

提供された音声データから文字起こしテキストと関連メタデータを取得します。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/transcriptions?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回答:ステータスコード:200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

翻訳 - 作成

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

入力された音声を英語テキストに書き起こし・翻訳します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: multipart/form-data

Responses

ステータスコード: 200

Description: OK

Examples

Example

提供された音声データから英語の文字起こしテキストと関連するメタデータを取得します。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回答:ステータスコード:200

{
  "body": {
    "text": "A structured object when requesting json or verbose_json"
  }
}

Example

提供された音声データから英語の文字起こしテキストと関連するメタデータを取得します。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/translations?api-version=2025-04-01-preview

"---multipart-boundary\nContent-Disposition: form-data; name=\"file\"; filename=\"file.wav\"\nContent-Type: application/octet-stream\n\nRIFF..audio.data.omitted\n---multipart-boundary--"

回答:ステータスコード:200

{
  "type": "string",
  "example": "plain text when requesting text, srt, or vtt"
}

スピーチ - 作成

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

入力テキストから音声を生成します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: multipart/form-data

Responses

ステータスコード: 200

Description: OK

Examples

Example

提供されたテキストから音声を合成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/audio/speech?api-version=2025-04-01-preview

{
 "input": "Hi! What are you going to make?",
 "voice": "fable",
 "response_format": "mp3"
}

回答:ステータスコード:200

{
  "body": "101010101"
}

画像生成 - 作成

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

与えられた画像生成モデルの展開において、テキストキャプションから画像の一括を生成する

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: Ok

ステータスコード: デフォルト

説明:エラーが発生しました。

Examples

Example

プロンプトを与えられた画像を作成します。

POST https://{endpoint}/openai/deployments/{deployment-id}/images/generations?api-version=2025-04-01-preview

{
 "prompt": "In the style of WordArt, Microsoft Clippy wearing a cowboy hat.",
 "n": 1,
 "style": "natural",
 "quality": "standard"
}

回答:ステータスコード:200

{
  "body": {
    "created": 1698342300,
    "data": [
      {
        "revised_prompt": "A vivid, natural representation of Microsoft Clippy wearing a cowboy hat.",
        "prompt_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          },
          "profanity": {
            "detected": false,
            "filtered": false
          },
          "custom_blocklists": {
            "filtered": false,
            "details": []
          }
        },
        "url": "https://dalletipusw2.blob.core.windows.net/private/images/e5451cc6-b1ad-4747-bd46-b89a3a3b8bc3/generated_00.png?se=2023-10-27T17%3A45%3A09Z&...",
        "content_filter_results": {
          "sexual": {
            "severity": "safe",
            "filtered": false
          },
          "violence": {
            "severity": "safe",
            "filtered": false
          },
          "hate": {
            "severity": "safe",
            "filtered": false
          },
          "self_harm": {
            "severity": "safe",
            "filtered": false
          }
        }
      }
    ]
  }
}

画像生成 - 編集

POST https://{endpoint}/openai/deployments/{deployment-id}/images/edits?api-version=2025-04-01-preview

与えられたGPT-image-1モデル展開上のテキストキャプションから画像を編集します

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: multipart/form-data

Responses

ステータスコード: 200

Description: Ok

ステータスコード: デフォルト

説明:エラーが発生しました。

リスト - アシスタント

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

助手のリストを返す。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

助手のリストを返す。

GET https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "asst_abc123",
        "object": "assistant",
        "created_at": 1707257477,
        "name": "Stock Analyst",
        "description": null,
        "model": "gpt-4-1106-preview",
        "instructions": "You are a financial analyst that analyzes stock market prices and other financial data present on user uploaded files or by calling external APIs.",
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc456",
        "object": "assistant",
        "created_at": 1698982718,
        "name": "My Assistant",
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": "You are a helpful assistant designed to make me better at coding!",
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      },
      {
        "id": "asst_abc789",
        "object": "assistant",
        "created_at": 1698982643,
        "name": null,
        "description": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "tools": [],
        "tool_resources": {},
        "metadata": {},
        "top_p": 1.0,
        "temperature": 1.0,
        "response_format": "auto"
      }
    ],
    "first_id": "asst_abc123",
    "last_id": "asst_abc789",
    "has_more": false
  }
}

Create - アシスタント

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

モデルと指示を持つアシスタントを作成しましょう。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

モデルと指示を持つアシスタントを作成しましょう。

POST https://{endpoint}/openai/assistants?api-version=2025-04-01-preview

{
 "name": "Math Tutor",
 "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
 "tools": [
  {
   "type": "code_interpreter"
  }
 ],
 "model": "gpt-4-1106-preview"
}

回答:ステータスコード:200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant",
    "created_at": 1707295707,
    "name": "Math Tutor",
    "description": null,
    "model": "gpt-4-1106-preview",
    "instructions": "When a customer asks about a specific math problem, use Python to evaluate their query.",
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

取得 - アシスタント

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

助手を連れてくる。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

助手を連れてくる。

GET https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "asst_abc123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

モディフィケート - アシスタント

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

アシスタントを修正する。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

アシスタントを修正する。

POST https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

{
 "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
 "tools": [
  {
   "type": "file_search"
  }
 ],
 "model": "gpt-4-turbo"
}

回答:ステータスコード:200

{
  "body": {
    "id": "asst_123",
    "object": "assistant",
    "created_at": 1699009709,
    "name": "HR Helper",
    "description": null,
    "model": "gpt-4-turbo",
    "instructions": "You are an HR bot, and you have access to files to answer employee questions about company policies. Always response with info from either of the files.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": []
      }
    },
    "metadata": {},
    "top_p": 1.0,
    "temperature": 1.0,
    "response_format": "auto"
  }
}

Delete - アシスタント

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

アシスタントを削除しましょう。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

アシスタントを削除します。

DELETE https://{endpoint}/openai/assistants/{assistant_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "asst_4nsG2qgNzimRPE7MazXTXbU7",
    "object": "assistant.deleted",
    "deleted": true
  }
}

作成 - スレッド

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

スレッドを立ててください。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

スレッドができてしまいます。

POST https://{endpoint}/openai/threads?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {}
  }
}

入手 - スレッド

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

スレッドを取り戻す。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

スレッドを取り戻す。

GET https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {},
    "tool_resources": {
      "code_interpreter": {
        "file_ids": []
      }
    }
  }
}

Modify - スレッド

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

スレッドを修正します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

スレッドを修正します。

POST https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

回答:ステータスコード:200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread",
    "created_at": 1707297136,
    "metadata": {
      "modified": "true",
      "user": "abc123"
    },
    "tool_resources": {}
  }
}

削除 - スレッド

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

スレッドを削除してください。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

スレッドを削除します。

DELETE https://{endpoint}/openai/threads/{thread_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "object": "thread.deleted",
    "deleted": true
  }
}

リスト - メッセージ

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

与えられたスレッドのメッセージリストを返します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

List Messages

GET https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "msg_abc123",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "How does AI work? Explain it in simple terms.",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      },
      {
        "id": "msg_abc456",
        "object": "thread.message",
        "created_at": 1699016383,
        "assistant_id": null,
        "thread_id": "thread_abc123",
        "run_id": null,
        "role": "user",
        "content": [
          {
            "type": "text",
            "text": {
              "value": "Hello, what is AI?",
              "annotations": []
            }
          }
        ],
        "attachments": [],
        "metadata": {}
      }
    ],
    "first_id": "msg_abc123",
    "last_id": "msg_abc456",
    "has_more": false
  }
}

Create - メッセージ

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

メッセージを作成しましょう。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

メッセージを作成しましょう。

POST https://{endpoint}/openai/threads/{thread_id}/messages?api-version=2025-04-01-preview

{
 "role": "user",
 "content": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces."
}

回答:ステータスコード:200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "assistant_id": null,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "attachments": [],
    "metadata": {}
  }
}

メッセージを取る

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

メッセージを回収する。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

メッセージを回収する。

GET https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "msg_as3XIk1tpVP3hdHjWBGg3uG4",
    "object": "thread.message",
    "created_at": 1707298421,
    "thread_id": "thread_v7V4csrNOxtNmgcwGg496Smx",
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "What is the cube root of the sum of 12, 14, 1234, 4321, 90000, 123213541223, 443123123124, 5423324234, 234324324234, 653434534545, 200000000, 98237432984, 99999999, 99999999999, 220000000000, 3309587702? Give me the answer rounded to the nearest integer without commas or spaces.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "assistant_id": null,
    "run_id": null,
    "metadata": {}
  }
}

Modify - メッセージ

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

メッセージを修正します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

メッセージを修正してください。

POST https://{endpoint}/openai/threads/{thread_id}/messages/{message_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "modified": "true",
  "user": "abc123"
 }
}

回答:ステータスコード:200

{
  "body": {
    "id": "msg_abc123",
    "object": "thread.message",
    "created_at": 1699017614,
    "assistant_id": null,
    "thread_id": "thread_abc123",
    "run_id": null,
    "role": "user",
    "content": [
      {
        "type": "text",
        "text": {
          "value": "How does AI work? Explain it in simple terms.",
          "annotations": []
        }
      }
    ],
    "file_ids": [],
    "metadata": {
      "modified": "true",
      "user": "abc123"
    }
  }
}

Create - スレッド&ラン

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

スレッドを作成し、1つのリクエストで実行します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

スレッドを作成し、1つのリクエストで実行します。

POST https://{endpoint}/openai/threads/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123",
 "thread": {
  "messages": [
   {
    "role": "user",
    "content": "Explain deep learning to a 5 year old."
   }
  ]
 }
}

回答:ステータスコード:200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076792,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": null,
    "expires_at": 1699077392,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "required_action": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You are a helpful assistant.",
    "tools": [],
    "tool_resources": {},
    "metadata": {},
    "temperature": 1.0,
    "top_p": 1.0,
    "max_completion_tokens": null,
    "max_prompt_tokens": null,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "incomplete_details": null,
    "usage": null,
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

リスト - 得点

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

スレッドに属するランのリストを返します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

スレッドに属するランのリストを返します。

GET https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "run_abc123",
        "object": "thread.run",
        "created_at": 1699075072,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699075072,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699075073,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      },
      {
        "id": "run_abc456",
        "object": "thread.run",
        "created_at": 1699063290,
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "status": "completed",
        "started_at": 1699063290,
        "expires_at": null,
        "cancelled_at": null,
        "failed_at": null,
        "completed_at": 1699063291,
        "last_error": null,
        "model": "gpt-4-turbo",
        "instructions": null,
        "incomplete_details": null,
        "tools": [
          {
            "type": "code_interpreter"
          }
        ],
        "tool_resources": {
          "code_interpreter": {
            "file_ids": [
              "file-abc123",
              "file-abc456"
            ]
          }
        },
        "metadata": {},
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        },
        "temperature": 1.0,
        "top_p": 1.0,
        "max_prompt_tokens": 1000,
        "max_completion_tokens": 1000,
        "truncation_strategy": {
          "type": "auto",
          "last_messages": null
        },
        "response_format": "auto",
        "tool_choice": "auto"
      }
    ],
    "first_id": "run_abc123",
    "last_id": "run_abc456",
    "has_more": false
  }
}

作成 - 実行

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

ランを作りましょう。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

ランを作りましょう。

POST https://{endpoint}/openai/threads/{thread_id}/runs?api-version=2025-04-01-preview

{
 "assistant_id": "asst_abc123"
}

回答:ステータスコード:200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699063290,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "queued",
    "started_at": 1699063290,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699063291,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

ゲット - ラン

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

ランを回収。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ランを取る。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "run_HsO8tYM4K5AAMAHgK0J3om8Q",
    "object": "thread.run",
    "created_at": 1707303196,
    "assistant_id": "asst_JtTwHk28cIocgFXZPCBxhOzl",
    "thread_id": "thread_eRNwflE3ncDYak1np6MdMHJh",
    "status": "completed",
    "started_at": 1707303197,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1707303201,
    "last_error": null,
    "model": "gpt-4-1106-preview",
    "instructions": "You are an AI model that empowers every person and every organization on the planet to achieve more.",
    "tools": [],
    "file_ids": [],
    "metadata": {}
  }
}

修正 - 走る

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

ランを修正します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

ランを修正します。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}?api-version=2025-04-01-preview

{
 "metadata": {
  "user_id": "user_abc123"
 }
}

回答:ステータスコード:200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699075072,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "completed",
    "started_at": 1699075072,
    "expires_at": null,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": 1699075073,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "incomplete_details": null,
    "tools": [
      {
        "type": "code_interpreter"
      }
    ],
    "tool_resources": {
      "code_interpreter": {
        "file_ids": [
          "file-abc123",
          "file-abc456"
        ]
      }
    },
    "metadata": {
      "user_id": "user_abc123"
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    },
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

送信 - 実行するツール出力

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

実行にstatus: "requires_action"がありrequired_action.typesubmit_tool_outputsされた場合、このエンドポイントを使ってツールコールの出力をすべて送信できます。 すべての出力は単一のリクエストで提出しなければなりません。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

実行にstatus: "requires_action"がありrequired_action.typesubmit_tool_outputsされた場合、このエンドポイントを使ってツールコールの出力をすべて送信できます。 すべての出力は単一のリクエストで提出しなければなりません。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/submit_tool_outputs?api-version=2025-04-01-preview

{
 "tool_outputs": [
  {
   "tool_call_id": "call_001",
   "output": "70 degrees and sunny."
  }
 ]
}

回答:ステータスコード:200

{
  "body": {
    "id": "run_123",
    "object": "thread.run",
    "created_at": 1699075592,
    "assistant_id": "asst_123",
    "thread_id": "thread_123",
    "status": "queued",
    "started_at": 1699075592,
    "expires_at": 1699076192,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": null,
    "tools": [
      {
        "type": "function",
        "function": {
          "name": "get_current_weather",
          "description": "Get the current weather in a given location",
          "parameters": {
            "type": "object",
            "properties": {
              "location": {
                "type": "string",
                "description": "The city and state, e.g. San Francisco, CA"
              },
              "unit": {
                "type": "string",
                "enum": [
                  "celsius",
                  "fahrenheit"
                ]
              }
            },
            "required": [
              "location"
            ]
          }
        }
      }
    ],
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "max_prompt_tokens": 1000,
    "max_completion_tokens": 1000,
    "truncation_strategy": {
      "type": "auto",
      "last_messages": null
    },
    "response_format": "auto",
    "tool_choice": "auto"
  }
}

キャンセル - 逃げる

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

in_progressのランをキャンセルします。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

in_progressのランをキャンセルします。

POST https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/cancel?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "run_abc123",
    "object": "thread.run",
    "created_at": 1699076126,
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "status": "cancelling",
    "started_at": 1699076126,
    "expires_at": 1699076726,
    "cancelled_at": null,
    "failed_at": null,
    "completed_at": null,
    "last_error": null,
    "model": "gpt-4-turbo",
    "instructions": "You summarize books.",
    "tools": [
      {
        "type": "file_search"
      }
    ],
    "tool_resources": {
      "file_search": {
        "vector_store_ids": [
          "vs_123"
        ]
      }
    },
    "metadata": {},
    "usage": null,
    "temperature": 1.0,
    "top_p": 1.0,
    "response_format": "auto"
  }
}

リスト - ランステップ

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

ランに属する実行ステップのリストを返します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ランに属する実行ステップのリストを返します。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "step_abc123",
        "object": "thread.run.step",
        "created_at": 1699063291,
        "run_id": "run_abc123",
        "assistant_id": "asst_abc123",
        "thread_id": "thread_abc123",
        "type": "message_creation",
        "status": "completed",
        "cancelled_at": null,
        "completed_at": 1699063291,
        "expired_at": null,
        "failed_at": null,
        "last_error": null,
        "step_details": {
          "type": "message_creation",
          "message_creation": {
            "message_id": "msg_abc123"
          }
        },
        "usage": {
          "prompt_tokens": 123,
          "completion_tokens": 456,
          "total_tokens": 579
        }
      }
    ],
    "first_id": "step_abc123",
    "last_id": "step_abc456",
    "has_more": false
  }
}

ゲット - ランステップ

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

ランステップを回収します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ランステップを回収します。

GET https://{endpoint}/openai/threads/{thread_id}/runs/{run_id}/steps/{step_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "step_abc123",
    "object": "thread.run.step",
    "created_at": 1699063291,
    "run_id": "run_abc123",
    "assistant_id": "asst_abc123",
    "thread_id": "thread_abc123",
    "type": "message_creation",
    "status": "completed",
    "cancelled_at": null,
    "completed_at": 1699063291,
    "expired_at": null,
    "failed_at": null,
    "last_error": null,
    "step_details": {
      "type": "message_creation",
      "message_creation": {
        "message_id": "msg_abc123"
      }
    },
    "usage": {
      "prompt_tokens": 123,
      "completion_tokens": 456,
      "total_tokens": 579
    }
  }
}

リスト - ベクターストア

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

ベクターストアのリストを返します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアのリストを返します。

GET https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "vs_abc123",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      },
      {
        "id": "vs_abc456",
        "object": "vector_store",
        "created_at": 1699061776,
        "name": "Support FAQ v2",
        "bytes": 139920,
        "file_counts": {
          "in_progress": 0,
          "completed": 3,
          "failed": 0,
          "cancelled": 0,
          "total": 3
        }
      }
    ],
    "first_id": "vs_abc123",
    "last_id": "vs_abc456",
    "has_more": false
  }
}

Create - ベクターストア

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

ベクターストアを作成します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアを作成します。

POST https://{endpoint}/openai/vector_stores?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

取得 - ベクターストア

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

ベクターストアを取得。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアを取得。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776
  }
}

Modify - ベクトルストア

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

ベクターストアを修正します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアを修正します。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

{
 "name": "Support FAQ"
}

回答:ステータスコード:200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store",
    "created_at": 1699061776,
    "name": "Support FAQ",
    "bytes": 139920,
    "file_counts": {
      "in_progress": 0,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 3
    }
  }
}

削除 - ベクターストア

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

ベクターストアを削除してください。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアを削除します。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vs_abc123",
    "object": "vector_store.deleted",
    "deleted": true
  }
}

リスト - ベクターストアファイル

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

ベクターストアファイルのリストを返します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアファイルのリストを返します。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Create - ベクターストアファイル

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

ベクターストアファイルを作成するには、ファイルをベクターストアにアタッチします。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアファイルを作成するには、ファイルをベクターストアにアタッチします。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files?api-version=2025-04-01-preview

{
 "file_id": "file-abc123"
}

回答:ステータスコード:200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "usage_bytes": 1234,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

Get - ベクターストアファイル

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

ベクターストアファイルを取得します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアファイルを取得します。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "file-abc123",
    "object": "vector_store.file",
    "created_at": 1699061776,
    "vector_store_id": "vs_abcd",
    "status": "completed",
    "last_error": null
  }
}

削除 - ベクターストアファイル

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

ベクターストアファイルを削除してください。 これでベクターストアからファイルは削除されますが、ファイル自体は削除されません。 ファイルを削除するには、delete fileエンドポイントを使います。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアファイルを削除してください。 これでベクターストアからファイルは削除されますが、ファイル自体は削除されません。 ファイルを削除するには、delete fileエンドポイントを使います。

DELETE https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "file_abc123",
    "object": "vector_store.file.deleted",
    "deleted": true
  }
}

Updatevectorstorefileattributes

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}?api-version=2025-04-01-preview

ベクターストアファイルの属性を更新します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

ベクターストアファイルの内容を取得

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/files/{file_id}/content?api-version=2025-04-01-preview

ベクターストアファイルの解析済み内容を取得します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

探索ベクターストア

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/search?api-version=2025-04-01-preview

クエリとファイル属性フィルターを使って、関連するチャンクをベクターストアで検索してください。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Create - ベクターストアファイルバッチ

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

ベクターストアのファイルのバッチを作成します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアのファイルのバッチを作成します。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches?api-version=2025-04-01-preview

{
 "file_ids": [
  "file-abc123",
  "file-abc456"
 ]
}

回答:ステータスコード:200

{
  "id": "vsfb_abc123",
  "object": "vector_store.file_batch",
  "created_at": 1699061776,
  "vector_store_id": "vs_abc123",
  "status": "in_progress",
  "file_counts": {
    "in_progress": 1,
    "completed": 1,
    "failed": 0,
    "cancelled": 0,
    "total": 0
  }
}

Get - ベクターストアファイルバッチ

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

ベクターストアファイルのバッチを取得します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアファイルのバッチを取得します。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "in_progress",
    "file_counts": {
      "in_progress": 1,
      "completed": 1,
      "failed": 0,
      "cancelled": 0,
      "total": 0
    }
  }
}

キャンセル - ベクターストアファイルバッチ

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

ベクターストアのファイルバッチをキャンセルします。 これはこのバッチのファイル処理をできるだけ早くキャンセルしようと試みます。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアのファイルバッチをキャンセルします。 これはこのバッチのファイル処理をできるだけ早くキャンセルしようと試みます。

POST https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/cancel?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "id": "vsfb_abc123",
    "object": "vector_store.file_batch",
    "created_at": 1699061776,
    "vector_store_id": "vs_abc123",
    "status": "cancelling",
    "file_counts": {
      "in_progress": 12,
      "completed": 3,
      "failed": 0,
      "cancelled": 0,
      "total": 15
    }
  }
}

リスト - ベクターストアファイルバッチファイル

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

バッチでベクターストアファイルのリストを返します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Examples

Example

ベクターストアファイルのリストを返します。

GET https://{endpoint}/openai/vector_stores/{vector_store_id}/file_batches/{batch_id}/files?api-version=2025-04-01-preview

回答:ステータスコード:200

{
  "body": {
    "object": "list",
    "data": [
      {
        "id": "file-abc123",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      },
      {
        "id": "file-abc456",
        "object": "vector_store.file",
        "created_at": 1699061776,
        "vector_store_id": "vs_abc123"
      }
    ],
    "first_id": "file-abc123",
    "last_id": "file-abc456",
    "has_more": false
  }
}

Create - Realtimesession

POST https://{endpoint}/openai/realtimeapi/sessions?api-version=2025-04-01-preview

リアルタイムAPIを使ってクライアントサイドアプリケーションで使用するための一時的なAPIトークンを作成します。 session.updateクライアントイベントと同じセッションパラメータで設定可能です。 セッションオブジェクトと、リアルタイムAPIのブラウザクライアント認証に使用できる一時的なAPIトークンを含む client_secret キーで応答します。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

説明:セッションが正常に作成されました。

Create - Transcriptionrealtimesession

POST https://{endpoint}/openai/realtimeapi/transcription_sessions?api-version=2025-04-01-preview

Realtime APIを使ってクライアントサイドアプリケーションで使う一時的なAPIトークンを作成し、リアルタイム文字起こし専用に作成してください。 transcription_session.updateクライアントイベントと同じセッションパラメータで設定可能です。 セッションオブジェクトと、リアルタイムAPIのブラウザクライアント認証に使用できる一時的なAPIトークンを含む client_secret キーで応答します。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

説明:セッションが正常に作成されました。

Responses

POST https://{endpoint}/openai/responses?api-version=2025-04-01-preview

モデル的な反応を作り出します。

Request Body

Content-Type: application/json

Responses

ステータスコード: 200

Description: OK

ステータスコード: デフォルト

説明:サービス利用不可

Responses API - 入力項目

GET https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

与えられたIDでモデル応答を取得します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

ステータスコード: デフォルト

説明:サービス利用不可

Delete response

DELETE https://{endpoint}/openai/responses/{response_id}?api-version=2025-04-01-preview

指定されたIDのモデル応答を削除します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

ステータスコード: 404

説明:見つかりません

ステータスコード: デフォルト

説明:サービス利用不可

Responses API - レスポンスアイテムリスト

GET https://{endpoint}/openai/responses/{response_id}/input_items?api-version=2025-04-01-preview

与えられた応答に対して入力項目のリストを返します。

URI Parameters

Request Header

トークンベースの認証かAPIキーのいずれかを使ってください。 トークンベースの認証を用いることが推奨され、より安全です。

Responses

ステータスコード: 200

Description: OK

Components

errorResponse

errorBase