Knowledge Retrieval - Retrieve

Служба:: Search Service

Версия API:: 2026-08-01-preview

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

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-08-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-query-work-iq-source-authorization	string (password)	Пользовательский токен утверждения для регистрации приложения Entra, принадлежащего клиенту, настроенной на источнике знаний Work IQ. Используется для аутентификации в API Work IQ.
x-ms-client-request-id	string (uuid)	Непрозрачный, глобально уникальный, созданный клиентом идентификатор строки для запроса.

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

Имя	Тип	Описание
includeActivity	boolean	Указывает, что результаты извлечения должны содержать информацию о действиях.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Список запросов, которые должны быть выполнены без планирования запросов модели.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Список параметров времени выполнения для источников знаний.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов на выходе.
maxOutputSize	integer (int32)	Ограничивает максимальный размер содержимого на выходе.
maxOutputSizeInTokens	integer (int32)	Ограничивает максимальный размер содержимого на выходе.
maxRuntimeInSeconds	integer (int32)	Максимальное время работы в секундах.
messages	KnowledgeBaseMessage[]	Список вводимых сообщений в стиле чата.
outputMode	KnowledgeRetrievalOutputMode	Конфигурация выходных данных для этого извлечения.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort 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

KnowledgeBaseRetrieveAzureBlobImageServing

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

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

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "neverQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

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

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "searchIndex",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "searchIndex",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "hello world two",
        "filter": "((category eq 'news') and (foo eq bar)) and (Key eq 'myDocKey1')",
        "semanticConfigurationName": "testconfig",
        "queryType": "simple",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      },
      "queryHintProcessing": {
        "generatedFilter": "Key eq 'myDocKey1'"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveAzureBlobImageServing

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

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-azureblob-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "type": "text",
          "text": "hello world"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "kind": "azureBlob",
      "enableImageServing": true
    }
  ]
}

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

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "azureBlob",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world"
      },
      "imageServing": {
        "imagesRetrieved": 2,
        "imagesSentToModel": 1,
        "totalImageSizeBytes": 3,
        "verbalizationUsed": true,
        "servedImages": [
          {
            "imageId": "1.1",
            "imagePath": "doc/normalized_images_0.jpg",
            "sizeBytes": 3
          }
        ]
      }
    },
    {
      "type": "azureBlob",
      "id": 2,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "azureblob-ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "azureBlobArguments": {
        "search": "hello world two"
      }
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10,
      "model": {
        "modelName": "gpt-4o",
        "deploymentId": "gpt-4o-deployment"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 4,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 78,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "logicalReasoningEffort": {
        "kind": "low"
      }
    }
  ],
  "references": [
    {
      "type": "azureBlob",
      "id": "83dd7d40",
      "activitySource": 1,
      "rerankerScore": 4,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world",
        "image_path": "1.1:doc/normalized_images_0.jpg"
      }
    },
    {
      "type": "azureBlob",
      "id": "83dd7d41",
      "activitySource": 1,
      "rerankerScore": 3.9,
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/azureblob-ks-preview-test-index/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world",
        "image_path": "3.2:doc/normalized_images_1.jpg"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithIntents

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

HTTP

POST https://typespecpreviewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-08-01-preview





{
  "intents": [
    {
      "type": "semantic",
      "search": "foo"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "failOnError": true,
      "rerankerThreshold": 2.1,
      "resultsProcessing": "rerank",
      "kind": "searchIndex",
      "filterAddOn": "foo eq bar",
      "queryHintOverrides": {
        "filters": [
          {
            "field": "country",
            "fieldValues": [
              "United States",
              "Japan",
              "France",
              "Germany"
            ],
            "filterInstructions": "Country associated with the document."
          }
        ],
        "boosts": [
          {
            "kind": "fieldValue",
            "boostInstructions": "Prefer documents matching the user's locale.",
            "field": "language",
            "fieldValues": [
              "en-US",
              "ja-JP",
              "fr-FR",
              "de-DE"
            ],
            "boost": 1.5
          }
        ]
      }
    }
  ]
}

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

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "searchIndexArguments": {
        "search": "foo",
        "filter": "(category eq 'news') and (foo eq bar)",
        "semanticConfigurationName": "testconfig",
        "sourceDataFields": [
          {
            "name": "category"
          },
          {
            "name": "description"
          },
          {
            "name": "ownerId"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": []
      }
    },
    {
      "type": "agenticReasoning",
      "id": 1,
      "startedAt": "2025-01-01T00:08:45.045Z",
      "completedAt": "2025-01-01T00:08:46.279Z",
      "reasoningTokens": 39,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "logicalReasoningEffort": {
        "kind": "minimal"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 0,
      "rerankerScore": 4,
      "docKey": "myDocKey1",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey1?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "searchIndex",
      "id": "83dd7d41",
      "activitySource": 0,
      "rerankerScore": 3.9,
      "docKey": "myDocKey2",
      "citationUrl": "https://typespecpreviewexampleservice.search.windows.net/indexes/preview-test/docs/myDocKey2?$select=category%2Cdescription%2CownerId%2Cid&api-version=2026-08-01-preview",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

KnowledgeBaseRetrieveWithSourceExclusion

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

HTTP

POST https://previewexampleservice.search.windows.net/knowledgebases('support-kb')/retrieve?api-version=2026-08-01-preview




{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "Explain the SSO provisioning steps from the product documentation only.",
          "type": "text"
        }
      ]
    }
  ],
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "knowledgeSourceName": "product-docs-ks",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "troubleshooting-ks",
      "neverQuerySource": true,
      "kind": "searchIndex"
    },
    {
      "knowledgeSourceName": "release-notes-web",
      "neverQuerySource": true,
      "kind": "web"
    }
  ]
}

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

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "To provision SSO, register the enterprise application, configure the redirect URI, upload the signing certificate, and complete the tenant-specific identity settings described in the product documentation."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 4,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    },
    {
      "type": "agenticReasoning",
      "id": 2,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "reasoningTokens": 74
    },
    {
      "type": "modelAnswerSynthesis",
      "id": 3,
      "inputTokens": 664,
      "outputTokens": 1328,
      "elapsedMs": 10
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

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

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "Partial results were returned before the retrieval completed."
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "product-docs-ks",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 1,
      "elapsedMs": 64,
      "searchIndexArguments": {
        "search": "SSO provisioning steps",
        "sourceDataFields": [
          {
            "name": "title"
          },
          {
            "name": "content"
          },
          {
            "name": "id"
          }
        ],
        "searchFields": [],
        "semanticConfigurationName": "testconfig"
      }
    }
  ],
  "references": [
    {
      "type": "searchIndex",
      "id": "83dd7d40",
      "activitySource": 1,
      "sourceData": {
        "id": "sso-provisioning-guide",
        "title": "SSO provisioning guide",
        "content": "Register the enterprise application and configure the redirect URI."
      },
      "rerankerScore": 3.5,
      "docKey": "sso-provisioning-guide"
    }
  ]
}

Определения

Имя	Описание
Accept	Заголовок Accept.
AzureBlobKnowledgeSourceParams	Указывает параметры среды выполнения для источника знаний о BLOB-объектах Azure
ErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
ErrorDetail	Подробности ошибки.
ErrorResponse	Распространенный ответ об ошибке для всех API Azure Resource Manager для возврата сведений об ошибке для неудачных операций. (Это также следует формату ответа об ошибках OData.).
FabricDataAgentKnowledgeSourceParams	Задаёт параметры выполнения для источника знаний Fabric Data Agent
FabricOntologyKnowledgeSourceParams	Задаёт параметры выполнения для источника знаний Fabric Ontology
FileKnowledgeSourceParams	Задаёт параметры выполнения для источника знаний Файла
ImageServingStatistics	Статистика по подаче изображений во время активности по поиску.
IndexedOneLakeKnowledgeSourceParams	Указывает параметры среды выполнения для индексированного источника знаний OneLake
IndexedSharePointKnowledgeSourceParams	Указывает параметры среды выполнения для индексированного источника знаний SharePoint
IndexedSqlKnowledgeSourceParams	Задаёт параметры выполнения для индексируемого SQL-источника знаний
KnowledgeBaseActivityRecordModel	Представляет модель, используемую для деятельности LLM базы знаний, включая её название и идентификатор развертывания.
KnowledgeBaseActivityRecordType	Тип записи активности.
KnowledgeBaseAgenticReasoningActivityRecord	Представляет собой запись активности агентного рассуждения.
KnowledgeBaseAzureBlobActivityArguments	Представляет аргументы, с которыми было выполнено действие извлечения BLOB-объектов Azure.
KnowledgeBaseAzureBlobActivityRecord	Представляет запись о действиях по получению BLOB-объектов Azure.
KnowledgeBaseAzureBlobReference	Представляет собой справочник по документам хранилища BLOB-объектов Azure.
KnowledgeBaseErrorAdditionalInfo	Дополнительные сведения об ошибке управления ресурсами.
KnowledgeBaseErrorDetail	Сведения об ошибке.
KnowledgeBaseFabricDataAgentActivityArguments	Представляет аргументы, с которыми выполнялась активность поиска Fabric Data Agent.
KnowledgeBaseFabricDataAgentActivityRecord	Представляет собой запись активности поиска Fabric Data Agent.
KnowledgeBaseFabricDataAgentReference	Представляет собой ссылку на документ Fabric Data Agent.
KnowledgeBaseFabricOntologyActivityArguments	Представляет аргументы, с которыми проводилась активность поиска Fabric Ontology.
KnowledgeBaseFabricOntologyActivityRecord	Представляет запись активности поиска Fabric Ontology.
KnowledgeBaseFabricOntologyReference	Представляет собой ссылку на документ Fabric Ontology.
KnowledgeBaseFileActivityArguments	Представляет аргументы, с которыми выполнялась активность по извлечению файла.
KnowledgeBaseFileActivityRecord	Представляет запись активности по извлечению файлов.
KnowledgeBaseFileReference	Представляет собой ссылку на документ файла.
KnowledgeBaseImageContent	Содержание изображений.
KnowledgeBaseIndexedOneLakeActivityArguments	Представляет аргументы, с которыми проводилась индексированная активность поиска OneLake.
KnowledgeBaseIndexedOneLakeActivityRecord	Представляет индексированную запись активности по поиску OneLake.
KnowledgeBaseIndexedOneLakeReference	Представляет индексированную ссылку на документ OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Представляет аргументы, с которыми выполнялась индексированная активность поиска SharePoint.
KnowledgeBaseIndexedSharePointActivityRecord	Представляет индексированную запись активности поиска в SharePoint.
KnowledgeBaseIndexedSharePointReference	Представляет собой индексированный документ SharePoint.
KnowledgeBaseIndexedSqlActivityArguments	Представляет аргументы, с которыми выполнялась индексированная активность поиска SQL.
KnowledgeBaseIndexedSqlActivityRecord	Представляет индексированную запись активности поиска SQL.
KnowledgeBaseIndexedSqlReference	Представляет ссылку на документ Azure SQL.
KnowledgeBaseMcpServerActivityArguments	Представляет аргументы, с которыми выполнялась активность по поиску MCP-сервера.
KnowledgeBaseMcpServerActivityRecord	Представляет запись активности поиска сервера MCP.
KnowledgeBaseMcpServerReference	Представляет ссылку на документ сервера MCP.
KnowledgeBaseMessage	Объект стиля сообщения на естественном языке.
KnowledgeBaseMessageContentType	Тип содержимого сообщения.
KnowledgeBaseMessageImageContent	Тип графического сообщения.
KnowledgeBaseMessageTextContent	Тип текстового сообщения.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Представляет собой запись активности синтеза ответов LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Представляет запись о планировании запроса LLM.
KnowledgeBaseModelWebSummarizationActivityRecord	Представляет запись активности по суммаризации веба в LLM.
KnowledgeBaseQueryHintProcessing	Детали о выражениях, генерируемых из подсказок запроса для активности поиска.
KnowledgeBaseReferenceType	Тип ссылки.
KnowledgeBaseRemoteSharePointActivityArguments	Представляет аргументы, с которыми выполнялась удалённая активность поиска SharePoint.
KnowledgeBaseRemoteSharePointActivityRecord	Представляет собой удалённую запись активности поиска SharePoint.
KnowledgeBaseRemoteSharePointReference	Представляет собой удаленную ссылку на документ SharePoint.
KnowledgeBaseRetrievalRequest	Входной контракт для запроса на извлечение.
KnowledgeBaseRetrievalResponse	Выходной контракт для ответа на извлечение.
KnowledgeBaseSearchIndexActivityArguments	Представляет аргументы, с которыми было выполнено действие извлечения индекса поиска.
KnowledgeBaseSearchIndexActivityRecord	Представляет запись о действиях извлечения из индекса поиска.
KnowledgeBaseSearchIndexReference	Представляет ссылку на документ Поиска Azure.
KnowledgeBaseWebActivityArguments	Представляет аргументы, с которыми запускалась активность поиска в интернете.
KnowledgeBaseWebActivityRecord	Представляет собой запись активности поиска в веб-центре.
KnowledgeBaseWebReference	Представляет собой ссылку на веб-документ.
KnowledgeBaseWorkIQActivityArguments	Представляет аргументы, с которыми выполнялась активность поиска WorkIQ.
KnowledgeBaseWorkIQActivityRecord	Представляет запись активности поиска WorkIQ.
KnowledgeBaseWorkIQReference	Представляет собой ссылку на документ WorkIQ.
KnowledgeRetrievalAutoReasoningEffort	Автоматически выбирайте усилие рассуждения во время извлечения. Сервис отправляет все запросы на самый дешёвый уровень и повышает нагрузку только до максимального доступного уровня сервиса.
KnowledgeRetrievalIntentType	Тип используемой конфигурации базы знаний.
KnowledgeRetrievalLowReasoningEffort	Выполняйте извлечение знаний с минимальными усилиями по рассуждениям.
KnowledgeRetrievalMediumReasoningEffort	Выполняйте извлечение знаний со средними усилиями на рассуждение.
KnowledgeRetrievalMinimalReasoningEffort	Выполняйте извлечение знаний с минимальными усилиями по рассуждениям.
KnowledgeRetrievalOutputMode	Конфигурация выходных данных для этого извлечения.
KnowledgeRetrievalReasoningEffortKind	Количество усилий, затрачиваемых во время извлечения.
KnowledgeRetrievalSemanticIntent	Семантический запрос.
KnowledgeSourceKind	Вид источника знаний.
KnowledgeSourceResultsProcessing	Контролирует, будут ли результаты источника знаний переранжированы.
McpServerKnowledgeSourceParams	Задаёт параметры выполнения для источника знаний сервера MCP
PurviewSensitivityLabelInfo	Информация о метке чувствительности, применяемой к документу
QueryType	Указывает синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте 'full', если в вашем запросе используется синтаксис запроса Lucene, и 'semantic', если синтаксис запроса не нужен.
RemoteSharePointKnowledgeSourceParams	Указывает параметры среды выполнения для удаленного источника знаний SharePoint
SearchIndexFieldReference	Поле для поискового индекса.
SearchIndexKnowledgeSourceBoostKind	Это тип подсказки для поискового индекса информации.
SearchIndexKnowledgeSourceFieldValueBoost	Подсказка, которая улучшает документы на основе значения поля.
SearchIndexKnowledgeSourceFilterHint	Подсказка, определяющая поле и репрезентативные значения, которые планировщик запросов может использовать при построении фильтра.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Подсказка, которая улучшает работу документов на основе многословного выражения.
SearchIndexKnowledgeSourceParams	Задает параметры времени выполнения для источника знаний индекса поиска
SearchIndexKnowledgeSourceQueryHints	Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям для поискового индекса информации.
ServedImage	Описывает одно изображение, выбранное моделью для подачи во время операции по поиску.
WebKnowledgeSourceParams	Задает параметры времени выполнения для веб-источника знаний
WorkIQKnowledgeSourceParams	Задаёт параметры выполнения для источника знаний WorkIQ

Accept

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

Заголовок Accept.

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

AzureBlobKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: azureBlob	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям. Если указано, этот объект заменяет полный набор подсказок запроса, настроенных на источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

ErrorAdditionalInfo

Объект

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

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

ErrorDetail

Объект

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

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

ErrorResponse

Объект

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

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

FabricDataAgentKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: fabricDataAgent	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

FabricOntologyKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: fabricOntology	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

FileKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: file	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям. Если указано, этот объект заменяет полный набор подсказок запроса, настроенных на источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

ImageServingStatistics

Объект

Статистика по подаче изображений во время активности по поиску.

Имя	Тип	Описание
imagesRetrieved	integer (int32)	Количество изображений, полученных из хранилища активов.
imagesSentToModel	integer (int32)	Количество изображений, отправленных в модель ниже по потоку.
servedImages	ServedImage[]	Набор изображений, выбранных моделью для подачи для следующей модели для этой операции по поиску.
totalImageSizeBytes	integer (int64)	Общий размер в байтах изображений, отправленных в модель.
verbalizationUsed	boolean	Указывает, использовалась ли вербализация изображения вместо прямого подачи изображения.

IndexedOneLakeKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: indexedOneLake	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям. Если указано, этот объект заменяет полный набор подсказок запроса, настроенных на источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

IndexedSharePointKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: indexedSharePoint	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям. Если указано, этот объект заменяет полный набор подсказок запроса, настроенных на источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

IndexedSqlKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: indexedSql	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям. Если указано, этот объект заменяет полный набор подсказок запроса, настроенных на источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

KnowledgeBaseActivityRecordModel

Объект

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

Имя	Тип	Описание
deploymentId	string	Идентификатор развертывания используемой для этой активности.
modelName	string	Название модели, используемой для этого занятия.

KnowledgeBaseActivityRecordType

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

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

Значение	Описание
searchIndex	Поисковая активность по поиску индекса.
azureBlob	Azure Blob retrieval activity.
indexedSharePoint	Индексированная активность поиска в SharePoint.
indexedOneLake	Индексированная активность по поиску OneLake.
web	Активность по поиску в интернете.
remoteSharePoint	Удалённая активность по поиску SharePoint.
workIQ	Активность по восстановлению WorkIQ.
fabricDataAgent	Активность по поиску Fabric Data Agent.
fabricOntology	Активность по поиску Fabric Ontology.
mcpServer	Активность по поиску серверов MCP.
file	Активность по извлечению файлов.
indexedSql	Индексированная активность по поиску SQL.
modelQueryPlanning	Активность по планированию запросов LLM.
modelAnswerSynthesis	Активность по синтезу ответов LLM.
modelWebSummarization	Активность по веб-резюме LLM.
agenticReasoning	Деятельность агентного рассуждения.

KnowledgeBaseAgenticReasoningActivityRecord

Объект

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

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

KnowledgeBaseAzureBlobActivityArguments

Объект

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

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

KnowledgeBaseAzureBlobActivityRecord

Объект

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

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

KnowledgeBaseAzureBlobReference

Объект

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

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

KnowledgeBaseErrorAdditionalInfo

Объект

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

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

KnowledgeBaseErrorDetail

Объект

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

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

KnowledgeBaseFabricDataAgentActivityArguments

Объект

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

Имя	Тип	Описание
search	string	Поисковая строка, используемая для запроса к источнику знаний Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Объект

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

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

KnowledgeBaseFabricDataAgentReference

Объект

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

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

KnowledgeBaseFabricOntologyActivityArguments

Объект

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

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

KnowledgeBaseFabricOntologyActivityRecord

Объект

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

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

KnowledgeBaseFabricOntologyReference

Объект

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

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

KnowledgeBaseFileActivityArguments

Объект

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

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

KnowledgeBaseFileActivityRecord

Объект

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

Имя	Тип	Описание
completedAt	string (date-time)	Время, когда деятельность завершилась.
count	integer (int32)	Количество извлеченных документов, которые были достаточно релевантными для того, чтобы преодолеть порог повторного ранжирования.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
fileArguments	KnowledgeBaseFileActivityArguments	Аргументы File для активности поиска.
id	integer (int32)	Идентификатор записи о действии.
imageServing	ImageServingStatistics	Статистика о том, что изображения служат для этой активности по поиску
knowledgeSourceName	string	Источник знаний для действия по извлечению.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Детали выражений, полученных из запроса, подсказки для этой активности.
queryTime	string (date-time)	Время запроса для этого действия извлечения.
startedAt	string (date-time)	Время, когда началось занятие.
type	string: file	Тип записи об активности.
warning	string	Предупреждающее сообщение, появляющееся о возможных проблемах конфигурации, таких как документы, отброшенные из-за порога баллов, усечения лимита токенов или условий тайм-аута.

KnowledgeBaseFileReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
citationUrl	string (uri)	URL, принадлежащий поиску, указывающий на поддерживающий документ для этой ссылки, используемый в качестве цели цитирования.
docName	string	Название документа для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
sourceData		Исходные данные для справки.
type	string: file	Тип ссылки.

KnowledgeBaseImageContent

Объект

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

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

KnowledgeBaseIndexedOneLakeActivityArguments

Объект

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

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

KnowledgeBaseIndexedOneLakeActivityRecord

Объект

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

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

KnowledgeBaseIndexedOneLakeReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
citationUrl	string (uri)	URL, принадлежащий поиску, указывающий на поддерживающий документ для этой ссылки, используемый в качестве цели цитирования.
docUrl	string	URL-адрес документа для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Информация о метке чувствительности для референса.
sourceData		Исходные данные для справки.
type	string: indexedOneLake	Тип ссылки.

KnowledgeBaseIndexedSharePointActivityArguments

Объект

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

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

KnowledgeBaseIndexedSharePointActivityRecord

Объект

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

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

KnowledgeBaseIndexedSharePointReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
citationUrl	string (uri)	URL, принадлежащий поиску, указывающий на поддерживающий документ для этой ссылки, используемый в качестве цели цитирования.
docUrl	string	URL-адрес документа для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	Информация о метке чувствительности для референса.
sourceData		Исходные данные для справки.
type	string: indexedSharePoint	Тип ссылки.

KnowledgeBaseIndexedSqlActivityArguments

Объект

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

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

KnowledgeBaseIndexedSqlActivityRecord

Объект

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

Имя	Тип	Описание
completedAt	string (date-time)	Время, когда деятельность завершилась.
count	integer (int32)	Количество извлеченных документов, которые были достаточно релевантными для того, чтобы преодолеть порог повторного ранжирования.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
imageServing	ImageServingStatistics	Статистика о том, что изображения служат для этой активности по поиску
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	Индексированные SQL-аргументы для активности поиска.
knowledgeSourceName	string	Источник знаний для действия по извлечению.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Детали выражений, полученных из запроса, подсказки для этой активности.
queryTime	string (date-time)	Время запроса для этого действия извлечения.
startedAt	string (date-time)	Время, когда началось занятие.
type	string: indexedSql	Тип записи об активности.
warning	string	Предупреждающее сообщение, появляющееся о возможных проблемах конфигурации, таких как документы, отброшенные из-за порога баллов, усечения лимита токенов или условий тайм-аута.

KnowledgeBaseIndexedSqlReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
citationUrl	string (uri)	URL, принадлежащий поиску, указывающий на поддерживающий документ для этой ссылки, используемый в качестве цели цитирования.
docUrl	string	URL-адрес документа для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
sourceData		Исходные данные для справки.
type	string: indexedSql	Тип ссылки.

KnowledgeBaseMcpServerActivityArguments

Объект

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

Имя	Тип	Описание
toolArguments		Аргументы передавались в инструмент сервера MCP.
toolName	string	Название инструмента сервера MCP, используемого для поиска данных.

KnowledgeBaseMcpServerActivityRecord

Объект

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

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

KnowledgeBaseMcpServerReference

Объект

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

Имя	Тип	Описание
activitySource	integer (int32)	Идентификатор исходного действия для ссылки.
id	string	Идентификатор ссылки.
rerankerScore	number (float)	Оценка повторного ранкинга для ссылки на документ.
sourceData		Исходные данные для справки.
title	string	Название результата MCP-серверного инструмента.
toolName	string	Название инструмента MCP-сервера, который создал эту ссылку.
type	string: mcpServer	Тип ссылки.

KnowledgeBaseMessage

Объект

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

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

KnowledgeBaseMessageContentType

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

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

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

KnowledgeBaseMessageImageContent

Объект

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

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

KnowledgeBaseMessageTextContent

Объект

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

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

KnowledgeBaseModelAnswerSynthesisActivityRecord

Объект

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

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

KnowledgeBaseModelQueryPlanningActivityRecord

Объект

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

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

KnowledgeBaseModelWebSummarizationActivityRecord

Объект

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

Имя	Тип	Описание
completedAt	string (date-time)	Время, когда деятельность завершилась.
elapsedMs	integer (int32)	Затраченное время в миллисекундах для извлечения данных.
error	KnowledgeBaseErrorDetail	Сведения об ошибке, объясняющие, почему операция не удалась. Это свойство включается только в том случае, если действие не завершается успешно.
id	integer (int32)	Идентификатор записи о действии.
inputTokens	integer (int32)	Количество входных токенов для активности по суммаризации веб-LLM.
model	KnowledgeBaseActivityRecordModel	Модель, используемая для активности по веб-суммаризации LLM.
outputTokens	integer (int32)	Количество выходных токенов для активности по суммаризации веба LLM.
startedAt	string (date-time)	Время, когда началось занятие.
type	string: modelWebSummarization	Тип записи об активности.
warning	string	Предупреждающее сообщение, появляющееся о возможных проблемах конфигурации, таких как документы, отброшенные из-за порога баллов, усечения лимита токенов или условий тайм-аута.

KnowledgeBaseQueryHintProcessing

Объект

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

Имя	Тип	Описание
generatedBoost	string	Поисковая клауза, созданная из boost, подсказывает для этой активности.
generatedFilter	string	Выражение фильтра, полученное из фильтра, подсказывает для этой активности.

KnowledgeBaseReferenceType

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

Тип ссылки.

Значение	Описание
searchIndex	Поиск указателя по документу.
azureBlob	Azure Blob document reference.
indexedSharePoint	Индексируемый документ SharePoint.
indexedOneLake	Индексированная ссылка на документ OneLake.
web	Ссылка на веб-документы.
remoteSharePoint	Удалённая ссылка на документы SharePoint.
workIQ	Справка с документом IQ для работы.
fabricDataAgent	Ссылка на документ Fabric Data Agent.
fabricOntology	Ссылка на документ Fabric Ontology.
mcpServer	Ссылка на документ сервера MCP.
file	Файл документа.
indexedSql	Индексируемая ссылка на SQL-документы.

KnowledgeBaseRemoteSharePointActivityArguments

Объект

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

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

KnowledgeBaseRemoteSharePointActivityRecord

Объект

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

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

KnowledgeBaseRemoteSharePointReference

Объект

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

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

KnowledgeBaseRetrievalRequest

Объект

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

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

KnowledgeBaseRetrievalResponse

Объект

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

Имя	Тип	Описание
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseFabricDataAgentActivityRecord[] KnowledgeBaseFabricOntologyActivityRecord[] KnowledgeBaseFileActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseIndexedSqlActivityRecord[] KnowledgeBaseMcpServerActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[] KnowledgeBaseWorkIQActivityRecord[]	Записи действий для отслеживания хода выполнения и последствий для выставления счетов.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseFabricDataAgentReference[] KnowledgeBaseFabricOntologyReference[] KnowledgeBaseFileReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseIndexedSqlReference[] KnowledgeBaseMcpServerReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[] KnowledgeBaseWorkIQReference[]	Ссылки на данные извлечения, использованные в ответе.
response	KnowledgeBaseMessage[]	Ответные сообщения.
responseSensitivityLabelInfo	PurviewSensitivityLabelInfo	Информация о метке чувствительности для общего ответа.

KnowledgeBaseSearchIndexActivityArguments

Объект

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

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

KnowledgeBaseSearchIndexActivityRecord

Объект

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

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

KnowledgeBaseSearchIndexReference

Объект

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

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

KnowledgeBaseWebActivityArguments

Объект

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

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

KnowledgeBaseWebActivityRecord

Объект

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

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

KnowledgeBaseWebReference

Объект

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

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

KnowledgeBaseWorkIQActivityArguments

Объект

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

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

KnowledgeBaseWorkIQActivityRecord

Объект

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

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

KnowledgeBaseWorkIQReference

Объект

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

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

KnowledgeRetrievalAutoReasoningEffort

Объект

Автоматически выбирайте усилие рассуждения во время извлечения. Сервис отправляет все запросы на самый дешёвый уровень и повышает нагрузку только до максимального доступного уровня сервиса.

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

KnowledgeRetrievalIntentType

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

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

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

KnowledgeRetrievalLowReasoningEffort

Объект

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

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

KnowledgeRetrievalMediumReasoningEffort

Объект

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

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

KnowledgeRetrievalMinimalReasoningEffort

Объект

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

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

KnowledgeRetrievalOutputMode

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

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

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

KnowledgeRetrievalReasoningEffortKind

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

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

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

KnowledgeRetrievalSemanticIntent

Объект

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

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

KnowledgeSourceKind

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

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

Значение	Описание
searchIndex	Источник знаний, который считывает данные из индекса поиска.
azureBlob	Источник знаний, который считывает и принимает данные из хранилища BLOB-объектов Azure в индекс поиска.
indexedSharePoint	Источник знаний, который считывает данные с индексируемого SharePoint Point.
indexedOneLake	Источник знаний, который читает данные с индексируемого OneLake.
indexedSql	Источник знаний, который извлекает и поглощает данные из База данных SQL Azure или Управляемый экземпляр SQL в поисковый индекс.
web	Источник знаний, который читает данные из интернета.
remoteSharePoint	Источник знаний, который считывает данные с удалённого SharePoint Point.
workIQ	Источник знаний, который считывает данные из рабочего IQ
file	Источник знаний, поддерживающий прямую загрузку и индексацию файлов.
mcpServer	Источник знаний, поддерживаемый сервером MCP (Model Context Protocol).
fabricDataAgent	Источник знаний, который получает данные из агента Fabric Data Agent.
fabricOntology	Источник знаний, который получает данные из онтологий Microsoft Fabric Ontology.

KnowledgeSourceResultsProcessing

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

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

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

McpServerKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: mcpServer	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

PurviewSensitivityLabelInfo

Объект

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

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

QueryType

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

Указывает синтаксис поискового запроса. Значение по умолчанию — 'simple'. Используйте 'full', если в вашем запросе используется синтаксис запроса Lucene, и 'semantic', если синтаксис запроса не нужен.

Значение	Описание
simple	Использует простой синтаксис запросов для поиска. Текст поиска интерпретируется с помощью простого языка запросов, который позволяет использовать такие символы, как +, * и "". По умолчанию запросы оцениваются по всем полям, доступным для поиска, если не указан параметр searchFields.
full	Использует полный синтаксис запросов Lucene для поиска. Текст поиска интерпретируется с помощью языка запросов Lucene, который позволяет выполнять поиск по конкретным полям и взвешенный поиск, а также использовать другие расширенные функции.
semantic	Лучше всего подходит для запросов, выраженных на естественном языке, а не ключевых слов. Повышает точность результатов поиска за счет повторного ранжирования верхних результатов поиска с помощью модели ранжирования, обученной на веб-корпусе.

RemoteSharePointKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
filterExpressionAddOn	string	Условие фильтра, применяемое к источнику данных SharePoint. Он должен быть указан в синтаксисе языка запросов по ключевым словам. Он будет объединен в союз с выражением фильтра, указанным в определении источника знаний.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: remoteSharePoint	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

SearchIndexFieldReference

Объект

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

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

SearchIndexKnowledgeSourceBoostKind

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

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

Значение	Описание
fieldValue	Улучшайте документы на основе значения поля.
multiWordExpression	Улучшайте документы на основе многословного выражения.

SearchIndexKnowledgeSourceFieldValueBoost

Объект

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

Имя	Тип	Описание
boost	number (double)	Множитель оценки по документу. Должно быть положительным числом, не равным 1,0.
boostInstructions	string	Инструкции на естественном языке, объясняющие, когда и как применять усиление.
field	string minLength: 1	Название поля индекса поиска.
fieldValues	string[]	Репрезентативные ценности для этой области.
kind	string: fieldValue	Такого рода подсказка для усиления.

SearchIndexKnowledgeSourceFilterHint

Объект

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

Имя	Тип	Описание
field	string minLength: 1	Название фильтруемого индексного поля поиска.
fieldValues	string[]	Репрезентативные ценности для этой области.
filterInstructions	string	Инструкции на естественном языке, объясняющие, когда и как фильтровать на поле.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Объект

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

Имя	Тип	Описание
boost	number (double)	Множитель оценки по документу. Должно быть положительным числом, не равным 1,0.
boostInstructions	string	Инструкции на естественном языке, объясняющие, когда и как применять усиление.
fieldValues	string[]	Репрезентативные ценности для усиления.
kind	string: multiWordExpression	Такого рода подсказка для усиления.

SearchIndexKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
filterAddOn	string	Условие фильтра, применяемое к индексу (например, 'State eq VA').
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: searchIndex	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Подсказки, которые направляют планирование запросов к полезным фильтрам и улучшениям. Если указано, этот объект заменяет полный набор подсказок запроса, настроенных на источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.

SearchIndexKnowledgeSourceQueryHints

Объект

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

Имя	Тип	Описание
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Подсказки, которые определяют условия, которые планировщик запросов может использовать для влияния на рейтинг документа.
filters	SearchIndexKnowledgeSourceFilterHint[]	Подсказки фильтра, которые определяют поля и репрезентативные значения, которые планировщик запросов может использовать при построении фильтров.

ServedImage

Объект

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

Имя	Тип	Описание
imageId	string	Метка изображения, извлеченная из исходного документа с помощью Content Understanding enrichment. Соответствует нумерации рисунков в оригинальном документе.
imagePath	string	Относительный путь к изображению внутри хранилища ассетов.
sizeBytes	integer (int64)	Размер этого изображения в байтах был отправлен в модель.

WebKnowledgeSourceParams

Объект

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

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

WorkIQKnowledgeSourceParams

Объект

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

Имя	Тип	Описание
alwaysQuerySource	boolean	Указывает, что этот источник знаний должен обходить выбор источника и всегда запрашиваться во время извлечения.
enableImageServing	boolean	Указывает, следует ли включать предоставление изображений для этого источника знаний при получении информации. Когда это верно, изображения, извлечённые во время поглощения, передаются в последующие модели.
failOnError	boolean	Указывает, что весь запрос на поиск должен провалиться, если извлечение из этого источника знаний сталкивается с ошибкой. По умолчанию false.
includeReferenceSourceData	boolean	Указывает, должны ли ссылки включать структурированные данные, полученные во время извлечения, в свои полезные данные.
includeReferences	boolean	Указывает, следует ли включать ссылки для данных, полученных из этого источника.
kind	string: workIQ	Тип источника знаний.
knowledgeSourceName	string	Имя индекса, к которому применяются параметры.
maxOutputDocuments	integer (int32)	Ограничивает максимальное количество документов, возвращаемых из этого источника знаний.
neverQuerySource	boolean	Указывает, что этот источник знаний должен быть исключён из набора кандидатов запроса и никогда не запрашиваться при получении. Исключение является локальным по запросу и не изменяет членство в базе знаний. Нельзя объединять с alwaysQuerySource на одном источнике знаний.
rerankerThreshold	number (float)	Пороговое значение для повторного ранжирования, которому должны соответствовать все извлеченные документы, чтобы быть включенным в ответ.
resultsProcessing	KnowledgeSourceResultsProcessing	Переопределяет сохранённые результаты источника знаний только для этого вызова получения информации. Если оно отсутствует, применяется значение источника сохранённых знаний.