Knowledge Sources - Create Or Update

Служба:: Search Service

Версия API:: 2026-04-01

Создает новый источник знаний или обновляет источник знаний, если он уже существует.

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

Параметры URI

Имя	В	Обязательно	Тип	Описание
endpoint	path	True	string (uri)	URL-адрес конечной точки службы поиска.
sourceName	path	True	string	Название источника знаний.
api-version	query	True	string minLength: 1	Версия API, используемая для данной операции.

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

Имя	Обязательно	Тип	Описание
Accept		Accept	Заголовок Accept.
If-Match		string	Определяет условие If-Match. Операция будет выполнена только в том случае, если ETag на сервере соответствует этому значению.
If-None-Match		string	Определяет условие If-None-Match. Операция будет выполнена только в том случае, если ETag на сервере не соответствует этому значению.
Prefer	True	Prefer	Для запросов HTTP PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении.
x-ms-client-request-id		string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

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

Имя	Описание
AzureBlobKnowledgeSource	Конфигурация для источника знаний Хранилище BLOB-объектов Azure.
IndexedOneLakeKnowledgeSource	Конфигурация для источника знаний OneLake.
SearchIndexKnowledgeSource	Источник знаний, нацеленный на индекс поиска.
WebKnowledgeSource	Источник знаний с таргетингом на веб-результаты.

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 г.

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 г.

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 г.

WebKnowledgeSource

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

Имя	Обязательно	Тип	Описание
kind	True	string: web	Тип источника знаний.
name	True	string	Название источника знаний.
@odata.etag		string	ETag источника знаний.
description		string	Необязательное пользовательское описание.
encryptionKey		SearchResourceEncryptionKey	Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
webParameters		WebKnowledgeSourceParameters	Параметры для веб-источника знаний.

Ответы

Имя	Тип	Описание
200 OK	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Запрос выполнен успешно.
201 Created	KnowledgeSource: AzureBlobKnowledgeSource IndexedOneLakeKnowledgeSource SearchIndexKnowledgeSource WebKnowledgeSource	Запрос успешно выполнен, и в результате был создан новый ресурс.
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

Примеры

SearchServiceCreateOrUpdateKnowledgeSource

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

SearchServiceCreateOrUpdateKnowledgeSourceWeb

SearchServiceCreateOrUpdateKnowledgeSource

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

HTTP

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "searchIndexParameters": {
    "searchIndexName": "example-index",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ],
    "semanticConfigurationName": "testconfig"
  },
  "name": "ks-example-index",
  "description": "Description of the knowledge source.",
  "kind": "searchIndex",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

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

Код состояния:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "example-index",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

Код состояния:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "searchIndex",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "searchIndexParameters": {
    "searchIndexName": "example-index",
    "semanticConfigurationName": "testconfig",
    "sourceDataFields": [
      {
        "name": "description"
      },
      {
        "name": "category"
      }
    ],
    "searchFields": [
      {
        "name": "*"
      }
    ]
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceAzureBlob

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

HTTP

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-example-index",
  "description": "Description of the knowledge source.",
  "kind": "azureBlob",
  "@odata.etag": "0x1234568AE7E58A1",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  }
}

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

Код состояния:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "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-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-example-index-datasource",
      "indexer": "ks-example-index-indexer",
      "skillset": "ks-example-index-skillset",
      "index": "ks-example-index-index"
    }
  }
}

Код состояния:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "isADLSGen2": false,
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "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-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    },
    "createdResources": {
      "dataSourceConnection": "ks-example-index-datasource",
      "indexer": "ks-example-index-indexer",
      "skillset": "ks-example-index-skillset",
      "index": "ks-example-index-index"
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceIndexedOneLake

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

HTTP

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





{
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "identity": {
        "userAssignedIdentity": "/my/userassigned/id",
        "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity"
      },
      "embeddingModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "model",
          "apiKey": "api-key",
          "modelName": "text-embedding-3-large"
        },
        "kind": "azureOpenAI"
      },
      "chatCompletionModel": {
        "azureOpenAIParameters": {
          "resourceUri": "https://test-sample.openai.azure.com/",
          "deploymentId": "myDeployment",
          "apiKey": "api-key",
          "modelName": "gpt-5-nano"
        },
        "kind": "azureOpenAI"
      },
      "disableImageVerbalization": false,
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2025-01-07T19:30:00Z"
      },
      "contentExtractionMode": "standard",
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  },
  "name": "ks-example-index",
  "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>"
    }
  }
}

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

Код состояния:: 200

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "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-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

Код состояния:: 201

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-example-index",
  "kind": "indexedOneLake",
  "description": "Description of the OneLake knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "indexedOneLakeParameters": {
    "fabricWorkspaceId": "ResourceId=fakeWorkspaceId",
    "lakehouseId": "fakeLakehouseId",
    "targetPath": "testfolder",
    "ingestionParameters": {
      "disableImageVerbalization": false,
      "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-5-nano"
        }
      },
      "ingestionSchedule": {
        "interval": "P1D",
        "startTime": "2024-06-06T00:01:50.265Z"
      },
      "aiServices": {
        "uri": "https://my-ai-service.azure.com/",
        "apiKey": "api-key"
      }
    }
  }
}

SearchServiceCreateOrUpdateKnowledgeSourceWeb

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

HTTP

PUT https://exampleservice.search.windows.net/knowledgesources('ks-example-index')?api-version=2026-04-01





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

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

Код состояния:: 200

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

Код состояния:: 201

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

Определения

Имя	Описание
Accept	Заголовок Accept.
AIServices	Параметры для сервисов ИИ.
AzureBlobKnowledgeSource	Конфигурация для источника знаний Хранилище BLOB-объектов Azure.
AzureBlobKnowledgeSourceParameters	Параметры для источника знаний Хранилище BLOB-объектов Azure.
AzureOpenAIModelName	Имя модели Azure Open AI, которое будет вызываться.
AzureOpenAIVectorizerParameters	Задает параметры для подключения к ресурсу Azure OpenAI.
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
IndexedOneLakeKnowledgeSource	Конфигурация для источника знаний OneLake.
IndexedOneLakeKnowledgeSourceParameters	Параметры для источника знаний OneLake.
IndexingSchedule	Представляет расписание выполнения индексатора.
KnowledgeBaseAzureOpenAIModel	Указывает ресурс Azure OpenAI, используемый для планирования запросов.
KnowledgeBaseModelKind	Модель ИИ, которая будет использоваться для планирования запросов.
KnowledgeSourceAzureOpenAIVectorizer	Указывает ресурс Azure OpenAI, используемый для векторизации строки запроса.
KnowledgeSourceIngestionParameters	Консолидирует все общие параметры приема для источников знаний.
KnowledgeSourceKind	Вид источника знаний.
Prefer	Для запросов HTTP PUT указывает службе вернуть созданный или обновленный ресурс при успешном выполнении.
SearchIndexerDataNoneIdentity	Очищает свойство удостоверения источника данных.
SearchIndexerDataUserAssignedIdentity	Указывает удостоверение для используемого источника данных.
SearchIndexFieldReference	Поле для поискового индекса.
SearchIndexKnowledgeSource	Источник знаний, нацеленный на индекс поиска.
SearchIndexKnowledgeSourceParameters	Параметры для источника знаний по индексу поиска.
SearchResourceEncryptionKey	Ключ шифрования, управляемый клиентом, в Azure Key Vault. Ключи, которые вы создаете и которыми управляете, можно использовать для шифрования или расшифровки хранимых данных, таких как индексы и сопоставления синонимов.
VectorSearchVectorizerKind	Метод векторизации, который будет использоваться во время запроса.
WebKnowledgeSource	Источник знаний с таргетингом на веб-результаты.
WebKnowledgeSourceDomain	Конфигурация для домена источника знаний в Интернете.
WebKnowledgeSourceDomains	Конфигурация разрешения/блокировки домена для веб-источника знаний.
WebKnowledgeSourceParameters	Параметры для веб-источника знаний.

Accept

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

Заголовок Accept.

Значение	Описание
application/json;odata.metadata=minimal

AIServices

Объект

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

Имя	Тип	Описание
apiKey	string	Ключ API для доступа к Сервисам ИИ.
uri	string (uri)	URI конечной точки служб ИИ.

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	Название источника знаний.

AzureBlobKnowledgeSourceParameters

Объект

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

Имя	Тип	Default value	Описание
connectionString	string		Строка подключения на основе ключа или формат ResourceId при использовании управляемого удостоверения.
containerName	string		Имя контейнера хранилища BLOB-объектов.
createdResources	object		Ресурсы, созданные источником знаний.
folderPath	string		Необязательный путь к папке в контейнере.
ingestionParameters	KnowledgeSourceIngestionParameters		Объединяет все общие параметры приема.
isADLSGen2	boolean	False	Установите значение true при подключении к учетной записи хранения ADLS 2-го поколения. По умолчанию — false.

AzureOpenAIModelName

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

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

Значение	Описание
text-embedding-ada-002	TextEmbeddingAda002 модель.
text-embedding-3-large	TextEmbedding3Большая модель.
text-embedding-3-small	TextEmbedding3Малая модель.
gpt-5-mini	Модель Gpt5Mini.
gpt-5-nano	Модель Gpt5Nano.
gpt-5.4-mini	Модель GPT54Mini.
gpt-5.4-nano	Модель Gpt54Nano.

AzureOpenAIVectorizerParameters

Объект

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

Имя	Тип	Описание
apiKey	string	Ключ API указанного ресурса Azure OpenAI.
authIdentity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений.
deploymentId	string	Идентификатор развертывания модели Azure OpenAI в указанном ресурсе.
modelName	AzureOpenAIModelName	Имя модели внедрения, развернутой по указанному пути deploymentId.
resourceUri	string (uri)	URI ресурса ресурса Azure OpenAI.

ErrorAdditionalInfo

Объект

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

Имя	Тип	Описание
info		Дополнительные сведения.
type	string	Дополнительный тип сведений.

ErrorDetail

Объект

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

Имя	Тип	Описание
additionalInfo	ErrorAdditionalInfo[]	Дополнительные сведения об ошибке.
code	string	Код ошибки.
details	ErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Целевой объект ошибки.

ErrorResponse

Объект

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

Имя	Тип	Описание
error	ErrorDetail	Объект ошибки.

IndexedOneLakeKnowledgeSource

Объект

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

Имя	Тип	Описание
@odata.etag	string	ETag источника знаний.
description	string	Необязательное пользовательское описание.
encryptionKey	SearchResourceEncryptionKey	Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для дополнительного уровня шифрования в состоянии покоя для определения вашего источника знаний, когда вы хотите полную уверенность, что никто, даже Microsoft, не сможет их расшифровать. После того как вы зашифровали определение источника знаний, оно всегда останется зашифрованным. Служба поиска будет игнорировать попытки установить для этого свойства значение null. Вы можете изменить это свойство по мере необходимости, если хотите повернуть ключ шифрования; Определение источника знаний не будет изменено. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
indexedOneLakeParameters	IndexedOneLakeKnowledgeSourceParameters	Параметры для источника знаний.
kind	string: indexedOneLake	Тип источника знаний.
name	string	Название источника знаний.

IndexedOneLakeKnowledgeSourceParameters

Объект

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

Имя	Тип	Описание
createdResources	object	Ресурсы, созданные источником знаний.
fabricWorkspaceId	string	Идентификатор рабочей области OneLake.
ingestionParameters	KnowledgeSourceIngestionParameters	Объединяет все общие параметры приема.
lakehouseId	string	Указывает, к какому домику у озера OneLake следует получить доступ.
targetPath	string	Необязательная папка OneLakehouse или ярлык для фильтрации содержимого OneLake.

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

Объект

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

Имя	Тип	Default value	Описание
aiServices	AIServices		Дополнительная конфигурация служб ИИ для обработки контента.
chatCompletionModel	KnowledgeBaseModel: KnowledgeBaseAzureOpenAIModel		Опциональная модель завершения чата для вербализации изображений или извлечения контекста.
contentExtractionMode	enum: minimal standard	minimal	Дополнительный режим извлечения контента. Значение по умолчанию — «минимальный».
disableImageVerbalization	boolean	False	Указывает, следует ли отключить вербализацию изображений. По умолчанию — false.
embeddingModel	KnowledgeSourceVectorizer: KnowledgeSourceAzureOpenAIVectorizer		Необязательная конфигурация векторизатора для векторизации содержимого.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity		Явное удостоверение для использования в этом источнике знаний.
ingestionSchedule	IndexingSchedule		Необязательное расписание для приема данных.

KnowledgeSourceKind

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

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

Значение	Описание
searchIndex	Источник знаний, который считывает данные из индекса поиска.
azureBlob	Источник знаний, который считывает и принимает данные из хранилища BLOB-объектов Azure в индекс поиска.
indexedOneLake	Источник знаний, который читает данные с индексируемого OneLake.
web	Источник знаний, который читает данные из интернета.

Prefer

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

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

Значение	Описание
return=representation

SearchIndexerDataNoneIdentity

Объект

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

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.DataNoneIdentity	Фрагмент URI, указывающий тип удостоверения.

SearchIndexerDataUserAssignedIdentity

Объект

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

Имя	Тип	Описание
@odata.type	string: #Microsoft.Azure.Search.DataUserAssignedIdentity	Фрагмент URI, указывающий тип удостоверения.
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	Название источника знаний.
searchIndexParameters	SearchIndexKnowledgeSourceParameters	Параметры для источника знаний.

SearchIndexKnowledgeSourceParameters

Объект

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

Имя	Тип	Описание
searchFields	SearchIndexFieldReference[]	Используется для ограничения того, какие поля следует искать в индексе поиска.
searchIndexName	string	Имя индекса поиска.
semanticConfigurationName	string	Используется для указания другой семантической конфигурации в целевом индексе поиска, отличной от конфигурации по умолчанию.
sourceDataFields	SearchIndexFieldReference[]	Используется для запроса дополнительных полей для ссылаемых исходных данных.

SearchResourceEncryptionKey

Объект

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

Имя	Тип	Описание
accessCredentials.applicationId	string	Идентификатор приложения AAD, которому было предоставлено необходимые разрешения на доступ к Azure Key Vault, который будет использоваться при шифровании неактивных данных. Идентификатор приложения не следует путать с идентификатором объекта для приложения AAD.
accessCredentials.applicationSecret	string	Ключ проверки подлинности указанного приложения AAD.
identity	SearchIndexerDataIdentity: SearchIndexerDataNoneIdentity SearchIndexerDataUserAssignedIdentity	Явное управляемое удостоверение, используемое для этого ключа шифрования. Если не указано, а свойство учетных данных доступа равно NULL, используется управляемое удостоверение, назначаемое системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если задано значение none, то значение этого свойства очищается.
keyVaultKeyName	string	Имя ключа Azure Key Vault, используемого для шифрования неактивных данных.
keyVaultKeyVersion	string	Версия ключа Azure Key Vault, используемая для шифрования неактивных данных.
keyVaultUri	string	Универсальный код ресурса (URI) Хранилища ключей Azure, который также называется DNS-именем, который содержит ключ, используемый для шифрования неактивных данных. Пример URI может быть `https://my-keyvault-name.vault.azure.net`.

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

WebKnowledgeSourceDomain

Объект

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

Имя	Тип	Описание
address	string	Адрес домена.
includeSubpages	boolean	Следует ли включать подстраницы из этого домена.

WebKnowledgeSourceDomains

Объект

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

Имя	Тип	Описание
allowedDomains	WebKnowledgeSourceDomain[]	Домены, которые разрешены для веб-результатов.
blockedDomains	WebKnowledgeSourceDomain[]	Домены, заблокированные в веб-результатах.

WebKnowledgeSourceParameters

Объект

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

Имя	Тип	Описание
domains	WebKnowledgeSourceDomains	Конфигурация разрешения/блокировки домена для веб-результатов.