Knowledge Retrieval - Retrieve

Serviço:: Search Service

Versão da API:: 2026-08-01-preview

A KnowledgeBase recupera dados relevantes de armazenamentos de backup.

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

Parâmetros do URI

Name	Em	Obrigatório	Tipo	Descrição
endpoint	path	True	string (uri)	A URL do ponto de extremidade do serviço de pesquisa.
knowledgeBaseName	path	True	string	O nome da base de conhecimento.
api-version	query	True	string minLength: 1	A versão da API a utilizar para esta operação.

Cabeçalho do Pedido

Name	Tipo	Descrição
Accept	Accept	O cabeçalho Aceitar.
x-ms-query-source-authorization	string	Token que identifica o usuário para o qual a consulta está sendo executada. Este token é usado para impor restrições de segurança em documentos.
x-ms-query-work-iq-source-authorization	string (password)	Token de asserção do utilizador para um registo de uma aplicação Entra propriedade do cliente, configurado numa fonte de conhecimento do Work IQ. Usado para autenticação em nome da API do Work IQ.
x-ms-client-request-id	string (uuid)	Um identificador de cadeia de caracteres opaco, globalmente exclusivo e gerado pelo cliente para a solicitação.

Corpo do Pedido

Name	Tipo	Descrição
includeActivity	boolean	Indica que os resultados da recuperação devem incluir informações sobre a atividade.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Uma lista de consultas pretendidas a serem executadas sem planejamento de consulta de modelo.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Uma lista de parâmetros de tempo de execução para as fontes de conhecimento.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos na saída.
maxOutputSize	integer (int32)	Limita o tamanho máximo do conteúdo na saída.
maxOutputSizeInTokens	integer (int32)	Limita o tamanho máximo do conteúdo na saída.
maxRuntimeInSeconds	integer (int32)	O tempo de execução máximo em segundos.
messages	KnowledgeBaseMessage[]	Uma lista de entrada de estilo de mensagem de chat.
outputMode	KnowledgeRetrievalOutputMode	A configuração de saída para essa recuperação.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	A configuração do esforço de raciocínio de recuperação.

Respostas

Name	Tipo	Descrição
200 OK	KnowledgeBaseRetrievalResponse	Resposta de recolha bem-sucedida.
Other Status Codes	KnowledgeBaseRetrievalResponse	Resposta parcial de recuperação.
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

api-key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Âmbitos

Name	Descrição
https://search.azure.com/.default

Exemplos

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveAzureBlobImageServing

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Pedido de amostra

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
          }
        ]
      }
    }
  ]
}

Resposta da amostra

Código de estado:: 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"
      }
    }
  ]
}

Código de estado:: 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

Pedido de amostra

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
    }
  ]
}

Resposta da amostra

Código de estado:: 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"
      }
    }
  ]
}

Código de estado:: 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

Pedido de amostra

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
          }
        ]
      }
    }
  ]
}

Resposta da amostra

Código de estado:: 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"
      }
    }
  ]
}

Código de estado:: 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

Pedido de amostra

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"
    }
  ]
}

Resposta da amostra

Código de estado:: 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"
    }
  ]
}

Código de estado:: 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"
    }
  ]
}

Definições

Name	Descrição
Accept	O cabeçalho Aceitar.
AzureBlobKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento azure blob
ErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)
FabricDataAgentKnowledgeSourceParams	Especifica parâmetros de execução para uma fonte de conhecimento do Fabric Data Agent
FabricOntologyKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento em Fabric Ontology
FileKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento de ficheiro
ImageServingStatistics	Estatísticas sobre o serviço de imagem durante uma atividade de recuperação.
IndexedOneLakeKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento OneLake indexada
IndexedSharePointKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento do SharePoint indexada
IndexedSqlKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento SQL indexada
KnowledgeBaseActivityRecordModel	Representa o modelo utilizado para uma atividade de LLM de base de conhecimento, incluindo o nome do modelo e o identificador de implementação.
KnowledgeBaseActivityRecordType	O tipo de registo de atividade.
KnowledgeBaseAgenticReasoningActivityRecord	Representa um registro de atividade de raciocínio agentico.
KnowledgeBaseAzureBlobActivityArguments	Representa os argumentos com os quais a atividade de recuperação de blob azure foi executada.
KnowledgeBaseAzureBlobActivityRecord	Representa um registro de atividade de recuperação de blob azure.
KnowledgeBaseAzureBlobReference	Representa uma referência de documento do Armazenamento de Blobs do Azure.
KnowledgeBaseErrorAdditionalInfo	Informações adicionais sobre o erro de gestão de recursos.
KnowledgeBaseErrorDetail	Os detalhes do erro.
KnowledgeBaseFabricDataAgentActivityArguments	Representa os argumentos com que a atividade de recuperação do Fabric Data Agent foi executada.
KnowledgeBaseFabricDataAgentActivityRecord	Representa um registo de atividade de recuperação do Fabric Data Agent.
KnowledgeBaseFabricDataAgentReference	Representa uma referência de documento do Fabric Data Agent.
KnowledgeBaseFabricOntologyActivityArguments	Representa os argumentos com que foi conduzida a atividade de recuperação da Fabric Ontology.
KnowledgeBaseFabricOntologyActivityRecord	Representa um registo de atividade de recuperação da Fabric Ontology.
KnowledgeBaseFabricOntologyReference	Representa uma referência documental da Fabric Ontology.
KnowledgeBaseFileActivityArguments	Representa os argumentos com que a atividade de recuperação de ficheiros foi executada.
KnowledgeBaseFileActivityRecord	Representa um registo de atividade de recuperação de ficheiros.
KnowledgeBaseFileReference	Representa uma referência de documento de ficheiro.
KnowledgeBaseImageContent	Conteúdo da imagem.
KnowledgeBaseIndexedOneLakeActivityArguments	Representa os argumentos com que foi conduzida a atividade de recuperação indexada do OneLake.
KnowledgeBaseIndexedOneLakeActivityRecord	Representa um registo indexado de atividade de recuperação do OneLake.
KnowledgeBaseIndexedOneLakeReference	Representa uma referência indexada de documento OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Representa os argumentos com que a atividade indexada de recuperação do SharePoint foi executada.
KnowledgeBaseIndexedSharePointActivityRecord	Representa um registo indexado de atividade de recuperação do SharePoint.
KnowledgeBaseIndexedSharePointReference	Representa uma referência indexada de um documento SharePoint.
KnowledgeBaseIndexedSqlActivityArguments	Representa os argumentos com que a atividade de recuperação de SQL indexado foi executada.
KnowledgeBaseIndexedSqlActivityRecord	Representa um registo indexado de atividade de recuperação SQL.
KnowledgeBaseIndexedSqlReference	Representa uma referência de documento SQL do Azure.
KnowledgeBaseMcpServerActivityArguments	Representa os argumentos com que a atividade de recuperação do servidor MCP foi executada.
KnowledgeBaseMcpServerActivityRecord	Representa um registo de atividade de recuperação de servidor MCP.
KnowledgeBaseMcpServerReference	Representa uma referência a um documento de servidor MCP.
KnowledgeBaseMessage	O objeto de estilo de mensagem em linguagem natural.
KnowledgeBaseMessageContentType	O tipo de conteúdo da mensagem.
KnowledgeBaseMessageImageContent	Tipo de mensagem de imagem.
KnowledgeBaseMessageTextContent	Tipo de mensagem de texto.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Representa um registro de atividade de síntese de resposta LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Representa um registro de atividade de planejamento de consulta LLM.
KnowledgeBaseModelWebSummarizationActivityRecord	Representa um registo de atividade de sumarização web de LLM.
KnowledgeBaseQueryHintProcessing	Detalhes sobre as expressões geradas a partir de dicas de consulta para uma atividade de recuperação.
KnowledgeBaseReferenceType	O tipo de referência.
KnowledgeBaseRemoteSharePointActivityArguments	Representa os argumentos com que a atividade remota de recuperação do SharePoint foi executada.
KnowledgeBaseRemoteSharePointActivityRecord	Representa um registo de atividade de recuperação remota do SharePoint.
KnowledgeBaseRemoteSharePointReference	Representa uma referência de documento remoto do SharePoint.
KnowledgeBaseRetrievalRequest	O contrato de entrada para a solicitação de recuperação.
KnowledgeBaseRetrievalResponse	O contrato de saída para a resposta de recuperação.
KnowledgeBaseSearchIndexActivityArguments	Representa os argumentos com os quais a atividade de recuperação do índice de pesquisa foi executada.
KnowledgeBaseSearchIndexActivityRecord	Representa um registro de atividade de recuperação de índice de pesquisa.
KnowledgeBaseSearchIndexReference	Representa uma referência de documento da Pesquisa do Azure.
KnowledgeBaseWebActivityArguments	Representa os argumentos com que a atividade de recuperação da web foi conduzida.
KnowledgeBaseWebActivityRecord	Representa um registo de atividade de recuperação web.
KnowledgeBaseWebReference	Representa uma referência de documento web.
KnowledgeBaseWorkIQActivityArguments	Representa os argumentos com que a atividade de recuperação do WorkIQ foi conduzida.
KnowledgeBaseWorkIQActivityRecord	Representa um registo de atividade de recuperação WorkIQ.
KnowledgeBaseWorkIQReference	Representa uma referência de documento WorkIQ.
KnowledgeRetrievalAutoReasoningEffort	Selecione automaticamente o esforço de raciocínio durante a recuperação. O serviço coloca cada pedido no nível mais barato e escala apenas até onde for necessário, até ao nível máximo disponível do serviço.
KnowledgeRetrievalIntentType	O tipo de configuração da base de dados de conhecimento a ser usada.
KnowledgeRetrievalLowReasoningEffort	Execute a recuperação de conhecimento com baixo esforço de raciocínio.
KnowledgeRetrievalMediumReasoningEffort	Execute a recuperação de conhecimento com esforço de raciocínio médio.
KnowledgeRetrievalMinimalReasoningEffort	Execute a recuperação de conhecimento com o mínimo esforço de raciocínio.
KnowledgeRetrievalOutputMode	A configuração de saída para essa recuperação.
KnowledgeRetrievalReasoningEffortKind	A quantidade de esforço a utilizar durante a recuperação.
KnowledgeRetrievalSemanticIntent	Uma intenção de consulta semântica.
KnowledgeSourceKind	O tipo de fonte de conhecimento.
KnowledgeSourceResultsProcessing	Controla se os resultados de uma fonte de conhecimento são reclassificados.
McpServerKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento de servidor MCP
PurviewSensitivityLabelInfo	Informação sobre o rótulo de sensibilidade aplicado a um documento
QueryType	Especifica a sintaxe da consulta de pesquisa. O padrão é 'simples'. Use 'completo' se sua consulta usar a sintaxe de consulta Lucene e 'semântica' se a sintaxe de consulta não for necessária.
RemoteSharePointKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento remota do SharePoint
SearchIndexFieldReference	Referência de campo para um índice de pesquisa.
SearchIndexKnowledgeSourceBoostKind	O tipo de dica de impulso para uma fonte de conhecimento de índice de pesquisa.
SearchIndexKnowledgeSourceFieldValueBoost	Uma dica que melhora documentos com base no valor de um campo.
SearchIndexKnowledgeSourceFilterHint	Uma dica que identifica um campo e valores representativos que o planeador de consultas pode usar ao construir um filtro.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Uma dica que melhora documentos com base numa expressão de várias palavras.
SearchIndexKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento de índice de pesquisa
SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planeamento das consultas para filtros úteis e reforços para uma fonte de conhecimento de índice de pesquisa.
ServedImage	Descreve uma única imagem que o modelo selecionou para ser servida durante uma atividade de recuperação.
WebKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento da Web
WorkIQKnowledgeSourceParams	Especifica parâmetros de execução para uma fonte de conhecimento WorkIQ

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Descrição
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento azure blob

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: azureBlob	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planeamento das consultas para filtros e impulsos úteis. Se especificado, este objeto substitui o conjunto completo de dicas de consulta configuradas na fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

ErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Descrição
info		As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

Object

O detalhe do erro.

Name	Tipo	Descrição
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

ErrorResponse

Object

Resposta de erro comum para todas as APIs do Azure Resource Manager para retornar detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.)

Name	Tipo	Descrição
error	ErrorDetail	O objeto de erro.

FabricDataAgentKnowledgeSourceParams

Object

Especifica parâmetros de execução para uma fonte de conhecimento do Fabric Data Agent

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: fabricDataAgent	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

FabricOntologyKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento em Fabric Ontology

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: fabricOntology	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

FileKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento de ficheiro

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: file	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planeamento das consultas para filtros e impulsos úteis. Se especificado, este objeto substitui o conjunto completo de dicas de consulta configuradas na fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

ImageServingStatistics

Object

Estatísticas sobre o serviço de imagem durante uma atividade de recuperação.

Name	Tipo	Descrição
imagesRetrieved	integer (int32)	O número de imagens recuperadas da loja de assets.
imagesSentToModel	integer (int32)	O número de imagens enviadas para o modelo a jusante.
servedImages	ServedImage[]	O conjunto de imagens que o modelo selecionou para serem servidas ao modelo a jusante para esta atividade de recuperação.
totalImageSizeBytes	integer (int64)	O tamanho total em bytes das imagens enviadas para o modelo.
verbalizationUsed	boolean	Indica se foi usada verbalização de imagem em vez de servir diretamente de imagem.

IndexedOneLakeKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento OneLake indexada

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: indexedOneLake	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planeamento das consultas para filtros e impulsos úteis. Se especificado, este objeto substitui o conjunto completo de dicas de consulta configuradas na fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

IndexedSharePointKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento do SharePoint indexada

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: indexedSharePoint	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planeamento das consultas para filtros e impulsos úteis. Se especificado, este objeto substitui o conjunto completo de dicas de consulta configuradas na fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

IndexedSqlKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento SQL indexada

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: indexedSql	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planeamento das consultas para filtros e impulsos úteis. Se especificado, este objeto substitui o conjunto completo de dicas de consulta configuradas na fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

KnowledgeBaseActivityRecordModel

Object

Representa o modelo utilizado para uma atividade de LLM de base de conhecimento, incluindo o nome do modelo e o identificador de implementação.

Name	Tipo	Descrição
deploymentId	string	O identificador de implementação do modelo utilizado para a atividade.
modelName	string	O nome do modelo utilizado para a atividade.

KnowledgeBaseActivityRecordType

Enumeração

O tipo de registo de atividade.

Valor	Descrição
searchIndex	Atividade de pesquisa e de recuperação de índices.
azureBlob	Atividade de recuperação do Azure Blob.
indexedSharePoint	Atividade indexada de recuperação do SharePoint.
indexedOneLake	Atividade de recuperação indexada no OneLake.
web	Atividade de recuperação da web.
remoteSharePoint	Atividade remota de recuperação do SharePoint.
workIQ	Atividade de recuperação do WorkIQ.
fabricDataAgent	Atividade de recuperação do Fabric Data Agent.
fabricOntology	Atividade de recuperação da Fabric Ontology.
mcpServer	Atividade de recuperação do servidor MCP.
file	Atividade de recuperação de ficheiros.
indexedSql	Atividade de recuperação SQL indexada.
modelQueryPlanning	Atividade de planeamento de consultas de LLM.
modelAnswerSynthesis	Atividade de síntese de respostas LLM.
modelWebSummarization	Atividade de resumo web de LLM.
agenticReasoning	Atividade de raciocínio agente.

KnowledgeBaseAgenticReasoningActivityRecord

Object

Representa um registro de atividade de raciocínio agentico.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
logicalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	O esforço de raciocínio lógico solicitado pelo cliente. Isto é distinto de `retrievalReasoningEffort`, que reporta o esforço de raciocínio utilizado para a faturação.
reasoningTokens	integer (int32)	O número de tokens de entrada para raciocínio agentico.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	A configuração do esforço de raciocínio de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: agenticReasoning	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseAzureBlobActivityArguments

Object

Representa os argumentos com os quais a atividade de recuperação de blob azure foi executada.

Name	Tipo	Descrição
search	string	A cadeia de caracteres de pesquisa usada para consultar o conteúdo do blob.

KnowledgeBaseAzureBlobActivityRecord

Object

Representa um registro de atividade de recuperação de blob azure.

Name	Tipo	Descrição
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Os argumentos azure blob para a atividade de recuperação.
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalhes sobre as expressões geradas a partir de dicas de consulta para esta atividade.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: azureBlob	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseAzureBlobReference

Object

Representa uma referência de documento do Armazenamento de Blobs do Azure.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
blobUrl	string	O URL de blob para a referência.
citationUrl	string (uri)	Um URL pertencente à pesquisa que aponta para o documento de apoio desta referência, utilizável como alvo de citação.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	A informação do rótulo de sensibilidade para a referência.
sourceData		Os dados de origem para a referência.
type	string: azureBlob	O tipo de referência.

KnowledgeBaseErrorAdditionalInfo

Object

Informações adicionais sobre o erro de gestão de recursos.

Name	Tipo	Descrição
info		As informações adicionais.
type	string	O tipo de informação adicional.

KnowledgeBaseErrorDetail

Object

Os detalhes do erro.

Name	Tipo	Descrição
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	KnowledgeBaseErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O alvo do erro.

KnowledgeBaseFabricDataAgentActivityArguments

Object

Representa os argumentos com que a atividade de recuperação do Fabric Data Agent foi executada.

Name	Tipo	Descrição
search	string	A cadeia de pesquisa usada para consultar a fonte de conhecimento do Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Object

Representa um registo de atividade de recuperação do Fabric Data Agent.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
fabricDataAgentArguments	KnowledgeBaseFabricDataAgentActivityArguments	Os argumentos do Fabric Data Agent para a atividade de recuperação.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: fabricDataAgent	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseFabricDataAgentReference

Object

Representa uma referência de documento do Fabric Data Agent.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
dataAgentId	string	O ID do Agente de Dados Fabric.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
type	string: fabricDataAgent	O tipo de referência.
workspaceId	string	O ID do espaço de trabalho do Fabric.

KnowledgeBaseFabricOntologyActivityArguments

Object

Representa os argumentos com que foi conduzida a atividade de recuperação da Fabric Ontology.

Name	Tipo	Descrição
search	string	A cadeia de pesquisa usada para consultar a fonte de conhecimento da Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Object

Representa um registo de atividade de recuperação da Fabric Ontology.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	Os argumentos da Fabric Ontology para a atividade de recuperação.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: fabricOntology	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseFabricOntologyReference

Object

Representa uma referência documental da Fabric Ontology.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
id	string	O ID da referência.
ontologyId	string	O ID da ontologia dentro do espaço de trabalho.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
type	string: fabricOntology	O tipo de referência.
workspaceId	string	O ID do espaço de trabalho do Fabric.

KnowledgeBaseFileActivityArguments

Object

Representa os argumentos com que a atividade de recuperação de ficheiros foi executada.

Name	Tipo	Descrição
search	string	A cadeia de pesquisa usada para consultar o conteúdo do ficheiro.

KnowledgeBaseFileActivityRecord

Object

Representa um registo de atividade de recuperação de ficheiros.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
fileArguments	KnowledgeBaseFileActivityArguments	Os argumentos do ficheiro para a atividade de recuperação.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalhes sobre as expressões geradas a partir de dicas de consulta para esta atividade.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: file	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseFileReference

Object

Representa uma referência de documento de ficheiro.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
citationUrl	string (uri)	Um URL pertencente à pesquisa que aponta para o documento de apoio desta referência, utilizável como alvo de citação.
docName	string	O nome do documento para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
type	string: file	O tipo de referência.

KnowledgeBaseImageContent

Object

Conteúdo da imagem.

Name	Tipo	Descrição
url	string (uri)	O url da imagem.

KnowledgeBaseIndexedOneLakeActivityArguments

Object

Representa os argumentos com que foi conduzida a atividade de recuperação indexada do OneLake.

Name	Tipo	Descrição
search	string	A cadeia de pesquisa usada para consultar indexava conteúdos do OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Object

Representa um registo indexado de atividade de recuperação do OneLake.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Os argumentos indexados do OneLake para a atividade de recuperação.
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalhes sobre as expressões geradas a partir de dicas de consulta para esta atividade.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: indexedOneLake	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseIndexedOneLakeReference

Object

Representa uma referência indexada de documento OneLake.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
citationUrl	string (uri)	Um URL pertencente à pesquisa que aponta para o documento de apoio desta referência, utilizável como alvo de citação.
docUrl	string	O URL do documento para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	A informação do rótulo de sensibilidade para a referência.
sourceData		Os dados de origem para a referência.
type	string: indexedOneLake	O tipo de referência.

KnowledgeBaseIndexedSharePointActivityArguments

Object

Representa os argumentos com que a atividade indexada de recuperação do SharePoint foi executada.

Name	Tipo	Descrição
search	string	A cadeia de pesquisa usada para consultar conteúdos indexados do SharePoint.

KnowledgeBaseIndexedSharePointActivityRecord

Object

Representa um registo indexado de atividade de recuperação do SharePoint.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	Os argumentos indexados do SharePoint para a atividade de recuperação.
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalhes sobre as expressões geradas a partir de dicas de consulta para esta atividade.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: indexedSharePoint	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseIndexedSharePointReference

Object

Representa uma referência indexada de um documento SharePoint.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
citationUrl	string (uri)	Um URL pertencente à pesquisa que aponta para o documento de apoio desta referência, utilizável como alvo de citação.
docUrl	string	O URL do documento para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	A informação do rótulo de sensibilidade para a referência.
sourceData		Os dados de origem para a referência.
type	string: indexedSharePoint	O tipo de referência.

KnowledgeBaseIndexedSqlActivityArguments

Object

Representa os argumentos com que a atividade de recuperação de SQL indexado foi executada.

Name	Tipo	Descrição
search	string	A cadeia de pesquisa usada para consultar conteúdos SQL indexados.

KnowledgeBaseIndexedSqlActivityRecord

Object

Representa um registo indexado de atividade de recuperação SQL.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	Os argumentos SQL indexados para a atividade de recuperação.
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalhes sobre as expressões geradas a partir de dicas de consulta para esta atividade.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: indexedSql	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseIndexedSqlReference

Object

Representa uma referência de documento SQL do Azure.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
citationUrl	string (uri)	Um URL pertencente à pesquisa que aponta para o documento de apoio desta referência, utilizável como alvo de citação.
docUrl	string	O URL do documento para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
type	string: indexedSql	O tipo de referência.

KnowledgeBaseMcpServerActivityArguments

Object

Representa os argumentos com que a atividade de recuperação do servidor MCP foi executada.

Name	Tipo	Descrição
toolArguments		Os argumentos passaram para a ferramenta de servidor MCP.
toolName	string	O nome da ferramenta servidor MCP usada para a atividade de recuperação.

KnowledgeBaseMcpServerActivityRecord

Object

Representa um registo de atividade de recuperação de servidor MCP.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
mcpServerArguments	KnowledgeBaseMcpServerActivityArguments	O servidor MCP argumenta para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: mcpServer	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseMcpServerReference

Object

Representa uma referência a um documento de servidor MCP.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
title	string	O título do resultado da ferramenta de servidor MCP.
toolName	string	O nome da ferramenta servidor MCP que produziu a referência.
type	string: mcpServer	O tipo de referência.

KnowledgeBaseMessage

Object

O objeto de estilo de mensagem em linguagem natural.

Name	Tipo	Descrição
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	O conteúdo da mensagem.
role	string	O papel da resposta da ferramenta.

KnowledgeBaseMessageContentType

Enumeração

O tipo de conteúdo da mensagem.

Valor	Descrição
text	Tipo de conteúdo de mensagem de texto.
image	Tipo de conteúdo da mensagem de imagem.

KnowledgeBaseMessageImageContent

Object

Tipo de mensagem de imagem.

Name	Tipo	Descrição
image	KnowledgeBaseImageContent	O conteúdo da imagem.
type	string: image	O tipo da mensagem

KnowledgeBaseMessageTextContent

Object

Tipo de mensagem de texto.

Name	Tipo	Descrição
text	string	O conteúdo do texto.
type	string: text	O tipo da mensagem

KnowledgeBaseModelAnswerSynthesisActivityRecord

Object

Representa um registro de atividade de síntese de resposta LLM.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
inputTokens	integer (int32)	O número de tokens de entrada para a atividade de síntese de resposta LLM.
model	KnowledgeBaseActivityRecordModel	O modelo utilizado para a atividade de síntese de respostas do LLM.
outputTokens	integer (int32)	O número de tokens de saída para a atividade de síntese de resposta LLM.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: modelAnswerSynthesis	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseModelQueryPlanningActivityRecord

Object

Representa um registro de atividade de planejamento de consulta LLM.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
inputTokens	integer (int32)	O número de tokens de entrada para a atividade de planejamento de consulta LLM.
model	KnowledgeBaseActivityRecordModel	O modelo utilizado para a atividade de planeamento de consultas do LLM.
outputTokens	integer (int32)	O número de tokens de saída para a atividade de planejamento de consulta LLM.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: modelQueryPlanning	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseModelWebSummarizationActivityRecord

Object

Representa um registo de atividade de sumarização web de LLM.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
inputTokens	integer (int32)	O número de tokens de entrada para a atividade de sumarização web do LLM.
model	KnowledgeBaseActivityRecordModel	O modelo utilizado para a atividade de resumo web de LLM.
outputTokens	integer (int32)	O número de tokens de saída para a atividade de sumarização web do LLM.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: modelWebSummarization	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseQueryHintProcessing

Object

Detalhes sobre as expressões geradas a partir de dicas de consulta para uma atividade de recuperação.

Name	Tipo	Descrição
generatedBoost	string	A cláusula de pesquisa gerada a partir de dicas de boost para esta atividade.
generatedFilter	string	A expressão do filtro gerada a partir das dicas do filtro para esta atividade.

KnowledgeBaseReferenceType

Enumeração

O tipo de referência.

Valor	Descrição
searchIndex	Pesquise índice de referência de documentos.
azureBlob	Referência de documento Azure Blob.
indexedSharePoint	Referência indexada do documento SharePoint.
indexedOneLake	Referência indexada do documento OneLake.
web	Referência de documentos web.
remoteSharePoint	Referência remota de documentos do SharePoint.
workIQ	Referência do documento Work IQ.
fabricDataAgent	Referência do documento Fabric Data Agent.
fabricOntology	Referência do documento Fabric Ontology.
mcpServer	Referência do documento do servidor MCP.
file	Apresente referência de documento.
indexedSql	Referência indexada de documentos SQL.

KnowledgeBaseRemoteSharePointActivityArguments

Object

Representa os argumentos com que a atividade remota de recuperação do SharePoint foi executada.

Name	Tipo	Descrição
filterExpressionAddOn	string	O complemento de expressão de filtro para a atividade de recuperação.
search	string	A cadeia de pesquisa usada para consultar a fonte remota de conhecimento do SharePoint.

KnowledgeBaseRemoteSharePointActivityRecord

Object

Representa um registo de atividade de recuperação remota do SharePoint.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	Os argumentos do SharePoint remoto para a atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: remoteSharePoint	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseRemoteSharePointReference

Object

Representa uma referência de documento remoto do SharePoint.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	A informação do rótulo de sensibilidade para a referência.
sourceData		Os dados de origem para a referência.
type	string: remoteSharePoint	O tipo de referência.
webUrl	string (uri)	A URL de onde os dados de referência se originaram.

KnowledgeBaseRetrievalRequest

Object

O contrato de entrada para a solicitação de recuperação.

Name	Tipo	Descrição
includeActivity	boolean	Indica que os resultados da recuperação devem incluir informações sobre a atividade.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Uma lista de consultas pretendidas a serem executadas sem planejamento de consulta de modelo.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Uma lista de parâmetros de tempo de execução para as fontes de conhecimento.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos na saída.
maxOutputSize	integer (int32)	Limita o tamanho máximo do conteúdo na saída.
maxOutputSizeInTokens	integer (int32)	Limita o tamanho máximo do conteúdo na saída.
maxRuntimeInSeconds	integer (int32)	O tempo de execução máximo em segundos.
messages	KnowledgeBaseMessage[]	Uma lista de entrada de estilo de mensagem de chat.
outputMode	KnowledgeRetrievalOutputMode	A configuração de saída para essa recuperação.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	A configuração do esforço de raciocínio de recuperação.

KnowledgeBaseRetrievalResponse

Object

O contrato de saída para a resposta de recuperação.

Name	Tipo	Descrição
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseFabricDataAgentActivityRecord[] KnowledgeBaseFabricOntologyActivityRecord[] KnowledgeBaseFileActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseIndexedSqlActivityRecord[] KnowledgeBaseMcpServerActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[] KnowledgeBaseWorkIQActivityRecord[]	Os registros de atividade para acompanhar o progresso e as implicações de faturamento.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseFabricDataAgentReference[] KnowledgeBaseFabricOntologyReference[] KnowledgeBaseFileReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseIndexedSqlReference[] KnowledgeBaseMcpServerReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[] KnowledgeBaseWorkIQReference[]	As referências para os dados de recuperação usados na resposta.
response	KnowledgeBaseMessage[]	As mensagens de resposta.
responseSensitivityLabelInfo	PurviewSensitivityLabelInfo	A informação do rótulo de sensibilidade para a resposta global.

KnowledgeBaseSearchIndexActivityArguments

Object

Representa os argumentos com os quais a atividade de recuperação do índice de pesquisa foi executada.

Name	Tipo	Descrição
filter	string	A cadeia de caracteres do filtro.
queryType	QueryType	A sintaxe da consulta usada para executar a pesquisa. As dicas de consulta podem fazer com que as consultas semânticas usem a sintaxe completa da consulta.
search	string	A cadeia de caracteres de pesquisa usada para consultar o índice de pesquisa.
searchFields	SearchIndexFieldReference[]	Quais campos foram pesquisados.
semanticConfigurationName	string	Que configuração semântica foi usada a partir do índice de pesquisa.
sourceDataFields	SearchIndexFieldReference[]	Que campos foram selecionados para pesquisa.

KnowledgeBaseSearchIndexActivityRecord

Object

Representa um registro de atividade de recuperação de índice de pesquisa.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalhes sobre as expressões geradas a partir de dicas de consulta para esta atividade.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Os argumentos do índice de pesquisa para a atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: searchIndex	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.

KnowledgeBaseSearchIndexReference

Object

Representa uma referência de documento da Pesquisa do Azure.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
citationUrl	string (uri)	Um URL pertencente à pesquisa que aponta para o documento de apoio desta referência, utilizável como alvo de citação.
docKey	string	A chave do documento para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	A informação do rótulo de sensibilidade para a referência.
sourceData		Os dados de origem para a referência.
type	string: searchIndex	O tipo de referência.

KnowledgeBaseWebActivityArguments

Object

Representa os argumentos com que a atividade de recuperação da web foi conduzida.

Name	Tipo	Descrição
count	integer (int32)	O número de resultados web devolvido.
freshness	string	A frescura para a atividade de recolha.
language	string	A linguagem para a atividade de recuperação.
market	string	O mercado para a atividade de recuperação.
search	string	A cadeia de pesquisa usada para consultar a web.

KnowledgeBaseWebActivityRecord

Object

Representa um registo de atividade de recuperação web.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: web	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.
webArguments	KnowledgeBaseWebActivityArguments	Os argumentos da web para a atividade de recuperação.

KnowledgeBaseWebReference

Object

Representa uma referência de documento web.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
sourceData		Os dados de origem para a referência.
title	string	O título do documento web.
type	string: web	O tipo de referência.
url	string (uri)	A URL de onde os dados de referência se originaram.

KnowledgeBaseWorkIQActivityArguments

Object

Representa os argumentos com que a atividade de recuperação do WorkIQ foi conduzida.

Name	Tipo	Descrição
search	string	A cadeia de pesquisa usada para consultar a fonte de conhecimento do WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Object

Representa um registo de atividade de recuperação WorkIQ.

Name	Tipo	Descrição
completedAt	string (date-time)	O momento em que a atividade foi concluída.
count	integer (int32)	A contagem de documentos recuperados que foram suficientemente relevantes para ultrapassar o limiar de reclassificação.
elapsedMs	integer (int32)	O tempo decorrido em milissegundos para a atividade de recuperação.
error	KnowledgeBaseErrorDetail	O detalhe do erro explicando por que a operação falhou. Esta propriedade só é incluída quando a atividade não é bem-sucedida.
id	integer (int32)	A ID do registro de atividade.
imageServing	ImageServingStatistics	Estatísticas sobre a função de imagem para esta atividade de recuperação
knowledgeSourceName	string	A fonte de conhecimento para a atividade de recuperação.
queryTime	string (date-time)	O tempo de consulta para essa atividade de recuperação.
startedAt	string (date-time)	A hora em que a atividade começou.
type	string: workIQ	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela potenciais problemas de configuração observados durante a atividade, como documentos perdidos devido ao limiar de pontuação, truncamento do limite de tokens ou condições de timeout.
workIQArguments	KnowledgeBaseWorkIQActivityArguments	Os argumentos do WorkIQ para a atividade de recuperação.

KnowledgeBaseWorkIQReference

Object

Representa uma referência de documento WorkIQ.

Name	Tipo	Descrição
activitySource	integer (int32)	O ID da atividade de origem para a referência.
id	string	O ID da referência.
rerankerScore	number (float)	A pontuação do reclassificador para a referência do documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	A informação do rótulo de sensibilidade para a referência.
sourceData		Os dados de origem para a referência.
type	string: workIQ	O tipo de referência.

KnowledgeRetrievalAutoReasoningEffort

Object

Selecione automaticamente o esforço de raciocínio durante a recuperação. O serviço coloca cada pedido no nível mais barato e escala apenas até onde for necessário, até ao nível máximo disponível do serviço.

Name	Tipo	Descrição
kind	string: auto	O tipo de esforço de raciocínio.

KnowledgeRetrievalIntentType

Enumeração

O tipo de configuração da base de dados de conhecimento a ser usada.

Valor	Descrição
semantic	Uma intenção de consulta semântica em linguagem natural.

KnowledgeRetrievalLowReasoningEffort

Object

Execute a recuperação de conhecimento com baixo esforço de raciocínio.

Name	Tipo	Descrição
kind	string: low	O tipo de esforço de raciocínio.

KnowledgeRetrievalMediumReasoningEffort

Object

Execute a recuperação de conhecimento com esforço de raciocínio médio.

Name	Tipo	Descrição
kind	string: medium	O tipo de esforço de raciocínio.

KnowledgeRetrievalMinimalReasoningEffort

Object

Execute a recuperação de conhecimento com o mínimo esforço de raciocínio.

Name	Tipo	Descrição
kind	string: minimal	O tipo de esforço de raciocínio.

KnowledgeRetrievalOutputMode

Enumeração

A configuração de saída para essa recuperação.

Valor	Descrição
extractiveData	Retornar dados das fontes de conhecimento diretamente, sem alteração generativa.
answerSynthesis	Sintetize uma resposta para a carga útil de resposta.

KnowledgeRetrievalReasoningEffortKind

Enumeração

A quantidade de esforço a utilizar durante a recuperação.

Valor	Descrição
minimal	Não executa nenhuma seleção de origem, planejamento de consulta ou pesquisa iterativa.
low	Use raciocínio baixo durante a recuperação.
medium	Use uma quantidade moderada de raciocínio durante a recuperação.
auto	Seleciona automaticamente o esforço de raciocínio durante a recuperação, escalando do nível mais barato apenas até onde for necessário.

KnowledgeRetrievalSemanticIntent

Object

Uma intenção de consulta semântica.

Name	Tipo	Descrição
search	string	A consulta semântica a ser executada
type	string: semantic	O tipo de intenção.

KnowledgeSourceKind

Enumeração

O tipo de fonte de conhecimento.

Valor	Descrição
searchIndex	Uma fonte de conhecimento que lê dados de um índice de pesquisa.
azureBlob	Uma fonte de conhecimento que lê e ingere dados do Armazenamento de Blobs do Azure para um Índice de Pesquisa.
indexedSharePoint	Uma fonte de conhecimento que lê dados do SharePoint indexado.
indexedOneLake	Uma fonte de conhecimento que lê dados do OneLake indexado.
indexedSql	Uma fonte de conhecimento que recupera e ingere dados do Base de Dados SQL do Azure ou SQL Managed Instance para um Índice de Pesquisa.
web	Uma fonte de conhecimento que lê dados da web.
remoteSharePoint	Uma fonte de conhecimento que lê dados do SharePoint remoto.
workIQ	Uma fonte de conhecimento que lê dados do QI de trabalho
file	Uma fonte de conhecimento que suporta o upload e indexação direta de ficheiros.
mcpServer	Uma fonte de conhecimento apoiada por um servidor MCP (Model Context Protocol).
fabricDataAgent	Uma fonte de conhecimento que recupera dados de um Fabric Data Agent.
fabricOntology	Uma fonte de conhecimento que recupera dados das ontologias Microsoft Fabric Ontology.

KnowledgeSourceResultsProcessing

Enumeração

Controla se os resultados de uma fonte de conhecimento são reclassificados.

Valor	Descrição
rerank	Os resultados desta fonte de conhecimento passam pelo pipeline de reclassificação. Este é o comportamento padrão.
none	Os resultados desta fonte de conhecimento contornam a reclassificação e preservam a sua ordem subjacente.

McpServerKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento de servidor MCP

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: mcpServer	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

PurviewSensitivityLabelInfo

Object

Informação sobre o rótulo de sensibilidade aplicado a um documento

Name	Tipo	Descrição
color	string	A cor que a interface do usuário deve exibir para o rótulo, se configurada.
displayName	string	O nome para exibição do rótulo de sensibilidade.
isEncrypted	boolean	Indica se o rótulo de sensibilidade impõe criptografia.
priority	integer (int32)	A prioridade na qual o rótulo de sensibilidade é aplicado.
sensitivityLabelId	string	A ID do rótulo de sensibilidade.
toolTip	string	A dica de ferramenta que deve ser exibida para o rótulo em uma interface do usuário.

QueryType

Enumeração

Especifica a sintaxe da consulta de pesquisa. O padrão é 'simples'. Use 'completo' se sua consulta usar a sintaxe de consulta Lucene e 'semântica' se a sintaxe de consulta não for necessária.

Valor	Descrição
simple	Usa a sintaxe de consulta simples para pesquisas. O texto de pesquisa é interpretado usando uma linguagem de consulta simples que permite símbolos como +, * e "". As consultas são avaliadas em todos os campos pesquisáveis por padrão, a menos que o parâmetro searchFields seja especificado.
full	Usa a sintaxe de consulta Lucene completa para pesquisas. O texto de pesquisa é interpretado usando a linguagem de consulta Lucene, que permite pesquisas ponderadas e específicas de campo, bem como outros recursos avançados.
semantic	Mais adequado para consultas expressas em linguagem natural em vez de palavras-chave. Melhora a precisão dos resultados da pesquisa reclassificando os principais resultados de pesquisa usando um modelo de classificação treinado no corpus da Web.

RemoteSharePointKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento remota do SharePoint

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
filterExpressionAddOn	string	Uma condição de filtro aplicada à fonte de dados do SharePoint. Ele deve ser especificado na sintaxe Keyword Query Language. Ele será combinado como uma conjunção com a expressão de filtro especificada na definição da fonte de conhecimento.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: remoteSharePoint	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

SearchIndexFieldReference

Object

Referência de campo para um índice de pesquisa.

Name	Tipo	Descrição
name	string	O nome do campo.

SearchIndexKnowledgeSourceBoostKind

Enumeração

O tipo de dica de impulso para uma fonte de conhecimento de índice de pesquisa.

Valor	Descrição
fieldValue	Impulsione documentos com base num valor de campo.
multiWordExpression	Impulsione documentos com base numa expressão de várias palavras.

SearchIndexKnowledgeSourceFieldValueBoost

Object

Uma dica que melhora documentos com base no valor de um campo.

Name	Tipo	Descrição
boost	number (double)	Um multiplicador para a pontuação do documento. Deve ser um número positivo não igual a 1,0.
boostInstructions	string	Instruções em linguagem natural que explicam quando e como aplicar o impulso.
field	string minLength: 1	O nome do campo índice de pesquisa.
fieldValues	string[]	Valores representativos para o campo.
kind	string: fieldValue	O tipo de dica de boost.

SearchIndexKnowledgeSourceFilterHint

Object

Uma dica que identifica um campo e valores representativos que o planeador de consultas pode usar ao construir um filtro.

Name	Tipo	Descrição
field	string minLength: 1	O nome do campo de índice de pesquisa filtrável.
fieldValues	string[]	Valores representativos para o campo.
filterInstructions	string	Instruções em linguagem natural que explicam quando e como filtrar no campo.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Object

Uma dica que melhora documentos com base numa expressão de várias palavras.

Name	Tipo	Descrição
boost	number (double)	Um multiplicador para a pontuação do documento. Deve ser um número positivo não igual a 1,0.
boostInstructions	string	Instruções em linguagem natural que explicam quando e como aplicar o impulso.
fieldValues	string[]	Valores representativos para o impulso.
kind	string: multiWordExpression	O tipo de dica de boost.

SearchIndexKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento de índice de pesquisa

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
filterAddOn	string	Uma condição de filtro aplicada ao índice (por exemplo, «State eq VA»).
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: searchIndex	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que orientam o planeamento das consultas para filtros e impulsos úteis. Se especificado, este objeto substitui o conjunto completo de dicas de consulta configuradas na fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

SearchIndexKnowledgeSourceQueryHints

Object

Dicas que orientam o planeamento das consultas para filtros úteis e reforços para uma fonte de conhecimento de índice de pesquisa.

Name	Tipo	Descrição
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Impulsione dicas que identificam condições que o planeador de consultas pode usar para influenciar a classificação dos documentos.
filters	SearchIndexKnowledgeSourceFilterHint[]	Dicas de filtro que identificam campos e valores representativos que o planeador de consultas pode usar ao construir filtros.

ServedImage

Object

Descreve uma única imagem que o modelo selecionou para ser servida durante uma atividade de recuperação.

Name	Tipo	Descrição
imageId	string	A etiqueta da imagem extraída do documento de origem pelo Content Understanding enrichment. Corresponde à numeração das figuras no documento original.
imagePath	string	O caminho relativo até à imagem dentro da loja de assets.
sizeBytes	integer (int64)	O tamanho em bytes desta imagem foi enviado para o modelo.

WebKnowledgeSourceParams

Object

Especifica parâmetros de tempo de execução para uma fonte de conhecimento da Web

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
count	integer (int32)	O número de resultados da Web a serem retornados.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
freshness	string	A frescura dos resultados da web.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: web	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
language	string	O idioma dos resultados da web.
market	string	O mercado dos resultados web.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.

WorkIQKnowledgeSourceParams

Object

Especifica parâmetros de execução para uma fonte de conhecimento WorkIQ

Name	Tipo	Descrição
alwaysQuerySource	boolean	Indica que essa fonte de conhecimento deve ignorar a seleção da fonte e sempre ser consultada no momento da recuperação.
enableImageServing	boolean	Indica se o serviço de imagem deve ser ativado para esta fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues para modelos a jusante.
failOnError	boolean	Indica que todo o pedido de recuperação deverá falhar se a recuperação desta fonte de conhecimento encontrar um erro. É definido para false por padrão.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga útil.
includeReferences	boolean	Indica se devem ser incluídas referências para os dados recuperados dessa fonte.
kind	string: workIQ	O tipo de fonte de conhecimento.
knowledgeSourceName	string	O nome do índice ao qual os parâmetros se aplicam.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos devolvidos desta fonte de conhecimento.
neverQuerySource	boolean	Indica que esta fonte de conhecimento deve ser excluída do conjunto de candidatos do pedido e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a pertença à base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
rerankerThreshold	number (float)	O limite de reclassificação que todos os documentos recuperados devem cumprir para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento apenas para esta chamada de recuperação. Quando omitido, aplica-se o valor da fonte de conhecimento armazenado.