Knowledge Sources - Create Or Update
Создает новый источник знаний или обновляет источник знаний, если он уже существует.
PUT {endpoint}/knowledgesources('{sourceName}')?api-version=2026-05-01-preview
Параметры URI
| Имя | В | Обязательно | Тип | Описание |
|---|---|---|---|---|
|
endpoint
|
path | True |
string (uri) |
URL-адрес конечной точки службы поиска. |
|
source
|
path | True |
string |
Название источника знаний. |
|
api-version
|
query | True |
string minLength: 1 |
Версия API, используемая для данной операции. |
Заголовок запроса
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| Accept |
Заголовок Accept. |
||
| If-Match |
string |
Определяет условие If-Match. Операция будет выполнена только в том случае, если ETag на сервере соответствует этому значению. |
|
| If-None-Match |
string |
Определяет условие If-None-Match. Операция будет выполнена только в том случае, если ETag на сервере не соответствует этому значению. |
|
| Prefer | True |
Для запросов HTTP PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении. |
|
| x-ms-client-request-id |
string (uuid) |
Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса. |
Текст запроса
Текст запроса может быть таким:
| Имя | Описание |
|---|---|
|
Azure |
Конфигурация для источника знаний Хранилище BLOB-объектов Azure. |
|
Fabric |
Конфигурация для источника знаний Fabric Data Agent. |
|
Fabric |
Источник знаний по конфигурации для Fabric Ontology. |
|
File |
Конфигурация для источника знания файлов, поддерживающая прямую загрузку и индексацию файлов. |
|
Indexed |
Конфигурация для источника знаний OneLake. |
|
Indexed |
Конфигурация для источника знаний SharePoint. |
|
Indexed |
Настройка для индексируемого источника знаний SQL. |
|
Mcp |
Конфигурация для источника знаний, поддерживаемого сервером MCP (Model Context Protocol). |
|
Remote |
Конфигурация для удаленного источника знаний SharePoint. |
|
Search |
Источник знаний, нацеленный на индекс поиска. |
|
Web |
Источник знаний с таргетингом на веб-результаты. |
|
Work |
Конфигурация для источника знаний WorkIQ. |
AzureBlobKnowledgeSource
Конфигурация для источника знаний Хранилище BLOB-объектов Azure.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| azureBlobParameters | True |
Тип источника знаний. |
|
| kind | True |
string:
azure |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
FabricDataAgentKnowledgeSource
Конфигурация для источника знаний Fabric Data Agent.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| fabricDataAgentParameters | True |
Параметры источника знаний Fabric Data Agent. |
|
| kind | True |
string:
fabric |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
FabricOntologyKnowledgeSource
Источник знаний по конфигурации для Fabric Ontology.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| fabricOntologyParameters | True |
Параметры источника знаний Fabric Ontology. |
|
| kind | True |
string:
fabric |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
FileKnowledgeSource
Конфигурация для источника знания файлов, поддерживающая прямую загрузку и индексацию файлов.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| fileParameters | True |
Параметры для источника знаний Файла. |
|
| kind | True |
string:
file |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
IndexedOneLakeKnowledgeSource
Конфигурация для источника знаний OneLake.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| indexedOneLakeParameters | True |
Параметры для источника знаний. |
|
| kind | True |
string:
indexed |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
IndexedSharePointKnowledgeSource
Конфигурация для источника знаний SharePoint.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| indexedSharePointParameters | True |
Параметры для источника знаний. |
|
| kind | True |
string:
indexed |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
IndexedSqlKnowledgeSource
Настройка для индексируемого источника знаний SQL.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| indexedSqlParameters | True |
Параметры для источника знаний SQL. |
|
| kind | True |
string:
indexed |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
McpServerKnowledgeSource
Конфигурация для источника знаний, поддерживаемого сервером MCP (Model Context Protocol).
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| kind | True |
string:
mcp |
Тип источника знаний. |
| mcpServerParameters | True |
Параметры источника знаний сервера MCP. |
|
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
RemoteSharePointKnowledgeSource
Конфигурация для удаленного источника знаний SharePoint.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| kind | True |
string:
remote |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
||
| remoteSharePointParameters |
Параметры для удалённого источника знаний в SharePoint. |
SearchIndexKnowledgeSource
Источник знаний, нацеленный на индекс поиска.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| kind | True |
string:
search |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| searchIndexParameters | True |
Параметры для источника знаний. |
|
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
WebKnowledgeSource
Источник знаний с таргетингом на веб-результаты.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| kind | True |
string:
web |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
||
| webParameters |
Параметры для веб-источника знаний. |
WorkIQKnowledgeSource
Конфигурация для источника знаний WorkIQ.
| Имя | Обязательно | Тип | Описание |
|---|---|---|---|
| kind | True |
string:
workIQ |
Тип источника знаний. |
| name | True |
string |
Название источника знаний. |
| @odata.etag |
string |
ETag источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
|
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
Ответы
| Имя | Тип | Описание |
|---|---|---|
| 200 OK |
KnowledgeSource:
|
Запрос выполнен успешно. |
| 201 Created |
KnowledgeSource:
|
Запрос успешно выполнен, и в результате был создан новый ресурс. |
| Other Status Codes |
Непредвиденное сообщение об ошибке. |
Безопасность
api-key
Тип:
apiKey
В:
header
OAuth2Auth
Тип:
oauth2
Flow:
implicit
URL-адрес авторизации:
https://login.microsoftonline.com/common/oauth2/v2.0/authorize
Области
| Имя | Описание |
|---|---|
| https://search.azure.com/.default |
Примеры
SearchServiceCreateOrUpdateKnowledgeSource
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview
{
"searchIndexParameters": {
"searchIndexName": "preview-test",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
],
"semanticConfigurationName": "testconfig"
},
"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>"
}
}
}
Пример ответа
{
"@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",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
]
}
}
{
"@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",
"semanticConfigurationName": "testconfig",
"sourceDataFields": [
{
"name": "description"
},
{
"name": "category"
}
],
"searchFields": [
{
"name": "*"
}
]
}
}
SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview
{
"azureBlobParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "test-container",
"folderPath": "test-path",
"isADLSGen2": false,
"ingestionParameters": {
"identity": {
"userAssignedIdentity": "/my/userassigned/id",
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
},
"embeddingModel": {
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
},
"kind": "azureOpenAI"
},
"chatCompletionModel": {
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
},
"kind": "azureOpenAI"
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"ingestionPermissionOptions": [
"userIds",
"groupIds",
"rbacScope"
],
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
},
"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>"
}
}
}
Пример ответа
{
"@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",
"isADLSGen2": false,
"ingestionParameters": {
"disableImageVerbalization": false,
"ingestionPermissionOptions": [
"userIds",
"groupIds",
"rbacScope"
],
"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"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"createdResources": {
"datasource": "ks-preview-test-datasource",
"indexer": "ks-preview-test-indexer",
"skillset": "ks-preview-test-skillset",
"index": "ks-preview-test-index"
}
}
}
{
"@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",
"isADLSGen2": false,
"ingestionParameters": {
"disableImageVerbalization": false,
"ingestionPermissionOptions": [
"userIds",
"groupIds",
"rbacScope"
],
"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"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
},
"createdResources": {
"datasource": "ks-preview-test-datasource",
"indexer": "ks-preview-test-indexer",
"skillset": "ks-preview-test-skillset",
"index": "ks-preview-test-index"
}
}
}
SearchServiceCreateOrUpdateKnowledgeSourceFabricDataAgent
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabric-agent-test')?api-version=2026-05-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>"
}
}
}
Пример ответа
{
"@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"
}
}
{
"@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
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-fabricontology-test')?api-version=2026-05-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>"
}
}
}
Пример ответа
{
"@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"
}
}
{
"@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"
}
}
SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview
{
"indexedOneLakeParameters": {
"fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
"lakehouseId": "fakeLakehouseId",
"targetPath": "testfolder",
"ingestionParameters": {
"identity": {
"userAssignedIdentity": "/my/userassigned/id",
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
},
"embeddingModel": {
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
},
"kind": "azureOpenAI"
},
"chatCompletionModel": {
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
},
"kind": "azureOpenAI"
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"ingestionPermissionOptions": [
"userIds",
"groupIds",
"rbacScope"
],
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
},
"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>"
}
}
}
Пример ответа
{
"@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",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedOneLakeParameters": {
"fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
"lakehouseId": "fakeLakehouseId",
"targetPath": "testfolder",
"ingestionParameters": {
"disableImageVerbalization": false,
"ingestionPermissionOptions": [
"userIds",
"groupIds",
"rbacScope"
],
"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"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
{
"@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",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
},
"indexedOneLakeParameters": {
"fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
"lakehouseId": "fakeLakehouseId",
"targetPath": "testfolder",
"ingestionParameters": {
"disableImageVerbalization": false,
"ingestionPermissionOptions": [
"userIds",
"groupIds",
"rbacScope"
],
"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"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
SearchServiceCreateOrUpdateKnowledgeSourceIndexedSharePoint
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview
{
"indexedSharePointParameters": {
"connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
"containerName": "defaultSiteLibrary",
"query": "*.docx OR *.pdf",
"ingestionParameters": {
"identity": {
"userAssignedIdentity": "/my/userassigned/id",
"@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
},
"embeddingModel": {
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "model",
"apiKey": "api-key",
"modelName": "text-embedding-3-large"
},
"kind": "azureOpenAI"
},
"chatCompletionModel": {
"azureOpenAIParameters": {
"resourceUri": "https://test-sample.openai.azure.com/",
"deploymentId": "myDeployment",
"apiKey": "api-key",
"modelName": "gpt-4o-mini"
},
"kind": "azureOpenAI"
},
"disableImageVerbalization": false,
"ingestionSchedule": {
"interval": "P1D",
"startTime": "2025-01-07T19:30:00Z"
},
"ingestionPermissionOptions": [
"userIds",
"groupIds",
"rbacScope"
],
"contentExtractionMode": "standard",
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
},
"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>"
}
}
}
Пример ответа
{
"@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",
"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",
"rbacScope"
],
"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"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
{
"@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",
"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",
"rbacScope"
],
"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"
},
"aiServices": {
"uri": "https://my-ai-service.azure.com/",
"apiKey": "api-key"
}
}
}
}
SearchServiceCreateOrUpdateKnowledgeSourceMcpServer
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-01-preview
{
"mcpServerParameters": {
"serverURL": "https://mcp.contoso.com/sse",
"authentication": {
"foundryConnectionParameters": {
"connectionId": "conn-123"
},
"kind": "foundryConnection"
},
"tools": [
{
"name": "search-code",
"outputParsing": {
"jsonParameters": {
"documentsPath": "$.documents[*]",
"includeContext": true
},
"kind": "json"
},
"inclusionMode": "reranked",
"maxOutputTokens": 4096
}
]
},
"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>"
}
}
}
Пример ответа
{
"@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",
"inclusionMode": "reranked",
"maxOutputTokens": 4096,
"outputParsing": {
"kind": "json",
"jsonParameters": {
"documentsPath": "$.documents[*]",
"includeContext": true
}
}
}
]
}
}
{
"@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",
"inclusionMode": "reranked",
"maxOutputTokens": 4096,
"outputParsing": {
"kind": "json",
"jsonParameters": {
"documentsPath": "$.documents[*]",
"includeContext": true
}
}
}
]
}
}
SearchServiceCreateOrUpdateKnowledgeSourceWeb
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-preview-test')?api-version=2026-05-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>"
}
}
}
Пример ответа
{
"@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",
"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
}
]
}
}
}
{
"@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",
"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
Образец запроса
PUT https://previewexampleservice.search.windows.net/knowledgesources('ks-workiq-test')?api-version=2026-05-01-preview
{
"name": "ks-workiq-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>"
}
}
}
Пример ответа
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-workiq-test",
"kind": "workIQ",
"description": "Description of the WorkIQ knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
{
"@odata.etag": "0x1234568AE7E58A1",
"name": "ks-workiq-test",
"kind": "workIQ",
"description": "Description of the WorkIQ knowledge source.",
"encryptionKey": {
"keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
"keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
"keyVaultUri": "https://myKeyVault.vault.azure.net",
"accessCredentials": {
"applicationId": "00000000-0000-0000-0000-000000000000",
"applicationSecret": "<applicationSecret>"
}
}
}
Определения
| Имя | Описание |
|---|---|
| Accept |
Заголовок Accept. |
| AIServices |
Параметры для сервисов ИИ. |
|
Asset |
Конфигурация хранилища активов, используемого для хранения извлечённых ассетов, таких как изображения. |
|
Azure |
Конфигурация для источника знаний Хранилище BLOB-объектов Azure. |
|
Azure |
Параметры для источника знаний Хранилище BLOB-объектов Azure. |
|
Azure |
Имя модели Azure Open AI, которое будет вызываться. |
|
Azure |
Задает параметры для подключения к ресурсу Azure OpenAI. |
|
Content |
Сопоставляет столбец SQL с полем индекса поиска. |
|
Embedding |
Отображает столбец SQL в векторное поле для вложения. |
|
Error |
Дополнительные сведения об ошибке управления ресурсами. |
|
Error |
Подробности ошибки. |
|
Error |
Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.). |
|
Fabric |
Конфигурация для источника знаний Fabric Data Agent. |
|
Fabric |
Параметры источника знаний Fabric Data Agent. |
|
Fabric |
Источник знаний по конфигурации для Fabric Ontology. |
|
Fabric |
Параметры для источника знаний Fabric Ontology. |
|
File |
Конфигурация для источника знания файлов, поддерживающая прямую загрузку и индексацию файлов. |
|
File |
Параметры для источника знания файлов. |
|
Freshness |
Настройка для поиска с учётом свежести. При установке новые документы получают повышение рейтинга во время поиска. |
|
Indexed |
Конфигурация для источника знаний OneLake. |
|
Indexed |
Параметры для источника знаний OneLake. |
|
Indexed |
Указывает, к каким библиотекам SharePoint необходимо получить доступ. |
|
Indexed |
Конфигурация для источника знаний SharePoint. |
|
Indexed |
Параметры для источника знаний SharePoint. |
|
Indexed |
Настройка для индексируемого источника знаний SQL. |
|
Indexed |
Параметры для индексируемого источника знаний SQL. |
|
Indexing |
Представляет расписание выполнения индексатора. |
|
Knowledge |
Указывает ресурс Azure OpenAI, используемый для планирования запросов. |
|
Knowledge |
Модель ИИ, которая будет использоваться для планирования запросов. |
|
Knowledge |
Указывает ресурс Azure OpenAI, используемый для векторизации строки запроса. |
|
Knowledge |
Консолидирует все общие параметры приема для источников знаний. |
|
Knowledge |
Типы разрешений на ввод вместе с содержимым документа. |
|
Knowledge |
Вид источника знаний. |
|
Mcp |
Такой тип аутентификации для MCP-сервера. |
|
Mcp |
Автоматически определите формат выхода и соответствующим образом разберите. |
|
Mcp |
Аутентификация с использованием соединения Azure AI Foundry. |
|
Mcp |
Параметры аутентификации соединения Foundry. |
|
Mcp |
Парсировать выход как JSON-документ с использованием настроенных параметров JSON. |
|
Mcp |
Конфигурация для источника знаний, поддерживаемого сервером MCP (Model Context Protocol). |
|
Mcp |
Параметры для источника знаний на сервере MCP. |
|
Mcp |
Воспринимайте выход как один блок без какого-либо разбора. |
|
Mcp |
Параметры для разбора JSON на выходе. |
|
Mcp |
Такой вид выводного парсинга для MCP-серверного инструмента. |
|
Mcp |
Параметры для разбитого выходного разбора. |
|
Mcp |
Разделите выход на страницы, используя заданные параметры разделения. |
|
Mcp |
Аутентификация с использованием сохранённых HTTP-заголовков. |
|
Mcp |
Параметры для аутентификации хранимых заголовков. |
|
Mcp |
Представляет собой единый инструмент внутри источника знаний сервера MCP. |
|
Mcp |
Контролирует интеграцию результатов парсинговых инструментов MCP в итоговый набор результатов. |
| Prefer |
Для запросов HTTP PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении. |
|
Remote |
Конфигурация для удаленного источника знаний SharePoint. |
|
Remote |
Параметры для удаленного источника знаний SharePoint. |
|
Search |
Очищает свойство удостоверения источника данных. |
|
Search |
Указывает удостоверение для используемого источника данных. |
|
Search |
Поле для поискового индекса. |
|
Search |
Источник знаний, нацеленный на индекс поиска. |
|
Search |
Параметры для источника знаний по индексу поиска. |
|
Search |
Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки хранимых данных, таких как индексы и сопоставления синонимов. |
|
Split |
Коды языков, поддерживаемые SplitSkill для ввода текста. |
|
Text |
Значение, указывающее, какой режим разделения для выполнения. |
|
Vector |
Метод векторизации, который будет использоваться во время запроса. |
|
Web |
Источник знаний с таргетингом на веб-результаты. |
|
Web |
Конфигурация для домена источника знаний в Интернете. |
|
Web |
Конфигурация разрешения/блокировки домена для веб-источника знаний. |
|
Web |
Параметры для веб-источника знаний. |
|
Work |
Конфигурация для источника знаний WorkIQ. |
Accept
Заголовок Accept.
| Значение | Описание |
|---|---|
| application/json;odata.metadata=minimal |
AIServices
Параметры для сервисов ИИ.
| Имя | Тип | Описание |
|---|---|---|
| apiKey |
string |
Ключ API для доступа к Сервисам ИИ. |
| uri |
string (uri) |
URI конечной точки служб ИИ. |
AssetStore
Конфигурация хранилища активов, используемого для хранения извлечённых ассетов, таких как изображения.
| Имя | Тип | Описание |
|---|---|---|
| connectionString |
string |
строка подключения для хранилища ассетов. |
| containerName |
string |
Название blob-контейнера внутри хранилища ассетов, где хранятся извлечённые ассеты (например, изображения). |
AzureBlobKnowledgeSource
Конфигурация для источника знаний Хранилище BLOB-объектов Azure.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| azureBlobParameters |
Тип источника знаний. |
|
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| kind |
string:
azure |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
AzureBlobKnowledgeSourceParameters
Параметры для источника знаний Хранилище BLOB-объектов Azure.
| Имя | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
| connectionString |
string |
Строка подключения на основе ключа или формат ResourceId при использовании управляемого удостоверения. |
|
| containerName |
string |
Имя контейнера хранилища BLOB-объектов. |
|
| createdResources |
object |
Ресурсы, созданные источником знаний. |
|
| folderPath |
string |
Необязательный путь к папке в контейнере. |
|
| ingestionParameters |
Объединяет все общие параметры приема. |
||
| isADLSGen2 |
boolean |
False |
Установите значение true при подключении к учетной записи хранения ADLS 2-го поколения. По умолчанию — false. |
AzureOpenAIModelName
Имя модели Azure Open AI, которое будет вызываться.
| Значение | Описание |
|---|---|
| text-embedding-ada-002 |
TextEmbeddingAda002 модель. |
| text-embedding-3-large |
TextEmbedding3Большая модель. |
| text-embedding-3-small |
TextEmbedding3Малая модель. |
| 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. |
AzureOpenAIVectorizerParameters
Задает параметры для подключения к ресурсу Azure OpenAI.
| Имя | Тип | Описание |
|---|---|---|
| apiKey |
string |
Ключ API указанного ресурса Azure OpenAI. |
| authIdentity | SearchIndexerDataIdentity: |
Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений. |
| deploymentId |
string |
Идентификатор развертывания модели Azure OpenAI в указанном ресурсе. |
| modelName |
Имя модели внедрения, развернутой по указанному пути deploymentId. |
|
| resourceUri |
string (uri) |
URI ресурса ресурса Azure OpenAI. |
ContentColumnMapping
Сопоставляет столбец SQL с полем индекса поиска.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя индексного поля цели. |
| searchFieldType |
string |
Поиск с использованием ИИ Azure field type (e.e., Edm.String, Edm.Int32). |
| sourceField |
string |
Имя столбца SQL. |
EmbeddingColumnMapping
Отображает столбец SQL в векторное поле для вложения.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя целевого векторного поля в индексе поиска. |
| sourceField |
string |
SQL-столбец используется как вход для генерации встраивания. |
ErrorAdditionalInfo
Дополнительные сведения об ошибке управления ресурсами.
| Имя | Тип | Описание |
|---|---|---|
| info |
Дополнительные сведения. |
|
| type |
string |
Тип дополнительных сведений. |
ErrorDetail
Подробности ошибки.
| Имя | Тип | Описание |
|---|---|---|
| additionalInfo |
Дополнительные сведения об ошибке. |
|
| code |
string |
Код ошибки. |
| details |
Сведения об ошибке. |
|
| message |
string |
Сообщение об ошибке. |
| target |
string |
Целевой объект ошибки. |
ErrorResponse
Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
| Имя | Тип | Описание |
|---|---|---|
| error |
Объект ошибки. |
FabricDataAgentKnowledgeSource
Конфигурация для источника знаний Fabric Data Agent.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| fabricDataAgentParameters |
Параметры источника знаний Fabric Data Agent. |
|
| kind |
string:
fabric |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
FabricDataAgentKnowledgeSourceParameters
Параметры источника знаний Fabric Data Agent.
| Имя | Тип | Описание |
|---|---|---|
| dataAgentId |
string |
Указывает, к какому агенту данных Fabric обратиться. |
| workspaceId |
string |
Fabric workspace ID. |
FabricOntologyKnowledgeSource
Источник знаний по конфигурации для Fabric Ontology.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| fabricOntologyParameters |
Параметры источника знаний Fabric Ontology. |
|
| kind |
string:
fabric |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
FabricOntologyKnowledgeSourceParameters
Параметры для источника знаний Fabric Ontology.
| Имя | Тип | Описание |
|---|---|---|
| ontologyId |
string |
ID онтологии для использования из рабочего пространства Fabric. |
| workspaceId |
string |
ID Fabric workspace, содержащий онтологию. |
FileKnowledgeSource
Конфигурация для источника знания файлов, поддерживающая прямую загрузку и индексацию файлов.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| fileParameters |
Параметры для источника знаний Файла. |
|
| kind |
string:
file |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
FileKnowledgeSourceParameters
Параметры для источника знания файлов.
| Имя | Тип | Описание |
|---|---|---|
| createdResources |
object |
Ресурсы, созданные источником знаний файла. |
| ingestionParameters |
Консолидирует все общие настройки ввода для источника знаний Файла, включая режим извлечения контента и опциональную модель вложения. |
FreshnessPolicy
Настройка для поиска с учётом свежести. При установке новые документы получают повышение рейтинга во время поиска.
| Имя | Тип | Описание |
|---|---|---|
| boostingDuration |
string |
Длительность ISO 8601 для окна повышения свежести (например, 'P90D' в течение 90 дней). Документы с более поздним сроком времени получают повышение рейтинга при поиске. |
IndexedOneLakeKnowledgeSource
Конфигурация для источника знаний OneLake.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| indexedOneLakeParameters |
Параметры для источника знаний. |
|
| kind |
string:
indexed |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
IndexedOneLakeKnowledgeSourceParameters
Параметры для источника знаний OneLake.
| Имя | Тип | Описание |
|---|---|---|
| createdResources |
object |
Ресурсы, созданные источником знаний. |
| fabricWorkspaceId |
string |
Идентификатор рабочей области OneLake. |
| ingestionParameters |
Объединяет все общие параметры приема. |
|
| lakehouseId |
string |
Указывает, к какому домику у озера OneLake следует получить доступ. |
| targetPath |
string |
Необязательная папка OneLakehouse или ярлык для фильтрации содержимого OneLake. |
IndexedSharePointContainerName
Указывает, к каким библиотекам SharePoint необходимо получить доступ.
| Значение | Описание |
|---|---|
| defaultSiteLibrary |
Индексируйте контент из библиотеки документов сайта по умолчанию. |
| allSiteLibraries |
Индексируйте контент из каждой библиотеки документов на сайте. |
| useQuery |
Используйте запрос для фильтрации контента SharePoint. |
IndexedSharePointKnowledgeSource
Конфигурация для источника знаний SharePoint.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| indexedSharePointParameters |
Параметры для источника знаний. |
|
| kind |
string:
indexed |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
IndexedSharePointKnowledgeSourceParameters
Параметры для источника знаний SharePoint.
| Имя | Тип | Описание |
|---|---|---|
| connectionString |
string |
Строка подключения к SharePoint в формате: SharePointOnlineEndpoint=[URL сайта SharePoint]; ApplicationId=[идентификатор приложения Azure AD]; ApplicationSecret=[секрет клиента приложения Azure AD]; TenantId=[Идентификатор клиента сайта SharePoint] |
| containerName |
Указывает, к каким библиотекам SharePoint необходимо получить доступ. |
|
| createdResources |
object |
Ресурсы, созданные источником знаний. |
| ingestionParameters |
Объединяет все общие параметры приема. |
|
| query |
string |
Необязательный запрос для фильтрации контента SharePoint. |
IndexedSqlKnowledgeSource
Настройка для индексируемого источника знаний SQL.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| indexedSqlParameters |
Параметры для источника знаний SQL. |
|
| kind |
string:
indexed |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
IndexedSqlKnowledgeSourceParameters
Параметры для индексируемого источника знаний SQL.
| Имя | Тип | Описание |
|---|---|---|
| connectionString |
string |
The строка подключения для База данных SQL Azure или Управляемый экземпляр SQL. |
| contentColumns |
Опциональные столбцовые отображения для полей содержания. Если это опущено, все столбцы автоматически обнаружуются. |
|
| createdResources |
object |
Ресурсы, созданные источником знаний. |
| embeddingColumns |
Опциональные столбцовые отображения для вложения векторных полей. Если его опускать, векторные поля не создаются. |
|
| highWaterMarkColumnName |
string |
Опциональное название столбца для обнаружения изменений отметки высокой воды. Если предоставлено, используйте HighWaterMarkChangeDetectionPolicy. |
| ingestionParameters |
Консолидирует все общие настройки вложения, включая модель вложения, расписание и идентичность. |
|
| tableOrView |
string |
Название таблицы или представления для индексирования. Может быть квалифицирован по схеме (например, 'dbo. MyTable'). |
IndexingSchedule
Представляет расписание выполнения индексатора.
| Имя | Тип | Описание |
|---|---|---|
| interval |
string (duration) |
Интервал времени между выполнениями индексатора. |
| startTime |
string (date-time) |
Время, когда индексатор должен начать работу. |
KnowledgeBaseAzureOpenAIModel
Указывает ресурс Azure OpenAI, используемый для планирования запросов.
| Имя | Тип | Описание |
|---|---|---|
| azureOpenAIParameters |
Azure OpenAI parameters. |
|
| kind |
string:
azure |
Модель ИИ, которая будет использоваться для планирования запросов. |
KnowledgeBaseModelKind
Модель ИИ, которая будет использоваться для планирования запросов.
| Значение | Описание |
|---|---|
| azureOpenAI |
Используйте модели Azure Open AI для планирования запросов. |
KnowledgeSourceAzureOpenAIVectorizer
Указывает ресурс Azure OpenAI, используемый для векторизации строки запроса.
| Имя | Тип | Описание |
|---|---|---|
| azureOpenAIParameters |
Содержит параметры, относящиеся к векторизации внедрения Azure OpenAI. |
|
| kind |
string:
azure |
Название метода векторизации, который настраивается для использования с векторным поиском. |
KnowledgeSourceIngestionParameters
Консолидирует все общие параметры приема для источников знаний.
| Имя | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
| aiServices |
Дополнительная конфигурация служб ИИ для обработки контента. |
||
| assetStore |
Опциональная конфигурация хранилища активов для хранения извлечённых ассетов, таких как изображения. |
||
| chatCompletionModel | KnowledgeBaseModel: |
Опциональная модель завершения чата для вербализации изображений или извлечения контекста. |
|
| contentExtractionMode |
enum:
|
minimal |
Дополнительный режим извлечения контента. Значение по умолчанию — «минимальный». |
| disableImageVerbalization |
boolean |
False |
Указывает, следует ли отключить вербализацию изображений. По умолчанию — false. |
| embeddingModel | KnowledgeSourceVectorizer: |
Необязательная конфигурация векторизатора для векторизации содержимого. |
|
| freshnessPolicy |
Опциональная политика свежести для предвзятого поиска в пользу новых документов. |
||
| identity | SearchIndexerDataIdentity: |
Явное удостоверение для использования в этом источнике знаний. |
|
| ingestionPermissionOptions |
Необязательный список типов разрешений для приема вместе с содержимым документа. Если указано, будут установлены параметры разрешений индексатора для источника данных. |
||
| ingestionSchedule |
Необязательное расписание для приема данных. |
KnowledgeSourceIngestionPermissionOption
Типы разрешений на ввод вместе с содержимым документа.
| Значение | Описание |
|---|---|
| userIds |
Принимайте явные идентификаторы пользователей вместе с содержимым документа. |
| groupIds |
Принимайте идентификаторы групп вместе с содержимым документа. |
| rbacScope |
Прием информации об области RBAC вместе с содержимым документа. |
| sensitivityLabels |
Вводите метки чувствительности Microsoft Purview вместе с содержимым документов. |
KnowledgeSourceKind
Вид источника знаний.
| Значение | Описание |
|---|---|
| searchIndex |
Источник знаний, который считывает данные из индекса поиска. |
| azureBlob |
Источник знаний, который считывает и принимает данные из хранилища BLOB-объектов Azure в индекс поиска. |
| indexedSharePoint |
Источник знаний, который считывает данные с индексируемого SharePoint Point. |
| indexedOneLake |
Источник знаний, который читает данные с индексируемого OneLake. |
| indexedSql |
Источник знаний, который извлекает и поглощает данные из База данных SQL Azure или Управляемый экземпляр SQL в поисковый индекс. |
| web |
Источник знаний, который читает данные из интернета. |
| remoteSharePoint |
Источник знаний, который считывает данные с удалённого SharePoint Point. |
| workIQ |
Источник знаний, который считывает данные из рабочего IQ |
| file |
Источник знаний, поддерживающий прямую загрузку и индексацию файлов. |
| mcpServer |
Источник знаний, поддерживаемый сервером MCP (Model Context Protocol). |
| fabricDataAgent |
Источник знаний, который получает данные из агента Fabric Data Agent. |
| fabricOntology |
Источник знаний, который получает данные из онтологий Microsoft Fabric Ontology. |
McpServerAuthenticationKind
Такой тип аутентификации для MCP-сервера.
| Значение | Описание |
|---|---|
| foundryConnection |
Аутентификация с помощью соединения Azure AI Foundry. |
| storedHeaders |
Аутентификация с использованием сохранённых HTTP-заголовков. |
McpServerAutoOutputParsing
Автоматически определите формат выхода и соответствующим образом разберите.
| Имя | Тип | Описание |
|---|---|---|
| kind |
string:
auto |
Тот тип парсинга вывода, который нужно применять. |
McpServerFoundryConnectionAuthentication
Аутентификация с использованием соединения Azure AI Foundry.
| Имя | Тип | Описание |
|---|---|---|
| foundryConnectionParameters |
Параметры аутентификации соединения Foundry. |
|
| kind |
string:
foundry |
Какой тип аутентификации стоит использовать. |
McpServerFoundryConnectionParameters
Параметры аутентификации соединения Foundry.
| Имя | Тип | Описание |
|---|---|---|
| connectionId |
string |
Идентификатор соединения Azure AI Foundry. |
McpServerJsonOutputParsing
Парсировать выход как JSON-документ с использованием настроенных параметров JSON.
| Имя | Тип | Описание |
|---|---|---|
| jsonParameters |
Параметры для разбора JSON на выходе. Обязательно, когда добрый — это «json». |
|
| kind |
string:
json |
Тот тип парсинга вывода, который нужно применять. |
McpServerKnowledgeSource
Конфигурация для источника знаний, поддерживаемого сервером MCP (Model Context Protocol).
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| kind |
string:
mcp |
Тип источника знаний. |
| mcpServerParameters |
Параметры источника знаний сервера MCP. |
|
| name |
string |
Название источника знаний. |
McpServerKnowledgeSourceParameters
Параметры для источника знаний на сервере MCP.
| Имя | Тип | Описание |
|---|---|---|
| authentication | McpServerAuthentication: |
Конфигурация аутентификации для MCP-сервера. |
| serverURL |
string |
URL конечной точки сервера MCP. |
| tools |
Список инструментов для вызова на сервере MCP. |
McpServerNoneOutputParsing
Воспринимайте выход как один блок без какого-либо разбора.
| Имя | Тип | Описание |
|---|---|---|
| kind |
string:
none |
Тот тип парсинга вывода, который нужно применять. |
McpServerOutputParsingJsonParameters
Параметры для разбора JSON на выходе.
| Имя | Тип | Описание |
|---|---|---|
| documentsPath |
string |
Путь JSON к массиву документов в выходе инструмента. |
| includeContext |
boolean |
Стоит ли включать окружающий контекст из JSON-выхода вместе с извлеченными документами. |
McpServerOutputParsingKind
Такой вид выводного парсинга для MCP-серверного инструмента.
| Значение | Описание |
|---|---|
| auto |
Автоматически определите формат выхода и соответствующим образом разберите. |
| json |
Парсировать выход как JSON-документ с использованием настроенных параметров JSON. |
| split |
Разделите выход на страницы, используя заданные параметры разделения. |
| none |
Воспринимайте выход как один блок без какого-либо разбора. |
McpServerOutputParsingSplitParameters
Параметры для разбитого выходного разбора.
| Имя | Тип | Описание |
|---|---|---|
| defaultLanguageCode |
Значение, указывающее, какой языковой код следует использовать. По умолчанию — |
|
| maximumPageLength |
integer (int32) |
Максимальное количество символов на странице. |
| maximumPagesToTake |
integer (int32) |
Максимальное количество страниц, которые нужно взять из результата. |
| pageOverlapLength |
integer (int32) |
Количество символов, которые пересекаются между страницами. |
| textSplitMode |
Режим разделения текста для использования. |
McpServerSplitOutputParsing
Разделите выход на страницы, используя заданные параметры разделения.
| Имя | Тип | Описание |
|---|---|---|
| kind |
string:
split |
Тот тип парсинга вывода, который нужно применять. |
| splitParameters |
Параметры для разбитого выходного разбора. |
McpServerStoredHeadersAuthentication
Аутентификация с использованием сохранённых HTTP-заголовков.
| Имя | Тип | Описание |
|---|---|---|
| kind |
string:
stored |
Какой тип аутентификации стоит использовать. |
| storedHeadersParameters |
Параметры для аутентификации хранимых заголовков. |
McpServerStoredHeadersParameters
Параметры для аутентификации хранимых заголовков.
| Имя | Тип | Описание |
|---|---|---|
| headers |
object |
Хранящиеся HTTP-заголовки для включения в запросы MCP сервера. |
McpServerTool
Представляет собой единый инструмент внутри источника знаний сервера MCP.
| Имя | Тип | Описание |
|---|---|---|
| inclusionMode |
Контролирует, как проанализированные результаты этого инструмента интегрируются в итоговый набор результатов. По умолчанию переходит в «переранжированный», если это не указано. |
|
| maxOutputTokens |
integer (int32) |
Опциональное ограничение токена после разбора для вывода этого инструмента. При указании должно быть больше 0. |
| name |
string |
Имя вызываемого средства MCP. |
| outputParsing | McpServerOutputParsing: |
Опциональная конфигурация для анализа вывода инструмента. |
McpServerToolInclusionMode
Контролирует интеграцию результатов парсинговых инструментов MCP в итоговый набор результатов.
| Значение | Описание |
|---|---|
| reranked |
Результаты инструментов проходят через процесс переклассификации и агрегации вместе с результатами из других источников знаний. Это поведение по умолчанию. |
| always |
Результаты инструмента обходят перераспределение и всегда включаются в контекст агента. |
Prefer
Для запросов HTTP PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении.
| Значение | Описание |
|---|---|
| return=representation |
RemoteSharePointKnowledgeSource
Конфигурация для удаленного источника знаний SharePoint.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| kind |
string:
remote |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
| remoteSharePointParameters |
Параметры для удалённого источника знаний в SharePoint. |
RemoteSharePointKnowledgeSourceParameters
Параметры для удаленного источника знаний SharePoint.
| Имя | Тип | Описание |
|---|---|---|
| containerTypeId |
string |
Идентификатор контейнера для подключения к SharePoint Embedded. Если значение равно null, будет использоваться SharePoint Online. |
| filterExpression |
string |
Выражение языка запросов по ключевым словам (KQL) с запрашиваемыми свойствами и атрибутами SharePoint для определения области извлечения перед выполнением запроса. |
| resourceMetadata |
string[] |
Список полей метаданных, возвращаемых для каждого элемента в ответе. В этот список можно включить только извлекаемые свойства метаданных. По умолчанию метаданные не возвращаются. |
SearchIndexerDataNoneIdentity
Очищает свойство удостоверения источника данных.
| Имя | Тип | Описание |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Фрагмент URI, указывающий тип удостоверения. |
SearchIndexerDataUserAssignedIdentity
Указывает удостоверение для используемого источника данных.
| Имя | Тип | Описание |
|---|---|---|
| @odata.type |
string:
#Microsoft. |
Фрагмент URI, указывающий тип удостоверения. |
| federatedIdentityClientId |
string |
Многоарендная User-Assigned управляемая поддержка идентичности: идентификатор клиента многостороннего приложения, настроенного для федерации с управляемой идентичностью, назначенной пользователем. |
| userAssignedIdentity |
string |
Полный идентификатор ресурса Azure назначаемого пользователем управляемого удостоверения обычно в форме "/subscriptions/12345678-1234-1234-1234-1234567890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", который должен быть назначен службе поиска. |
SearchIndexFieldReference
Поле для поискового индекса.
| Имя | Тип | Описание |
|---|---|---|
| name |
string |
Имя поля. |
SearchIndexKnowledgeSource
Источник знаний, нацеленный на индекс поиска.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| kind |
string:
search |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
| searchIndexParameters |
Параметры для источника знаний. |
SearchIndexKnowledgeSourceParameters
Параметры для источника знаний по индексу поиска.
| Имя | Тип | Описание |
|---|---|---|
| baseFilter |
string |
Стандартное условие фильтра, применяемое к индексу при получении информации (например, «State eq VA»). Можно переопределить во время запроса с помощью параметров выполнения источника знаний. |
| searchFields |
Используется для ограничения того, какие поля следует искать в индексе поиска. |
|
| searchIndexName |
string |
Имя индекса поиска. |
| semanticConfigurationName |
string |
Используется для указания другой семантической конфигурации в целевом индексе поиска, отличной от конфигурации по умолчанию. |
| sourceDataFields |
Используется для запроса дополнительных полей для ссылаемых исходных данных. |
SearchResourceEncryptionKey
Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки хранимых данных, таких как индексы и сопоставления синонимов.
| Имя | Тип | Значение по умолчанию | Описание |
|---|---|---|---|
| accessCredentials.applicationId |
string |
Идентификатор приложения AAD, которому было предоставлено необходимые разрешения на доступ к Azure Key Vault, который будет использоваться при шифровании неактивных данных. Идентификатор приложения не следует путать с идентификатором объекта для приложения AAD. |
|
| accessCredentials.applicationSecret |
string |
Ключ проверки подлинности указанного приложения AAD. |
|
| identity | SearchIndexerDataIdentity: |
Явное управляемое удостоверение, используемое для этого ключа шифрования. Если не указано, а свойство учетных данных доступа равно NULL, используется управляемое удостоверение, назначаемое системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если задано значение none, то значение этого свойства очищается. |
|
| isServiceLevelKey |
boolean |
False |
Необязательное значение, указывающее, является ли этот ключ ключом уровня сервиса. По умолчанию — false. |
| keyVaultKeyName |
string |
Имя ключа Azure Key Vault, используемого для шифрования неактивных данных. |
|
| keyVaultKeyVersion |
string |
Версия ключа Azure Key Vault, используемая для шифрования неактивных данных. |
|
| keyVaultUri |
string |
Универсальный код ресурса (URI) Хранилища ключей Azure, который также называется DNS-именем, который содержит ключ, используемый для шифрования неактивных данных. Пример URI может быть |
SplitSkillLanguage
Коды языков, поддерживаемые SplitSkill для ввода текста.
| Значение | Описание |
|---|---|
| am |
Амхарский |
| bs |
Боснийский |
| cs |
Чешский |
| da |
Датский |
| de |
Немецкий |
| en |
English |
| es |
испанский |
| et |
Эстонский |
| fi |
Финский |
| fr |
Французский |
| he |
Иврит |
| hi |
Хинди |
| hr |
Croatian |
| hu |
Hungarian |
| id |
Indonesian |
| is |
Исландский |
| it |
Итальянский |
| ja |
Japanese |
| ko |
Корейский |
| lv |
Латышский |
| nb |
Норвежский |
| nl |
Нидерландский |
| pl |
Польский |
| pt |
Португальский (Португалия) |
| pt-br |
португальский (Бразилия) |
| ru |
Russian |
| sk |
Словацкий |
| sl |
Словенский |
| sr |
Сербский |
| sv |
Шведский |
| tr |
Турецкий |
| ur |
Урду |
| zh |
Китайский (упрощённый) |
TextSplitMode
Значение, указывающее, какой режим разделения для выполнения.
| Значение | Описание |
|---|---|
| pages |
Разделить текст на отдельные страницы. |
| sentences |
Разделить текст на отдельные предложения. |
VectorSearchVectorizerKind
Метод векторизации, который будет использоваться во время запроса.
| Значение | Описание |
|---|---|
| azureOpenAI |
Создайте внедрение с помощью ресурса Azure OpenAI во время запроса. |
| customWebApi |
Создание внедрения с помощью пользовательской веб-конечной точки во время запроса. |
| aiServicesVision |
Создайте внедрения для ввода изображения или текста во время запроса с помощью API векторизации визуального распознавания служб ИСКУССТВЕННОго интеллекта Azure. |
| aml |
Создавайте внедрения с помощью конечной точки Машинного обучения Azure, развернутой с помощью каталога моделей Azure AI Foundry во время запроса. |
WebKnowledgeSource
Источник знаний с таргетингом на веб-результаты.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| kind |
string:
web |
Тип источника знаний. |
| name |
string |
Название источника знаний. |
| webParameters |
Параметры для веб-источника знаний. |
WebKnowledgeSourceDomain
Конфигурация для домена источника знаний в Интернете.
| Имя | Тип | Описание |
|---|---|---|
| address |
string |
Адрес домена. |
| includeSubpages |
boolean |
Следует ли включать подстраницы из этого домена. |
WebKnowledgeSourceDomains
Конфигурация разрешения/блокировки домена для веб-источника знаний.
| Имя | Тип | Описание |
|---|---|---|
| allowedDomains |
Домены, которые разрешены для веб-результатов. |
|
| blockedDomains |
Домены, заблокированные в веб-результатах. |
WebKnowledgeSourceParameters
Параметры для веб-источника знаний.
| Имя | Тип | Описание |
|---|---|---|
| count |
integer (int32) |
По умолчанию количество веб-результатов, которые возвращаются. Можно переопределить во время запроса с помощью параметров выполнения источника знаний. |
| domains |
Конфигурация разрешения/блокировки домена для веб-результатов. |
|
| freshness |
string |
Стандартный фильтр свежести для веб-результатов. Можно переопределить во время запроса с помощью параметров выполнения источника знаний. |
| language |
string |
Стандартный язык для веб-результатов. Можно переопределить во время запроса с помощью параметров выполнения источника знаний. |
| market |
string |
Рынок по умолчанию для веб-результатов. Можно переопределить во время запроса с помощью параметров выполнения источника знаний. |
WorkIQKnowledgeSource
Конфигурация для источника знаний WorkIQ.
| Имя | Тип | Описание |
|---|---|---|
| @odata.etag |
string |
ETag источника знаний. |
| description |
string |
Необязательное пользовательское описание. |
| encryptionKey |
Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г. |
|
| kind |
string:
workIQ |
Тип источника знаний. |
| name |
string |
Название источника знаний. |