参照ドキュメント (Azure AI Search REST API)
Lookup Document 操作は、Azure AI Search からドキュメントを取得します。 これは、ユーザーが特定の検索結果をクリックして、そのドキュメントに関する詳細を検索するときに役立ちます。 一度に取得できるドキュメントは 1 つだけです。 [ドキュメントの検索] を使用して、1 つの要求で複数のドキュメントを取得します。
GET https://[service name].search.windows.net/indexes/[index name]/docs/key?[query parameters]
Content-Type: application/json
api-key: [admin or query key]
または、従来の OData 構文をキー参照に使用することもできます。
GET /indexes/[index name]/docs('[key]')?[query parameters]
URI パラメーター
| パラメーター | 説明 |
|---|---|
| サービス名 | 必須。 これを検索サービスの一意のユーザー定義名に設定します。 |
| インデックス名 | 必須。 要求 URI では、クエリするインデックスの名前を指定します。 クエリ パラメーターは、GET 要求のクエリ文字列と POST 要求の要求本文で指定されます。 |
| key | 必須。 インデックス内の Edm.String 各ドキュメントを一意に識別する値。 キーは、ドキュメント ID と呼ばれることもあります。 キーの値では大文字と小文字が区別されます。 たとえば、キー "abc" を持つドキュメントは、キー "ABC" を持つドキュメントとは異なります。 |
| クエリ パラメーター (query parameters) | (省略可能) と api-version=2020-06-30 (必須) を$select含むマルチパート構造。 この操作の場合、クエリ パラメーターとして api-version を指定します。 $select=[string] は、取得するコンマ区切りフィールドの一覧です。 この句には、取得可能としてマークされたフィールドのみを含めることができます。 指定しない場合、または *に設定した場合は、スキーマで取得可能とマークされているすべてのフィールドが含まれます。 |
要求ヘッダー
次の表では、必須と省略可能の要求ヘッダーについて説明します。
| フィールド | 説明 |
|---|---|
| Content-Type | 必須。 これを application/json |
| api-key | Azure ロールを使用していて、要求にベアラー トークンが指定されている場合は省略可能。それ以外の場合はキーが必要です。 api-key は、検索サービスに対する要求を認証する一意のシステム生成文字列です。 オブジェクト定義の要求を取得するには、(クエリ キーではなく) 管理キーに設定された api-key フィールドを含める必要があります。 詳細については、「 キー認証を使用して Azure AI Search に接続 する」を参照してください。 |
要求本文
[なし] :
Response
状態コード: 正常に応答するために "200 OK" が返されます。
{
field_name: field_value (fields matching the default or specified projection)
}
例
キー '2' を持つドキュメントを検索します。
GET /indexes/hotels/docs/2?api-version=2020-06-30
OData 構文を使用して、キー '3' を持つドキュメントを参照します。
GET /indexes/hotels/docs('3')?api-version=2020-06-30