Knowledge Sources - Create Or Update

サービス:: Search Service

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

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

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

URI パラメーター

名前	/	必須	型	説明
endpoint	path	True	string	検索サービスのエンドポイント URL。
sourceName	path	True	string	作成または更新するナレッジソースの名前。
api-version	query	True	string	クライアント API バージョン。

要求ヘッダー

名前	必須	型	説明
x-ms-client-request-id		string (uuid)	デバッグを支援するためにリクエストとともに送信されたトラッキング ID。
If-Match		string	If-Match 条件を定義します。この操作は、サーバー上の ETag がこの値に一致する場合にのみ実行されます。
If-None-Match		string	If-None-Match 条件を定義します。この操作は、サーバー上の ETag がこの値と一致しない場合にのみ実行されます。
Prefer	True	string	HTTP PUT 要求の場合、成功時に作成/更新されたリソースを返すようにサービスに指示します。

要求本文

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

名前	説明
AzureBlobKnowledgeSource	Azure Blob Storage の構成ナレッジソース。
SearchIndexKnowledgeSource	検索インデックスを対象とするナレッジソース。

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 日以降に作成された有料サービスでのみ使用できます。

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 日以降に作成された有料サービスでのみ使用できます。

応答

名前	型	説明
200 OK	KnowledgeSource: SearchIndexKnowledgeSource AzureBlobKnowledgeSource
201 Created	KnowledgeSource: SearchIndexKnowledgeSource AzureBlobKnowledgeSource
Other Status Codes	ErrorResponse	エラー応答。

例

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSource

要求のサンプル

HTTP

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





{
  "searchIndexParameters": {
    "searchIndexName": "preview-test",
    "sourceDataSelect": "description,category"
  },
  "name": "ks-preview-test",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "@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": "searchIndex",
  "description": "Description of the knowledge source.",
  "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",
    "sourceDataSelect": "description,category"
  }
}

状態コード:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "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",
    "sourceDataSelect": "description,category"
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

要求のサンプル

HTTP

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





{
  "azureBlobParameters": {
    "identity": {
      "userAssignedIdentity": "/my/userassigned/id",
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
    },
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "embeddingModel": {
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "model",
        "apiKey": "api-key",
        "modelName": "text-embedding-3-large"
      },
      "name": "openai",
      "kind": "azureOpenAI"
    },
    "chatCompletionModel": {
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com/",
        "deploymentId": "myDeployment",
        "apiKey": "api-key",
        "modelName": "gpt-4o-mini"
      },
      "kind": "azureOpenAI"
    },
    "ingestionSchedule": {
      "interval": "P1D",
      "startTime": "2025-01-07T19:30:00Z"
    },
    "disableImageVerbalization": false
  },
  "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>"
    }
  }
}

応答のサンプル

状態コード:: 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",
    "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",
    "disableImageVerbalization": false,
    "identity": {
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
      "userAssignedIdentity": "/my/userassigned/id"
    },
    "embeddingModel": {
      "name": "openai",
      "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"
    }
  }
}

状態コード:: 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",
    "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",
    "disableImageVerbalization": false,
    "identity": {
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
      "userAssignedIdentity": "/my/userassigned/id"
    },
    "embeddingModel": {
      "name": "openai",
      "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"
    }
  }
}

定義

名前	説明
AIFoundryModelCatalogName	呼び出される Azure AI Foundry カタログの埋め込みモデルの名前。
AIServicesVisionParameters	クエリ画像またはテキストをベクトル化するための AI サービスビジョンパラメータを指定します。
AIServicesVisionVectorizer	クエリ画像またはテキストをベクトル化するための AI サービスビジョンパラメータを指定します。
AMLParameters	AML ベクトルライザに接続するためのプロパティを指定します。
AMLVectorizer	クエリ文字列のベクトル埋め込みを生成するために、Azure AI Foundry モデルカタログを介してデプロイされた Azure Machine Learning エンドポイントを指定します。
AzureActiveDirectoryApplicationCredentials	検索サービス用に作成された登録済みアプリケーションの資格情報で、Azure Key Vault に格納されている暗号化キーへの認証済みアクセスに使用されます。
AzureBlobKnowledgeSource	Azure Blob Storage の構成ナレッジソース。
AzureBlobKnowledgeSourceParameters	Azure Blob Storage ナレッジソースのパラメーター。
AzureOpenAIEmbeddingSkill	Azure OpenAI リソースを使用して、特定のテキスト入力のベクトル埋め込みを生成できます。
AzureOpenAIModelName	呼び出される Azure Open AI モデル名。
AzureOpenAIParameters	Azure OpenAI リソースに接続するためのパラメーターを指定します。
AzureOpenAIVectorizer	クエリ文字列のベクトル化に使用される Azure OpenAI リソースを指定します。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
IndexingSchedule	インデクサー実行のスケジュールを表します。
InputFieldMappingEntry	スキルの入力フィールド・マッピング。
KnowledgeAgentAzureOpenAIModel	クエリ計画の実行に使用する Azure OpenAI リソースを指定します。
KnowledgeAgentModelKind	クエリ計画に使用される AI モデル。
KnowledgeSourceKind	知識源の種類。
OutputFieldMappingEntry	スキルの出力フィールドマッピング。
SearchIndexerDataNoneIdentity	データソースの identity プロパティをクリアします。
SearchIndexerDataUserAssignedIdentity	使用するデータソースの ID を指定します。
SearchIndexKnowledgeSource	検索インデックスを対象とするナレッジソース。
SearchIndexKnowledgeSourceParameters	検索インデックスナレッジソースのパラメーター。
SearchResourceEncryptionKey	Azure Key Vault の顧客管理暗号化キー。作成および管理するキーを使用して、インデックスやシノニムマップなどの保存データの暗号化または暗号化解除を行うことができます。
VectorSearchVectorizerKind	クエリ時に使用するベクトル化方法。
WebApiParameters	ユーザー定義のベクトルライザーに接続するためのプロパティを指定します。
WebApiVectorizer	クエリ文字列のベクトル埋め込みを生成するためのユーザー定義ベクトルライザーを指定します。外部ベクトルライザーの統合は、スキルセットのカスタム Web API インターフェイスを使用して実現されます。

AIFoundryModelCatalogName

列挙

呼び出される Azure AI Foundry カタログの埋め込みモデルの名前。

値	説明
OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32
OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336
Facebook-DinoV2-Image-Embeddings-ViT-Base
Facebook-DinoV2-Image-Embeddings-ViT-Giant
Cohere-embed-v3-english
Cohere-embed-v3-multilingual
Cohere-embed-v4	テキストと画像の両方から埋め込みを生成するための Cohere embed v4 モデル。

AIServicesVisionParameters

Object

クエリ画像またはテキストをベクトル化するための AI サービスビジョンパラメータを指定します。

名前	型	説明
apiKey	string	指定されたAIサービス・リソースのAPIキー。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	送信接続に使用されるユーザー割り当てマネージド ID。 authResourceId が指定されていて指定されていない場合は、システム割り当てマネージド ID が使用されます。インデックスの更新時に、ID が指定されていない場合、値は変更されません。「none」に設定すると、このプロパティの値はクリアされます。
modelVersion	string	AI Services Vision サービスを呼び出すときに使用するモデルのバージョン。指定しない場合は、デフォルトで利用可能な最新のものになります。
resourceUri	string (uri)	AI サービスリソースのリソース URI。

AIServicesVisionVectorizer

Object

クエリ画像またはテキストをベクトル化するための AI サービスビジョンパラメータを指定します。

名前	型	説明
aiServicesVisionParameters	AIServicesVisionParameters	AI Services Vision 埋め込みベクトル化に固有のパラメーターが含まれます。
kind	string: aiServicesVision	ベクトル検索で使用するために構成されているベクトル化方法の種類の名前。
name	string	この特定のベクトル化方法に関連付ける名前。

AMLParameters

Object

AML ベクトルライザに接続するためのプロパティを指定します。

名前	型	説明
key	string	(鍵認証に必要)AML サービスのキー。
modelName	AIFoundryModelCatalogName	指定されたエンドポイントにデプロイされている Azure AI Foundry カタログの埋め込みモデルの名前。
region	string	(トークン認証の場合は省略可能)。 AML サービスがデプロイされているリージョン。
resourceId	string	(トークン認証に必要)。 AML サービスの Azure Resource Manager リソース ID。これは、subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name} の形式にする必要があります。
timeout	string (duration)	(オプション)指定すると、API 呼び出しを行う http クライアントのタイムアウトを示します。
uri	string (uri)	(認証なしまたはキー認証の場合は必須)JSON ペイロードの送信先となる AML サービスのスコアリング URI。 https URI スキームのみが許可されます。

AMLVectorizer

Object

クエリ文字列のベクトル埋め込みを生成するために、Azure AI Foundry モデルカタログを介してデプロイされた Azure Machine Learning エンドポイントを指定します。

名前	型	説明
amlParameters	AMLParameters	AML ベクトル化器のプロパティを指定します。
kind	string: aml	ベクトル検索で使用するために構成されているベクトル化方法の種類の名前。
name	string	この特定のベクトル化方法に関連付ける名前。

AzureActiveDirectoryApplicationCredentials

Object

検索サービス用に作成された登録済みアプリケーションの資格情報で、Azure Key Vault に格納されている暗号化キーへの認証済みアクセスに使用されます。

名前	型	説明
applicationId	string	保存データを暗号化するときに使用する Azure Key Vault への必要なアクセス許可が付与された AAD アプリケーション ID。アプリケーション ID を AAD アプリケーションのオブジェクト ID と混同しないでください。
applicationSecret	string	指定した AAD アプリケーションの認証キー。

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	ナレッジソースの名前。

AzureBlobKnowledgeSourceParameters

Object

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

名前	型	説明
chatCompletionModel	KnowledgeAgentModel: KnowledgeAgentAzureOpenAIModel	画像の言語化またはコンテキスト抽出のためのオプションのチャット完了モデル。
connectionString	string	キーベースの接続文字列、またはマネージド ID を使用している場合は ResourceId 形式。
containerName	string	BLOB ストレージコンテナーの名前。
createdResources	object	ナレッジソースによって作成されたリソース。
disableImageVerbalization	boolean	イメージの言語化を無効にするかどうかを示します。
embeddingModel	VectorSearchVectorizer: AIServicesVisionVectorizer AMLVectorizer AzureOpenAIVectorizer WebApiVectorizer	コンテンツをベクトル化するためのオプションのベクトルライザー構成。
folderPath	string	コンテナ内のオプションのフォルダーパス。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	このナレッジソースに使用する明示的な ID。
ingestionSchedule	IndexingSchedule	データ取り込みのオプションのスケジュール。

AzureOpenAIEmbeddingSkill

Object

Azure OpenAI リソースを使用して、特定のテキスト入力のベクトル埋め込みを生成できます。

名前	型	説明
@odata.type	string: #Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill	スキルのタイプを指定するURIフラグメント。
apiKey	string	指定された Azure OpenAI リソースの API キー。
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	送信接続に使用されるユーザー割り当てマネージド ID。
context	string	ドキュメントルートやドキュメントコンテンツ (/document や /document/content など) など、操作が実行されるレベルを表します。デフォルトは /document です。
deploymentId	string	指定されたリソース上の Azure OpenAI モデルデプロイの ID。
description	string	スキルの入力、出力および使用法を説明するスキルの説明。
dimensions	integer (int32)	結果として出力される埋め込みに必要なディメンションの数。 text-embedding-3 以降のモデルでのみサポートされます。
inputs	InputFieldMappingEntry[]	スキルの入力は、ソース・データ・セットの列、またはアップストリーム・スキルの出力である可能性があります。
modelName	AzureOpenAIModelName	指定された deploymentId パスにデプロイされる埋め込みモデルの名前。
name	string	スキルセット内で一意に識別するスキルの名前。名前が定義されていないスキルには、スキル配列内の 1 から始まるインデックスのデフォルト名が与えられ、接頭辞に文字「#」が付けられます。
outputs	OutputFieldMappingEntry[]	スキルの出力は、検索インデックスのフィールド、または別のスキルによる入力として使用できる値のいずれかです。
resourceUri	string (uri)	Azure OpenAI リソースのリソース URI。

AzureOpenAIModelName

列挙

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

値	説明
text-embedding-ada-002
text-embedding-3-large
text-embedding-3-small
gpt-4o
gpt-4o-mini
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano

AzureOpenAIParameters

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。

AzureOpenAIVectorizer

Object

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

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

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細です。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

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

IndexingSchedule

Object

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

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

InputFieldMappingEntry

Object

スキルの入力フィールド・マッピング。

名前	型	説明
inputs	InputFieldMappingEntry[]	複合型の作成時に使用される再帰的入力。
name	string	入力の名前。
source	string	入力のソース。
sourceContext	string	再帰入力の選択に使用されるソースコンテキスト。

KnowledgeAgentAzureOpenAIModel

Object

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

名前	型	説明
azureOpenAIParameters	AzureOpenAIParameters: AzureOpenAIEmbeddingSkill	Azure OpenAI モデルエンドポイントに固有のパラメーターが含まれています。
kind	string: azureOpenAI	AI モデルの種類。

KnowledgeAgentModelKind

列挙

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

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

KnowledgeSourceKind

列挙

知識源の種類。

値	説明
searchIndex	検索インデックスからデータを読み取るナレッジソース。
azureBlob	Azure Blob Storage から検索インデックスにデータを読み取り、取り込むナレッジソース。

OutputFieldMappingEntry

Object

スキルの出力フィールドマッピング。

名前	型	説明
name	string	スキルによって定義された出力の名前。
targetName	string	出力のターゲット名。これはオプションであり、デフォルトは名前です。

SearchIndexerDataNoneIdentity

Object

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

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

SearchIndexerDataUserAssignedIdentity

Object

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

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

SearchIndexKnowledgeSource

Object

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

名前	型	説明
@odata.etag	string	エージェントの ETag。
description	string	オプションのユーザー定義の説明。
encryptionKey	SearchResourceEncryptionKey	Azure Key Vault で作成する暗号化キーの説明。このキーは、Microsoft を含む誰もエージェントを復号化できないという完全な保証が必要な場合に、エージェント定義に追加レベルの保存時の暗号化を提供するために使用されます。エージェント定義を暗号化すると、常に暗号化されたままになります。検索サービスは、このプロパティを null に設定しようとすると無視されます。暗号化キーをローテーションする場合は、必要に応じてこのプロパティを変更できます。エージェント定義は影響を受けません。カスタマーマネージドキーによる暗号化は、無料の検索サービスでは使用できず、2019 年 1 月 1 日以降に作成された有料サービスでのみ使用できます。
kind	string: searchIndex	ナレッジソースのタイプ。
name	string	ナレッジソースの名前。
searchIndexParameters	SearchIndexKnowledgeSourceParameters	ナレッジソースのパラメーター。

SearchIndexKnowledgeSourceParameters

Object

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

名前	型	説明
searchIndexName	string	検索インデックスの名前。
sourceDataSelect	string	参照元データの追加フィールドを要求するために使用します。

SearchResourceEncryptionKey

Object

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

名前	型	説明
accessCredentials	AzureActiveDirectoryApplicationCredentials	Azure Key Vault へのアクセスに使用されるオプションの Azure Active Directory 資格情報。代わりにマネージド ID を使用する場合は必要ありません。
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	この暗号化キーに使用する明示的なマネージド ID。指定されておらず、アクセス資格情報プロパティが null の場合は、システム割り当てマネージド ID が使用されます。リソースの更新時に、明示的な ID が指定されていない場合は、変更されません。 "none" を指定すると、このプロパティの値はクリアされます。
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` です。

VectorSearchVectorizerKind

列挙

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

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

WebApiParameters

Object

ユーザー定義のベクトルライザーに接続するためのプロパティを指定します。

名前	型	説明
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	送信接続に使用されるユーザー割り当てマネージド ID。 authResourceId が指定されていて指定されていない場合は、システム割り当てマネージド ID が使用されます。インデクサーの更新時に、ID が指定されていない場合、値は変更されません。「none」に設定すると、このプロパティの値はクリアされます。
authResourceId	string	Azure 関数の外部コード、または変換を提供するその他のアプリケーションに接続するカスタムエンドポイントに適用されます。この値は、Azure Active Directory に登録されたときに関数またはアプリ用に作成されたアプリケーション ID である必要があります。指定すると、ベクトル化は、検索サービスのマネージド ID (システムまたはユーザー割り当て) と関数またはアプリのアクセストークンを使用して関数またはアプリに接続し、この値をアクセストークンのスコープを作成するためのリソース ID として使用します。
httpHeaders	object	HTTP 要求を行うために必要なヘッダー。
httpMethod	string	HTTP 要求のメソッド。
timeout	string (duration)	要求に必要なタイムアウト。デフォルトは 30 秒です。
uri	string (uri)	ベクタライザーを提供する Web API の URI。

WebApiVectorizer

Object

クエリ文字列のベクトル埋め込みを生成するためのユーザー定義ベクトルライザーを指定します。外部ベクトルライザーの統合は、スキルセットのカスタム Web API インターフェイスを使用して実現されます。

名前	型	説明
customWebApiParameters	WebApiParameters	ユーザー定義のベクトル化器のプロパティを指定します。
kind	string: customWebApi	ベクトル検索で使用するために構成されているベクトル化方法の種類の名前。
name	string	この特定のベクトル化方法に関連付ける名前。