Knowledge Retrieval - Retrieve

Служба:: Search Service

Версия API:: 2025-11-01-preview

База знаний извлекает релевантные данные из резервных хранилищ.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2025-11-01-preview

Параметры URI

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

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

Имя	Тип	Описание
Accept	Accept	Заголовок Accept.
x-ms-query-source-authorization	string	Маркер, идентифицирующий пользователя, для которого выполняется запрос. Этот маркер используется для применения ограничений безопасности к документам.
x-ms-client-request-id	string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

Имя	Тип	Описание
includeActivity	boolean	Указывает, что результаты извлечения должны содержать информацию о действиях.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Список запросов, которые должны быть выполнены без планирования запросов модели.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Список параметров времени выполнения для источников знаний.
maxOutputSize	integer (int32)	Ограничивает максимальный размер содержимого на выходе.
maxRuntimeInSeconds	integer (int32)	Максимальное время работы в секундах.
messages	KnowledgeBaseMessage[]	Список вводимых сообщений в стиле чата.
outputMode	KnowledgeRetrievalOutputMode	Конфигурация выходных данных для этого извлечения.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Конфигурация усилия рассуждения для поиска.

Ответы

Имя	Тип	Описание
200 OK	KnowledgeBaseRetrievalResponse	Успешный ответ на восстановление.
Other Status Codes	KnowledgeBaseRetrievalResponse	Ответ частичного извлечения.
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

Примеры

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

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

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2025-11-01-preview



{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "hello world",
          "type": "text"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

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

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 2,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 3,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 4,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

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

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2025-11-01-preview



{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

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

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "foo eq bar",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "web",
      "id": 1,
      "knowledgeSourceName": "ks-preview-web",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 10,
      "elapsedMs": 2345,
      "error": {
        "code": "403",
        "message": "The error message",
        "details": [],
        "additionalInfo": [
          {
            "type": "SomeErrorType",
            "info": {
              "someProperty": "Some value"
            }
          }
        ]
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "reasoningTokens": 37
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      },
      "rerankerScore": 3.5,
      "docKey": "myDocKey1"
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      },
      "rerankerScore": 2.7,
      "docKey": "myDocKey2"
    }
  ]
}

Определения

Имя	Описание
Accept	Заголовок Accept.
AzureBlobKnowledgeSourceParams	Указывает параметры среды выполнения для источника знаний о BLOB-объектах Azure
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Сведения об ошибке.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
IndexedOneLakeKnowledgeSourceParams	Указывает параметры среды выполнения для индексированного источника знаний OneLake
IndexedSharePointKnowledgeSourceParams	Указывает параметры среды выполнения для индексированного источника знаний SharePoint
KnowledgeBaseActivityRecordType	Тип записи активности.
KnowledgeBaseAgenticReasoningActivityRecord	Представляет собой запись активности агентного рассуждения.
KnowledgeBaseAzureBlobActivityArguments	Представляет аргументы, с которыми было выполнено действие извлечения BLOB-объектов Azure.
KnowledgeBaseAzureBlobActivityRecord	Представляет запись о действиях по получению BLOB-объектов Azure.
KnowledgeBaseAzureBlobReference	Представляет собой справочник по документам хранилища BLOB-объектов Azure.
KnowledgeBaseErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
KnowledgeBaseErrorDetail	Сведения об ошибке.
KnowledgeBaseImageContent	Содержание изображений.
KnowledgeBaseIndexedOneLakeActivityArguments	Представляет аргументы, с которыми проводилась индексированная активность поиска OneLake.
KnowledgeBaseIndexedOneLakeActivityRecord	Представляет индексированную запись активности по поиску OneLake.
KnowledgeBaseIndexedOneLakeReference	Представляет индексированную ссылку на документ OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Представляет аргументы, с которыми выполнялась индексированная активность поиска SharePoint.
KnowledgeBaseIndexedSharePointActivityRecord	Представляет индексированную запись активности поиска в SharePoint.
KnowledgeBaseIndexedSharePointReference	Представляет собой индексированный документ SharePoint.
KnowledgeBaseMessage	Объект стиля сообщения на естественном языке.
KnowledgeBaseMessageContentType	Тип содержимого сообщения.
KnowledgeBaseMessageImageContent	Тип графического сообщения.
KnowledgeBaseMessageTextContent	Тип текстового сообщения.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Представляет собой запись активности синтеза ответов LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Представляет запись о планировании запроса LLM.
KnowledgeBaseReferenceType	Тип ссылки.
KnowledgeBaseRemoteSharePointActivityArguments	Представляет аргументы, с которыми выполнялась удалённая активность поиска SharePoint.
KnowledgeBaseRemoteSharePointActivityRecord	Представляет собой удалённую запись активности поиска SharePoint.
KnowledgeBaseRemoteSharePointReference	Представляет собой удаленную ссылку на документ SharePoint.
KnowledgeBaseRetrievalRequest	Входной контракт для запроса на извлечение.
KnowledgeBaseRetrievalResponse	Выходной контракт для ответа на извлечение.
KnowledgeBaseSearchIndexActivityArguments	Представляет аргументы, с которыми было выполнено действие извлечения индекса поиска.
KnowledgeBaseSearchIndexActivityRecord	Представляет запись о действиях извлечения из индекса поиска.
KnowledgeBaseSearchIndexReference	Представляет ссылку на документ Поиска Azure.
KnowledgeBaseWebActivityArguments	Представляет аргументы, с которыми запускалась активность поиска в интернете.
KnowledgeBaseWebActivityRecord	Представляет собой запись активности поиска в веб-центре.
KnowledgeBaseWebReference	Представляет собой ссылку на веб-документ.
KnowledgeRetrievalIntentType	Тип используемой конфигурации базы знаний.
KnowledgeRetrievalLowReasoningEffort	Выполняйте извлечение знаний с минимальными усилиями по рассуждениям.
KnowledgeRetrievalMediumReasoningEffort	Выполняйте извлечение знаний со средними усилиями на рассуждение.
KnowledgeRetrievalMinimalReasoningEffort	Выполняйте извлечение знаний с минимальными усилиями по рассуждениям.
KnowledgeRetrievalOutputMode	Конфигурация выходных данных для этого извлечения.
KnowledgeRetrievalReasoningEffortKind	Количество усилий, затрачиваемых во время извлечения.
KnowledgeRetrievalSemanticIntent	Семантический запрос.
KnowledgeSourceKind	Вид источника знаний.
RemoteSharePointKnowledgeSourceParams	Указывает параметры среды выполнения для удаленного источника знаний SharePoint
SearchIndexFieldReference	Поле для поискового индекса.
SearchIndexKnowledgeSourceParams	Задает параметры времени выполнения для источника знаний индекса поиска
SharePointSensitivityLabelInfo	Сведения о метке конфиденциальности, примененной к документу SharePoint.
WebKnowledgeSourceParams	Задает параметры времени выполнения для веб-источника знаний

Accept

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

Заголовок Accept.

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

AzureBlobKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: azureBlob	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

IndexedOneLakeKnowledgeSourceParams

Объект

Указывает параметры среды выполнения для индексированного источника знаний OneLake

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: indexedOneLake	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.

IndexedSharePointKnowledgeSourceParams

Объект

Указывает параметры среды выполнения для индексированного источника знаний SharePoint

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: indexedSharePoint	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.

KnowledgeBaseActivityRecordType

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

Тип записи активности.

Значение	Описание
searchIndex	Поисковая активность по поиску индекса.
azureBlob	Azure Blob retrieval activity.
indexedSharePoint	Индексированная активность поиска в SharePoint.
indexedOneLake	Индексированная активность по поиску OneLake.
web	Активность по поиску в интернете.
remoteSharePoint	Удалённая активность по поиску SharePoint.
modelQueryPlanning	Активность по планированию запросов LLM.
modelAnswerSynthesis	Активность по синтезу ответов LLM.
agenticReasoning	Деятельность агентного рассуждения.

KnowledgeBaseAgenticReasoningActivityRecord

Объект

Представляет собой запись активности агентного рассуждения.

Имя	Тип	Описание
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
reasoningTokens	integer (int32)	Количество входных токенов для агентных рассуждений.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Конфигурация усилия рассуждения для поиска.
type	string: agenticReasoning	Тип записи об активности.

KnowledgeBaseAzureBlobActivityArguments

Объект

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

Имя	Тип	Описание
search	string	Строка поиска, используемая для запроса содержимого BLOB-объекта.

KnowledgeBaseAzureBlobActivityRecord

Объект

Представляет запись о действиях по получению BLOB-объектов Azure.

Имя	Тип	Описание
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Аргументы большого двоичного объекта Azure для действия извлечения.
count	integer (int32)	Количество извлеченных документов, которые были достаточно релевантными для того, чтобы преодолеть порог повторного ранжирования.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
knowledgeSourceName	string	Источник знаний для действия по извлечению.
queryTime	string (date-time)	Время запроса для этого действия извлечения.
type	string: azureBlob	Тип записи об активности.

KnowledgeBaseAzureBlobReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
blobUrl	string	URL-адрес большого двоичного объекта для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
sourceData		Исходные данные для справки.
type	string: azureBlob	Тип ссылки.

KnowledgeBaseErrorAdditionalInfo

Объект

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

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

KnowledgeBaseErrorDetail

Объект

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

Имя	Тип	Описание
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	Ошибка дополнительная информация.
code	string	Код ошибки.
details	KnowledgeBaseErrorDetail[]	Сведения об ошибке.
message	string	Сообщение об ошибке.
target	string	Цель ошибки.

KnowledgeBaseImageContent

Объект

Содержание изображений.

Имя	Тип	Описание
url	string (uri)	URL-адрес изображения.

KnowledgeBaseIndexedOneLakeActivityArguments

Объект

Представляет аргументы, с которыми проводилась индексированная активность поиска OneLake.

Имя	Тип	Описание
search	string	Поисковая строка, используемая для запроса, индексировала содержимое OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Объект

Представляет индексированную запись активности по поиску OneLake.

Имя	Тип	Описание
count	integer (int32)	Количество извлеченных документов, которые были достаточно релевантными для того, чтобы преодолеть порог повторного ранжирования.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Индексированные аргументы OneLake в пользу активности поиска.
knowledgeSourceName	string	Источник знаний для действия по извлечению.
queryTime	string (date-time)	Время запроса для этого действия извлечения.
type	string: indexedOneLake	Тип записи об активности.

KnowledgeBaseIndexedOneLakeReference

Объект

Представляет индексированную ссылку на документ OneLake.

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
docUrl	string	URL-адрес документа для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
sourceData		Исходные данные для справки.
type	string: indexedOneLake	Тип ссылки.

KnowledgeBaseIndexedSharePointActivityArguments

Объект

Представляет аргументы, с которыми выполнялась индексированная активность поиска SharePoint.

Имя	Тип	Описание
search	string	Поисковая строка, используемая для запроса индексируемого содержимого SharePoint.

KnowledgeBaseIndexedSharePointActivityRecord

Объект

Представляет индексированную запись активности поиска в SharePoint.

Имя	Тип	Описание
count	integer (int32)	Количество извлеченных документов, которые были достаточно релевантными для того, чтобы преодолеть порог повторного ранжирования.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	Индексируемые аргументы SharePoint для активности поиска.
knowledgeSourceName	string	Источник знаний для действия по извлечению.
queryTime	string (date-time)	Время запроса для этого действия извлечения.
type	string: indexedSharePoint	Тип записи об активности.

KnowledgeBaseIndexedSharePointReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
docUrl	string	URL-адрес документа для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
sourceData		Исходные данные для справки.
type	string: indexedSharePoint	Тип ссылки.

KnowledgeBaseMessage

Объект

Объект стиля сообщения на естественном языке.

Имя	Тип	Описание
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Содержимое сообщения.
role	string	Роль инструмента реакции.

KnowledgeBaseMessageContentType

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

Тип содержимого сообщения.

Значение	Описание
text	Вид содержимого текстового сообщения.
image	Вид содержимого графического сообщения.

KnowledgeBaseMessageImageContent

Объект

Тип графического сообщения.

Имя	Тип	Описание
image	KnowledgeBaseImageContent	Содержание изображения.
type	string: image	Тип сообщения

KnowledgeBaseMessageTextContent

Объект

Тип текстового сообщения.

Имя	Тип	Описание
text	string	Текстовое содержимое.
type	string: text	Тип сообщения

KnowledgeBaseModelAnswerSynthesisActivityRecord

Объект

Представляет собой запись активности синтеза ответов LLM.

Имя	Тип	Описание
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
inputTokens	integer (int32)	Количество входных токенов для действия синтеза ответов LLM.
outputTokens	integer (int32)	Количество выходных токенов для действия синтеза ответов LLM.
type	string: modelAnswerSynthesis	Тип записи об активности.

KnowledgeBaseModelQueryPlanningActivityRecord

Объект

Представляет запись о планировании запроса LLM.

Имя	Тип	Описание
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
inputTokens	integer (int32)	Количество входных маркеров для действия планирования запроса LLM.
outputTokens	integer (int32)	Количество выходных маркеров для действия планирования запроса LLM.
type	string: modelQueryPlanning	Тип записи об активности.

KnowledgeBaseReferenceType

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

Тип ссылки.

Значение	Описание
searchIndex	Поиск указателя по документу.
azureBlob	Azure Blob document reference.
indexedSharePoint	Индексируемый документ SharePoint.
indexedOneLake	Индексированная ссылка на документ OneLake.
web	Ссылка на веб-документы.
remoteSharePoint	Удалённая ссылка на документы SharePoint.

KnowledgeBaseRemoteSharePointActivityArguments

Объект

Представляет аргументы, с которыми выполнялась удалённая активность поиска SharePoint.

Имя	Тип	Описание
filterExpressionAddOn	string	Дополнение фильтрующего выражения для активности извлечения.
search	string	Поисковая строка, используемая для запроса к удалённому источнику знаний SharePoint.

KnowledgeBaseRemoteSharePointActivityRecord

Объект

Представляет собой удалённую запись активности поиска SharePoint.

Имя	Тип	Описание
count	integer (int32)	Количество извлеченных документов, которые были достаточно релевантными для того, чтобы преодолеть порог повторного ранжирования.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
knowledgeSourceName	string	Источник знаний для действия по извлечению.
queryTime	string (date-time)	Время запроса для этого действия извлечения.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	Аргументы удалённого SharePoint для активности поиска.
type	string: remoteSharePoint	Тип записи об активности.

KnowledgeBaseRemoteSharePointReference

Объект

Представляет собой удаленную ссылку на документ SharePoint.

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
searchSensitivityLabelInfo	SharePointSensitivityLabelInfo	Информация о метке чувствительности, применяемой к документу SharePoint.
sourceData		Исходные данные для справки.
type	string: remoteSharePoint	Тип ссылки.
webUrl	string (uri)	URL-адрес, с которого были получены справочные данные.

KnowledgeBaseRetrievalRequest

Объект

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

Имя	Тип	Описание
includeActivity	boolean	Указывает, что результаты извлечения должны содержать информацию о действиях.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Список запросов, которые должны быть выполнены без планирования запросов модели.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Список параметров времени выполнения для источников знаний.
maxOutputSize	integer (int32)	Ограничивает максимальный размер содержимого на выходе.
maxRuntimeInSeconds	integer (int32)	Максимальное время работы в секундах.
messages	KnowledgeBaseMessage[]	Список вводимых сообщений в стиле чата.
outputMode	KnowledgeRetrievalOutputMode	Конфигурация выходных данных для этого извлечения.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	Конфигурация усилия рассуждения для поиска.

KnowledgeBaseRetrievalResponse

Объект

Выходной контракт для ответа на извлечение.

Имя	Тип	Описание
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	Записи действий для отслеживания хода выполнения и последствий для выставления счетов.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	Ссылки на данные извлечения, использованные в ответе.
response	KnowledgeBaseMessage[]	Ответные сообщения.

KnowledgeBaseSearchIndexActivityArguments

Объект

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

Имя	Тип	Описание
filter	string	Строка фильтра.
search	string	Строка поиска, используемая для запроса индекса поиска.
searchFields	SearchIndexFieldReference[]	На каких полях проводились обыски.
semanticConfigurationName	string	Какая семантическая конфигурация была использована из поискового индекса?
sourceDataFields	SearchIndexFieldReference[]	Какие поля были выбраны для поиска?

KnowledgeBaseSearchIndexActivityRecord

Объект

Представляет запись о действиях извлечения из индекса поиска.

Имя	Тип	Описание
count	integer (int32)	Количество извлеченных документов, которые были достаточно релевантными для того, чтобы преодолеть порог повторного ранжирования.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
knowledgeSourceName	string	Источник знаний для действия по извлечению.
queryTime	string (date-time)	Время запроса для этого действия извлечения.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Аргументы поискового индекса для действия извлечения.
type	string: searchIndex	Тип записи об активности.

KnowledgeBaseSearchIndexReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
docKey	string	Ключ документа для справки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
sourceData		Исходные данные для справки.
type	string: searchIndex	Тип ссылки.

KnowledgeBaseWebActivityArguments

Объект

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

Имя	Тип	Описание
count	integer (int32)	Количество вернутых веб-результатов.
freshness	string	Свежесть для активности по извлечению.
language	string	Язык для активности по поиску.
market	string	Рынок деятельности по поиску.
search	string	Поисковая строка, используемая для запроса в интернете.

KnowledgeBaseWebActivityRecord

Объект

Представляет собой запись активности поиска в веб-центре.

Имя	Тип	Описание
count	integer (int32)	Количество извлеченных документов, которые были достаточно релевантными для того, чтобы преодолеть порог повторного ранжирования.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
knowledgeSourceName	string	Источник знаний для действия по извлечению.
queryTime	string (date-time)	Время запроса для этого действия извлечения.
type	string: web	Тип записи об активности.
webArguments	KnowledgeBaseWebActivityArguments	Веб-аргументы в пользу активности поиска.

KnowledgeBaseWebReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
sourceData		Исходные данные для справки.
title	string	Заголовок веб-документа.
type	string: web	Тип ссылки.
url	string (uri)	URL-адрес, с которого были получены справочные данные.

KnowledgeRetrievalIntentType

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

Тип используемой конфигурации базы знаний.

Значение	Описание
semantic	Намерение семантического запроса на естественном языке.

KnowledgeRetrievalLowReasoningEffort

Объект

Выполняйте извлечение знаний с минимальными усилиями по рассуждениям.

Имя	Тип	Описание
kind	string: low	Своего рода попытка рассуждения.

KnowledgeRetrievalMediumReasoningEffort

Объект

Выполняйте извлечение знаний со средними усилиями на рассуждение.

Имя	Тип	Описание
kind	string: medium	Своего рода попытка рассуждения.

KnowledgeRetrievalMinimalReasoningEffort

Объект

Выполняйте извлечение знаний с минимальными усилиями по рассуждениям.

Имя	Тип	Описание
kind	string: minimal	Своего рода попытка рассуждения.

KnowledgeRetrievalOutputMode

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

Конфигурация выходных данных для этого извлечения.

Значение	Описание
extractiveData	Возвращайте данные из источников знаний напрямую без генеративного изменения.
answerSynthesis	Синтезируйте ответ для полезной нагрузки ответа.

KnowledgeRetrievalReasoningEffortKind

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

Количество усилий, затрачиваемых во время извлечения.

Значение	Описание
minimal	Не выполняет выбор источников, планирование запросов или итеративный поиск.
low	Используйте низкое рассуждение во время поиска.
medium	Используйте умеренное количество рассуждений во время поиска.

KnowledgeRetrievalSemanticIntent

Объект

Семантический запрос.

Имя	Тип	Описание
search	string	Семантический запрос для выполнения
type	string: semantic	Тип намерения.

KnowledgeSourceKind

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

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

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

RemoteSharePointKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
filterExpressionAddOn	string	Условие фильтра, применяемое к источнику данных SharePoint. Он должен быть указан в синтаксисе языка запросов по ключевым словам. Он будет объединен в союз с выражением фильтра, указанным в определении источника знаний.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: remoteSharePoint	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.

SearchIndexFieldReference

Объект

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

Имя	Тип	Описание
name	string	Имя поля.

SearchIndexKnowledgeSourceParams

Объект

Задает параметры времени выполнения для источника знаний индекса поиска

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
filterAddOn	string	Условие фильтра, применяемое к индексу (например, 'State eq VA').
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: searchIndex	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.

SharePointSensitivityLabelInfo

Объект

Сведения о метке конфиденциальности, примененной к документу SharePoint.

Имя	Тип	Описание
color	string	Цвет, который должен отображаться в пользовательском интерфейсе для метки, если это настроено.
displayName	string	Отображаемое имя метки конфиденциальности.
isEncrypted	boolean	Указывает, применяет ли метка конфиденциальности шифрование.
priority	integer (int32)	Приоритет, в котором применяется метка конфиденциальности.
sensitivityLabelId	string	Идентификатор метки конфиденциальности.
tooltip	string	Подсказка, которая должна отображаться для метки в пользовательском интерфейсе.

WebKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
count	integer (int32)	Количество возвращаемых веб-результатов.
freshness	string	Свежесть веб-результатов.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: web	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
language	string	Язык результатов поиска в Интернете.
market	string	Рынок веб-результатов.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.