Knowledge Sources - Get

Извлекает определение источника знаний.

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

Параметры URI

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

string

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

sourceName
path True

string

Имя источника знаний для извлечения.

api-version
query True

string

Версия API клиента.

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

Имя Обязательно Тип Описание
x-ms-client-request-id

string (uuid)

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

Ответы

Имя Тип Описание
200 OK KnowledgeSource:
Other Status Codes

ErrorResponse

Ответ на ошибку.

Примеры

SearchServiceGetKnowledgeSource
SearchServiceGetKnowledgeSourceAzureBlob

SearchServiceGetKnowledgeSource

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

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

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

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

SearchServiceGetKnowledgeSourceAzureBlob

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

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

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

{
  "@odata.etag": "0x1234568AE7E58A1",
  "name": "ks-preview-test",
  "kind": "azureBlob",
  "description": "Description of the knowledge source.",
  "encryptionKey": {
    "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault",
    "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString",
    "keyVaultUri": "https://myKeyVault.vault.azure.net",
    "accessCredentials": {
      "applicationId": "00000000-0000-0000-0000-000000000000",
      "applicationSecret": "<applicationSecret>"
    }
  },
  "azureBlobParameters": {
    "connectionString": "DefaultEndpointsProtocol=https;AccountName=myAccountName;AccountKey=myAccountKey;EndpointSuffix=core.windows.net ",
    "containerName": "test-container",
    "folderPath": "test-path",
    "identity": {
      "@odata.type": "#Microsoft.Azure.Search.DataUserAssignedIdentity",
      "userAssignedIdentity": "/my/userassigned/id"
    },
    "embeddingModel": {
      "name": "openai",
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com",
        "deploymentId": "model",
        "apiKey": "<redacted>",
        "modelName": "text-embedding-3-large"
      }
    },
    "chatCompletionModel": {
      "kind": "azureOpenAI",
      "azureOpenAIParameters": {
        "resourceUri": "https://test-sample.openai.azure.com",
        "deploymentId": "myDeployment",
        "apiKey": "<redacted>",
        "modelName": "gpt-4o-mini"
      }
    },
    "ingestionSchedule": {
      "interval": "P1D",
      "startTime": "2024-06-06T00:01:50.265Z"
    }
  }
}

Определения

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

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

AIServicesVisionParameters

Указывает параметры Vision служб ИИ для векторизации изображения или текста запроса.

AIServicesVisionVectorizer

Указывает параметры Vision служб ИИ для векторизации изображения или текста запроса.

AMLParameters

Задает свойства для подключения к векторизатору AML.

AMLVectorizer

Указывает конечную точку Машинного обучения Azure, развернутую с помощью каталога моделей Azure AI Foundry для создания векторного внедрения строки запроса.

AzureActiveDirectoryApplicationCredentials

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

AzureBlobKnowledgeSource

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

AzureBlobKnowledgeSourceParameters

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

AzureOpenAIEmbeddingSkill

Позволяет создать векторное встраивание для заданного текстового ввода с помощью ресурса Azure OpenAI.

AzureOpenAIModelName

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

AzureOpenAIParameters

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

AzureOpenAIVectorizer

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

ErrorAdditionalInfo

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

ErrorDetail

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

ErrorResponse

Ответ на ошибку

IndexingSchedule

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

InputFieldMappingEntry

Сопоставление полей ввода для навыка.

KnowledgeAgentAzureOpenAIModel

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

KnowledgeAgentModelKind

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

KnowledgeSourceKind

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

OutputFieldMappingEntry

Сопоставление выходных полей для навыка.

SearchIndexerDataNoneIdentity

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

SearchIndexerDataUserAssignedIdentity

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

SearchIndexKnowledgeSource

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

SearchIndexKnowledgeSourceParameters

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

SearchResourceEncryptionKey

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

VectorSearchVectorizerKind

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

WebApiParameters

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

WebApiVectorizer

Указывает определяемый пользователем векторизатор для создания векторного встраивания строки запроса. Интеграция внешнего векторизатора достигается с помощью пользовательского интерфейса Web API набора навыков.

AIFoundryModelCatalogName

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

Значение Описание
OpenAI-CLIP-Image-Text-Embeddings-vit-base-patch32
OpenAI-CLIP-Image-Text-Embeddings-ViT-Large-Patch14-336
Facebook-DinoV2-Image-Embeddings-ViT-Base
Facebook-DinoV2-Image-Embeddings-ViT-Giant
Cohere-embed-v3-english
Cohere-embed-v3-multilingual
Cohere-embed-v4

Модель Cohere Embed v4 для создания встраиваемых объектов как из текста, так и из изображений.

AIServicesVisionParameters

Указывает параметры Vision служб ИИ для векторизации изображения или текста запроса.

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

string

Ключ API указанного ресурса AI Services.

authIdentity SearchIndexerDataIdentity:

Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений. Если указан authResourceId, но он не указан, используется управляемое удостоверение, назначенное системой. При обновлении индекса, если идентификатор не указан, значение остается неизменным. Если установлено значение "none", значение этого свойства очищается.

modelVersion

string

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

resourceUri

string (uri)

URI ресурса AI Services.

AIServicesVisionVectorizer

Указывает параметры Vision служб ИИ для векторизации изображения или текста запроса.

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

AIServicesVisionParameters

Содержит параметры, специфичные для векторизации встраивания AI Services Vision.

kind string:

aiServicesVision

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

name

string

Имя, которое будет ассоциироваться с этим конкретным методом векторизации.

AMLParameters

Задает свойства для подключения к векторизатору AML.

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

string

(Требуется для аутентификации ключа) Ключ для услуги AML.

modelName

AIFoundryModelCatalogName

Имя модели внедрения из каталога Azure AI Foundry, развернутой в предоставленной конечной точке.

region

string

(Необязательно для аутентификации по маркерам). Регион, в котором развернута служба AML.

resourceId

string

(Требуется для аутентификации по токенам). Идентификатор ресурса Azure Resource Manager службы AML. Он должен быть в формате subscriptions/{guid}/resourceGroups/{resource-group-name}/Microsoft.MachineLearningServices/workspaces/{workspace-name}/services/{service_name}.

timeout

string (duration)

(Дополнительный) Если указано, указывает время ожидания для HTTP-клиента, выполняющего вызов API.

uri

string (uri)

(Требуется без аутентификации или аутентификации по ключу) URI скоринга службы AML, в которую будут отправлены полезные данные JSON. Разрешена только схема URI https.

AMLVectorizer

Указывает конечную точку Машинного обучения Azure, развернутую с помощью каталога моделей Azure AI Foundry для создания векторного внедрения строки запроса.

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

AMLParameters

Задает свойства векторизатора AML.

kind string:

aml

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

name

string

Имя, которое будет ассоциироваться с этим конкретным методом векторизации.

AzureActiveDirectoryApplicationCredentials

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

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

string

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

applicationSecret

string

Ключ аутентификации указанного приложения AAD.

AzureBlobKnowledgeSource

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

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

string

ETag агента.

azureBlobParameters

AzureBlobKnowledgeSourceParameters

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

description

string

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

encryptionKey

SearchResourceEncryptionKey

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

kind string:

azureBlob

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

name

string

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

AzureBlobKnowledgeSourceParameters

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

Имя Тип Описание
chatCompletionModel KnowledgeAgentModel:

KnowledgeAgentAzureOpenAIModel

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

connectionString

string

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

containerName

string

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

createdResources

object

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

disableImageVerbalization

boolean

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

embeddingModel VectorSearchVectorizer:

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

folderPath

string

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

identity SearchIndexerDataIdentity:

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

ingestionSchedule

IndexingSchedule

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

AzureOpenAIEmbeddingSkill

Позволяет создать векторное встраивание для заданного текстового ввода с помощью ресурса Azure OpenAI.

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

#Microsoft.Skills.Text.AzureOpenAIEmbeddingSkill

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

apiKey

string

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

authIdentity SearchIndexerDataIdentity:

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

context

string

Представляет уровень, на котором выполняются операции, например корневой каталог документа или содержимое документа (например, /document или /document/content). Значение по умолчанию — /document.

deploymentId

string

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

description

string

Описание навыка, которое описывает входы, выходы и использование навыка.

dimensions

integer (int32)

Число измерений, в которых должны быть внедренные выходные данные. Поддерживается только в моделях text-embedding-3 и более поздних версий.

inputs

InputFieldMappingEntry[]

Входными данными навыков может быть столбец в исходном наборе данных или выходные данные вышестоящего навыка.

modelName

AzureOpenAIModelName

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

name

string

Название навыка, которое однозначно идентифицирует его в наборе навыков. Навыку, имя которого не определено, будет присвоено по умолчанию в виде индекса из 1 в массиве навыков, начинающегося с префикса '#'.

outputs

OutputFieldMappingEntry[]

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

resourceUri

string (uri)

URI ресурса Azure OpenAI.

AzureOpenAIModelName

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

Значение Описание
text-embedding-ada-002
text-embedding-3-large
text-embedding-3-small
gpt-4o
gpt-4o-mini
gpt-4.1
gpt-4.1-mini
gpt-4.1-nano

AzureOpenAIParameters

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

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

string

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

authIdentity SearchIndexerDataIdentity:

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

deploymentId

string

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

modelName

AzureOpenAIModelName

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

resourceUri

string (uri)

URI ресурса Azure OpenAI.

AzureOpenAIVectorizer

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

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

AzureOpenAIEmbeddingSkill

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

kind string:

azureOpenAI

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

name

string

Имя, которое будет ассоциироваться с этим конкретным методом векторизации.

ErrorAdditionalInfo

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

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

object

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

type

string

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

ErrorDetail

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

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

ErrorAdditionalInfo[]

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

code

string

Код ошибки.

details

ErrorDetail[]

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

message

string

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

target

string

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

ErrorResponse

Ответ на ошибку

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

ErrorDetail

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

IndexingSchedule

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

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

string (duration)

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

startTime

string (date-time)

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

InputFieldMappingEntry

Сопоставление полей ввода для навыка.

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

InputFieldMappingEntry[]

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

name

string

Имя входных данных.

source

string

Источник входных данных.

sourceContext

string

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

KnowledgeAgentAzureOpenAIModel

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

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

AzureOpenAIEmbeddingSkill

Содержит параметры, относящиеся к конечной точке модели Azure OpenAI.

kind string:

azureOpenAI

Тип модели ИИ.

KnowledgeAgentModelKind

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

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

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

KnowledgeSourceKind

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

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

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

azureBlob

Источник знаний, который считывает и принимает данные из хранилища BLOB-объектов Azure в индекс поиска.

OutputFieldMappingEntry

Сопоставление выходных полей для навыка.

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

string

Имя выходных данных, определяемое навыком.

targetName

string

Целевое имя выходных данных. Он является необязательным и по умолчанию является именем.

SearchIndexerDataNoneIdentity

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

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

#Microsoft.Azure.Search.DataNoneIdentity

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

SearchIndexerDataUserAssignedIdentity

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

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

#Microsoft.Azure.Search.DataUserAssignedIdentity

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

userAssignedIdentity

string

Полный идентификатор ресурса Azure управляемого удостоверения, назначенного пользователем, обычно в форме "/subscriptions/12345678-1234-1234-123467890ab/resourceGroups/rg/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myId", который должен быть назначен службе поиска.

SearchIndexKnowledgeSource

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

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

string

ETag агента.

description

string

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

encryptionKey

SearchResourceEncryptionKey

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

kind string:

searchIndex

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

name

string

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

searchIndexParameters

SearchIndexKnowledgeSourceParameters

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

SearchIndexKnowledgeSourceParameters

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

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

string

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

sourceDataSelect

string

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

SearchResourceEncryptionKey

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

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

AzureActiveDirectoryApplicationCredentials

Необязательные учетные данные Azure Active Directory, используемые для доступа к Azure Key Vault. Не требуется, если вместо этого используется управляемое удостоверение.

identity SearchIndexerDataIdentity:

Явное управляемое удостоверение, используемое для этого ключа шифрования. Если значение не указано и свойство учетных данных для доступа равно null, используется управляемое удостоверение, назначенное системой. При обновлении ресурса, если явное удостоверение не указано, оно остается неизменным. Если указано значение "none", значение этого свойства сбрасывается.

keyVaultKeyName

string

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

keyVaultKeyVersion

string

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

keyVaultUri

string

URI Azure Key Vault, также называемый DNS-именем, который содержит ключ, используемый для шифрования неактивных данных. Примером URI может быть .https://my-keyvault-name.vault.azure.net

VectorSearchVectorizerKind

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

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

Создание внедрений с помощью ресурса Azure OpenAI во время запроса.

customWebApi

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

aiServicesVision

Создавайте встраивания для ввода изображения или текста во время запроса с помощью API Vision Vectorize служб Azure AI.

aml

Создавайте внедрения с помощью конечной точки Машинного обучения Azure, развернутой с помощью каталога моделей Azure AI Foundry во время запроса.

WebApiParameters

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

Имя Тип Описание
authIdentity SearchIndexerDataIdentity:

Назначаемое пользователем управляемое удостоверение, используемое для исходящих подключений. Если указан authResourceId, но он не указан, используется управляемое удостоверение, назначенное системой. При обновлении индексатора, если идентификатор не указан, значение остается неизменным. Если установлено значение "none", значение этого свойства очищается.

authResourceId

string

Применяется к пользовательским конечным точкам, которые подключаются к внешнему коду в функции Azure или другом приложении, выполняющем преобразования. Это значение должно быть идентификатором приложения, созданным для функции или приложения при его регистрации в Azure Active Directory. Если указано, векторизация подключается к функции или приложению с помощью управляемого идентификатора (системного или назначаемого пользователем) службы поиска и маркера доступа функции или приложения, используя это значение в качестве идентификатора ресурса для создания области маркера доступа.

httpHeaders

object

Заголовки, необходимые для выполнения HTTP-запроса.

httpMethod

string

Метод для HTTP-запроса.

timeout

string (duration)

Требуемое время ожидания для запроса. По умолчанию — 30 секунд.

uri

string (uri)

URI веб-API, предоставляющего векторизатор.

WebApiVectorizer

Указывает определяемый пользователем векторизатор для создания векторного встраивания строки запроса. Интеграция внешнего векторизатора достигается с помощью пользовательского интерфейса Web API набора навыков.

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

WebApiParameters

Задает свойства определяемого пользователем векторизатора.

kind string:

customWebApi

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

name

string

Имя, которое будет ассоциироваться с этим конкретным методом векторизации.