Knowledge Bases - Get

サービス:: Search Service

API バージョン:: 2026-08-01-preview

ナレッジベースの定義を取得します。

GET {endpoint}/knowledgebases('{knowledgeBaseName}')?api-version=2026-08-01-preview

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string (uri)	検索サービスのエンドポイント URL。
knowledgeBaseName	path	True	string	ナレッジベースの名前。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

応答

名前	型	説明
200 OK	KnowledgeBase	要求は成功しました。
Other Status Codes	ErrorResponse	予期しないエラー応答。

セキュリティ

api-key

型: apiKey
/: header

OAuth2Auth

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/v2.0/authorize

スコープ

名前	説明
https://search.azure.com/.default

例

SearchServiceGetKnowledgeBase

要求のサンプル

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')?api-version=2026-08-01-preview

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "base-preview-test",
  "description": "Description of the knowledge base.",
  "retrievalInstructions": "Instructions for retrieval for the knowledge base.",
  "answerInstructions": "Instructions for answer synthesis.",
  "outputMode": "extractiveData",
  "knowledgeSources": [
    {
      "name": "ks-preview-test"
    }
  ],
  "models": [
    {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com",
        "deploymentId": "myDeployment",
        "apiKey": "<redacted>",
        "modelName": "gpt-4o-mini"
      }
    }
  ],
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "tags": {
    "businessUnit": "Contoso Engineering Department",
    "costCenter": "ABC-123",
    "owner": "Contoso"
  },
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  },
  "retrieveDefaults": {
    "maxRuntimeInSeconds": 45,
    "maxOutputDocuments": 8,
    "maxOutputSizeInTokens": 12000
  }
}

定義

名前	説明
Accept	Acceptヘッダーです。
AzureOpenAIModelName	呼び出される Azure Open AI モデル名。
AzureOpenAIVectorizerParameters	Azure OpenAI リソースに接続するためのパラメーターを指定します。
CorsOptions	インデックスのクロスオリジンリソース共有 (CORS) を制御するオプションを定義します。
ErrorAdditionalInfo	リソース管理エラーの追加情報
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
KnowledgeBase	ナレッジベースの定義を表しています。
KnowledgeBaseAzureOpenAIModel	クエリ計画の実行に使用する Azure OpenAI リソースを指定します。
KnowledgeBaseModelKind	クエリ計画に使用される AI モデル。
KnowledgeBaseRetrieveDefaults	ナレッジベースの取得リクエストに対してリクエスト全体のデフォルトを永続化します。各値は対応するリトリート-リクエストフィールドのデフォルトを提供します。サービスデフォルトは設定されていない時に適用され、リクエストタイムの値が存在する場合は優先されます。
KnowledgeRetrievalAutoReasoningEffort	検索時に自動的に推論努力を選択します。サービスはすべてのリクエストを最も安価なティアでシードし、サービスの最大利用可能なティアまで必要な範囲でのみエスカレーションします。
KnowledgeRetrievalLowReasoningEffort	知識検索は、推論の手間を抑えて実行しましょう。
KnowledgeRetrievalMediumReasoningEffort	中程度の推論作業で知識検索を実行します。
KnowledgeRetrievalMinimalReasoningEffort	最小限の推論で知識検索を実行しましょう。
KnowledgeRetrievalOutputMode	この取得の出力設定。
KnowledgeRetrievalReasoningEffortKind	取得中に使用する作業量。
KnowledgeSourceReference	知識源への言及。
SearchIndexerDataNoneIdentity	データソースの ID プロパティをクリアします。
SearchIndexerDataUserAssignedIdentity	使用するデータソースの ID を指定します。
SearchResourceEncryptionKey	Azure Key Vault のカスタマーマネージド暗号化キー。作成および管理するキーを使用して、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除を行うことができます。

Accept

列挙

Acceptヘッダーです。

値	説明
application/json;odata.metadata=minimal

AzureOpenAIModelName

列挙

呼び出される Azure Open AI モデル名。

値	説明
text-embedding-ada-002	TextEmbeddingAda002モデル。
text-embedding-3-large	TextEmbedding3Largeモデル。
text-embedding-3-small	TextEmbedding3Small モデル。
gpt-4o	GPT4oモデル。
gpt-4o-mini	GPT4oMiniモデル。
gpt-4.1	GPT41モデル。
gpt-4.1-mini	GPT41Miniモデルです。
gpt-4.1-nano	GPT41Nanoモデル。
gpt-5	GPT5モデル。
gpt-5-mini	GPT5Miniモデル。
gpt-5-nano	Gpt5Nanoモデルです。
gpt-5.1	GPT51モデル。
gpt-5.2	GPT52モデル。
gpt-5.4	GPT54モデルです。
gpt-5.4-mini	GPT54Miniモデル。
gpt-5.4-nano	Gpt54Nanoモデル。
gpt-5.5	GPT55モデルです。
gpt-5.6-sol	GPT56Solモデル。
gpt-5.6-terra	GPT56Terraモデル。
gpt-5.6-luna	GPT56Lunaモデル。

AzureOpenAIVectorizerParameters

Object

Azure OpenAI リソースに接続するためのパラメーターを指定します。

名前	型	説明
apiKey	string	指定された Azure OpenAI リソースの API キー。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	送信接続に使用されるユーザー割り当てマネージド ID。
deploymentId	string	指定されたリソースに対する Azure OpenAI モデルデプロイの ID。
modelName	AzureOpenAIModelName	指定された deploymentId パスにデプロイされる埋め込みモデルの名前。
resourceUri	string (uri)	Azure OpenAI リソースのリソース URI。

CorsOptions

Object

インデックスのクロスオリジンリソース共有 (CORS) を制御するオプションを定義します。

名前	型	説明
allowedOrigins	string[]	JavaScript コードにインデックスへのアクセスを許可されるオリジンのリスト。 {protocol}://{fully-qualified-domain-name}[:{port#}] 形式のホストのリスト、またはすべてのオリジンを許可する 1 つの '*' を含めることができます (推奨されません)。
maxAgeInSeconds	integer (int64)	ブラウザーが CORS プリフライト応答をキャッシュする期間。デフォルトは 5 分です。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報

名前	型	説明
info		追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーに関する追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーの対象。

ErrorResponse

Object

失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

KnowledgeBase

Object

ナレッジベースの定義を表しています。

名前	型	説明
@odata.etag	string	ナレッジベースの ETag。
answerInstructions	string	回答を生成する際にナレッジベースが考慮する指示。
corsOptions	CorsOptions	ナレッジベースにおけるクロスオリジン資源共有(CORS)の制御オプション。
description	string	ナレッジベースの説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。
knowledgeSources	KnowledgeSourceReference[]	このナレッジベースで参照される知識源。
models	KnowledgeBaseModel[]: KnowledgeBaseAzureOpenAIModel[]	AI モデルへの接続方法に関する構成オプションが含まれています。
name	string	ナレッジベースの名前。
outputMode	KnowledgeRetrievalOutputMode	ナレッジベースの出力モードです。
retrievalInstructions	string	クエリプラン作成時にナレッジベースが考慮する指示。
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	検索推論の努力構成。
retrieveDefaults	KnowledgeBaseRetrieveDefaults	このナレッジベースのリクエスト全体での永続的な取得デフォルト。これらの値は対応するフィールドを省略したリクエストの取得に適用されます。存在する場合はリクエスト時間の値が優先されます。
tags	object	ナレッジベースを分類し、その利用状況やコストを割り当てるユーザー定義のキー-値ペア。

KnowledgeBaseAzureOpenAIModel

Object

クエリ計画の実行に使用する Azure OpenAI リソースを指定します。

名前	型	説明
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAIパラメータ。
kind	string: azureOpenAI	クエリ計画に使用される AI モデル。

KnowledgeBaseModelKind

列挙

クエリ計画に使用される AI モデル。

値	説明
azureOpenAI	クエリ計画に Azure Open AI モデルを使用します。

KnowledgeBaseRetrieveDefaults

Object

ナレッジベースの取得リクエストに対してリクエスト全体のデフォルトを永続化します。各値は対応するリトリート-リクエストフィールドのデフォルトを提供します。サービスデフォルトは設定されていない時に適用され、リクエストタイムの値が存在する場合は優先されます。

名前	型	説明
maxOutputDocuments	integer (int32)	取得出力のデフォルト最大ドキュメント数です。
maxOutputSizeInTokens	integer (int32)	リトリーブ出力のコンテンツのデフォルトの最大サイズ(トークン単位)です。
maxRuntimeInSeconds	integer (int32)	取得リクエストのデフォルトの最大実行時間は秒単位です。

KnowledgeRetrievalAutoReasoningEffort

Object

検索時に自動的に推論努力を選択します。サービスはすべてのリクエストを最も安価なティアでシードし、サービスの最大利用可能なティアまで必要な範囲でのみエスカレーションします。

名前	型	説明
kind	string: auto	推論の努力のようなものです。

KnowledgeRetrievalLowReasoningEffort

Object

知識検索は、推論の手間を抑えて実行しましょう。

名前	型	説明
kind	string: low	推論の努力のようなものです。

KnowledgeRetrievalMediumReasoningEffort

Object

中程度の推論作業で知識検索を実行します。

名前	型	説明
kind	string: medium	推論の努力のようなものです。

KnowledgeRetrievalMinimalReasoningEffort

Object

最小限の推論で知識検索を実行しましょう。

名前	型	説明
kind	string: minimal	推論の努力のようなものです。

KnowledgeRetrievalOutputMode

列挙

この取得の出力設定。

値	説明
extractiveData	生成変更なしでナレッジソースから直接データを返します。
answerSynthesis	応答ペイロードの回答を合成します。

KnowledgeRetrievalReasoningEffortKind

列挙

取得中に使用する作業量。

値	説明
minimal	ソースの選択、クエリの計画、または反復検索は実行しません。
low	検索中は低い推論を使用します。
medium	検索中は適度な量の推論を使用します。
auto	回収時に自動的に理由付けの努力を選択し、最も安い階層から必要な範囲だけエスカレーションします。

KnowledgeSourceReference

Object

知識源への言及。

名前	型	説明
enableFreshness	boolean	この知識ソースに対して新鮮度認識検索を有効にするべきかどうかを示します。正しい場合、検索時に新しさスコアプロファイルが適用され、結果は新しい文書に偏ります。
enableImageServing	boolean	この知識ソースに対して画像提供を有効にするべきかどうかを示します。もしそうであれば、インジェスト時に抽出された画像はクエリ時に下流モデルに提供されます。
name	string	ナレッジソースの名前。

SearchIndexerDataNoneIdentity

Object

データソースの ID プロパティをクリアします。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	ID のタイプを指定する URI フラグメント。

SearchIndexerDataUserAssignedIdentity

Object

使用するデータソースの ID を指定します。

名前	型	説明
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	ID のタイプを指定する URI フラグメント。
federatedIdentityClientId	string	マルチテナント User-Assigned マネージドIDサポート:ユーザー割り当てのマネージデンティティIDとフェデレートするように設定されたマルチテンタントアプリのクライアントID。
userAssignedIdentity	string	通常、ユーザー割り当てマネージド ID の完全修飾 Azure リソース ID は、検索サービスに割り当てられている必要がある "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" の形式です。

SearchResourceEncryptionKey

Object

Azure Key Vault のカスタマーマネージド暗号化キー。作成および管理するキーを使用して、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除を行うことができます。

名前	型	規定値	説明
accessCredentials.applicationId	string		保存データの暗号化時に使用される Azure Key Vault に対する必要なアクセス許可が付与された AAD アプリケーション ID。アプリケーション ID は、AAD アプリケーションのオブジェクト ID と混同しないでください。
accessCredentials.applicationSecret	string		指定した AAD アプリケーションの認証キー。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		この暗号化キーに使用する明示的なマネージド ID。指定されず、アクセス資格情報プロパティが null の場合は、システム割り当てマネージド ID が使用されます。リソースの更新時に、明示的な ID が指定されていない場合、変更されません。 "none" が指定されている場合、このプロパティの値はクリアされます。
isServiceLevelKey	boolean	False	このキーがサービスレベルキーかどうかを示すオプションの値です。既定値は falseです。
keyVaultKeyName	string		保存データの暗号化に使用する Azure Key Vault キーの名前。
keyVaultKeyVersion	string		保存データの暗号化に使用する Azure Key Vault キーのバージョン。
keyVaultUri	string		保存データの暗号化に使用するキーを含む Azure Key Vault の URI (DNS 名とも呼ばれます)。 URI の例は、`https://my-keyvault-name.vault.azure.net`可能性があります。