Knowledge Sources - Create

• AzureBlobKnowledgeSource
• FabricDataAgentKnowledgeSource
• FabricOntologyKnowledgeSource
• FileKnowledgeSource
• IndexedOneLakeKnowledgeSource
• IndexedSharePointKnowledgeSource
• IndexedSqlKnowledgeSource
• McpServerKnowledgeSource
• RemoteSharePointKnowledgeSource
• SearchIndexKnowledgeSource
• WebKnowledgeSource
• WorkIQKnowledgeSource

要求が成功し、結果として新しいリソースが作成されました。

ErrorResponse

予期しないエラー応答。

string

AIサービスにアクセスするためのAPIキー。

string (uri)

AI サービス エンドポイントの URI。

string

アセットストアの接続文字列です。

string

抽出したアセット(例えば画像)を格納するアセットストア内のブロブコンテナの名前です。

string

知識源のETag。

AzureBlobKnowledgeSourceParameters

ナレッジ ソースのタイプ。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

azureBlob

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

string

キーベースの接続文字列、またはマネージド ID を使用している場合は ResourceId 形式。

string

BLOB ストレージ コンテナーの名前。

object

ナレッジソースによって作成されたリソース。

string

コンテナ内のオプションのフォルダー パス。

KnowledgeSourceIngestionParameters

すべての一般的な取り込み設定を統合します。

boolean

ADLS Gen2 ストレージ アカウントに接続する場合は true に設定します。 既定値は falseです。

string

指定された Azure OpenAI リソースの API キー。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

送信接続に使用されるユーザー割り当てマネージド ID。

string

指定されたリソースに対する Azure OpenAI モデルデプロイの ID。

AzureOpenAIModelName

指定された deploymentId パスにデプロイされる埋め込みモデルの名前。

string (uri)

Azure OpenAI リソースのリソース URI。

string

ターゲットインデックスフィールド名。

string

Azure AI 検索 フィールドタイプ(例:Edm.String、Edm.Int32)。

string

SQLカラム名。

string

検索インデックス内のターゲットベクトルフィールド名。

string

埋め込み生成の入力として使われるSQL列。

追加情報。

string

追加情報の種類。

ErrorAdditionalInfo[]

エラーに関する追加情報。

string

エラー コード。

ErrorDetail[]

エラーの詳細。

string

エラー メッセージ。

string

エラーの対象。

ErrorDetail

エラー オブジェクト。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

FabricDataAgentKnowledgeSourceParameters

Fabric Data Agentの知識ソースのパラメータ。

fabricDataAgent

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

string

どのFabricデータエージェントにアクセスするかを指定します。

string

Fabric ワークスペース ID。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

FabricOntologyKnowledgeSourceParameters

Fabric Ontologyの知識ソースのパラメータ。

fabricOntology

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

string

Fabricワークスペースから使用するオントロジーのID。

string

オントロジーを含むFabricワークスペースIDです。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

FileKnowledgeSourceParameters

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

file

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

object

ファイル知識ソースによって作成されたリソース。

KnowledgeSourceIngestionParameters

ファイル知識ソースの一般的な取り込み設定をすべて統合し、コンテンツ抽出モードやオプションのembeddingModelも含まれます。

string

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

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

IndexedOneLakeKnowledgeSourceParameters

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

indexedOneLake

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

object

ナレッジソースによって作成されたリソース。

string

OneLake ワークスペース ID。

KnowledgeSourceIngestionParameters

すべての一般的な取り込み設定を統合します。

string

アクセスする OneLake レイクハウスを指定します。

string

オプションの OneLakehouse フォルダーまたはショートカットで、OneLake コンテンツをフィルター処理します。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

IndexedSharePointKnowledgeSourceParameters

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

indexedSharePoint

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

string

形式の SharePoint 接続文字列: SharePointOnlineEndpoint=[SharePoint サイトの URL];ApplicationId=[Azure AD アプリ ID];ApplicationSecret=[Azure AD アプリ クライアント シークレット];TenantId=[SharePoint サイト テナント ID]

IndexedSharePointContainerName

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

object

ナレッジソースによって作成されたリソース。

KnowledgeSourceIngestionParameters

すべての一般的な取り込み設定を統合します。

string

SharePoint コンテンツをフィルター処理するための省略可能なクエリ。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

IndexedSqlKnowledgeSourceParameters

SQL知識ソースのパラメータです。

indexedSql

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

string

Azure SQL Database または SQL Managed Instance の 接続文字列 です。

ContentColumnMapping[]

コンテンツフィールドの任意のカラムマッピングも可能です。 省略すると、すべての列は自動発見されます。

object

ナレッジソースによって作成されたリソース。

EmbeddingColumnMapping[]

ベクトル場の埋め込みのための任意の列写像。 省略するとベクトル場は生成されません。

string

高水位変化検出用の任意の列名。 提供されている場合はHighWaterMarkChangeDetectionPolicyを使用します。

KnowledgeSourceIngestionParameters

埋め込みモデル、スケジュール、アイデンティティを含むすべての一般的な取り込み設定を統合します。

string

インデックスにするテーブルやビューの名前。 スキーマ限定(例:'dbo))は可能です。MyTable')。

string (duration)

インデクサーの実行間の時間間隔。

string (date-time)

インデクサーの実行を開始する時刻。

AzureOpenAIVectorizerParameters

Azure OpenAIパラメータ。

azureOpenAI

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

AzureOpenAIVectorizerParameters

Azure OpenAI 埋め込みベクトル化に固有のパラメーターが含まれています。

azureOpenAI

ベクトル検索で使用するために構成されているベクトル化方法の種類の名前。

AIServices

コンテンツ処理用のオプションの AI サービス構成。

AssetStore

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

KnowledgeBaseAzureOpenAIModel

画像の言語化またはコンテキスト抽出のためのオプションのチャット完了モデル。

• minimal
• standard

オプションのコンテンツ抽出モード。 デフォルトは「最小」です。

boolean

イメージの言語化を無効にするかどうかを示します。 既定値は falseです。

KnowledgeSourceAzureOpenAIVectorizer

コンテンツをベクトル化するためのオプションのベクトルライザー構成。

FreshnessPolicy

新しい文書に偏るためのオプションの新規性ポリシー。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

このナレッジソースに使用する明示的な ID。

KnowledgeSourceIngestionPermissionOption[]

ドキュメントコンテンツと一緒に取り込む権限タイプのオプションのリスト。 指定すると、データ ソースのインデクサー アクセス許可オプションが設定されます。

IndexingSchedule

データ取り込みのオプションのスケジュール。

auto

適用すべき出力解析の種類。

McpServerFoundryConnectionParameters

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

foundryConnection

使うべき認証の種類。

string

Azure AI Foundry 接続識別子。

McpServerOutputParsingJsonParameters

JSON出力解析のパラメータ。 種類が「json」の場合に必要です。

json

適用すべき出力解析の種類。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

mcpServer

ナレッジ ソースのタイプ。

McpServerKnowledgeSourceParameters

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

string

ナレッジソースの名前。

• McpServerFoundryConnectionAuthentication
• McpServerStoredHeadersAuthentication

MCPサーバーの認証設定。

string

MCPサーバーエンドポイントのURLです。

McpServerTool[]

MCPサーバー上で呼び出すツールのリスト。

none

適用すべき出力解析の種類。

string

ツール出力内のドキュメント配列へのJSONパスです。

boolean

抽出した文書と一緒にJSON出力の周囲のコンテキストを含めるかどうか。

SplitSkillLanguage

使用する言語コードを示す値。 既定値は en です。

integer (int32)

ページあたりの最大文字数。

integer (int32)

出力から取る最大ページ数。

integer (int32)

ページ間で重なる文字数。

TextSplitMode

テキスト分割モードを使うこと。

split

適用すべき出力解析の種類。

McpServerOutputParsingSplitParameters

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

storedHeaders

使うべき認証の種類。

McpServerStoredHeadersParameters

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

object

MCPサーバーのリクエストに含める保存されたHTTPヘッダー。

McpServerToolInclusionMode

このツールで解析された結果が最終的な結果セットにどのように統合されるかを制御します。 指定されていない場合はデフォルトで「再ランク(再ランク)」となります。

integer (int32)

このツールの出力にはオプションで解析後のトークン上限を設けます。 指定した場合は0より大きくなければなりません。

string

呼び出す MCP ツールの名前。

• McpServerAutoOutputParsing
• McpServerJsonOutputParsing
• McpServerNoneOutputParsing
• McpServerSplitOutputParsing

ツールの出力を解析するためのオプション設定。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

remoteSharePoint

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

RemoteSharePointKnowledgeSourceParameters

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

string

SharePoint Embedded 接続のコンテナー ID。 これが null の場合、SharePoint Online が使用されます。

string

クエリを実行する前に取得のスコープを設定するためのクエリ可能な SharePoint プロパティと属性を持つキーワード クエリ言語 (KQL) 式。

string[]

応答内の各項目に対して返されるメタデータ フィールドの一覧。 この一覧には、取得可能なメタデータ プロパティのみを含めることができます。 既定では、メタデータは返されません。

#Microsoft.Azure.Search.DataNoneIdentity

ID のタイプを指定する URI フラグメント。

#Microsoft.Azure.Search.DataUserAssignedIdentity

ID のタイプを指定する URI フラグメント。

string

マルチテナント User-Assigned マネージドIDサポート:ユーザー割り当てのマネージデンティティIDとフェデレートするように設定されたマルチテンタントアプリのクライアントID。

string

通常、ユーザー割り当てマネージド ID の完全修飾 Azure リソース ID は、検索サービスに割り当てられている必要がある "/subscriptions/12345678-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId" の形式です。

string

フィールドの名前。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

searchIndex

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

SearchIndexKnowledgeSourceParameters

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

string

取得時にインデックスにデフォルトのフィルター条件が適用されます(例:「状態方程式VA」)。 クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。

SearchIndexFieldReference[]

検索インデックスで検索するフィールドを制限するために使用します。

string

検索インデックスの名前。

string

ターゲット検索インデックスで、デフォルトのセマンティック構成以外のセマンティック構成を指定するために使用します。

SearchIndexFieldReference[]

参照元データの追加フィールドを要求するために使用します。

string

保存データの暗号化時に使用される Azure Key Vault に対する必要なアクセス許可が付与された AAD アプリケーション ID。 アプリケーション ID は、AAD アプリケーションのオブジェクト ID と混同しないでください。

string

指定した AAD アプリケーションの認証キー。

• SearchIndexerDataNoneIdentity
• SearchIndexerDataUserAssignedIdentity

この暗号化キーに使用する明示的なマネージド ID。 指定されず、アクセス資格情報プロパティが null の場合は、システム割り当てマネージド ID が使用されます。 リソースの更新時に、明示的な ID が指定されていない場合、変更されません。 "none" が指定されている場合、このプロパティの値はクリアされます。

boolean

このキーがサービスレベルキーかどうかを示すオプションの値です。 既定値は falseです。

string

保存データの暗号化に使用する Azure Key Vault キーの名前。

string

保存データの暗号化に使用する Azure Key Vault キーのバージョン。

string

保存データの暗号化に使用するキーを含む Azure Key Vault の URI (DNS 名とも呼ばれます)。 URI の例は、https://my-keyvault-name.vault.azure.net可能性があります。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

web

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。

WebKnowledgeSourceParameters

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

string

ドメインのアドレス。

boolean

このドメインのサブページを含めるかどうか。

WebKnowledgeSourceDomain[]

ウェブ結果に許可されているドメイン。

WebKnowledgeSourceDomain[]

ウェブ検索結果からブロックされたドメイン。

integer (int32)

返すべきウェブ結果のデフォルト数。 クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。

WebKnowledgeSourceDomains

Web 結果のドメイン許可/ブロック構成。

string

ウェブ結果のデフォルトの鮮度フィルターです。 クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。

string

ウェブ結果のデフォルト言語です。 クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。

string

ウェブ結果のデフォルト市場。 クエリ時に知識ソースのランタイムパラメータを通じてオーバーライド可能です。

string

知識源のETag。

string

オプションのユーザー定義の説明。

SearchResourceEncryptionKey

Azure Key Vault で作成する暗号化キーの説明。 この鍵は、誰も、Microsoftでさえもそれを復号できないと完全に保証したい場合に、知識ソースの定義に対して追加の暗号化レベルを提供するために使われます。 一度知識ソースの定義を暗号化すれば、それは常に暗号化されたままです。 検索サービスは、このプロパティを null に設定しようとすると無視されます。 この特性は必要に応じて変更可能ですが、暗号鍵を回転させたい場合は可能です。知識源の定義には影響がありません。 カスタマー マネージド キーを使用した暗号化は、無料の検索サービスでは使用できません。また、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。

workIQ

ナレッジ ソースのタイプ。

string

ナレッジソースの名前。