Knowledge Sources - Create

Служба:
Search Service
Версия API:
2026-08-01-preview

Создает новый источник знаний.

POST {endpoint}/knowledgesources?api-version=2026-08-01-preview

Параметры URI

Имя В Обязательно Тип Описание
endpoint
 path True

string (uri)

URL-адрес конечной точки службы поиска.
api-version
 query True

string

minLength: 1

Версия API, используемая для данной операции.

Заголовок запроса

Имя Обязательно Тип Описание
Accept

Accept

Заголовок Accept.
x-ms-client-request-id

string (uuid)

Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

Текст запроса

Текст запроса может быть таким:

Имя Описание
AzureBlobKnowledgeSource

Конфигурация для источника знаний Хранилище BLOB-объектов Azure.
FabricDataAgentKnowledgeSource

Конфигурация для источника знаний Fabric Data Agent.
FabricOntologyKnowledgeSource

Источник знаний по конфигурации для Fabric Ontology.
FileKnowledgeSource

Конфигурация для источника знания файлов, поддерживающая прямую загрузку и индексацию файлов.
IndexedOneLakeKnowledgeSource

Конфигурация для источника знаний OneLake.
IndexedSharePointKnowledgeSource

Конфигурация для источника знаний SharePoint.
IndexedSqlKnowledgeSource

Настройка для индексируемого источника знаний SQL.
McpServerKnowledgeSource

Конфигурация для источника знаний, поддерживаемого сервером MCP (Model Context Protocol).
RemoteSharePointKnowledgeSource

Конфигурация для удаленного источника знаний SharePoint.
SearchIndexKnowledgeSource

Источник знаний, нацеленный на индекс поиска.
WebKnowledgeSource

Источник знаний с таргетингом на веб-результаты.
WorkIQKnowledgeSource

Конфигурация для источника знаний WorkIQ.

AzureBlobKnowledgeSource

Конфигурация для источника знаний Хранилище BLOB-объектов Azure.

Имя Обязательно Тип Описание
azureBlobParameters True

AzureBlobKnowledgeSourceParameters

Тип источника знаний.
kind True string:

azureBlob

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

FabricDataAgentKnowledgeSource

Конфигурация для источника знаний Fabric Data Agent.

Имя Обязательно Тип Описание
fabricDataAgentParameters True

FabricDataAgentKnowledgeSourceParameters

Параметры источника знаний Fabric Data Agent.
kind True string:

fabricDataAgent

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

FabricOntologyKnowledgeSource

Источник знаний по конфигурации для Fabric Ontology.

Имя Обязательно Тип Описание
fabricOntologyParameters True

FabricOntologyKnowledgeSourceParameters

Параметры источника знаний Fabric Ontology.
kind True string:

fabricOntology

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

FileKnowledgeSource

Конфигурация для источника знания файлов, поддерживающая прямую загрузку и индексацию файлов.

Имя Обязательно Тип Описание
fileParameters True

FileKnowledgeSourceParameters

Параметры для источника знаний Файла.
kind True string:

file

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
corsOptions

CorsOptions

Опции управления обменом ресурсами между источниками (CORS) для конечных точек файла источника знаний (загрузка, список, обновление, удаление).
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

IndexedOneLakeKnowledgeSource

Конфигурация для источника знаний OneLake.

Имя Обязательно Тип Описание
indexedOneLakeParameters True

IndexedOneLakeKnowledgeSourceParameters

Параметры для источника знаний.
kind True string:

indexedOneLake

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

IndexedSharePointKnowledgeSource

Конфигурация для источника знаний SharePoint.

Имя Обязательно Тип Описание
indexedSharePointParameters True

IndexedSharePointKnowledgeSourceParameters

Параметры для источника знаний.
kind True string:

indexedSharePoint

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

IndexedSqlKnowledgeSource

Настройка для индексируемого источника знаний SQL.

Имя Обязательно Тип Описание
indexedSqlParameters True

IndexedSqlKnowledgeSourceParameters

Параметры для источника знаний SQL.
kind True string:

indexedSql

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

McpServerKnowledgeSource

Конфигурация для источника знаний, поддерживаемого сервером MCP (Model Context Protocol).

Имя Обязательно Тип Описание
kind True string:

mcpServer

Тип источника знаний.
mcpServerParameters True

McpServerKnowledgeSourceParameters

Параметры источника знаний сервера MCP.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

RemoteSharePointKnowledgeSource

Конфигурация для удаленного источника знаний SharePoint.

Имя Обязательно Тип Описание
kind True string:

remoteSharePoint

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
remoteSharePointParameters

RemoteSharePointKnowledgeSourceParameters

Параметры для удалённого источника знаний в SharePoint.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

SearchIndexKnowledgeSource

Источник знаний, нацеленный на индекс поиска.

Имя Обязательно Тип Описание
kind True string:

searchIndex

Тип источника знаний.
name True

string

Название источника знаний.
searchIndexParameters True

SearchIndexKnowledgeSourceParameters

Параметры для источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

WebKnowledgeSource

Источник знаний с таргетингом на веб-результаты.

Имя Обязательно Тип Описание
kind True string:

web

Тип источника знаний.
name True

string

Название источника знаний.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.
webParameters

WebKnowledgeSourceParameters

Параметры для веб-источника знаний.

WorkIQKnowledgeSource

Конфигурация для источника знаний WorkIQ.

Имя Обязательно Тип Описание
kind True string:

workIQ

Тип источника знаний.
name True

string

Название источника знаний.
workIQParameters True

WorkIQKnowledgeSourceParameters

Параметры источника знаний WorkIQ, включая клиентскую конфигурацию приложения Entra, используемую для аутентификации от имени пользователя.
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

Ответы

Имя Тип Описание
201 Created KnowledgeSource:

Запрос успешно выполнен, и в результате был создан новый ресурс.
Other Status Codes

ErrorResponse

Непредвиденное сообщение об ошибке.

Безопасность

api-key

Тип: apiKey
В: header

OAuth2Auth

Тип: oauth2
Flow: implicit
URL-адрес авторизации: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Области

Имя Описание
https://search.azure.com/.default

Примеры

SearchServiceCreateKnowledgeSource
SearchServiceCreateKnowledgeSourceAzureBlob
SearchServiceCreateKnowledgeSourceFabricDataAgent
SearchServiceCreateKnowledgeSourceFabricOntology
SearchServiceCreateKnowledgeSourceFile
SearchServiceCreateKnowledgeSourceIndexedOneLake
SearchServiceCreateKnowledgeSourceIndexedSharePoint
SearchServiceCreateKnowledgeSourceIndexedSql
SearchServiceCreateKnowledgeSourceMcpServer
SearchServiceCreateKnowledgeSourceWeb
SearchServiceCreateKnowledgeSourceWorkIQ

SearchServiceCreateKnowledgeSource

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

SearchServiceCreateKnowledgeSourceAzureBlob

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

SearchServiceCreateKnowledgeSourceFabricDataAgent

Образец запроса

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview


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

Пример ответа

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

SearchServiceCreateKnowledgeSourceFabricOntology

Образец запроса

POST https://previewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview


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

Пример ответа

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

SearchServiceCreateKnowledgeSourceFile

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

SearchServiceCreateKnowledgeSourceIndexedOneLake

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

SearchServiceCreateKnowledgeSourceIndexedSharePoint

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

SearchServiceCreateKnowledgeSourceIndexedSql

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

SearchServiceCreateKnowledgeSourceMcpServer

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

SearchServiceCreateKnowledgeSourceWeb

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

SearchServiceCreateKnowledgeSourceWorkIQ

Образец запроса

POST https://typespecpreviewexampleservice.search.windows.net/knowledgesources?api-version=2026-08-01-preview



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

Пример ответа

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

Определения

Имя Описание
Accept

Заголовок Accept.
AIServices

Параметры для сервисов ИИ.
AssetStore

Конфигурация хранилища активов, используемого для хранения извлечённых ассетов, таких как изображения.
AzureBlobKnowledgeSource

Конфигурация для источника знаний Хранилище BLOB-объектов Azure.
AzureBlobKnowledgeSourceParameters

Параметры для источника знаний Хранилище BLOB-объектов Azure.
AzureOpenAIModelName

Имя модели Azure Open AI, которое будет вызываться.
AzureOpenAIVectorizerParameters

Задает параметры для подключения к ресурсу Azure OpenAI.
ContentColumnMapping

Сопоставляет столбец SQL с полем индекса поиска.
CorsOptions

Определяет параметры управления общим доступом к ресурсам между источниками (CORS) для индекса.
EmbeddingColumnMapping

Отображает столбец SQL в векторное поле для вложения.
EntraAppAuthentication

Конфигурация для регистрации приложения Microsoft Entra, принадлежащего клиенту, используемого для аутентификации на основе федеративных учетных данных от имени пользователя.
ErrorAdditionalInfo

Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail

Подробности ошибки.
ErrorResponse

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
FabricDataAgentKnowledgeSource

Конфигурация для источника знаний Fabric Data Agent.
FabricDataAgentKnowledgeSourceParameters

Параметры источника знаний Fabric Data Agent.
FabricOntologyKnowledgeSource

Источник знаний по конфигурации для Fabric Ontology.
FabricOntologyKnowledgeSourceParameters

Параметры для источника знаний Fabric Ontology.
FileKnowledgeSource

Конфигурация для источника знания файлов, поддерживающая прямую загрузку и индексацию файлов.
FileKnowledgeSourceParameters

Параметры для источника знания файлов.
FreshnessPolicy

Настройка для поиска с учётом свежести. При установке новые документы получают повышение рейтинга во время поиска.
IndexedOneLakeKnowledgeSource

Конфигурация для источника знаний OneLake.
IndexedOneLakeKnowledgeSourceParameters

Параметры для источника знаний OneLake.
IndexedSharePointContainerName

Указывает, к каким библиотекам SharePoint необходимо получить доступ.
IndexedSharePointKnowledgeSource

Конфигурация для источника знаний SharePoint.
IndexedSharePointKnowledgeSourceParameters

Параметры для источника знаний SharePoint.
IndexedSqlKnowledgeSource

Настройка для индексируемого источника знаний SQL.
IndexedSqlKnowledgeSourceParameters

Параметры для индексируемого источника знаний SQL.
IndexingSchedule

Представляет расписание выполнения индексатора.
KnowledgeBaseAzureOpenAIModel

Указывает ресурс Azure OpenAI, используемый для планирования запросов.
KnowledgeBaseModelKind

Модель ИИ, которая будет использоваться для планирования запросов.
KnowledgeSourceAzureOpenAIVectorizer

Указывает ресурс Azure OpenAI, используемый для векторизации строки запроса.
KnowledgeSourceIngestionParameters

Консолидирует все общие параметры приема для источников знаний.
KnowledgeSourceIngestionPermissionOption

Типы разрешений на ввод вместе с содержимым документа.
KnowledgeSourceKind

Вид источника знаний.
KnowledgeSourceNetworkAccessMode

Задаёт режим доступа к сети для погружения источников знаний. По умолчанию — «публичный».
KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты источника знаний переранжированы.
McpServerAuthenticationKind

Такой тип аутентификации для MCP-сервера.
McpServerAutoOutputParsing

Автоматически определите формат выхода и соответствующим образом разберите.
McpServerFoundryConnectionAuthentication

Аутентификация с использованием соединения Azure AI Foundry.
McpServerFoundryConnectionParameters

Параметры аутентификации соединения Foundry.
McpServerJsonOutputParsing

Парсировать выход как JSON-документ с использованием настроенных параметров JSON.
McpServerKnowledgeSource

Конфигурация для источника знаний, поддерживаемого сервером MCP (Model Context Protocol).
McpServerKnowledgeSourceParameters

Параметры для источника знаний на сервере MCP.
McpServerNoneOutputParsing

Воспринимайте выход как один блок без какого-либо разбора.
McpServerOutputParsingJsonParameters

Параметры для разбора JSON на выходе.
McpServerOutputParsingKind

Такой вид выводного парсинга для MCP-серверного инструмента.
McpServerOutputParsingSplitParameters

Параметры для разбитого выходного разбора.
McpServerSplitOutputParsing

Разделите выход на страницы, используя заданные параметры разделения.
McpServerStoredHeadersAuthentication

Аутентификация с использованием сохранённых HTTP-заголовков.
McpServerStoredHeadersParameters

Параметры для аутентификации хранимых заголовков.
McpServerTool

Представляет собой единый инструмент внутри источника знаний сервера MCP.
RemoteSharePointKnowledgeSource

Конфигурация для удаленного источника знаний SharePoint.
RemoteSharePointKnowledgeSourceParameters

Параметры для удаленного источника знаний SharePoint.
SearchIndexerDataNoneIdentity

Очищает свойство удостоверения источника данных.
SearchIndexerDataUserAssignedIdentity

Указывает удостоверение для используемого источника данных.
SearchIndexFieldReference

Поле для поискового индекса.
SearchIndexKnowledgeSource

Источник знаний, нацеленный на индекс поиска.
SearchIndexKnowledgeSourceBoostKind

Это тип подсказки для поискового индекса информации.
SearchIndexKnowledgeSourceFieldValueBoost

Подсказка, которая улучшает документы на основе значения поля.
SearchIndexKnowledgeSourceFilterHint

Подсказка, определяющая поле и репрезентативные значения, которые планировщик запросов может использовать при построении фильтра.
SearchIndexKnowledgeSourceMultiWordExpressionBoost

Подсказка, которая улучшает работу документов на основе многословного выражения.
SearchIndexKnowledgeSourceParameters

Параметры для источника знаний по индексу поиска.
SearchIndexKnowledgeSourceQueryHints

Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям для поискового индекса информации.
SearchResourceEncryptionKey

Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки хранимых данных, таких как индексы и сопоставления синонимов.
SplitSkillLanguage

Коды языков, поддерживаемые SplitSkill для ввода текста.
TextSplitMode

Значение, указывающее, какой режим разделения для выполнения.
VectorSearchVectorizerKind

Метод векторизации, который будет использоваться во время запроса.
WebKnowledgeSource

Источник знаний с таргетингом на веб-результаты.
WebKnowledgeSourceDomain

Конфигурация для домена источника знаний в Интернете.
WebKnowledgeSourceDomains

Конфигурация разрешения/блокировки домена для веб-источника знаний.
WebKnowledgeSourceParameters

Параметры для веб-источника знаний.
WorkIQKnowledgeSource

Конфигурация для источника знаний WorkIQ.
WorkIQKnowledgeSourceParameters

Параметры для источника знаний 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

AzureBlobKnowledgeSourceParameters

Тип источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
kind string:

azureBlob

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

AzureBlobKnowledgeSourceParameters

Объект

Параметры для источника знаний Хранилище BLOB-объектов Azure.

Имя Тип Значение по умолчанию Описание
connectionString

string

Строка подключения на основе ключа или формат ResourceId при использовании управляемого удостоверения.
containerName

string

Имя контейнера хранилища BLOB-объектов.
createdResources

object

Ресурсы, созданные источником знаний.
folderPath

string

Необязательный путь к папке в контейнере.
ingestionParameters

KnowledgeSourceIngestionParameters

Объединяет все общие параметры приема.
isADLSGen2

boolean

False

Установите значение true при подключении к учетной записи хранения ADLS 2-го поколения. По умолчанию — false.
queryHints

SearchIndexKnowledgeSourceQueryHints

Стандартные подсказки, которые направляют планирование запросов к полезным фильтрам и усилениям для этого индексно-поддерживаемого источника знаний. Подсказки запроса во время запроса заменяют эти значения по умолчанию как полный объект.

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.
gpt-5.6-sol

Модель Gpt56Sol.
gpt-5.6-terra

Модель Gpt56Terra.
gpt-5.6-luna

Модель Gpt56Luna.

AzureOpenAIVectorizerParameters

Объект

Задает параметры для подключения к ресурсу Azure OpenAI.

Имя Тип Описание
apiKey

string

Ключ API указанного ресурса Azure OpenAI.
authIdentity SearchIndexerDataIdentity:

Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений.
deploymentId

string

Идентификатор развертывания модели Azure OpenAI в указанном ресурсе.
modelName

AzureOpenAIModelName

Имя модели внедрения, развернутой по указанному пути 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.

CorsOptions

Объект

Определяет параметры управления общим доступом к ресурсам между источниками (CORS) для индекса.

Имя Тип Описание
allowedOrigins

string[]

Список источников, из которых коду JavaScript будет предоставлен доступ к вашему индексу. Может содержать список хостов вида {protocol}://{fully-qualified-domain-name}[:{port#}], или один '*' для разрешения всех источников (не рекомендуется).
maxAgeInSeconds

integer (int64)

Продолжительность, в течение которой браузеры должны кэшировать ответы CORS перед проверкой. По умолчанию 5 минут.

EmbeddingColumnMapping

Объект

Отображает столбец SQL в векторное поле для вложения.

Имя Тип Описание
name

string

Имя целевого векторного поля в индексе поиска.
sourceField

string

SQL-столбец используется как вход для генерации встраивания.

EntraAppAuthentication

Объект

Конфигурация для регистрации приложения Microsoft Entra, принадлежащего клиенту, используемого для аутентификации на основе федеративных учетных данных от имени пользователя.

Имя Тип Описание
applicationId

string (uuid)

Идентификатор приложения (клиента) регистрации приложения Entra, принадлежащего клиенту.
federatedCredentialId

string (uuid)

Федеративный идентификатор учетных данных был настроен при регистрации приложения, что позволяло поисковой службе аутентифицироваться как приложение без сохранённого секрета клиента.
tenantId

string (uuid)

Идентификатор арендатора при регистрации в приложении. Это требуется, если регистрация приложения находится в другом арендаторе, не в поисковой службе. Если это опущено, используется арендатор поисковой службы.

ErrorAdditionalInfo

Объект

Дополнительные сведения об ошибке управления ресурсами.

Имя Тип Описание
info

Дополнительные сведения.
type

string

Тип дополнительных сведений.

ErrorDetail

Объект

Подробности ошибки.

Имя Тип Описание
additionalInfo

ErrorAdditionalInfo[]

Дополнительные сведения об ошибке.
code

string

Код ошибки.
details

ErrorDetail[]

Сведения об ошибке.
message

string

Сообщение об ошибке.
target

string

Целевой объект ошибки.

ErrorResponse

Объект

Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).

Имя Тип Описание
error

ErrorDetail

Объект ошибки.

FabricDataAgentKnowledgeSource

Объект

Конфигурация для источника знаний Fabric Data Agent.

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
fabricDataAgentParameters

FabricDataAgentKnowledgeSourceParameters

Параметры источника знаний Fabric Data Agent.
kind string:

fabricDataAgent

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

FabricDataAgentKnowledgeSourceParameters

Объект

Параметры источника знаний Fabric Data Agent.

Имя Тип Описание
dataAgentId

string

Указывает, к какому агенту данных Fabric обратиться.
workspaceId

string

Fabric workspace ID.

FabricOntologyKnowledgeSource

Объект

Источник знаний по конфигурации для Fabric Ontology.

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
fabricOntologyParameters

FabricOntologyKnowledgeSourceParameters

Параметры источника знаний Fabric Ontology.
kind string:

fabricOntology

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

FabricOntologyKnowledgeSourceParameters

Объект

Параметры для источника знаний Fabric Ontology.

Имя Тип Описание
ontologyId

string

ID онтологии для использования из рабочего пространства Fabric.
workspaceId

string

ID Fabric workspace, содержащий онтологию.

FileKnowledgeSource

Объект

Конфигурация для источника знания файлов, поддерживающая прямую загрузку и индексацию файлов.

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
corsOptions

CorsOptions

Опции управления обменом ресурсами между источниками (CORS) для конечных точек файла источника знаний (загрузка, список, обновление, удаление).
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
fileParameters

FileKnowledgeSourceParameters

Параметры для источника знаний Файла.
kind string:

file

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

FileKnowledgeSourceParameters

Объект

Параметры для источника знания файлов.

Имя Тип Описание
createdResources

object

Ресурсы, созданные источником знаний файла.
ingestionParameters

KnowledgeSourceIngestionParameters

Консолидирует все общие настройки ввода для источника знаний Файла, включая режим извлечения контента и опциональную модель вложения.
queryHints

SearchIndexKnowledgeSourceQueryHints

Стандартные подсказки, которые направляют планирование запросов к полезным фильтрам и усилениям для этого индексно-поддерживаемого источника знаний. Подсказки запроса во время запроса заменяют эти значения по умолчанию как полный объект.

FreshnessPolicy

Объект

Настройка для поиска с учётом свежести. При установке новые документы получают повышение рейтинга во время поиска.

Имя Тип Описание
boostingDuration

string

Длительность ISO 8601 для окна повышения свежести (например, 'P90D' в течение 90 дней). Документы с более поздним сроком времени получают повышение рейтинга при поиске.

IndexedOneLakeKnowledgeSource

Объект

Конфигурация для источника знаний OneLake.

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
indexedOneLakeParameters

IndexedOneLakeKnowledgeSourceParameters

Параметры для источника знаний.
kind string:

indexedOneLake

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

IndexedOneLakeKnowledgeSourceParameters

Объект

Параметры для источника знаний OneLake.

Имя Тип Описание
createdResources

object

Ресурсы, созданные источником знаний.
fabricWorkspaceId

string

Идентификатор рабочей области OneLake.
ingestionParameters

KnowledgeSourceIngestionParameters

Объединяет все общие параметры приема.
lakehouseId

string

Указывает, к какому домику у озера OneLake следует получить доступ.
queryHints

SearchIndexKnowledgeSourceQueryHints

Стандартные подсказки, которые направляют планирование запросов к полезным фильтрам и усилениям для этого индексно-поддерживаемого источника знаний. Подсказки запроса во время запроса заменяют эти значения по умолчанию как полный объект.
targetPath

string

Необязательная папка OneLakehouse или ярлык для фильтрации содержимого OneLake.

IndexedSharePointContainerName

Перечисление

Указывает, к каким библиотекам SharePoint необходимо получить доступ.

Значение Описание
defaultSiteLibrary

Индексируйте контент из библиотеки документов сайта по умолчанию.
allSiteLibraries

Индексируйте контент из каждой библиотеки документов на сайте.
useQuery

Используйте запрос для фильтрации контента SharePoint.

IndexedSharePointKnowledgeSource

Объект

Конфигурация для источника знаний SharePoint.

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
indexedSharePointParameters

IndexedSharePointKnowledgeSourceParameters

Параметры для источника знаний.
kind string:

indexedSharePoint

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

IndexedSharePointKnowledgeSourceParameters

Объект

Параметры для источника знаний SharePoint.

Имя Тип Описание
connectionString

string

Строка подключения к SharePoint в формате: SharePointOnlineEndpoint=[URL сайта SharePoint]; ApplicationId=[идентификатор приложения Azure AD]; ApplicationSecret=[секрет клиента приложения Azure AD]; TenantId=[Идентификатор клиента сайта SharePoint]
containerName

IndexedSharePointContainerName

Указывает, к каким библиотекам SharePoint необходимо получить доступ.
createdResources

object

Ресурсы, созданные источником знаний.
ingestionParameters

KnowledgeSourceIngestionParameters

Объединяет все общие параметры приема.
query

string

Необязательный запрос для фильтрации контента SharePoint.
queryHints

SearchIndexKnowledgeSourceQueryHints

Стандартные подсказки, которые направляют планирование запросов к полезным фильтрам и усилениям для этого индексно-поддерживаемого источника знаний. Подсказки запроса во время запроса заменяют эти значения по умолчанию как полный объект.

IndexedSqlKnowledgeSource

Объект

Настройка для индексируемого источника знаний SQL.

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
indexedSqlParameters

IndexedSqlKnowledgeSourceParameters

Параметры для источника знаний SQL.
kind string:

indexedSql

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

IndexedSqlKnowledgeSourceParameters

Объект

Параметры для индексируемого источника знаний SQL.

Имя Тип Описание
connectionString

string

The строка подключения для База данных SQL Azure или Управляемый экземпляр SQL.
contentColumns

ContentColumnMapping[]

Опциональные столбцовые отображения для полей содержания. Если это опущено, все столбцы автоматически обнаружуются.
createdResources

object

Ресурсы, созданные источником знаний.
embeddingColumns

EmbeddingColumnMapping[]

Опциональные столбцовые отображения для вложения векторных полей. Если его опускать, векторные поля не создаются.
highWaterMarkColumnName

string

Опциональное название столбца для обнаружения изменений отметки высокой воды. Если предоставлено, используйте HighWaterMarkChangeDetectionPolicy.
ingestionParameters

KnowledgeSourceIngestionParameters

Консолидирует все общие настройки вложения, включая модель вложения, расписание и идентичность.
queryHints

SearchIndexKnowledgeSourceQueryHints

Стандартные подсказки, которые направляют планирование запросов к полезным фильтрам и усилениям для этого индексно-поддерживаемого источника знаний. Подсказки запроса во время запроса заменяют эти значения по умолчанию как полный объект.
tableOrView

string

Название таблицы или представления для индексирования. Может быть квалифицирован по схеме (например, 'dbo. MyTable').

IndexingSchedule

Объект

Представляет расписание выполнения индексатора.

Имя Тип Описание
interval

string (duration)

Интервал времени между выполнениями индексатора.
startTime

string (date-time)

Время, когда индексатор должен начать работу.

KnowledgeBaseAzureOpenAIModel

Объект

Указывает ресурс Azure OpenAI, используемый для планирования запросов.

Имя Тип Описание
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Azure OpenAI parameters.
kind string:

azureOpenAI

Модель ИИ, которая будет использоваться для планирования запросов.

KnowledgeBaseModelKind

Перечисление

Модель ИИ, которая будет использоваться для планирования запросов.

Значение Описание
azureOpenAI

Используйте модели Azure Open AI для планирования запросов.

KnowledgeSourceAzureOpenAIVectorizer

Объект

Указывает ресурс Azure OpenAI, используемый для векторизации строки запроса.

Имя Тип Описание
azureOpenAIParameters

AzureOpenAIVectorizerParameters

Содержит параметры, относящиеся к векторизации внедрения Azure OpenAI.
kind string:

azureOpenAI

Название метода векторизации, который настраивается для использования с векторным поиском.

KnowledgeSourceIngestionParameters

Объект

Консолидирует все общие параметры приема для источников знаний.

Имя Тип Значение по умолчанию Описание
aiServices

AIServices

Дополнительная конфигурация служб ИИ для обработки контента.
assetStore

AssetStore

Опциональная конфигурация хранилища активов для хранения извлечённых ассетов, таких как изображения.
chatCompletionModel KnowledgeBaseModel:

KnowledgeBaseAzureOpenAIModel

Опциональная модель завершения чата для вербализации изображений или извлечения контекста.
contentExtractionMode enum:
  • minimal
  • standard
minimal

Дополнительный режим извлечения контента. Значение по умолчанию — «минимальный».
disableImageVerbalization

boolean

False

Указывает, следует ли отключить вербализацию изображений. По умолчанию — false.
embeddingModel KnowledgeSourceVectorizer:

KnowledgeSourceAzureOpenAIVectorizer

Необязательная конфигурация векторизатора для векторизации содержимого.
freshnessPolicy

FreshnessPolicy

Опциональная политика свежести для предвзятого поиска в пользу новых документов.
identity SearchIndexerDataIdentity:

Явное удостоверение для использования в этом источнике знаний.
ingestionPermissionOptions

KnowledgeSourceIngestionPermissionOption[]

Необязательный список типов разрешений для приема вместе с содержимым документа. Если указано, будут установлены параметры разрешений индексатора для источника данных.
ingestionSchedule

IndexingSchedule

Необязательное расписание для приема данных.
networkAccessMode

KnowledgeSourceNetworkAccessMode

public

Опциональный режим сетевого доступа для поглощения. Установите «приватный» режим для запуска введения в частной среде выполнения, которая может достигать источников данных и зависимостей через частную сеть. По умолчанию — «публичный». Это среда создания времени и не может быть изменена после создания источника знаний.

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.

KnowledgeSourceNetworkAccessMode

Перечисление

Задаёт режим доступа к сети для погружения источников знаний. По умолчанию — «публичный».

Значение Описание
public

Внедрение работает в стандартной, публично доступной среде исполнения. Это значение по умолчанию.
private

Внедрение осуществляется в закрытой среде выполнения, чтобы достигать источников данных и зависимостей через частную сеть (приватная конечная точка / общая приватная связь).

KnowledgeSourceResultsProcessing

Перечисление

Контролирует, будут ли результаты источника знаний переранжированы.

Значение Описание
rerank

Результаты из этого источника знаний проходят через процесс реранжирования. Это поведение по умолчанию.
none

Результаты этого источника знаний обходят перераспределение и сохраняют свой базовый порядок.

McpServerAuthenticationKind

Перечисление

Такой тип аутентификации для MCP-сервера.

Значение Описание
foundryConnection

Аутентификация с помощью соединения Azure AI Foundry.
storedHeaders

Аутентификация с использованием сохранённых HTTP-заголовков.

McpServerAutoOutputParsing

Объект

Автоматически определите формат выхода и соответствующим образом разберите.

Имя Тип Описание
kind string:

auto

Тот тип парсинга вывода, который нужно применять.

McpServerFoundryConnectionAuthentication

Объект

Аутентификация с использованием соединения Azure AI Foundry.

Имя Тип Описание
foundryConnectionParameters

McpServerFoundryConnectionParameters

Параметры аутентификации соединения Foundry.
kind string:

foundryConnection

Какой тип аутентификации стоит использовать.

McpServerFoundryConnectionParameters

Объект

Параметры аутентификации соединения Foundry.

Имя Тип Описание
connectionId

string

Идентификатор соединения Azure AI Foundry.

McpServerJsonOutputParsing

Объект

Парсировать выход как JSON-документ с использованием настроенных параметров JSON.

Имя Тип Описание
jsonParameters

McpServerOutputParsingJsonParameters

Параметры для разбора JSON на выходе. Обязательно, когда добрый — это «json».
kind string:

json

Тот тип парсинга вывода, который нужно применять.

McpServerKnowledgeSource

Объект

Конфигурация для источника знаний, поддерживаемого сервером MCP (Model Context Protocol).

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
kind string:

mcpServer

Тип источника знаний.
mcpServerParameters

McpServerKnowledgeSourceParameters

Параметры источника знаний сервера MCP.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

McpServerKnowledgeSourceParameters

Объект

Параметры для источника знаний на сервере MCP.

Имя Тип Описание
authentication McpServerAuthentication:

Конфигурация аутентификации для MCP-сервера.
serverURL

string

URL конечной точки сервера MCP.
tools

McpServerTool[]

Список инструментов для вызова на сервере MCP.

McpServerNoneOutputParsing

Объект

Воспринимайте выход как один блок без какого-либо разбора.

Имя Тип Описание
kind string:

none

Тот тип парсинга вывода, который нужно применять.

McpServerOutputParsingJsonParameters

Объект

Параметры для разбора JSON на выходе.

Имя Тип Описание
documentsPath

string

Путь JSON к массиву документов в выходе инструмента.
includeContext

boolean

Стоит ли включать окружающий контекст из JSON-выхода вместе с извлеченными документами.

McpServerOutputParsingKind

Перечисление

Такой вид выводного парсинга для MCP-серверного инструмента.

Значение Описание
auto

Автоматически определите формат выхода и соответствующим образом разберите.
json

Парсировать выход как JSON-документ с использованием настроенных параметров JSON.
split

Разделите выход на страницы, используя заданные параметры разделения.
none

Воспринимайте выход как один блок без какого-либо разбора.

McpServerOutputParsingSplitParameters

Объект

Параметры для разбитого выходного разбора.

Имя Тип Описание
defaultLanguageCode

SplitSkillLanguage

Значение, указывающее, какой языковой код следует использовать. По умолчанию — en.
maximumPageLength

integer (int32)

Максимальное количество символов на странице.
maximumPagesToTake

integer (int32)

Максимальное количество страниц, которые нужно взять из результата.
pageOverlapLength

integer (int32)

Количество символов, которые пересекаются между страницами.
textSplitMode

TextSplitMode

Режим разделения текста для использования.

McpServerSplitOutputParsing

Объект

Разделите выход на страницы, используя заданные параметры разделения.

Имя Тип Описание
kind string:

split

Тот тип парсинга вывода, который нужно применять.
splitParameters

McpServerOutputParsingSplitParameters

Параметры для разбитого выходного разбора.

McpServerStoredHeadersAuthentication

Объект

Аутентификация с использованием сохранённых HTTP-заголовков.

Имя Тип Описание
kind string:

storedHeaders

Какой тип аутентификации стоит использовать.
storedHeadersParameters

McpServerStoredHeadersParameters

Параметры для аутентификации хранимых заголовков.

McpServerStoredHeadersParameters

Объект

Параметры для аутентификации хранимых заголовков.

Имя Тип Описание
headers

object

Хранящиеся HTTP-заголовки для включения в запросы MCP сервера.

McpServerTool

Объект

Представляет собой единый инструмент внутри источника знаний сервера MCP.

Имя Тип Описание
maxOutputTokens

integer (int32)

Опциональное ограничение токена после разбора для вывода этого инструмента. При указании должно быть больше 0.
name

string

Имя инструмента MCP, который нужно вызвать.
outputParsing McpServerOutputParsing:

Опциональная конфигурация для анализа вывода инструмента.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли проанализированные результаты этого инструмента переранжированы. По умолчанию переходит на «перерейтинг», если не указано.

RemoteSharePointKnowledgeSource

Объект

Конфигурация для удаленного источника знаний SharePoint.

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
kind string:

remoteSharePoint

Тип источника знаний.
name

string

Название источника знаний.
remoteSharePointParameters

RemoteSharePointKnowledgeSourceParameters

Параметры для удалённого источника знаний в SharePoint.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.

RemoteSharePointKnowledgeSourceParameters

Объект

Параметры для удаленного источника знаний SharePoint.

Имя Тип Описание
containerTypeId

string

Идентификатор контейнера для подключения к SharePoint Embedded. Если значение равно null, будет использоваться SharePoint Online.
filterExpression

string

Выражение языка запросов по ключевым словам (KQL) с запрашиваемыми свойствами и атрибутами SharePoint для определения области извлечения перед выполнением запроса.
resourceMetadata

string[]

Список полей метаданных, которые должны быть возвращены для каждого элемента в ответе. В этот список могут быть включены только извлекаемые свойства метаданных. По умолчанию метаданные не возвращаются.

SearchIndexerDataNoneIdentity

Объект

Очищает свойство удостоверения источника данных.

Имя Тип Описание
@odata.type string:

#Microsoft.Azure.Search.DataNoneIdentity

Фрагмент URI, указывающий тип удостоверения.

SearchIndexerDataUserAssignedIdentity

Объект

Указывает удостоверение для используемого источника данных.

Имя Тип Описание
@odata.type string:

#Microsoft.Azure.Search.DataUserAssignedIdentity

Фрагмент 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

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
kind string:

searchIndex

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.
searchIndexParameters

SearchIndexKnowledgeSourceParameters

Параметры для источника знаний.

SearchIndexKnowledgeSourceBoostKind

Перечисление

Это тип подсказки для поискового индекса информации.

Значение Описание
fieldValue

Улучшайте документы на основе значения поля.
multiWordExpression

Улучшайте документы на основе многословного выражения.

SearchIndexKnowledgeSourceFieldValueBoost

Объект

Подсказка, которая улучшает документы на основе значения поля.

Имя Тип Описание
boost

number (double)

Множитель оценки по документу. Должно быть положительным числом, не равным 1,0.
boostInstructions

string

Инструкции на естественном языке, объясняющие, когда и как применять усиление.
field

string

minLength: 1

Название поля индекса поиска.
fieldValues

string[]

Репрезентативные ценности для этой области.
kind string:

fieldValue

Такого рода подсказка для усиления.

SearchIndexKnowledgeSourceFilterHint

Объект

Подсказка, определяющая поле и репрезентативные значения, которые планировщик запросов может использовать при построении фильтра.

Имя Тип Описание
field

string

minLength: 1

Название фильтруемого индексного поля поиска.
fieldValues

string[]

Репрезентативные ценности для этой области.
filterInstructions

string

Инструкции на естественном языке, объясняющие, когда и как фильтровать на поле.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Объект

Подсказка, которая улучшает работу документов на основе многословного выражения.

Имя Тип Описание
boost

number (double)

Множитель оценки по документу. Должно быть положительным числом, не равным 1,0.
boostInstructions

string

Инструкции на естественном языке, объясняющие, когда и как применять усиление.
fieldValues

string[]

Репрезентативные ценности для усиления.
kind string:

multiWordExpression

Такого рода подсказка для усиления.

SearchIndexKnowledgeSourceParameters

Объект

Параметры для источника знаний по индексу поиска.

Имя Тип Описание
baseFilter

string

Стандартное условие фильтра, применяемое к индексу при получении информации (например, «State eq VA»). Можно переопределить во время запроса с помощью параметров выполнения источника знаний.
queryHints

SearchIndexKnowledgeSourceQueryHints

Стандартные подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям для этого источника знаний по индексу поиска. Подсказки запроса во время запроса заменяют эти значения по умолчанию как полный объект.
searchFields

SearchIndexFieldReference[]

Используется для ограничения того, какие поля следует искать в индексе поиска.
searchIndexName

string

Имя индекса поиска.
semanticConfigurationName

string

Используется для указания другой семантической конфигурации в целевом индексе поиска, отличной от конфигурации по умолчанию.
sourceDataFields

SearchIndexFieldReference[]

Используется для запроса дополнительных полей для ссылаемых исходных данных.

SearchIndexKnowledgeSourceQueryHints

Объект

Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям для поискового индекса информации.

Имя Тип Описание
boosts SearchIndexKnowledgeSourceBoost[]:

Подсказки, которые определяют условия, которые планировщик запросов может использовать для влияния на рейтинг документа.
filters

SearchIndexKnowledgeSourceFilterHint[]

Подсказки фильтра, которые определяют поля и репрезентативные значения, которые планировщик запросов может использовать при построении фильтров.

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 может быть https://my-keyvault-name.vault.azure.net.

SplitSkillLanguage

Перечисление

Коды языков, поддерживаемые SplitSkill для ввода текста.

Значение Описание
am

Амхарский
bs

Боснийский
cs

Чешский
da

Датский
de

German
en

English
es

испанский
et

Эстонский
fi

Финский
fr

French
he

Иврит
hi

Хинди
hr

Croatian
hu

Hungarian
id

Indonesian
is

Исландский
it

Italian
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

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
kind string:

web

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.
webParameters

WebKnowledgeSourceParameters

Параметры для веб-источника знаний.

WebKnowledgeSourceDomain

Объект

Конфигурация для домена источника знаний в Интернете.

Имя Тип Описание
address

string

Адрес домена.
includeSubpages

boolean

Следует ли включать подстраницы из этого домена.

WebKnowledgeSourceDomains

Объект

Конфигурация разрешения/блокировки домена для веб-источника знаний.

Имя Тип Описание
allowedDomains

WebKnowledgeSourceDomain[]

Домены, которые разрешены для веб-результатов.
blockedDomains

WebKnowledgeSourceDomain[]

Домены, заблокированные в веб-результатах.

WebKnowledgeSourceParameters

Объект

Параметры для веб-источника знаний.

Имя Тип Описание
count

integer (int32)

По умолчанию количество веб-результатов, которые возвращаются. Можно переопределить во время запроса с помощью параметров выполнения источника знаний.
domains

WebKnowledgeSourceDomains

Конфигурация разрешения/блокировки домена для веб-результатов.
freshness

string

Стандартный фильтр свежести для веб-результатов. Можно переопределить во время запроса с помощью параметров выполнения источника знаний.
language

string

Стандартный язык для веб-результатов. Можно переопределить во время запроса с помощью параметров выполнения источника знаний.
market

string

Рынок по умолчанию для веб-результатов. Можно переопределить во время запроса с помощью параметров выполнения источника знаний.

WorkIQKnowledgeSource

Объект

Конфигурация для источника знаний WorkIQ.

Имя Тип Описание
@odata.etag

string

ETag источника знаний.
description

string

Необязательное пользовательское описание.
encryptionKey

SearchResourceEncryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
kind string:

workIQ

Тип источника знаний.
name

string

Название источника знаний.
resultsProcessing

KnowledgeSourceResultsProcessing

Контролирует, будут ли результаты из этого источника знаний переранжированы перед включением в итоговый набор результатов. По умолчанию переходит на «перерейтинг», если не указано.
workIQParameters

WorkIQKnowledgeSourceParameters

Параметры источника знаний WorkIQ, включая клиентскую конфигурацию приложения Entra, используемую для аутентификации от имени пользователя.

WorkIQKnowledgeSourceParameters

Объект

Параметры для источника знаний WorkIQ.

Имя Тип Описание
entraAppAuthentication

EntraAppAuthentication

Регистрационная конфигурация приложения Microsoft Entra, принадлежащая клиенту, используемая для аутентификации в API Work IQ. Клиент регистрирует приложение Entra, принадлежащее арендатору, предоставляет ему разрешение WorkIQAgent.Ask delegated permission и настраивает федеративную учетную запись, чтобы Поиск с использованием ИИ Azure мог аутентифицироваться как это приложение без сохранения секрета клиента.