独自のデータに基づく Azure OpenAI の API リファレンス

注

このドキュメントでは、 Microsoft Foundry (クラシック) ポータルを参照します。

🔍 新しいポータルの詳細については、Microsoft Foundry (新しい) ドキュメントを参照してください。

Important

Azure OpenAI On Your Data は非推奨となり、廃止に近づいています。

Microsoft は、Azure OpenAI On Your Data への新しいモデルのオンボードを停止しました。この機能は、次のモデルのみをサポートします。

GPT-4o (バージョン 2024-05-13、2024-08-06、および 2024-11-20)
GPT-4o-mini (バージョン 2024-07-18)
GPT-4.1、GPT-4.1-mini、GPT-4.1-nano (バージョン 2025-04-14)

GPT-4.1 モデルが廃止されると、すべての Azure OpenAI On Your Data API エンドポイントとサポートされているデータソースコネクタが機能しなくなります。

Azure OpenAI On Your Data ワークロードを Foundry IQ を使用して Foundry Agent Service に移行して、コンテンツを取得し、データから根拠のある回答を生成することをお勧めします。開始するには、 Foundry IQ ナレッジベースの接続に関する記事を参照してください。

この記事では、新しい Azure OpenAI On Your Data API の Python と REST 用のリファレンスドキュメントを提供します。最新の API バージョンは 2024-05-01-previewSwagger の仕様です。

注

API バージョン 2024-02-15-preview 以降、以前の API バージョンと比較して、次の破壊的変更が導入されました。

API パスが /extensions/chat/completions から /chat/completions に変更されます。
プロパティキーと列挙値の名前付け規則は、キャメルケースからスネークケースの大文字と小文字表現に変更されます。例: deploymentName が deployment_name に変更されます。
データソースの種類 AzureCognitiveSearch が azure_search に変更されます。
引用と意図は、アシスタントメッセージのコンテキストツールメッセージから、明示的なスキーマが定義されたアシスタントメッセージのコンテキストルートレベルに移動されます。

POST {endpoint}/openai/deployments/{deployment-id}/chat/completions?api-version={api-version}

サポートされているバージョン

2024-02-15-preview Swagger の仕様。
2024-02-01 Swagger の仕様。
2024-05-01-preview Swagger の仕様

注

Pinecone と Elasticsearch は、プレビューとしてのみサポートされます。

URI パラメーター

名前	で	タイプ	必須	説明
`deployment-id`	パス	文字列	正しい	この要求に使用するチャット完了モデルのデプロイ名を指定します。
`endpoint`	パス	文字列	正しい	Azure OpenAI エンドポイント。例: `https://{YOUR_RESOURCE_NAME}.openai.azure.com`
`api-version`	クエリ	文字列	正しい	この操作に使用する API バージョン。

リクエストの本文

要求本文は、チャット完了 API 要求と同じスキーマを継承します。次の表に、Azure OpenAI On Your Data に固有のパラメーターを示します。

名前	タイプ	必須	説明
`data_sources`	データソース[]	正しい	Azure OpenAI On Your Data の構成エントリ。配列には 1 つの要素が必要です。指定されていない場合、`data_sources` サービスはチャット入力候補モデルを直接使用し、Azure OpenAI On Your Data を使用しません。 `data_sources` パラメーターを指定すると、`logprobs`または`top_logprobs`パラメーターを使用できなくなります。

応答内容

応答本文は、チャット完了 API 応答と同じスキーマを継承します。応答チャットメッセージには context プロパティがあります。これは、Azure OpenAI On Your Data 用に追加されます。

チャットメッセージ

応答アシスタントメッセージスキーマはチャット入力候補アシスタントのチャットメッセージから継承され、プロパティ context で拡張されます。

名前	タイプ	必須	説明
`context`	コンテキスト	いいえ	取得したドキュメントなど、要求の処理中に Azure OpenAI On Your Data によって実行される増分ステップを表します。

コンテキスト

名前	タイプ	必須	説明
`citations`	引用[]	いいえ	応答でアシスタントメッセージを生成するために使用されるデータソースの取得結果。クライアントでは、引用文献からの参照をレンダリングできます。
`intent`	文字列	いいえ	チャット履歴から検出された意図。前の意図を戻す必要はなくなりました。このプロパティは無視します。
`all_retrieved_documents`	取得したドキュメント[]	いいえ	すべての取得したドキュメント。

引用

名前	タイプ	必須	説明
`content`	文字列	正しい	引用の内容。
`title`	文字列	いいえ	引用のタイトル。
`url`	文字列	いいえ	引用の URL。
`filepath`	文字列	いいえ	引用のファイルパス。
`chunk_id`	文字列	いいえ	引用のチャンク ID。

取得したドキュメント

名前	タイプ	必須	説明
`search_queries`	文字列[]	正しい	ドキュメント取得に使用した検索クエリ。
`data_source_index`	整数	正しい	データソースのインデックス。
`original_search_score`	ダブル	正しい	取得したドキュメントの元の検索スコア。
`rerank_score`	ダブル	いいえ	取得したドキュメントの再ランク付けスコア。
`filter_reason`	文字列	いいえ	ドキュメントをフィルター処理するための根拠を表します。ドキュメントがフィルター処理されない場合は、このフィールドは設定されないままになります。ドキュメントが `score` で定義された元の検索スコアのしきい値でフィルター処理されている場合、`strictness` になります。ドキュメントが、元の検索スコアのしきい値でフィルター処理されずに再ランク付けスコアと `rerank` でフィルター処理されている場合、`top_n_documents` になります。

データソース

この一覧には、サポートされているデータソースが表示されます。

例示

この例では、より良い結果を得るために会話履歴を渡す方法を示します。

前提条件:

Azure OpenAI システム割り当てマネージド ID から Azure Search サービスへのロールの割り当てを構成します。必要なロール: Search Index Data Reader、Search Service Contributor。
ユーザーから Azure OpenAI リソースへのロールの割り当てを構成します。必要なロール: Cognitive Services OpenAI User。
Az CLI をインストールし、az login を実行します。
環境変数 AzureOpenAIEndpoint、ChatCompletionsDeploymentName、SearchEndpoint、SearchIndex を定義します。

export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export SearchEndpoint=https://example.search.windows.net
export SearchIndex=example-index

Python 1.x
レスト

最新の pip パッケージ openai、azure-identity をインストールします。

import os
from openai import AzureOpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider

endpoint = os.environ.get("AzureOpenAIEndpoint")
deployment = os.environ.get("ChatCompletionsDeploymentName")
search_endpoint = os.environ.get("SearchEndpoint")
search_index = os.environ.get("SearchIndex")

token_provider = get_bearer_token_provider(DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default")

client = AzureOpenAI(
    azure_endpoint=endpoint,
    azure_ad_token_provider=token_provider,
    api_version="2024-05-01-preview",
)

completion = client.chat.completions.create(
    model=deployment,
    messages=[
        {
            "role": "user",
            "content": "Who is DRI?",
        },
        {
            "role": "assistant",
            "content": "DRI stands for Directly Responsible Individual of a service. Which service are you asking about?"
        },
        {
            "role": "user",
            "content": "Opinion mining service"
        }
    ],
    extra_body={
        "data_sources": [
            {
                "type": "azure_search",
                "parameters": {
                    "endpoint": search_endpoint,
                    "index_name": search_index,
                    "authentication": {
                        "type": "system_assigned_managed_identity"
                    }
                }
            }
        ]
    }
)

print(completion.model_dump_json(indent=2))

# render the citations

content = completion.choices[0].message.content
context = completion.choices[0].message.context
for citation_index, citation in enumerate(context["citations"]):
    citation_reference = f"[doc{citation_index + 1}]"
    url = "https://example.com/?redirect=" + citation["url"] # replace with actual host and encode the URL
    filepath = citation["filepath"]
    title = citation["title"]
    snippet = citation["content"]
    chunk_id = citation["chunk_id"]
    replaced_html = f"<a href='{url}' title='{title}\n{snippet}''>(See from file {filepath}, Part {chunk_id})</a>"
    content = content.replace(citation_reference, replaced_html)
print(content)

az rest --method POST \
 --uri $AzureOpenAIEndpoint/openai/deployments/$ChatCompletionsDeploymentName/chat/completions?api-version=2024-05-01-preview \
 --resource https://cognitiveservices.azure.com/ \
 --body \
'
{
    "data_sources": [
        {
            "type": "azure_search",
            "parameters": {
                "endpoint": "'$SearchEndpoint'",
                "index_name": "'$SearchIndex'",
                "authentication": {
                    "type": "system_assigned_managed_identity"
                }
            }
        }
    ],
    "messages": [
        {
            "role": "user",
            "content": "Who is DRI?"
        },
        {
            "role": "assistant",
            "content": "DRI stands for Directly Responsible Individual of a service. Which service are you asking about?"
        },
        {
            "role": "user",
            "content": "Opinion mining service"
        }
    ]
}
'

フィードバック

このページはお役に立ちましたか?

Last updated on 2026-02-07