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 de URI

Nome	Em	Obrigatório	Tipo	Description
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 dados de conhecimento.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Cabeçalho da solicitação

Nome	Tipo	Description
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. Esse 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 usuário para um registro de aplicativo Entra de propriedade do cliente, configurado em uma 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 da solicitação

Nome	Tipo	Description
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 máximo de execução 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

Nome	Tipo	Description
200 OK	KnowledgeBaseRetrievalResponse	Resposta de coleta 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
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Escopos

Nome	Description
https://search.azure.com/.default

Exemplos

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveAzureBlobImageServing

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Solicitação de exemplo

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 de exemplo

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

Solicitação de exemplo

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 de exemplo

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

Solicitação de exemplo

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 de exemplo

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

Solicitação de exemplo

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 de exemplo

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

Nome	Description
Accept	O cabeçalho Aceitar.
AzureBlobKnowledgeSourceParams	Especifica parâmetros de runtime para uma fonte de conhecimento de blob do Azure
ErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro comum para todas as APIs do Azure Resource Manager retornarem detalhes de erro para operações com falha. (Isso também segue o formato de resposta de erro OData.).
FabricDataAgentKnowledgeSourceParams	Especifica parâmetros de runtime para uma fonte de conhecimento do Fabric Data Agent
FabricOntologyKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento do Fabric Ontology
FileKnowledgeSourceParams	Especifica parâmetros de runtime para uma fonte de conhecimento de arquivo
ImageServingStatistics	Estatísticas sobre a aplicação de imagem durante uma atividade de recuperação.
IndexedOneLakeKnowledgeSourceParams	Especifica parâmetros de runtime para uma fonte de conhecimento indexada do OneLake
IndexedSharePointKnowledgeSourceParams	Especifica parâmetros de tempo de execução para uma fonte de conhecimento indexada do SharePoint
IndexedSqlKnowledgeSourceParams	Especifica parâmetros de runtime para uma fonte de conhecimento SQL indexada
KnowledgeBaseActivityRecordModel	Representa o modelo usado para uma atividade de LLM de base de conhecimento, incluindo seu nome do modelo e identificador de implantação.
KnowledgeBaseActivityRecordType	O tipo de registro de atividade.
KnowledgeBaseAgenticReasoningActivityRecord	Representa um registro de atividade de raciocínio agente.
KnowledgeBaseAzureBlobActivityArguments	Representa os argumentos com os quais a atividade de recuperação de blob do Azure foi executada.
KnowledgeBaseAzureBlobActivityRecord	Representa um registro de atividade de recuperação de blob do Azure.
KnowledgeBaseAzureBlobReference	Representa uma referência de documento do Armazenamento de Blobs do Azure.
KnowledgeBaseErrorAdditionalInfo	Informações adicionais sobre o erro de gerenciamento de recursos.
KnowledgeBaseErrorDetail	Os detalhes do erro.
KnowledgeBaseFabricDataAgentActivityArguments	Representa os argumentos com os quais a atividade de recuperação do Fabric Data Agent foi executada.
KnowledgeBaseFabricDataAgentActivityRecord	Representa um registro 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 a atividade de recuperação da Fabric Ontology foi conduzida.
KnowledgeBaseFabricOntologyActivityRecord	Representa um registro de atividade de recuperação da Fabric Ontology.
KnowledgeBaseFabricOntologyReference	Representa uma referência de documento da Fabric Ontology.
KnowledgeBaseFileActivityArguments	Representa os argumentos com que a atividade de recuperação de arquivos foi executada.
KnowledgeBaseFileActivityRecord	Representa um registro de atividade de recuperação de arquivos.
KnowledgeBaseFileReference	Representa uma referência a um documento de arquivo.
KnowledgeBaseImageContent	Conteúdo de imagens.
KnowledgeBaseIndexedOneLakeActivityArguments	Representa os argumentos com que a atividade de recuperação indexada do OneLake foi conduzida.
KnowledgeBaseIndexedOneLakeActivityRecord	Representa um registro indexado de atividade de recuperação do OneLake.
KnowledgeBaseIndexedOneLakeReference	Representa uma referência indexada de documento OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Representa os argumentos com os quais a atividade indexada de recuperação do SharePoint foi executada.
KnowledgeBaseIndexedSharePointActivityRecord	Representa um registro indexado de atividade de recuperação do SharePoint.
KnowledgeBaseIndexedSharePointReference	Representa uma referência indexada de documento do SharePoint.
KnowledgeBaseIndexedSqlActivityArguments	Representa os argumentos com os quais a atividade de recuperação do SQL indexado foi executada.
KnowledgeBaseIndexedSqlActivityRecord	Representa um registro indexado de atividade de recuperação SQL.
KnowledgeBaseIndexedSqlReference	Representa uma referência de documento SQL do Azure.
KnowledgeBaseMcpServerActivityArguments	Representa os argumentos com os quais a atividade de recuperação do servidor MCP foi conduzida.
KnowledgeBaseMcpServerActivityRecord	Representa um registro de atividade de recuperação de servidor MCP.
KnowledgeBaseMcpServerReference	Representa uma referência de documento de servidor MCP.
KnowledgeBaseMessage	O objeto de estilo de mensagem de 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 do LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Representa um registro de atividade de planejamento de consulta LLM.
KnowledgeBaseModelWebSummarizationActivityRecord	Representa um registro de atividade de resumo 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 registro remoto de atividade de recuperação 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 de í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 do Azure Search.
KnowledgeBaseWebActivityArguments	Representa os argumentos com que a atividade de recuperação web foi conduzida.
KnowledgeBaseWebActivityRecord	Representa um registro de atividade de recuperação web.
KnowledgeBaseWebReference	Representa uma referência de documento da Web.
KnowledgeBaseWorkIQActivityArguments	Representa os argumentos com que a atividade de recuperação do WorkIQ foi conduzida.
KnowledgeBaseWorkIQActivityRecord	Representa um registro de atividade de recuperação do 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 segmenta cada solicitação no nível mais barato e escala apenas até o nível mais alto disponível.
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 de esforço de raciocínio.
KnowledgeRetrievalOutputMode	A configuração de saída para essa recuperação.
KnowledgeRetrievalReasoningEffortKind	A quantidade de esforço a ser usado durante a recuperação.
KnowledgeRetrievalSemanticIntent	Uma intenção de consulta semântica.
KnowledgeSourceKind	O tipo de fonte de conhecimento.
KnowledgeSourceResultsProcessing	Controle 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ções sobre o rótulo de sensibilidade aplicado a um documento
QueryType	Especifica a sintaxe da consulta de pesquisa. O padrão é "simples". Use 'full' 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 busca.
SearchIndexKnowledgeSourceBoostKind	O tipo de dica de impulso para uma fonte de conhecimento de índice de busca.
SearchIndexKnowledgeSourceFieldValueBoost	Uma dica que impulsiona documentos com base no valor de um campo.
SearchIndexKnowledgeSourceFilterHint	Uma dica que identifica um campo e valores representativos que o planejador de consultas pode usar ao construir um filtro.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Uma dica que melhora documentos com base em uma 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 planejamento de consultas para filtros úteis e reforços para uma fonte de conhecimento de índice de busca.
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 tempo de execução para uma fonte de conhecimento WorkIQ

Accept

Enumeração

O cabeçalho Aceitar.

Valor	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objeto

Especifica parâmetros de runtime para uma fonte de conhecimento de blob do Azure

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: azureBlob	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que guiam o planejamento de consultas para filtros e impulsos úteis. Se especificado, esse 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

ErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

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

ErrorDetail

Objeto

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	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

Objeto

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

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

FabricDataAgentKnowledgeSourceParams

Objeto

Especifica parâmetros de runtime para uma fonte de conhecimento do Fabric Data Agent

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: fabricDataAgent	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

FabricOntologyKnowledgeSourceParams

Objeto

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

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: fabricOntology	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

FileKnowledgeSourceParams

Objeto

Especifica parâmetros de runtime para uma fonte de conhecimento de arquivo

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: file	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que guiam o planejamento de consultas para filtros e impulsos úteis. Se especificado, esse 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

ImageServingStatistics

Objeto

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

Nome	Tipo	Description
imagesRetrieved	integer (int32)	O número de imagens recuperadas da loja de ativos.
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 ser servido ao modelo a jusante para essa atividade de recuperação.
totalImageSizeBytes	integer (int64)	O tamanho total em bytes das imagens enviadas ao modelo.
verbalizationUsed	boolean	Indica se a verbalização da imagem foi usada em vez da aplicação direta da imagem.

IndexedOneLakeKnowledgeSourceParams

Objeto

Especifica parâmetros de runtime para uma fonte de conhecimento indexada do OneLake

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: indexedOneLake	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que guiam o planejamento de consultas para filtros e impulsos úteis. Se especificado, esse 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

IndexedSharePointKnowledgeSourceParams

Objeto

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

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: indexedSharePoint	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que guiam o planejamento de consultas para filtros e impulsos úteis. Se especificado, esse 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

IndexedSqlKnowledgeSourceParams

Objeto

Especifica parâmetros de runtime para uma fonte de conhecimento SQL indexada

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: indexedSql	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que guiam o planejamento de consultas para filtros e impulsos úteis. Se especificado, esse 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

KnowledgeBaseActivityRecordModel

Objeto

Representa o modelo usado para uma atividade de LLM de base de conhecimento, incluindo seu nome do modelo e identificador de implantação.

Nome	Tipo	Description
deploymentId	string	O identificador de implantação do modelo usado para a atividade.
modelName	string	O nome do modelo usado para a atividade.

KnowledgeBaseActivityRecordType

Enumeração

O tipo de registro de atividade.

Valor	Description
searchIndex	Atividade de busca de índice de recuperação.
azureBlob	Atividade de recuperação do Azure Blob.
indexedSharePoint	Atividade indexada de recuperação do SharePoint.
indexedOneLake	Atividade de recuperação indexada do OneLake.
web	Atividade de recuperação 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 arquivos.
indexedSql	Atividade de recuperação SQL indexada.
modelQueryPlanning	Atividade de planejamento 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

Objeto

Representa um registro de atividade de raciocínio agente.

Nome	Tipo	Description
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. Essa 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 lógico de raciocínio solicitado pelo cliente. Isso é diferente de `retrievalReasoningEffort`, que relata o esforço de raciocínio usado para a faturação.
reasoningTokens	integer (int32)	O número de tokens de entrada para o raciocínio agente.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	A configuração do esforço de raciocínio de recuperação.
startedAt	string (date-time)	O horário em que a atividade começou.
type	string: agenticReasoning	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseAzureBlobActivityArguments

Objeto

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

Nome	Tipo	Description
search	string	A cadeia de caracteres de pesquisa usada para consultar o conteúdo do blob.

KnowledgeBaseAzureBlobActivityRecord

Objeto

Representa um registro de atividade de recuperação de blob do Azure.

Nome	Tipo	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Os argumentos do blob azul 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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: azureBlob	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseAzureBlobReference

Objeto

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

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
blobUrl	string	A URL do blob para a referência.
citationUrl	string (uri)	Uma URL pertencente à Busca que aponta para o documento de respaldo dessa referência, utilizável como alvo de citação.
id	string	A 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 da referência.

KnowledgeBaseErrorAdditionalInfo

Objeto

Informações adicionais sobre o erro de gerenciamento de recursos.

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

KnowledgeBaseErrorDetail

Objeto

Os detalhes do erro.

Nome	Tipo	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	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

Objeto

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

Nome	Tipo	Description
search	string	A string de busca usada para consultar a fonte de conhecimento do Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Objeto

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

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: fabricDataAgent	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseFabricDataAgentReference

Objeto

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

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
dataAgentId	string	O ID do Agente de Dados Fabric.
id	string	A 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 da referência.
workspaceId	string	A ID do workspace Fabric.

KnowledgeBaseFabricOntologyActivityArguments

Objeto

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

Nome	Tipo	Description
search	string	A string de busca usada para consultar a fonte de conhecimento do Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Objeto

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

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa propriedade só é incluída quando a atividade não é bem-sucedida.
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	Os argumentos da Ontologia Fabric 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)	O horário em que a atividade começou.
type	string: fabricOntology	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseFabricOntologyReference

Objeto

Representa uma referência de documento da Fabric Ontology.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
id	string	A 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 da referência.
workspaceId	string	A ID do workspace Fabric.

KnowledgeBaseFileActivityArguments

Objeto

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

Nome	Tipo	Description
search	string	A string de busca usada para consultar o conteúdo do arquivo.

KnowledgeBaseFileActivityRecord

Objeto

Representa um registro de atividade de recuperação de arquivos.

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa propriedade só é incluída quando a atividade não é bem-sucedida.
fileArguments	KnowledgeBaseFileActivityArguments	Os argumentos do arquivo 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)	O horário em que a atividade começou.
type	string: file	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseFileReference

Objeto

Representa uma referência a um documento de arquivo.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
citationUrl	string (uri)	Uma URL pertencente à Busca que aponta para o documento de respaldo dessa referência, utilizável como alvo de citação.
docName	string	O nome do documento para a referência.
id	string	A 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 da referência.

KnowledgeBaseImageContent

Objeto

Conteúdo de imagens.

Nome	Tipo	Description
url	string (uri)	O url da imagem.

KnowledgeBaseIndexedOneLakeActivityArguments

Objeto

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

Nome	Tipo	Description
search	string	A string de busca usada para consultar indexava o conteúdo do OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Objeto

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

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: indexedOneLake	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseIndexedOneLakeReference

Objeto

Representa uma referência indexada de documento OneLake.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
citationUrl	string (uri)	Uma URL pertencente à Busca que aponta para o documento de respaldo dessa referência, utilizável como alvo de citação.
docUrl	string	A URL do documento para a referência.
id	string	A 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 da referência.

KnowledgeBaseIndexedSharePointActivityArguments

Objeto

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

Nome	Tipo	Description
search	string	A string de busca usada para consultar conteúdos indexados do SharePoint.

KnowledgeBaseIndexedSharePointActivityRecord

Objeto

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

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: indexedSharePoint	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseIndexedSharePointReference

Objeto

Representa uma referência indexada de documento do SharePoint.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
citationUrl	string (uri)	Uma URL pertencente à Busca que aponta para o documento de respaldo dessa referência, utilizável como alvo de citação.
docUrl	string	A URL do documento para a referência.
id	string	A 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 da referência.

KnowledgeBaseIndexedSqlActivityArguments

Objeto

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

Nome	Tipo	Description
search	string	A string de busca usada para consultar conteúdos SQL indexados.

KnowledgeBaseIndexedSqlActivityRecord

Objeto

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

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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 indexados do SQL 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)	O horário em que a atividade começou.
type	string: indexedSql	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseIndexedSqlReference

Objeto

Representa uma referência de documento SQL do Azure.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
citationUrl	string (uri)	Uma URL pertencente à Busca que aponta para o documento de respaldo dessa referência, utilizável como alvo de citação.
docUrl	string	A URL do documento para a referência.
id	string	A 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 da referência.

KnowledgeBaseMcpServerActivityArguments

Objeto

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

Nome	Tipo	Description
toolArguments		Os argumentos foram repassados para a ferramenta de servidor MCP.
toolName	string	O nome da ferramenta servidor MCP usada para a atividade de recuperação.

KnowledgeBaseMcpServerActivityRecord

Objeto

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

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: mcpServer	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseMcpServerReference

Objeto

Representa uma referência de documento de servidor MCP.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
id	string	A 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 da referência.

KnowledgeBaseMessage

Objeto

O objeto de estilo de mensagem de linguagem natural.

Nome	Tipo	Description
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	Description
text	Tipo de conteúdo de mensagem de texto.
image	Tipo de conteúdo da mensagem de imagem.

KnowledgeBaseMessageImageContent

Objeto

Tipo de mensagem de imagem.

Nome	Tipo	Description
image	KnowledgeBaseImageContent	O conteúdo da imagem.
type	string: image	O tipo da mensagem

KnowledgeBaseMessageTextContent

Objeto

Tipo de mensagem de texto.

Nome	Tipo	Description
text	string	O conteúdo do texto.
type	string: text	O tipo da mensagem

KnowledgeBaseModelAnswerSynthesisActivityRecord

Objeto

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

Nome	Tipo	Description
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. Essa 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)	O horário em que a atividade começou.
type	string: modelAnswerSynthesis	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseModelQueryPlanningActivityRecord

Objeto

Representa um registro de atividade de planejamento de consulta LLM.

Nome	Tipo	Description
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. Essa 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 do LLM.
model	KnowledgeBaseActivityRecordModel	O modelo utilizado para a atividade de planejamento 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)	O horário em que a atividade começou.
type	string: modelQueryPlanning	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseModelWebSummarizationActivityRecord

Objeto

Representa um registro de atividade de resumo web de LLM.

Nome	Tipo	Description
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. Essa 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 resumo web do LLM.
model	KnowledgeBaseActivityRecordModel	O modelo utilizado para a atividade de resumo web do LLM.
outputTokens	integer (int32)	O número de tokens de saída para a atividade de resumo web do LLM.
startedAt	string (date-time)	O horário em que a atividade começou.
type	string: modelWebSummarization	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseQueryHintProcessing

Objeto

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

Nome	Tipo	Description
generatedBoost	string	A cláusula de busca gerada a partir de dicas boost para essa atividade.
generatedFilter	string	A expressão do filtro gerada a partir de dicas de filtro para essa atividade.

KnowledgeBaseReferenceType

Enumeração

O tipo de referência.

Valor	Description
searchIndex	Pesquise índice de referência de documentos.
azureBlob	Referência de documento Azure Blob.
indexedSharePoint	Referência indexada de documento do SharePoint.
indexedOneLake	Referência indexada do documento OneLake.
web	Referência de documentos na web.
remoteSharePoint	Referência remota de documentos do SharePoint.
workIQ	Referência de documento de QI de trabalho.
fabricDataAgent	Referência de documento do Fabric Data Agent.
fabricOntology	Referência de documento Fabric Ontology.
mcpServer	Referência de documento do servidor MCP.
file	Arquivo de referência de documento.
indexedSql	Referência indexada de documento SQL.

KnowledgeBaseRemoteSharePointActivityArguments

Objeto

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

Nome	Tipo	Description
filterExpressionAddOn	string	O complemento de expressão do filtro para a atividade de recuperação.
search	string	A string de busca é usada para consultar a fonte remota de conhecimento do SharePoint.

KnowledgeBaseRemoteSharePointActivityRecord

Objeto

Representa um registro remoto de atividade de recuperação do SharePoint.

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: remoteSharePoint	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseRemoteSharePointReference

Objeto

Representa uma referência de documento remoto do SharePoint.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
id	string	A 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 da referência.
webUrl	string (uri)	A url da origem dos dados de referência.

KnowledgeBaseRetrievalRequest

Objeto

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

Nome	Tipo	Description
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 máximo de execução 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

Objeto

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

Nome	Tipo	Description
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 cobrança.
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	As informações do rótulo de sensibilidade para a resposta geral.

KnowledgeBaseSearchIndexActivityArguments

Objeto

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

Nome	Tipo	Description
filter	string	A cadeia de caracteres de filtro.
queryType	QueryType	A sintaxe da consulta usada para executar a busca. Dicas de consulta podem fazer com que 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	Qual configuração semântica foi usada a partir do índice de busca.
sourceDataFields	SearchIndexFieldReference[]	Quais campos foram selecionados para busca.

KnowledgeBaseSearchIndexActivityRecord

Objeto

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

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: searchIndex	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.

KnowledgeBaseSearchIndexReference

Objeto

Representa uma referência de documento do Azure Search.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
citationUrl	string (uri)	Uma URL pertencente à Busca que aponta para o documento de respaldo dessa referência, utilizável como alvo de citação.
docKey	string	A chave do documento para a referência.
id	string	A 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 da referência.

KnowledgeBaseWebActivityArguments

Objeto

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

Nome	Tipo	Description
count	integer (int32)	O número de resultados web retornados.
freshness	string	A frescura para a atividade de recuperação.
language	string	A linguagem para a atividade de recuperação.
market	string	O mercado para a atividade de recuperação.
search	string	A string de busca usada para consultar a web.

KnowledgeBaseWebActivityRecord

Objeto

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

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: web	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.
webArguments	KnowledgeBaseWebActivityArguments	Os argumentos da web para a atividade de recuperação.

KnowledgeBaseWebReference

Objeto

Representa uma referência de documento da Web.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
id	string	A 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 da Web.
type	string: web	O tipo da referência.
url	string (uri)	A url da origem dos dados de referência.

KnowledgeBaseWorkIQActivityArguments

Objeto

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

Nome	Tipo	Description
search	string	A string de busca usada para consultar a fonte de conhecimento do WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Objeto

Representa um registro de atividade de recuperação do WorkIQ.

Nome	Tipo	Description
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 limite do reclassificador.
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. Essa 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)	O horário em que a atividade começou.
type	string: workIQ	O tipo de registro de atividade.
warning	string	Uma mensagem de aviso que revela possíveis problemas de configuração observados durante a atividade, como documentos perdidos devido ao limite de pontuação, truncamento do limite do token ou condições de timeout.
workIQArguments	KnowledgeBaseWorkIQActivityArguments	Os argumentos do WorkIQ para a atividade de recuperação.

KnowledgeBaseWorkIQReference

Objeto

Representa uma referência de documento WorkIQ.

Nome	Tipo	Description
activitySource	integer (int32)	A ID da atividade de origem para a referência.
id	string	A 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 da referência.

KnowledgeRetrievalAutoReasoningEffort

Objeto

Selecione automaticamente o esforço de raciocínio durante a recuperação. O serviço segmenta cada solicitação no nível mais barato e escala apenas até o nível mais alto disponível.

Nome	Tipo	Description
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	Description
semantic	Uma intenção de consulta semântica de linguagem natural.

KnowledgeRetrievalLowReasoningEffort

Objeto

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

Nome	Tipo	Description
kind	string: low	O tipo de esforço de raciocínio.

KnowledgeRetrievalMediumReasoningEffort

Objeto

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

Nome	Tipo	Description
kind	string: medium	O tipo de esforço de raciocínio.

KnowledgeRetrievalMinimalReasoningEffort

Objeto

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

Nome	Tipo	Description
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	Description
extractiveData	Retorne dados das fontes de conhecimento diretamente sem alteração geradora.
answerSynthesis	Sintetize uma resposta para a carga de resposta.

KnowledgeRetrievalReasoningEffortKind

Enumeração

A quantidade de esforço a ser usado durante a recuperação.

Valor	Description
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	Selecione automaticamente o esforço de raciocínio durante a recuperação, escalando do nível mais barato apenas até onde for necessário.

KnowledgeRetrievalSemanticIntent

Objeto

Uma intenção de consulta semântica.

Nome	Tipo	Description
search	string	A consulta semântica a ser executada
type	string: semantic	O tipo da intenção.

KnowledgeSourceKind

Enumeração

O tipo de fonte de conhecimento.

Valor	Description
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 em 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 Banco de Dados SQL do Azure ou Instância Gerenciada de SQL para um Índice de Busca.
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 no trabalho
file	Uma fonte de conhecimento que suporta upload direto de arquivos e indexação.
mcpServer	Uma fonte de conhecimento respaldada 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 do Microsoft Fabric Ontology.

KnowledgeSourceResultsProcessing

Enumeração

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

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

McpServerKnowledgeSourceParams

Objeto

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

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: mcpServer	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

PurviewSensitivityLabelInfo

Objeto

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

Nome	Tipo	Description
color	string	A cor que a interface do usuário deve exibir para o rótulo, se configurado.
displayName	string	O nome de exibição do rótulo de confidencialidade.
isEncrypted	boolean	Indica se o rótulo de confidencialidade impõe criptografia.
priority	integer (int32)	A prioridade na qual o rótulo de confidencialidade é aplicado.
sensitivityLabelId	string	A ID do rótulo de confidencialidade.
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 'full' se sua consulta usar a sintaxe de consulta Lucene e 'semântica' se a sintaxe de consulta não for necessária.

Valor	Description
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 da pesquisa é interpretado usando a linguagem de consulta Lucene, que permite pesquisas ponderadas e específicas do 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 da pesquisa usando um modelo de classificação treinado no corpus da Web.

RemoteSharePointKnowledgeSourceParams

Objeto

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

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
filterExpressionAddOn	string	Uma condição de filtro aplicada à fonte de dados do SharePoint. Ele deve ser especificado na sintaxe da Linguagem de Consulta de Palavra-chave. 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.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: remoteSharePoint	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

SearchIndexFieldReference

Objeto

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

Nome	Tipo	Description
name	string	O nome do campo.

SearchIndexKnowledgeSourceBoostKind

Enumeração

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

Valor	Description
fieldValue	Impulsione documentos com base no valor de um campo.
multiWordExpression	Impulsione documentos baseados em uma expressão de várias palavras.

SearchIndexKnowledgeSourceFieldValueBoost

Objeto

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

Nome	Tipo	Description
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 busca.
fieldValues	string[]	Valores representativos para o campo.
kind	string: fieldValue	Aquele tipo de dica de impulso.

SearchIndexKnowledgeSourceFilterHint

Objeto

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

Nome	Tipo	Description
field	string minLength: 1	O nome do campo índice de busca 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

Objeto

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

Nome	Tipo	Description
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	Aquele tipo de dica de impulso.

SearchIndexKnowledgeSourceParams

Objeto

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

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
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.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: searchIndex	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da base de conhecimento. Não pode ser combinado com alwaysQuerySource na mesma fonte de conhecimento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Dicas que guiam o planejamento de consultas para filtros e impulsos úteis. Se especificado, esse 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

SearchIndexKnowledgeSourceQueryHints

Objeto

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

Nome	Tipo	Description
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Impulsione dicas que identificam condições que o planejador de consultas pode usar para influenciar o ranking do documento.
filters	SearchIndexKnowledgeSourceFilterHint[]	Dicas de filtro que identificam campos e valores representativos que o planejador de consultas pode usar ao construir filtros.

ServedImage

Objeto

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

Nome	Tipo	Description
imageId	string	O rótulo da imagem extraído do documento fonte pelo enriquecimento de Compreensão de Conteúdo. Corresponde à numeração das figuras no documento original.
imagePath	string	O caminho relativo até a imagem dentro do asset store.
sizeBytes	integer (int64)	O tamanho em bytes dessa imagem enviado ao modelo.

WebKnowledgeSourceParams

Objeto

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

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
freshness	string	O frescor dos resultados da web.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: web	O tipo da 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 da web.
maxOutputDocuments	integer (int32)	Limita o número máximo de documentos retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.

WorkIQKnowledgeSourceParams

Objeto

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

Nome	Tipo	Description
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 essa fonte de conhecimento no momento da recuperação. Quando verdade, as imagens extraídas durante a ingestão são entregues a modelos posteriores.
failOnError	boolean	Indica que toda a solicitação de recuperação deve falhar se a recuperação dessa fonte de conhecimento encontrar um erro. O padrão é false.
includeReferenceSourceData	boolean	Indica se as referências devem incluir os dados estruturados obtidos durante a recuperação em sua carga.
includeReferences	boolean	Indica se as referências devem ser incluídas para dados recuperados dessa fonte.
kind	string: workIQ	O tipo da 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 retornados dessa fonte de conhecimento.
neverQuerySource	boolean	Indica que essa fonte de conhecimento deve ser excluída do conjunto de candidatos da solicitação e nunca consultada no momento da recuperação. A exclusão é request-local e não modifica a membresia da 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 atender para serem incluídos na resposta.
resultsProcessing	KnowledgeSourceResultsProcessing	Sobrepõe os resultados armazenados da fonte de conhecimento Processing apenas para esta chamada de recuperação. Quando omitido, o valor da fonte de conhecimento armazenado se aplica.