Knowledge Sources - Create Or Update

サービス:: Search Service

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

新しいナレッジソースを作成するか、ナレッジソースが既に存在する場合は更新します。

PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2026-08-01-preview

URI パラメーター

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

要求ヘッダー

名前	必須	型	説明
Accept		Accept	Acceptヘッダーです。
If-Match		string	If-Match 条件を定義します。この操作は、サーバー上の ETag がこの値に一致する場合にのみ実行されます。
If-None-Match		string	If-None-Match 条件を定義します。この操作は、サーバー上の ETag がこの値と一致しない場合にのみ実行されます。
Prefer	True	Prefer	HTTP PUT 要求の場合、成功時に作成/更新されたリソースを返すようにサービスに指示します。
x-ms-client-request-id		string (uuid)	要求の非透過的なグローバルに一意のクライアント生成文字列識別子。

要求本文

要求本文は、次のいずれかの可能性があります。

名前	説明
AzureBlobKnowledgeSource	Azure Blob Storage の構成ナレッジソース。
FabricDataAgentKnowledgeSource	Fabric Data Agent ナレッジソースの設定。
FabricOntologyKnowledgeSource	Fabric Ontologyの知識ソースのための構成。
FileKnowledgeSource	ファイル知識ソースの構成は、直接ファイルのアップロードとインデックス作成をサポートします。
IndexedOneLakeKnowledgeSource	OneLake ナレッジソースの構成。
IndexedSharePointKnowledgeSource	SharePoint ナレッジソースの構成。
IndexedSqlKnowledgeSource	インデックス付きSQLのナレッジソースの設定。
McpServerKnowledgeSource	MCP(モデルコンテキストプロトコル)サーバーでバックアップされた知識ソースの設定。
RemoteSharePointKnowledgeSource	リモート SharePoint ナレッジソースの構成。
SearchIndexKnowledgeSource	検索インデックスを対象とするナレッジソース。
WebKnowledgeSource	Web 結果をターゲットとするナレッジソース。
WorkIQKnowledgeSource	WorkIQナレッジソースの設定。

AzureBlobKnowledgeSource

Azure Blob Storage の構成ナレッジソース。

名前	必須	型	説明
azureBlobParameters	True	AzureBlobKnowledgeSourceParameters	ナレッジソースのタイプ。
kind	True	string: azureBlob	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

FabricDataAgentKnowledgeSource

Fabric Data Agent ナレッジソースの設定。

名前	必須	型	説明
fabricDataAgentParameters	True	FabricDataAgentKnowledgeSourceParameters	Fabric Data Agentの知識ソースのパラメータ。
kind	True	string: fabricDataAgent	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

FabricOntologyKnowledgeSource

Fabric Ontologyの知識ソースのための構成。

名前	必須	型	説明
fabricOntologyParameters	True	FabricOntologyKnowledgeSourceParameters	Fabric Ontologyの知識ソースのパラメータ。
kind	True	string: fabricOntology	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

FileKnowledgeSource

ファイル知識ソースの構成は、直接ファイルのアップロードとインデックス作成をサポートします。

名前	必須	型	説明
fileParameters	True	FileKnowledgeSourceParameters	ファイル知識ソースのパラメータ。
kind	True	string: file	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
corsOptions		CorsOptions	ファイル知識ソースのファイルエンドポイント(アップロード、リスト、更新、削除)に対するクロスオリジンリソース共有(CORS)の制御オプション。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

IndexedOneLakeKnowledgeSource

OneLake ナレッジソースの構成。

名前	必須	型	説明
indexedOneLakeParameters	True	IndexedOneLakeKnowledgeSourceParameters	ナレッジソースのパラメーター。
kind	True	string: indexedOneLake	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

IndexedSharePointKnowledgeSource

SharePoint ナレッジソースの構成。

名前	必須	型	説明
indexedSharePointParameters	True	IndexedSharePointKnowledgeSourceParameters	ナレッジソースのパラメーター。
kind	True	string: indexedSharePoint	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

IndexedSqlKnowledgeSource

インデックス付きSQLのナレッジソースの設定。

名前	必須	型	説明
indexedSqlParameters	True	IndexedSqlKnowledgeSourceParameters	SQL知識ソースのパラメータです。
kind	True	string: indexedSql	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

McpServerKnowledgeSource

MCP(モデルコンテキストプロトコル)サーバーでバックアップされた知識ソースの設定。

名前	必須	型	説明
kind	True	string: mcpServer	ナレッジソースのタイプ。
mcpServerParameters	True	McpServerKnowledgeSourceParameters	MCPサーバーの知識ソースのパラメータ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

RemoteSharePointKnowledgeSource

リモート SharePoint ナレッジソースの構成。

名前	必須	型	説明
kind	True	string: remoteSharePoint	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
remoteSharePointParameters		RemoteSharePointKnowledgeSourceParameters	リモートSharePointナレッジソースのパラメータ。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

SearchIndexKnowledgeSource

検索インデックスを対象とするナレッジソース。

名前	必須	型	説明
kind	True	string: searchIndex	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
searchIndexParameters	True	SearchIndexKnowledgeSourceParameters	ナレッジソースのパラメーター。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

WebKnowledgeSource

Web 結果をターゲットとするナレッジソース。

名前	必須	型	説明
kind	True	string: web	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。
webParameters		WebKnowledgeSourceParameters	Web ナレッジソースのパラメーター。

WorkIQKnowledgeSource

WorkIQナレッジソースの設定。

名前	必須	型	説明
kind	True	string: workIQ	ナレッジソースのタイプ。
name	True	string	ナレッジソースの名前。
workIQParameters	True	WorkIQKnowledgeSourceParameters	認証に使用される顧客所有のEntraアプリ構成を含むWorkIQナレッジソースのパラメータ。
@odata.etag		string	知識源のETag。
description		string	オプションのユーザー定義の説明。
encryptionKey		SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
resultsProcessing		KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

応答

名前	型	説明
200 OK	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	要求は成功しました。
201 Created	KnowledgeSource: AzureBlobKnowledgeSource FabricDataAgentKnowledgeSource FabricOntologyKnowledgeSource FileKnowledgeSource IndexedOneLakeKnowledgeSource IndexedSharePointKnowledgeSource IndexedSqlKnowledgeSource McpServerKnowledgeSource RemoteSharePointKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource WorkIQKnowledgeSource	要求が成功し、結果として新しいリソースが作成されました。
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

例

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent

SearchServiceCreateOrUpdateKnowledgeSourceFabricOntology

SearchServiceCreateOrUpdateKnowledgeSourceFile

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql

SearchServiceCreateOrUpdateKnowledgeSourceMcpServer

SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ

SearchServiceCreateOrUpdateKnowledgeSource

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "resultsProcessing": "none",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "resultsProcessing": "none",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "semanticConfigurationName": "testconfig",
    "baseFilter": "category eq 'news'",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      },
      "networkAccessMode": "private"
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "rbacScope"
      ],
      "contentExtractionMode": "standard",
      "networkAccessMode": "private",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "datasource": "ks-preview-test-datasource",
      "indexer": "ks-preview-test-indexer",
      "skillset": "ks-preview-test-skillset",
      "index": "ks-preview-test-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent

要求のサンプル

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabric-agent-test')?api-version=2026-08-01-preview





{
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  },
  "name": "ks-fabric-agent-test",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "kind": "fabricDataAgent",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabric-agent-test",
  "kind": "fabricDataAgent",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabric-agent-test",
  "kind": "fabricDataAgent",
  "description": "Description of the Fabric Data Agent knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricDataAgentParameters": {
    "workspaceId": "fakeWorkspaceId",
    "dataAgentId": "fakeAgentId"
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFabricOntology

要求のサンプル

HTTP

PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabricontology-test')?api-version=2026-08-01-preview





{
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  },
  "name": "ks-fabricontology-test",
  "description": "Description of the Fabric Ontology knowledge source.",
  "kind": "fabricOntology",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabricontology-test",
  "kind": "fabricOntology",
  "description": "Description of the Fabric Ontology knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-fabricontology-test",
  "kind": "fabricOntology",
  "description": "Description of the Fabric Ontology knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "fabricOntologyParameters": {
    "workspaceId": "12345678-1234-1234-1234-123456789abc",
    "ontologyId": "ontology-456"
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceFile

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "name": "ks-preview-test",
  "description": "Description of the File knowledge source.",
  "kind": "file",
  "fileParameters": {
    "ingestionParameters": {
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "index": "ks-preview-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "file",
  "description": "Description of the File knowledge source.",
  "fileParameters": {
    "ingestionParameters": {
      "contentExtractionMode": "standard",
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    },
    "createdResources": {
      "index": "ks-preview-test-index"
    }
  },
  "corsOptions": {
    "allowedOrigins": [
      "https://myapp.example.com"
    ],
    "maxAgeInSeconds": 300
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "name": "ks-preview-test",
  "description": "Description of the OneLake knowledge source.",
  "kind": "indexedOneLake",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "name": "ks-preview-test",
  "description": "Description of the SharePoint knowledge source.",
  "kind": "indexedSharePoint",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSharePoint",
  "description": "Description of the SharePoint knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSharePointParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "defaultSiteLibrary",
    "query": "*.docx OR *.pdf",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "ingestionPermissionOptions": [
        "userIds",
        "groupIds"
      ],
      "contentExtractionMode": "standard",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "chatCompletionModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-4o-mini"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "assetStore": {
        "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
        "containerName": "image-assets"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      },
      "freshnessPolicy": {
        "boostingDuration": "P90D"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedSql

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "name": "ks-preview-test",
  "description": "Description of the SQL knowledge source.",
  "kind": "indexedSql",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "minimal"
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "boostInstructions": "Document language; pick from the user's locale.",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2
        }
      ]
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSql",
  "description": "Description of the SQL knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "contentExtractionMode": "minimal",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "indexedSql",
  "description": "Description of the SQL knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedSqlParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "tableOrView": "dbo.Products",
    "contentColumns": [
      {
        "name": "title",
        "sourceField": "Title",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "description",
        "sourceField": "Description",
        "searchFieldType": "Edm.String"
      },
      {
        "name": "price",
        "sourceField": "Price",
        "searchFieldType": "Edm.Double"
      }
    ],
    "embeddingColumns": [
      {
        "name": "descriptionEmbedding",
        "sourceField": "Description"
      }
    ],
    "ingestionParameters": {
      "contentExtractionMode": "minimal",
      "identity": {
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
        "userAssignedIdentity": "/my/userassigned/id"
      },
      "embeddingModel": {
        "kind": "azureOpenAI",
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      }
    },
    "queryHints": {
      "filters": [
        {
          "field": "model",
          "fieldValues": [
            "Model-X100",
            "Model-X200",
            "Model-Pro"
          ],
          "filterInstructions": "Product model name."
        }
      ],
      "boosts": [
        {
          "kind": "fieldValue",
          "field": "language",
          "fieldValues": [
            "en",
            "ja",
            "fr",
            "de"
          ],
          "boost": 2,
          "boostInstructions": "Document language; pick from the user's locale."
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceMcpServer

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "name": "ks-preview-test",
  "description": "Description of the MCP server knowledge source.",
  "kind": "mcpServer",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        },
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096
      }
    ]
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "mcpServer",
  "description": "Description of the MCP server knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "mcpServer",
  "description": "Description of the MCP server knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "mcpServerParameters": {
    "serverURL": "https://mcp.contoso.com/sse",
    "authentication": {
      "kind": "foundryConnection",
      "foundryConnectionParameters": {
        "connectionId": "conn-123"
      }
    },
    "tools": [
      {
        "name": "search-code",
        "resultsProcessing": "rerank",
        "maxOutputTokens": 4096,
        "outputParsing": {
          "kind": "json",
          "jsonParameters": {
            "documentsPath": "$.documents[*]",
            "includeContext": true
          }
        }
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "web",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "web",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "webParameters": {
    "domains": {
      "allowedDomains": [
        {
          "address": "example.com",
          "includeSubpages": true
        },
        {
          "address": "another-example.com"
        }
      ],
      "blockedDomains": [
        {
          "address": "blocked.com"
        },
        {
          "address": "spam.com",
          "includeSubpages": true
        }
      ]
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWorkIQ

要求のサンプル

HTTP

PUT https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-08-01-preview






{
  "name": "ks-preview-test",
  "description": "Description of the WorkIQ knowledge source.",
  "kind": "workIQ",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

応答のサンプル

状態コード:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "workIQ",
  "description": "Description of the WorkIQ knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "isServiceLevelKey": false,
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "workIQParameters": {
    "entraAppAuthentication": {
      "applicationId": "11111111-1111-1111-1111-111111111111",
      "federatedCredentialId": "22222222-2222-2222-2222-222222222222"
    }
  }
}

定義

名前	説明
Accept	Acceptヘッダーです。
AIServices	AIサービスのパラメータ。
AssetStore	画像などの抽出した資産を保存するためのアセットストアの設定。
AzureBlobKnowledgeSource	Azure Blob Storage の構成ナレッジソース。
AzureBlobKnowledgeSourceParameters	Azure Blob Storage ナレッジソースのパラメーター。
AzureOpenAIModelName	呼び出される Azure Open AI モデル名。
AzureOpenAIVectorizerParameters	Azure OpenAI リソースに接続するためのパラメーターを指定します。
ContentColumnMapping	SQL列を検索インデックスフィールドにマッピングします。
CorsOptions	インデックスのクロスオリジンリソース共有 (CORS) を制御するオプションを定義します。
EmbeddingColumnMapping	SQL列をベクトルフィールドにマッピングして埋め込みを行います。
EntraAppAuthentication	フェデレーテッド認証認証に使用される顧客所有のMicrosoft Entraアプリ登録の設定。
ErrorAdditionalInfo	リソース管理エラーの追加情報
ErrorDetail	エラーの詳細。
ErrorResponse	失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API の一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。
FabricDataAgentKnowledgeSource	Fabric Data Agent ナレッジソースの設定。
FabricDataAgentKnowledgeSourceParameters	Fabric Data Agentのナレッジソースのパラメータ。
FabricOntologyKnowledgeSource	Fabric Ontologyの知識ソースのための構成。
FabricOntologyKnowledgeSourceParameters	Fabric Ontologyのパラメータ知識源。
FileKnowledgeSource	ファイル知識ソースの構成は、直接ファイルのアップロードとインデックス作成をサポートします。
FileKnowledgeSourceParameters	ファイル知識ソースのパラメータ。
FreshnessPolicy	フレッシュネス認識検索のための設定。設定すると、新しい文書は検索時にランキングが上昇します。
IndexedOneLakeKnowledgeSource	OneLake ナレッジソースの構成。
IndexedOneLakeKnowledgeSourceParameters	OneLake ナレッジソースのパラメーター。
IndexedSharePointContainerName	アクセスする SharePoint ライブラリを指定します。
IndexedSharePointKnowledgeSource	SharePoint ナレッジソースの構成。
IndexedSharePointKnowledgeSourceParameters	SharePoint ナレッジソースのパラメーター。
IndexedSqlKnowledgeSource	インデックス付きSQLのナレッジソースの設定。
IndexedSqlKnowledgeSourceParameters	インデックス化されたSQL知識ソースのパラメータ。
IndexingSchedule	インデクサー実行のスケジュールを表します。
KnowledgeBaseAzureOpenAIModel	クエリ計画の実行に使用する Azure OpenAI リソースを指定します。
KnowledgeBaseModelKind	クエリ計画に使用される AI モデル。
KnowledgeSourceAzureOpenAIVectorizer	クエリ文字列のベクトル化に使用される Azure OpenAI リソースを指定します。
KnowledgeSourceIngestionParameters	ナレッジソースのすべての一般的な取り込み設定を統合します。
KnowledgeSourceIngestionPermissionOption	ドキュメントコンテンツと一緒に取り込む権限タイプ。
KnowledgeSourceKind	知識源の種類。
KnowledgeSourceNetworkAccessMode	知識ソースの取り込みのためのネットワークアクセスモードを指定します。デフォルトは「パブリック」です。
KnowledgeSourceResultsProcessing	知識ソースの結果が再ランク付けされるかどうかを制御します。
McpServerAuthenticationKind	MCPサーバー向けの認証の種類です。
McpServerAutoOutputParsing	出力フォーマットを自動的に検出し、適切に解析します。
McpServerFoundryConnectionAuthentication	Azure AI Foundry接続を使った認証。
McpServerFoundryConnectionParameters	Foundry接続認証のパラメータ。
McpServerJsonOutputParsing	出力を設定したJSONパラメータを使ってJSONドキュメントとして解析します。
McpServerKnowledgeSource	MCP(モデルコンテキストプロトコル)サーバーでバックアップされた知識ソースの設定。
McpServerKnowledgeSourceParameters	MCPサーバーの知識ソースのパラメータ。
McpServerNoneOutputParsing	出力は解析なしで単一のブロックとして扱います。
McpServerOutputParsingJsonParameters	JSON出力解析のパラメータ。
McpServerOutputParsingKind	MCPサーバーツール向けの出力解析のようなものです。
McpServerOutputParsingSplitParameters	分割出力解析のパラメータ。
McpServerSplitOutputParsing	出力を分割パラメータでページに分割します。
McpServerStoredHeadersAuthentication	保存されたHTTPヘッダーを使った認証。
McpServerStoredHeadersParameters	保存ヘッダー認証のパラメータ。
McpServerTool	MCPサーバーの知識ソース内の単一のツールを表します。
Prefer	HTTP PUT 要求の場合、成功時に作成/更新されたリソースを返すようにサービスに指示します。
RemoteSharePointKnowledgeSource	リモート SharePoint ナレッジソースの構成。
RemoteSharePointKnowledgeSourceParameters	リモート SharePoint ナレッジソースのパラメーター。
SearchIndexerDataNoneIdentity	データソースの ID プロパティをクリアします。
SearchIndexerDataUserAssignedIdentity	使用するデータソースの ID を指定します。
SearchIndexFieldReference	検索インデックスのフィールド参照。
SearchIndexKnowledgeSource	検索インデックスを対象とするナレッジソース。
SearchIndexKnowledgeSourceBoostKind	検索インデックスの知識源のためのブーストヒントのようなものです。
SearchIndexKnowledgeSourceFieldValueBoost	フィールド値に基づいて文書を強化するヒントです。
SearchIndexKnowledgeSourceFilterHint	フィールドと代表値を示すヒントで、クエリプランナーがフィルターを構築する際に利用できます。
SearchIndexKnowledgeSourceMultiWordExpressionBoost	複数の単語表現に基づいて文書を強化するヒントです。
SearchIndexKnowledgeSourceParameters	検索インデックスナレッジソースのパラメーター。
SearchIndexKnowledgeSourceQueryHints	検索インデックスの知識ソースのための有用なフィルターやブーストに向けたクエリ計画を導くヒント。
SearchResourceEncryptionKey	Azure Key Vault のカスタマーマネージド暗号化キー。作成および管理するキーを使用して、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除を行うことができます。
SplitSkillLanguage	SplitSkill による入力テキストでサポートされている言語コード。
TextSplitMode	実行する分割モードを示す値。
VectorSearchVectorizerKind	クエリ時に使用するベクトル化方法。
WebKnowledgeSource	Web 結果をターゲットとするナレッジソース。
WebKnowledgeSourceDomain	Web ナレッジソースドメインの構成。
WebKnowledgeSourceDomains	Web ナレッジソースのドメイン許可/ブロック構成。
WebKnowledgeSourceParameters	Web ナレッジソースのパラメーター。
WorkIQKnowledgeSource	WorkIQナレッジソースの設定。
WorkIQKnowledgeSourceParameters	WorkIQ知識ソースのパラメータ。

Accept

列挙

Acceptヘッダーです。

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

AIServices

Object

AIサービスのパラメータ。

名前	型	説明
apiKey	string	AIサービスにアクセスするためのAPIキー。
uri	string (uri)	AI サービスエンドポイントの URI。

AssetStore

Object

画像などの抽出した資産を保存するためのアセットストアの設定。

名前	型	説明
connectionString	string	アセットストアの接続文字列です。
containerName	string	抽出したアセット(例えば画像)を格納するアセットストア内のブロブコンテナの名前です。

AzureBlobKnowledgeSource

Object

Azure Blob Storage の構成ナレッジソース。

名前	型	説明
@odata.etag	string	知識源のETag。
azureBlobParameters	AzureBlobKnowledgeSourceParameters	ナレッジソースのタイプ。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
kind	string: azureBlob	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

AzureBlobKnowledgeSourceParameters

Object

Azure Blob Storage ナレッジソースのパラメーター。

名前	型	規定値	説明
connectionString	string		キーベースの接続文字列、またはマネージド ID を使用している場合は ResourceId 形式。
containerName	string		BLOB ストレージコンテナーの名前。
createdResources	object		ナレッジソースによって作成されたリソース。
folderPath	string		コンテナ内のオプションのフォルダーパス。
ingestionParameters	KnowledgeSourceIngestionParameters		すべての一般的な取り込み設定を統合します。
isADLSGen2	boolean	False	ADLS Gen2 ストレージアカウントに接続する場合は true に設定します。既定値は falseです。
queryHints	SearchIndexKnowledgeSourceQueryHints		クエリ計画を導くデフォルトのヒントで、このインデックスに基づく知識ソースのための有用なフィルターやブーストを導きます。リクエスト時クエリのヒントは、これらのデフォルトを完全なオブジェクトとして置き換えます。

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。

ContentColumnMapping

Object

SQL列を検索インデックスフィールドにマッピングします。

名前	型	説明
name	string	ターゲットインデックスフィールド名。
searchFieldType	string	Azure AI 検索フィールドタイプ(例:Edm.String、Edm.Int32)。
sourceField	string	SQLカラム名。

CorsOptions

Object

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

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

EmbeddingColumnMapping

Object

SQL列をベクトルフィールドにマッピングして埋め込みを行います。

名前	型	説明
name	string	検索インデックス内のターゲットベクトルフィールド名。
sourceField	string	埋め込み生成の入力として使われるSQL列。

EntraAppAuthentication

Object

フェデレーテッド認証認証に使用される顧客所有のMicrosoft Entraアプリ登録の設定。

名前	型	説明
applicationId	string (uuid)	顧客所有のEntraアプリ登録のアプリケーション(クライアント)ID。
federatedCredentialId	string (uuid)	アプリ登録時に設定されたフェデレーテッド認証IDにより、検索サービスはクライアント秘密を保存せずにアプリとして認証できます。
tenantId	string (uuid)	アプリの登録時の入居者IDです。検索サービスとは異なるテナントのアプリ登録の場合に必須です。省略する場合は、検索サービスのテナントが使用されます。

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	エラーオブジェクト。

FabricDataAgentKnowledgeSource

Object

Fabric Data Agent ナレッジソースの設定。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
fabricDataAgentParameters	FabricDataAgentKnowledgeSourceParameters	Fabric Data Agentの知識ソースのパラメータ。
kind	string: fabricDataAgent	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

FabricDataAgentKnowledgeSourceParameters

Object

Fabric Data Agentのナレッジソースのパラメータ。

名前	型	説明
dataAgentId	string	どのFabricデータエージェントにアクセスするかを指定します。
workspaceId	string	Fabric ワークスペース ID。

FabricOntologyKnowledgeSource

Object

Fabric Ontologyの知識ソースのための構成。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
fabricOntologyParameters	FabricOntologyKnowledgeSourceParameters	Fabric Ontologyの知識ソースのパラメータ。
kind	string: fabricOntology	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

FabricOntologyKnowledgeSourceParameters

Object

Fabric Ontologyのパラメータ知識源。

名前	型	説明
ontologyId	string	Fabricワークスペースから使用するオントロジーのID。
workspaceId	string	オントロジーを含むFabricワークスペースIDです。

FileKnowledgeSource

Object

ファイル知識ソースの構成は、直接ファイルのアップロードとインデックス作成をサポートします。

名前	型	説明
@odata.etag	string	知識源のETag。
corsOptions	CorsOptions	ファイル知識ソースのファイルエンドポイント(アップロード、リスト、更新、削除)に対するクロスオリジンリソース共有(CORS)の制御オプション。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
fileParameters	FileKnowledgeSourceParameters	ファイル知識ソースのパラメータ。
kind	string: file	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

FileKnowledgeSourceParameters

Object

ファイル知識ソースのパラメータ。

名前	型	説明
createdResources	object	ファイル知識ソースによって作成されたリソース。
ingestionParameters	KnowledgeSourceIngestionParameters	ファイル知識ソースの一般的な取り込み設定をすべて統合し、コンテンツ抽出モードやオプションのembeddingModelも含まれます。
queryHints	SearchIndexKnowledgeSourceQueryHints	クエリ計画を導くデフォルトのヒントで、このインデックスに基づく知識ソースのための有用なフィルターやブーストを導きます。リクエスト時クエリのヒントは、これらのデフォルトを完全なオブジェクトとして置き換えます。

FreshnessPolicy

Object

フレッシュネス認識検索のための設定。設定すると、新しい文書は検索時にランキングが上昇します。

名前	型	説明
boostingDuration	string	鮮度向上ウィンドウのISO 8601期間(例:90日間の「P90D」)。この期間を超える新しい文書は、検索時にランキングが上昇します。

IndexedOneLakeKnowledgeSource

Object

OneLake ナレッジソースの構成。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	ナレッジソースのパラメーター。
kind	string: indexedOneLake	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

IndexedOneLakeKnowledgeSourceParameters

Object

OneLake ナレッジソースのパラメーター。

名前	型	説明
createdResources	object	ナレッジソースによって作成されたリソース。
fabricWorkspaceId	string	OneLake ワークスペース ID。
ingestionParameters	KnowledgeSourceIngestionParameters	すべての一般的な取り込み設定を統合します。
lakehouseId	string	アクセスする OneLake レイクハウスを指定します。
queryHints	SearchIndexKnowledgeSourceQueryHints	クエリ計画を導くデフォルトのヒントで、このインデックスに基づく知識ソースのための有用なフィルターやブーストを導きます。リクエスト時クエリのヒントは、これらのデフォルトを完全なオブジェクトとして置き換えます。
targetPath	string	オプションの OneLakehouse フォルダーまたはショートカットで、OneLake コンテンツをフィルター処理します。

IndexedSharePointContainerName

列挙

アクセスする SharePoint ライブラリを指定します。

値	説明
defaultSiteLibrary	サイトの既定のドキュメントライブラリからコンテンツにインデックスを付けます。
allSiteLibraries	サイト内のすべてのドキュメントライブラリからコンテンツにインデックスを付けます。
useQuery	クエリを使ってSharePointのコンテンツをフィルタリングしましょう。

IndexedSharePointKnowledgeSource

Object

SharePoint ナレッジソースの構成。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
indexedSharePointParameters	IndexedSharePointKnowledgeSourceParameters	ナレッジソースのパラメーター。
kind	string: indexedSharePoint	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

IndexedSharePointKnowledgeSourceParameters

Object

SharePoint ナレッジソースのパラメーター。

名前	型	説明
connectionString	string	形式の SharePoint 接続文字列: SharePointOnlineEndpoint=[SharePoint サイトの URL];ApplicationId=[Azure AD アプリ ID];ApplicationSecret=[Azure AD アプリクライアントシークレット];TenantId=[SharePoint サイトテナント ID]
containerName	IndexedSharePointContainerName	アクセスする SharePoint ライブラリを指定します。
createdResources	object	ナレッジソースによって作成されたリソース。
ingestionParameters	KnowledgeSourceIngestionParameters	すべての一般的な取り込み設定を統合します。
query	string	SharePoint コンテンツをフィルター処理するための省略可能なクエリ。
queryHints	SearchIndexKnowledgeSourceQueryHints	クエリ計画を導くデフォルトのヒントで、このインデックスに基づく知識ソースのための有用なフィルターやブーストを導きます。リクエスト時クエリのヒントは、これらのデフォルトを完全なオブジェクトとして置き換えます。

IndexedSqlKnowledgeSource

Object

インデックス付きSQLのナレッジソースの設定。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
indexedSqlParameters	IndexedSqlKnowledgeSourceParameters	SQL知識ソースのパラメータです。
kind	string: indexedSql	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

IndexedSqlKnowledgeSourceParameters

Object

インデックス化されたSQL知識ソースのパラメータ。

名前	型	説明
connectionString	string	Azure SQL Database または SQL Managed Instance の接続文字列です。
contentColumns	ContentColumnMapping[]	コンテンツフィールドの任意のカラムマッピングも可能です。省略すると、すべての列は自動発見されます。
createdResources	object	ナレッジソースによって作成されたリソース。
embeddingColumns	EmbeddingColumnMapping[]	ベクトル場の埋め込みのための任意の列写像。省略するとベクトル場は生成されません。
highWaterMarkColumnName	string	高水位変化検出用の任意の列名。提供されている場合はHighWaterMarkChangeDetectionPolicyを使用します。
ingestionParameters	KnowledgeSourceIngestionParameters	埋め込みモデル、スケジュール、アイデンティティを含むすべての一般的な取り込み設定を統合します。
queryHints	SearchIndexKnowledgeSourceQueryHints	クエリ計画を導くデフォルトのヒントで、このインデックスに基づく知識ソースのための有用なフィルターやブーストを導きます。リクエスト時クエリのヒントは、これらのデフォルトを完全なオブジェクトとして置き換えます。
tableOrView	string	インデックスにするテーブルやビューの名前。スキーマ限定(例:'dbo))は可能です。MyTable')。

IndexingSchedule

Object

インデクサー実行のスケジュールを表します。

名前	型	説明
interval	string (duration)	インデクサーの実行間の時間間隔。
startTime	string (date-time)	インデクサーの実行を開始する時刻。

KnowledgeBaseAzureOpenAIModel

Object

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

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

KnowledgeBaseModelKind

列挙

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

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

KnowledgeSourceAzureOpenAIVectorizer

Object

クエリ文字列のベクトル化に使用される Azure OpenAI リソースを指定します。

名前	型	説明
azureOpenAIParameters	AzureOpenAIVectorizerParameters	Azure OpenAI 埋め込みベクトル化に固有のパラメーターが含まれています。
kind	string: azureOpenAI	ベクトル検索で使用するために構成されているベクトル化方法の種類の名前。

KnowledgeSourceIngestionParameters

Object

ナレッジソースのすべての一般的な取り込み設定を統合します。

名前	型	規定値	説明
aiServices	AIServices		コンテンツ処理用のオプションの AI サービス構成。
assetStore	AssetStore		抽出した画像などの資産を保存するためのオプションのアセットストア設定。
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		画像の言語化またはコンテキスト抽出のためのオプションのチャット完了モデル。
contentExtractionMode	enum: minimal standard	minimal	オプションのコンテンツ抽出モード。デフォルトは「最小」です。
disableImageVerbalization	boolean	False	イメージの言語化を無効にするかどうかを示します。既定値は falseです。
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		コンテンツをベクトル化するためのオプションのベクトルライザー構成。
freshnessPolicy	FreshnessPolicy		新しい文書に偏るためのオプションの新規性ポリシー。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		このナレッジソースに使用する明示的な ID。
ingestionPermissionOptions	KnowledgeSourceIngestionPermissionOption[]		ドキュメントコンテンツと一緒に取り込む権限タイプのオプションのリスト。指定すると、データソースのインデクサーアクセス許可オプションが設定されます。
ingestionSchedule	IndexingSchedule		データ取り込みのオプションのスケジュール。
networkAccessMode	KnowledgeSourceNetworkAccessMode	public	インジェスト用の任意のネットワークアクセスモード。プライベートネットワーク経由でデータソースや依存関係にアクセスできるプライベート実行環境で取り込みを実行するために「private」に設定します。デフォルトは「パブリック」です。これは作成時の設定であり、知識ソースが作成された後は変更できません。

KnowledgeSourceIngestionPermissionOption

列挙

ドキュメントコンテンツと一緒に取り込む権限タイプ。

値	説明
userIds	明示的なユーザー識別子をドキュメントコンテンツと一緒に取り込みます。
groupIds	ドキュメントコンテンツと一緒にグループ識別子を取り込みます。
rbacScope	ドキュメントコンテンツと一緒に RBAC スコープ情報を取り込みます。
sensitivityLabels	文書内容と一緒にMicrosoft Purviewのセンシティビュアラベルを取り込みます。

KnowledgeSourceKind

列挙

知識源の種類。

値	説明
searchIndex	検索インデックスからデータを読み取るナレッジソース。
azureBlob	Azure Blob Storage から検索インデックスにデータを読み取り、取り込むナレッジソース。
indexedSharePoint	インデックス化されたSharePointからデータを読み取る知識ソース。
indexedOneLake	インデックス化されたOneLakeからデータを読み取る知識源です。
indexedSql	Azure SQL DatabaseやSQL Managed Instanceからデータを検索インデックスに取り込み、取得する知識ソースです。
web	ウェブからデータを読み取る知識源です。
remoteSharePoint	リモートのSharePointからデータを読み取る知識ソース。
workIQ	仕事IQからデータを読み取る知識源
file	直接ファイルのアップロードとインデックス作成をサポートする知識源です。
mcpServer	MCP(モデルコンテキストプロトコル)サーバーによって裏付けられた知識源です。
fabricDataAgent	Fabric Data Agentからデータを取得する知識ソースです。
fabricOntology	Microsoft Fabricのオントロジーからデータを取得する知識ソースです。

KnowledgeSourceNetworkAccessMode

列挙

知識ソースの取り込みのためのネットワークアクセスモードを指定します。デフォルトは「パブリック」です。

値	説明
public	インジェスションは標準的で公開可能な実行環境で動作します。これが既定値です。
private	取り込みはプライベート実行環境で動作するため、プライベートネットワーク(プライベートエンドポイント/共有プライベートリンク)を通じてデータソースや依存関係に到達できます。

KnowledgeSourceResultsProcessing

列挙

知識ソースの結果が再ランク付けされるかどうかを制御します。

値	説明
rerank	この知識源から得られる結果は、ランキング再評価のパイプラインを通過します。これが既定の動作です。
none	この知識源から得られる結果は、再ランク付けを回避し、その基礎となる順序を保持します。

McpServerAuthenticationKind

列挙

MCPサーバー向けの認証の種類です。

値	説明
foundryConnection	Azure AI Foundry接続を使って認証してください。
storedHeaders	保存されたHTTPヘッダーを使って認証します。

McpServerAutoOutputParsing

Object

出力フォーマットを自動的に検出し、適切に解析します。

名前	型	説明
kind	string: auto	適用すべき出力解析の種類。

McpServerFoundryConnectionAuthentication

Object

Azure AI Foundry接続を使った認証。

名前	型	説明
foundryConnectionParameters	McpServerFoundryConnectionParameters	Foundry接続認証のパラメータ。
kind	string: foundryConnection	使うべき認証の種類。

McpServerFoundryConnectionParameters

Object

Foundry接続認証のパラメータ。

名前	型	説明
connectionId	string	Azure AI Foundry 接続識別子。

McpServerJsonOutputParsing

Object

出力を設定したJSONパラメータを使ってJSONドキュメントとして解析します。

名前	型	説明
jsonParameters	McpServerOutputParsingJsonParameters	JSON出力解析のパラメータ。種類が「json」の場合に必要です。
kind	string: json	適用すべき出力解析の種類。

McpServerKnowledgeSource

Object

MCP(モデルコンテキストプロトコル)サーバーでバックアップされた知識ソースの設定。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
kind	string: mcpServer	ナレッジソースのタイプ。
mcpServerParameters	McpServerKnowledgeSourceParameters	MCPサーバーの知識ソースのパラメータ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

McpServerKnowledgeSourceParameters

Object

MCPサーバーの知識ソースのパラメータ。

名前	型	説明
authentication	McpServerAuthentication: McpServerFoundryConnectionAuthentication McpServerStoredHeadersAuthentication	MCPサーバーの認証設定。
serverURL	string	MCPサーバーエンドポイントのURLです。
tools	McpServerTool[]	MCPサーバー上で呼び出すツールのリスト。

McpServerNoneOutputParsing

Object

出力は解析なしで単一のブロックとして扱います。

名前	型	説明
kind	string: none	適用すべき出力解析の種類。

McpServerOutputParsingJsonParameters

Object

JSON出力解析のパラメータ。

名前	型	説明
documentsPath	string	ツール出力内のドキュメント配列へのJSONパスです。
includeContext	boolean	抽出した文書と一緒にJSON出力の周囲のコンテキストを含めるかどうか。

McpServerOutputParsingKind

列挙

MCPサーバーツール向けの出力解析のようなものです。

値	説明
auto	出力フォーマットを自動的に検出し、適切に解析します。
json	出力を設定したJSONパラメータを使ってJSONドキュメントとして解析します。
split	出力を分割パラメータでページに分割します。
none	出力は解析なしで単一のブロックとして扱います。

McpServerOutputParsingSplitParameters

Object

分割出力解析のパラメータ。

名前	型	説明
defaultLanguageCode	SplitSkillLanguage	使用する言語コードを示す値。既定値は `en` です。
maximumPageLength	integer (int32)	ページあたりの最大文字数。
maximumPagesToTake	integer (int32)	出力から取る最大ページ数。
pageOverlapLength	integer (int32)	ページ間で重なる文字数。
textSplitMode	TextSplitMode	テキスト分割モードを使うこと。

McpServerSplitOutputParsing

Object

出力を分割パラメータでページに分割します。

名前	型	説明
kind	string: split	適用すべき出力解析の種類。
splitParameters	McpServerOutputParsingSplitParameters	分割出力解析のパラメータ。

McpServerStoredHeadersAuthentication

Object

保存されたHTTPヘッダーを使った認証。

名前	型	説明
kind	string: storedHeaders	使うべき認証の種類。
storedHeadersParameters	McpServerStoredHeadersParameters	保存ヘッダー認証のパラメータ。

McpServerStoredHeadersParameters

Object

保存ヘッダー認証のパラメータ。

名前	型	説明
headers	object	MCPサーバーのリクエストに含める保存されたHTTPヘッダー。

McpServerTool

Object

MCPサーバーの知識ソース内の単一のツールを表します。

名前	型	説明
maxOutputTokens	integer (int32)	このツールの出力にはオプションで解析後のトークン上限を設けます。指定した場合は0より大きくなければなりません。
name	string	呼び出す MCP ツールの名前。
outputParsing	McpServerOutputParsing: McpServerAutoOutputParsing McpServerJsonOutputParsing McpServerNoneOutputParsing McpServerSplitOutputParsing	ツールの出力を解析するためのオプション設定。
resultsProcessing	KnowledgeSourceResultsProcessing	このツールから解析された結果が再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

Prefer

列挙

HTTP PUT 要求の場合、成功時に作成/更新されたリソースを返すようにサービスに指示します。

値	説明
return=representation

RemoteSharePointKnowledgeSource

Object

リモート SharePoint ナレッジソースの構成。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
kind	string: remoteSharePoint	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
remoteSharePointParameters	RemoteSharePointKnowledgeSourceParameters	リモートSharePointナレッジソースのパラメータ。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。

RemoteSharePointKnowledgeSourceParameters

Object

リモート SharePoint ナレッジソースのパラメーター。

名前	型	説明
containerTypeId	string	SharePoint Embedded 接続のコンテナー ID。これが null の場合、SharePoint Online が使用されます。
filterExpression	string	クエリを実行する前に取得のスコープを設定するためのクエリ可能な SharePoint プロパティと属性を持つキーワードクエリ言語 (KQL) 式。
resourceMetadata	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" の形式です。

SearchIndexFieldReference

Object

検索インデックスのフィールド参照。

名前	型	説明
name	string	フィールドの名前。

SearchIndexKnowledgeSource

Object

検索インデックスを対象とするナレッジソース。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
kind	string: searchIndex	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。
searchIndexParameters	SearchIndexKnowledgeSourceParameters	ナレッジソースのパラメーター。

SearchIndexKnowledgeSourceBoostKind

列挙

検索インデックスの知識源のためのブーストヒントのようなものです。

値	説明
fieldValue	フィールド値に基づいて文書をブーストします。
multiWordExpression	複数語の表現に基づいて文書を強化しましょう。

SearchIndexKnowledgeSourceFieldValueBoost

Object

フィールド値に基づいて文書を強化するヒントです。

名前	型	説明
boost	number (double)	文書スコアの乗算器です。 1.0 に等しくない正の数値を指定する必要があります。
boostInstructions	string	ブーストをいつどのように適用するかを説明する自然言語の指示。
field	string minLength: 1	検索インデックスフィールドの名前です。
fieldValues	string[]	フィールドの代表的な価値。
kind	string: fieldValue	いわゆるブーストのヒントです。

SearchIndexKnowledgeSourceFilterHint

Object

フィールドと代表値を示すヒントで、クエリプランナーがフィルターを構築する際に利用できます。

名前	型	説明
field	string minLength: 1	フィルタリング可能な検索インデックスフィールドの名前です。
fieldValues	string[]	フィールドの代表的な価値。
filterInstructions	string	フィールドでいつどのようにフィルタリングするかを説明する自然言語の指示。

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Object

複数の単語表現に基づいて文書を強化するヒントです。

名前	型	説明
boost	number (double)	文書スコアの乗算器です。 1.0 に等しくない正の数値を指定する必要があります。
boostInstructions	string	ブーストをいつどのように適用するかを説明する自然言語の指示。
fieldValues	string[]	ブーストの代表値。
kind	string: multiWordExpression	いわゆるブーストのヒントです。

SearchIndexKnowledgeSourceParameters

Object

検索インデックスナレッジソースのパラメーター。

名前	型	説明
baseFilter	string	取得時にインデックスにデフォルトのフィルター条件が適用されます(例:「状態方程式VA」)。クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。
queryHints	SearchIndexKnowledgeSourceQueryHints	検索インデックスの知識ソースに対する有用なフィルターやブーストを導くためのデフォルトヒントです。リクエスト時クエリのヒントは、これらのデフォルトを完全なオブジェクトとして置き換えます。
searchFields	SearchIndexFieldReference[]	検索インデックスで検索するフィールドを制限するために使用します。
searchIndexName	string	検索インデックスの名前。
semanticConfigurationName	string	ターゲット検索インデックスで、デフォルトのセマンティック構成以外のセマンティック構成を指定するために使用します。
sourceDataFields	SearchIndexFieldReference[]	参照元データの追加フィールドを要求するために使用します。

SearchIndexKnowledgeSourceQueryHints

Object

検索インデックスの知識ソースのための有用なフィルターやブーストに向けたクエリ計画を導くヒント。

名前	型	説明
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	クエリプランナーが文書ランキングに影響を与えるために使える条件を特定するヒントを強化しましょう。
filters	SearchIndexKnowledgeSourceFilterHint[]	フィールドや代表的な値を特定するフィルターヒントをクエリプランナーがフィルター構築時に使えるようにします。

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`可能性があります。

SplitSkillLanguage

列挙

SplitSkill による入力テキストでサポートされている言語コード。

値	説明
am	アムハラ語
bs	Bosnian
cs	チェコ語
da	デンマーク語
de	German
en	English
es	スペイン語
et	Estonian
fi	フィンランド語
fr	フランス語
he	Hebrew
hi	ヒンディー語
hr	Croatian
hu	ハンガリー語
id	Indonesian
is	Icelandic
it	Italian
ja	Japanese
ko	韓国語
lv	Latvian
nb	ノルウェー語
nl	オランダ語
pl	ポーランド語
pt	ポルトガル語 (ポルトガル)
pt-br	ポルトガル語 (ブラジル)
ru	ロシア語
sk	スロバキア語
sl	スロベニア語
sr	セルビア語
sv	スウェーデン語
tr	トルコ語
ur	Urdu
zh	中国語 (簡体)

TextSplitMode

列挙

実行する分割モードを示す値。

値	説明
pages	テキストを個々のページに分割します。
sentences	テキストを個々の文に分割します。

VectorSearchVectorizerKind

列挙

クエリ時に使用するベクトル化方法。

値	説明
azureOpenAI	クエリ時に Azure OpenAI リソースを使用して埋め込みを生成します。
customWebApi	クエリ時にカスタム Web エンドポイントを使用して埋め込みを生成します。
aiServicesVision	Azure AI Services Vision Vectorize API を使用して、クエリ時に画像またはテキスト入力の埋め込みを生成します。
aml	クエリ時に Azure AI Foundry モデルカタログを介してデプロイされた Azure Machine Learning エンドポイントを使用して埋め込みを生成します。

WebKnowledgeSource

Object

Web 結果をターゲットとするナレッジソース。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
kind	string: web	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。
webParameters	WebKnowledgeSourceParameters	Web ナレッジソースのパラメーター。

WebKnowledgeSourceDomain

Object

Web ナレッジソースドメインの構成。

名前	型	説明
address	string	ドメインのアドレス。
includeSubpages	boolean	このドメインのサブページを含めるかどうか。

WebKnowledgeSourceDomains

Object

Web ナレッジソースのドメイン許可/ブロック構成。

名前	型	説明
allowedDomains	WebKnowledgeSourceDomain[]	ウェブ結果に許可されているドメイン。
blockedDomains	WebKnowledgeSourceDomain[]	ウェブ検索結果からブロックされたドメイン。

WebKnowledgeSourceParameters

Object

Web ナレッジソースのパラメーター。

名前	型	説明
count	integer (int32)	返すべきウェブ結果のデフォルト数。クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。
domains	WebKnowledgeSourceDomains	Web 結果のドメイン許可/ブロック構成。
freshness	string	ウェブ結果のデフォルトの鮮度フィルターです。クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。
language	string	ウェブ結果のデフォルト言語です。クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。
market	string	ウェブ結果のデフォルト市場。クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。

WorkIQKnowledgeSource

Object

WorkIQナレッジソースの設定。

名前	型	説明
@odata.etag	string	知識源のETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。検索サービスは、このプロパティを null に設定しようとすると無視されます。この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。カスタマーマネージドキーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
kind	string: workIQ	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
resultsProcessing	KnowledgeSourceResultsProcessing	この知識源の結果が最終結果セットに含める前に再ランク付けされるかどうかを制御します。指定されていない場合は「再ランク」にデフォルトで切り替えます。
workIQParameters	WorkIQKnowledgeSourceParameters	認証に使用される顧客所有のEntraアプリ構成を含むWorkIQナレッジソースのパラメータ。

WorkIQKnowledgeSourceParameters

Object

WorkIQ知識ソースのパラメータ。

名前	型	説明
entraAppAuthentication	EntraAppAuthentication	顧客所有のMicrosoft Entraアプリ登録構成は、Work IQ APIへの認証に代わって使用されます。顧客はテナント所有のEntraアプリを登録し、WorkIQAgent.Ask delegated権限を付与し、Azure AI 検索が保存されたクライアントシークレットなしでそのアプリとして認証できるようにフェデレーテッド認証資格を設定します。