Knowledge Retrieval - Retrieve

Servicio:: Search Service

Versión de la API:: 2026-08-01-preview

KnowledgeBase recupera datos relevantes de los almacenes de respaldo.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	La dirección URL del punto de conexión del servicio de búsqueda.
knowledgeBaseName	path	True	string	Nombre de la base de conocimiento.
api-version	query	True	string minLength: 1	Versión de la API que se va a usar para esta operación.

Encabezado de la solicitud

Nombre	Tipo	Description
Accept	Accept	El encabezado Aceptar.
x-ms-query-source-authorization	string	Token que identifica al usuario para el que se ejecuta la consulta. Este token se utiliza para aplicar restricciones de seguridad en los documentos.
x-ms-query-work-iq-source-authorization	string (password)	Token de aserción de usuario para un registro de una app propiedad del cliente configurado en una fuente de conocimiento de Work IQ. Utilizado para la autenticación en nombre de la API de Work IQ.
x-ms-client-request-id	string (uuid)	Identificador de cadena globalmente único y generado por el cliente para la solicitud.

Cuerpo de la solicitud

Nombre	Tipo	Description
includeActivity	boolean	Indica que los resultados de la recuperación deben incluir información de la actividad.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Una lista de consultas previstas para ejecutar sin planear consultas de modelo.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Una lista de parámetros de tiempo de ejecución para los orígenes de conocimiento.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos en la salida.
maxOutputSize	integer (int32)	Limita el tamaño máximo del contenido de la salida.
maxOutputSizeInTokens	integer (int32)	Limita el tamaño máximo del contenido de la salida.
maxRuntimeInSeconds	integer (int32)	El tiempo máximo de ejecución en segundos.
messages	KnowledgeBaseMessage[]	Una lista de entradas de estilo de mensajes de chat.
outputMode	KnowledgeRetrievalOutputMode	La configuración de salida para esta recuperación.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configuración del esfuerzo de razonamiento de recuperación.

Respuestas

Nombre	Tipo	Description
200 OK	KnowledgeBaseRetrievalResponse	Respuesta de extracción exitosa.
Other Status Codes	KnowledgeBaseRetrievalResponse	Respuesta de recuperación parcial.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada.

Seguridad

api-key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Ámbitos

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

Ejemplos

KnowledgeBaseRetrieve

KnowledgeBaseRetrieveAzureBlobImageServing

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieveWithSourceExclusion

KnowledgeBaseRetrieve

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
      }
    }
  ]
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
      }
    }
  ]
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
      }
    }
  ]
}

status code:: 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

Solicitud de ejemplo

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

Respuesta de muestra

status code:: 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"
    }
  ]
}

status code:: 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"
    }
  ]
}

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
AzureBlobKnowledgeSourceParams	Especifica parámetros en tiempo de ejecución para un origen de conocimiento de blobs de Azure
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).
FabricDataAgentKnowledgeSourceParams	Especifica parámetros de ejecución para una fuente de conocimiento del Fabric Data Agent
FabricOntologyKnowledgeSourceParams	Especifica parámetros de ejecución para una fuente de conocimiento de Fabric Ontology
FileKnowledgeSourceParams	Especifica parámetros de ejecución para una fuente de conocimiento de archivo
ImageServingStatistics	Estadísticas sobre la aplicación de imágenes durante una actividad de recuperación.
IndexedOneLakeKnowledgeSourceParams	Especifica parámetros de tiempo de ejecución para un origen de conocimiento de OneLake indexado
IndexedSharePointKnowledgeSourceParams	Especifica parámetros en tiempo de ejecución para un origen de conocimiento de SharePoint indexado
IndexedSqlKnowledgeSourceParams	Especifica parámetros de ejecución para una fuente de conocimiento SQL indexada
KnowledgeBaseActivityRecordModel	Representa el modelo utilizado para una actividad de LLM en una base de conocimiento, incluyendo su nombre de modelo e identificador de despliegue.
KnowledgeBaseActivityRecordType	El tipo de registro de actividad.
KnowledgeBaseAgenticReasoningActivityRecord	Representa un registro de actividad de razonamiento agente.
KnowledgeBaseAzureBlobActivityArguments	Representa los argumentos con los que se ejecutó la actividad de recuperación de blobs de Azure.
KnowledgeBaseAzureBlobActivityRecord	Representa un registro de actividad de recuperación de blobs de Azure.
KnowledgeBaseAzureBlobReference	Representa una referencia de documento de Azure Blob Storage.
KnowledgeBaseErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
KnowledgeBaseErrorDetail	Detalles del error.
KnowledgeBaseFabricDataAgentActivityArguments	Representa los argumentos con los que se ejecutó la actividad de recuperación del Fabric Data Agent.
KnowledgeBaseFabricDataAgentActivityRecord	Representa un registro de actividad de recuperación del Fabric Data Agent.
KnowledgeBaseFabricDataAgentReference	Representa una referencia documental del Fabric Data Agent.
KnowledgeBaseFabricOntologyActivityArguments	Representa los argumentos con los que se ejecutó la actividad de recuperación de la Ontología Fabric.
KnowledgeBaseFabricOntologyActivityRecord	Representa un registro de actividad de recuperación de Fabric Ontology.
KnowledgeBaseFabricOntologyReference	Representa una referencia documental de Fabric Ontology.
KnowledgeBaseFileActivityArguments	Representa los argumentos con los que se ejecutó la actividad de recuperación de archivos.
KnowledgeBaseFileActivityRecord	Representa un registro de actividad de recuperación de archivos.
KnowledgeBaseFileReference	Representa una referencia a un documento de archivo.
KnowledgeBaseImageContent	Contenido de la imagen.
KnowledgeBaseIndexedOneLakeActivityArguments	Representa los argumentos con los que se llevó a cabo la actividad de recuperación indexada de OneLake.
KnowledgeBaseIndexedOneLakeActivityRecord	Representa un registro indexado de actividad de recuperación de OneLake.
KnowledgeBaseIndexedOneLakeReference	Representa una referencia indexada de un documento OneLake.
KnowledgeBaseIndexedSharePointActivityArguments	Representa los argumentos con los que se ejecutó la actividad de recuperación indexada de SharePoint.
KnowledgeBaseIndexedSharePointActivityRecord	Representa un registro indexado de actividad de recuperación de SharePoint.
KnowledgeBaseIndexedSharePointReference	Representa una referencia indexada de un documento de SharePoint.
KnowledgeBaseIndexedSqlActivityArguments	Representa los argumentos con los que se ejecutó la actividad de recuperación de SQL indexado.
KnowledgeBaseIndexedSqlActivityRecord	Representa un registro indexado de actividad de recuperación SQL.
KnowledgeBaseIndexedSqlReference	Representa una referencia de documento Azure SQL.
KnowledgeBaseMcpServerActivityArguments	Representa los argumentos con los que se ejecutó la actividad de recuperación del servidor MCP.
KnowledgeBaseMcpServerActivityRecord	Representa un registro de actividad de recuperación de servidor MCP.
KnowledgeBaseMcpServerReference	Representa una referencia de documento de servidor MCP.
KnowledgeBaseMessage	El objeto de estilo de mensaje de lenguaje natural.
KnowledgeBaseMessageContentType	El tipo de contenido del mensaje.
KnowledgeBaseMessageImageContent	Tipo de mensaje de imagen.
KnowledgeBaseMessageTextContent	Tipo de mensaje de texto.
KnowledgeBaseModelAnswerSynthesisActivityRecord	Representa un registro de actividad de síntesis de respuestas LLM.
KnowledgeBaseModelQueryPlanningActivityRecord	Representa un registro de actividad de planeación de consultas LLM.
KnowledgeBaseModelWebSummarizationActivityRecord	Representa un registro de actividad de resumen web de LLM.
KnowledgeBaseQueryHintProcessing	Detalles sobre las expresiones generadas a partir de pistas de consulta para una actividad de recuperación.
KnowledgeBaseReferenceType	El tipo de referencia.
KnowledgeBaseRemoteSharePointActivityArguments	Representa los argumentos con los que se ejecutó la actividad remota de recuperación de SharePoint.
KnowledgeBaseRemoteSharePointActivityRecord	Representa un registro remoto de actividad de recuperación de SharePoint.
KnowledgeBaseRemoteSharePointReference	Representa una referencia de documento remoto de SharePoint.
KnowledgeBaseRetrievalRequest	El contrato de entrada para la solicitud de recuperación.
KnowledgeBaseRetrievalResponse	El contrato de salida para la respuesta de recuperación.
KnowledgeBaseSearchIndexActivityArguments	Representa los argumentos con los que se ejecutó la actividad de recuperación del índice de búsqueda.
KnowledgeBaseSearchIndexActivityRecord	Representa un registro de actividad de recuperación de índice de búsqueda.
KnowledgeBaseSearchIndexReference	Representa una referencia de documento de Búsqueda de Azure.
KnowledgeBaseWebActivityArguments	Representa los argumentos con los que se llevó a cabo la actividad de recuperación web.
KnowledgeBaseWebActivityRecord	Representa un registro de actividad de recuperación web.
KnowledgeBaseWebReference	Representa una referencia de documento web.
KnowledgeBaseWorkIQActivityArguments	Representa los argumentos con los que se realizó la actividad de recuperación de WorkIQ.
KnowledgeBaseWorkIQActivityRecord	Representa un registro de actividad de recuperación WorkIQ.
KnowledgeBaseWorkIQReference	Representa una referencia de un documento WorkIQ.
KnowledgeRetrievalAutoReasoningEffort	Selecciona automáticamente el esfuerzo de razonamiento durante la recuperación. El servicio siembra cada solicitud en el nivel más barato y escala solo hasta donde sea necesario, hasta el nivel máximo disponible del servicio.
KnowledgeRetrievalIntentType	El tipo de configuración de la base de conocimiento que se va a usar.
KnowledgeRetrievalLowReasoningEffort	Ejecute la recuperación de conocimientos con poco esfuerzo de razonamiento.
KnowledgeRetrievalMediumReasoningEffort	Ejecute la recuperación de conocimientos con un esfuerzo de razonamiento medio.
KnowledgeRetrievalMinimalReasoningEffort	Realiza la recuperación de conocimiento con un esfuerzo mínimo de razonamiento.
KnowledgeRetrievalOutputMode	La configuración de salida para esta recuperación.
KnowledgeRetrievalReasoningEffortKind	La cantidad de esfuerzo que se debe utilizar durante la recuperación.
KnowledgeRetrievalSemanticIntent	Una intención de consulta semántica.
KnowledgeSourceKind	El tipo de fuente de conocimiento.
KnowledgeSourceResultsProcessing	Controla si los resultados de una fuente de conocimiento se reclasifican.
McpServerKnowledgeSourceParams	Especifica parámetros de ejecución para una fuente de conocimiento de servidor MCP
PurviewSensitivityLabelInfo	Información sobre la etiqueta de sensibilidad aplicada a un documento
QueryType	Especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use 'full' si su consulta usa la sintaxis de consulta de Lucene y 'semántica' si no se necesita la sintaxis de consulta.
RemoteSharePointKnowledgeSourceParams	Especifica parámetros en tiempo de ejecución para un origen de conocimiento remoto de SharePoint
SearchIndexFieldReference	Referencia de campo para un índice de búsqueda.
SearchIndexKnowledgeSourceBoostKind	El tipo de consejo de impulso para una fuente de conocimiento de un índice de búsqueda.
SearchIndexKnowledgeSourceFieldValueBoost	Una pista que mejora documentos basándose en el valor de un campo.
SearchIndexKnowledgeSourceFilterHint	Una pista que identifica un campo y valores representativos que el planificador de consultas puede usar al construir un filtro.
SearchIndexKnowledgeSourceMultiWordExpressionBoost	Una pista que mejora los documentos basándose en una expresión de varias palabras.
SearchIndexKnowledgeSourceParams	Especifica parámetros de tiempo de ejecución para un origen de conocimiento de índice de búsqueda
SearchIndexKnowledgeSourceQueryHints	Consejos que guían la planificación de consultas hacia filtros útiles y mejoras para una fuente de conocimiento de índice de búsqueda.
ServedImage	Describe una única imagen que el modelo seleccionó para ser servida durante una actividad de recuperación.
WebKnowledgeSourceParams	Especifica parámetros de tiempo de ejecución para un origen de conocimiento web
WorkIQKnowledgeSourceParams	Especifica parámetros de ejecución para una fuente de conocimiento WorkIQ

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

Objeto

Especifica parámetros en tiempo de ejecución para un origen de conocimiento de blobs de Azure

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: azureBlob	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Consejos que guían la planificación de consultas hacia filtros y mejoras útiles. Si se especifica, este objeto reemplaza el conjunto completo de pistas de consulta configuradas en la fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

ErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

ErrorDetail

Objeto

Detalle del error.

Nombre	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	ErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

ErrorResponse

Objeto

Respuesta de error común para todas las API de Azure Resource Manager para devolver los detalles de error de las operaciones con errores. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

FabricDataAgentKnowledgeSourceParams

Objeto

Especifica parámetros de ejecución para una fuente de conocimiento del Fabric Data Agent

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: fabricDataAgent	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

FabricOntologyKnowledgeSourceParams

Objeto

Especifica parámetros de ejecución para una fuente de conocimiento de Fabric Ontology

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: fabricOntology	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

FileKnowledgeSourceParams

Objeto

Especifica parámetros de ejecución para una fuente de conocimiento de archivo

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: file	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Consejos que guían la planificación de consultas hacia filtros y mejoras útiles. Si se especifica, este objeto reemplaza el conjunto completo de pistas de consulta configuradas en la fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

ImageServingStatistics

Objeto

Estadísticas sobre la aplicación de imágenes durante una actividad de recuperación.

Nombre	Tipo	Description
imagesRetrieved	integer (int32)	El número de imágenes recuperadas de la tienda de recursos.
imagesSentToModel	integer (int32)	El número de imágenes enviadas al modelo posterior.
servedImages	ServedImage[]	El conjunto de imágenes que el modelo seleccionó para ser servido al modelo aguas abajo para esta actividad de recuperación.
totalImageSizeBytes	integer (int64)	El tamaño total en bytes de las imágenes enviadas al modelo.
verbalizationUsed	boolean	Indica si se usó verbalización de imagen en lugar de servicio directo de imágenes.

IndexedOneLakeKnowledgeSourceParams

Objeto

Especifica parámetros de tiempo de ejecución para un origen de conocimiento de OneLake indexado

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: indexedOneLake	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Consejos que guían la planificación de consultas hacia filtros y mejoras útiles. Si se especifica, este objeto reemplaza el conjunto completo de pistas de consulta configuradas en la fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

IndexedSharePointKnowledgeSourceParams

Objeto

Especifica parámetros en tiempo de ejecución para un origen de conocimiento de SharePoint indexado

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: indexedSharePoint	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Consejos que guían la planificación de consultas hacia filtros y mejoras útiles. Si se especifica, este objeto reemplaza el conjunto completo de pistas de consulta configuradas en la fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

IndexedSqlKnowledgeSourceParams

Objeto

Especifica parámetros de ejecución para una fuente de conocimiento SQL indexada

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: indexedSql	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Consejos que guían la planificación de consultas hacia filtros y mejoras útiles. Si se especifica, este objeto reemplaza el conjunto completo de pistas de consulta configuradas en la fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

KnowledgeBaseActivityRecordModel

Objeto

Representa el modelo utilizado para una actividad de LLM en una base de conocimiento, incluyendo su nombre de modelo e identificador de despliegue.

Nombre	Tipo	Description
deploymentId	string	El identificador de despliegue del modelo utilizado para la actividad.
modelName	string	El nombre del modelo utilizado para la actividad.

KnowledgeBaseActivityRecordType

Enumeración

El tipo de registro de actividad.

Valor	Description
searchIndex	Actividad de búsqueda en el índice de búsqueda.
azureBlob	Actividad de recuperación de Azure Blob.
indexedSharePoint	Actividad indexada de recuperación de SharePoint.
indexedOneLake	Actividad de recuperación indexada de OneLake.
web	Actividad de recuperación web.
remoteSharePoint	Actividad remota de recuperación de SharePoint.
workIQ	Actividad de recuperación WorkIQ.
fabricDataAgent	Actividad de recuperación del Fabric Data Agent.
fabricOntology	Actividad de recuperación de la Ontología Fabric.
mcpServer	Actividad de recuperación del servidor MCP.
file	Actividad de recuperación de archivos.
indexedSql	Actividad de recuperación SQL indexada.
modelQueryPlanning	Actividad de planificación de consultas de LLM.
modelAnswerSynthesis	Actividad de síntesis de respuestas LLM.
modelWebSummarization	Actividad de resumen web de LLM.
agenticReasoning	Actividad de razonamiento agentivo.

KnowledgeBaseAgenticReasoningActivityRecord

Objeto

Representa un registro de actividad de razonamiento agente.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
logicalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	El esfuerzo de razonamiento lógico que solicita el cliente. Esto es distinto de `retrievalReasoningEffort`, que informa del esfuerzo de razonamiento utilizado para la facturación.
reasoningTokens	integer (int32)	El número de tokens de entrada para el razonamiento agente.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configuración del esfuerzo de razonamiento de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: agenticReasoning	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseAzureBlobActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad de recuperación de blobs de Azure.

Nombre	Tipo	Description
search	string	Cadena de búsqueda que se usa para consultar el contenido del blob.

KnowledgeBaseAzureBlobActivityRecord

Objeto

Representa un registro de actividad de recuperación de blobs de Azure.

Nombre	Tipo	Description
azureBlobArguments	KnowledgeBaseAzureBlobActivityArguments	Los argumentos del blob azur para la actividad de recuperación.
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalles sobre las expresiones generadas a partir de las pistas de consulta para esta actividad.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: azureBlob	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseAzureBlobReference

Objeto

Representa una referencia de documento de Azure Blob Storage.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
blobUrl	string	La dirección URL del blob para la referencia.
citationUrl	string (uri)	Una URL propiedad de Search, que apunta al documento de respaldo de esta referencia, utilizable como objetivo de cita.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	La información de la etiqueta de sensibilidad para la referencia.
sourceData		Los datos fuente para la referencia.
type	string: azureBlob	El tipo de referencia.

KnowledgeBaseErrorAdditionalInfo

Objeto

Información adicional sobre el error de administración de recursos.

Nombre	Tipo	Description
info		Información adicional.
type	string	Tipo de información adicional.

KnowledgeBaseErrorDetail

Objeto

Detalles del error.

Nombre	Tipo	Description
additionalInfo	KnowledgeBaseErrorAdditionalInfo[]	Información adicional del error.
code	string	Código de error.
details	KnowledgeBaseErrorDetail[]	Detalles del error.
message	string	El mensaje de error.
target	string	Destino del error.

KnowledgeBaseFabricDataAgentActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad de recuperación del Fabric Data Agent.

Nombre	Tipo	Description
search	string	La cadena de búsqueda utilizada para consultar la fuente de conocimiento del Fabric Data Agent.

KnowledgeBaseFabricDataAgentActivityRecord

Objeto

Representa un registro de actividad de recuperación del Fabric Data Agent.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
fabricDataAgentArguments	KnowledgeBaseFabricDataAgentActivityArguments	El Fabric Data Agent argumenta para la actividad de recuperación.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: fabricDataAgent	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseFabricDataAgentReference

Objeto

Representa una referencia documental del Fabric Data Agent.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
dataAgentId	string	El ID del Agente de Datos Fabric.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
sourceData		Los datos fuente para la referencia.
type	string: fabricDataAgent	El tipo de referencia.
workspaceId	string	Identificador del área de trabajo de Fabric.

KnowledgeBaseFabricOntologyActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad de recuperación de la Ontología Fabric.

Nombre	Tipo	Description
search	string	La cadena de búsqueda utilizada para consultar la fuente de conocimiento de Fabric Ontology.

KnowledgeBaseFabricOntologyActivityRecord

Objeto

Representa un registro de actividad de recuperación de Fabric Ontology.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
fabricOntologyArguments	KnowledgeBaseFabricOntologyActivityArguments	Los argumentos de la Ontología de Fabric para la actividad de recuperación.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: fabricOntology	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseFabricOntologyReference

Objeto

Representa una referencia documental de Fabric Ontology.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
id	string	El ID de la referencia.
ontologyId	string	El ID de ontología dentro del espacio de trabajo.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
sourceData		Los datos fuente para la referencia.
type	string: fabricOntology	El tipo de referencia.
workspaceId	string	Identificador del área de trabajo de Fabric.

KnowledgeBaseFileActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad de recuperación de archivos.

Nombre	Tipo	Description
search	string	La cadena de búsqueda utilizada para consultar el contenido del archivo.

KnowledgeBaseFileActivityRecord

Objeto

Representa un registro de actividad de recuperación de archivos.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
fileArguments	KnowledgeBaseFileActivityArguments	Los argumentos del archivo para la actividad de recuperación.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalles sobre las expresiones generadas a partir de las pistas de consulta para esta actividad.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: file	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseFileReference

Objeto

Representa una referencia a un documento de archivo.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
citationUrl	string (uri)	Una URL propiedad de Search, que apunta al documento de respaldo de esta referencia, utilizable como objetivo de cita.
docName	string	El nombre del documento para la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
sourceData		Los datos fuente para la referencia.
type	string: file	El tipo de referencia.

KnowledgeBaseImageContent

Objeto

Contenido de la imagen.

Nombre	Tipo	Description
url	string (uri)	La dirección URL de la imagen.

KnowledgeBaseIndexedOneLakeActivityArguments

Objeto

Representa los argumentos con los que se llevó a cabo la actividad de recuperación indexada de OneLake.

Nombre	Tipo	Description
search	string	La cadena de búsqueda utilizada para consultar indexaba el contenido de OneLake.

KnowledgeBaseIndexedOneLakeActivityRecord

Objeto

Representa un registro indexado de actividad de recuperación de OneLake.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
indexedOneLakeArguments	KnowledgeBaseIndexedOneLakeActivityArguments	Los argumentos indexados de OneLake para la actividad de recuperación.
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalles sobre las expresiones generadas a partir de las pistas de consulta para esta actividad.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: indexedOneLake	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseIndexedOneLakeReference

Objeto

Representa una referencia indexada de un documento OneLake.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
citationUrl	string (uri)	Una URL propiedad de Search, que apunta al documento de respaldo de esta referencia, utilizable como objetivo de cita.
docUrl	string	La URL del documento para la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	La información de la etiqueta de sensibilidad para la referencia.
sourceData		Los datos fuente para la referencia.
type	string: indexedOneLake	El tipo de referencia.

KnowledgeBaseIndexedSharePointActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad de recuperación indexada de SharePoint.

Nombre	Tipo	Description
search	string	La cadena de búsqueda utilizada para consultar contenidos indexados de SharePoint.

KnowledgeBaseIndexedSharePointActivityRecord

Objeto

Representa un registro indexado de actividad de recuperación de SharePoint.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
indexedSharePointArguments	KnowledgeBaseIndexedSharePointActivityArguments	Los argumentos indexados de SharePoint para la actividad de recuperación.
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalles sobre las expresiones generadas a partir de las pistas de consulta para esta actividad.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: indexedSharePoint	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseIndexedSharePointReference

Objeto

Representa una referencia indexada de un documento de SharePoint.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
citationUrl	string (uri)	Una URL propiedad de Search, que apunta al documento de respaldo de esta referencia, utilizable como objetivo de cita.
docUrl	string	La URL del documento para la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	La información de la etiqueta de sensibilidad para la referencia.
sourceData		Los datos fuente para la referencia.
type	string: indexedSharePoint	El tipo de referencia.

KnowledgeBaseIndexedSqlActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad de recuperación de SQL indexado.

Nombre	Tipo	Description
search	string	La cadena de búsqueda utilizada para consultar contenidos SQL indexados.

KnowledgeBaseIndexedSqlActivityRecord

Objeto

Representa un registro indexado de actividad de recuperación SQL.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
indexedSqlArguments	KnowledgeBaseIndexedSqlActivityArguments	Los argumentos SQL indexados para la actividad de recuperación.
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalles sobre las expresiones generadas a partir de las pistas de consulta para esta actividad.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: indexedSql	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseIndexedSqlReference

Objeto

Representa una referencia de documento Azure SQL.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
citationUrl	string (uri)	Una URL propiedad de Search, que apunta al documento de respaldo de esta referencia, utilizable como objetivo de cita.
docUrl	string	La URL del documento para la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
sourceData		Los datos fuente para la referencia.
type	string: indexedSql	El tipo de referencia.

KnowledgeBaseMcpServerActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad de recuperación del servidor MCP.

Nombre	Tipo	Description
toolArguments		Los argumentos pasaron a la herramienta de servidor MCP.
toolName	string	El nombre de la herramienta servidor MCP utilizada para la actividad de recuperación.

KnowledgeBaseMcpServerActivityRecord

Objeto

Representa un registro de actividad de recuperación de servidor MCP.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
mcpServerArguments	KnowledgeBaseMcpServerActivityArguments	El servidor MCP argumenta a favor de la actividad de recuperación.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: mcpServer	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseMcpServerReference

Objeto

Representa una referencia de documento de servidor MCP.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
sourceData		Los datos fuente para la referencia.
title	string	El título del resultado de la herramienta de servidor MCP.
toolName	string	El nombre de la herramienta servidor MCP que produjo la referencia.
type	string: mcpServer	El tipo de referencia.

KnowledgeBaseMessage

Objeto

El objeto de estilo de mensaje de lenguaje natural.

Nombre	Tipo	Description
content	KnowledgeBaseMessageContent[]: KnowledgeBaseMessageImageContent[] KnowledgeBaseMessageTextContent[]	Contenido del mensaje.
role	string	El papel de la respuesta de la herramienta.

KnowledgeBaseMessageContentType

Enumeración

El tipo de contenido del mensaje.

Valor	Description
text	Tipo de contenido de mensajes de texto.
image	Tipo de contenido del mensaje de imagen.

KnowledgeBaseMessageImageContent

Objeto

Tipo de mensaje de imagen.

Nombre	Tipo	Description
image	KnowledgeBaseImageContent	El contenido de la imagen.
type	string: image	Tipo del mensaje

KnowledgeBaseMessageTextContent

Objeto

Tipo de mensaje de texto.

Nombre	Tipo	Description
text	string	Contenido de texto.
type	string: text	Tipo del mensaje

KnowledgeBaseModelAnswerSynthesisActivityRecord

Objeto

Representa un registro de actividad de síntesis de respuestas LLM.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
inputTokens	integer (int32)	El número de tokens de entrada para la actividad de síntesis de respuestas LLM.
model	KnowledgeBaseActivityRecordModel	El modelo utilizado para la actividad de síntesis de respuestas LLM.
outputTokens	integer (int32)	El número de tokens de salida para la actividad de síntesis de respuestas LLM.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: modelAnswerSynthesis	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseModelQueryPlanningActivityRecord

Objeto

Representa un registro de actividad de planeación de consultas LLM.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
inputTokens	integer (int32)	Número de tokens de entrada para la actividad de planeación de consultas LLM.
model	KnowledgeBaseActivityRecordModel	El modelo utilizado para la actividad de planificación de consultas de LLM.
outputTokens	integer (int32)	Número de tokens de salida para la actividad de planeación de consultas LLM.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: modelQueryPlanning	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseModelWebSummarizationActivityRecord

Objeto

Representa un registro de actividad de resumen web de LLM.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
inputTokens	integer (int32)	El número de tokens de entrada para la actividad de resumen web del LLM.
model	KnowledgeBaseActivityRecordModel	El modelo utilizado para la actividad de resumen web de LLM.
outputTokens	integer (int32)	El número de tokens de salida para la actividad de resumen web de LLM.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: modelWebSummarization	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseQueryHintProcessing

Objeto

Detalles sobre las expresiones generadas a partir de pistas de consulta para una actividad de recuperación.

Nombre	Tipo	Description
generatedBoost	string	La cláusula de búsqueda generada a partir de pistas boost para esta actividad.
generatedFilter	string	La expresión del filtro generada a partir de pistas de filtro para esta actividad.

KnowledgeBaseReferenceType

Enumeración

El tipo de referencia.

Valor	Description
searchIndex	Buscar índice de referencia de documentos.
azureBlob	Referencia de documento Azure Blob.
indexedSharePoint	Referencia indexada de documentos de SharePoint.
indexedOneLake	Referencia indexada de documentos OneLake.
web	Referencia de documentos web.
remoteSharePoint	Referencia remota de documentos de SharePoint.
workIQ	Referencia de documentos de Work IQ.
fabricDataAgent	Referencia de documento del Fabric Data Agent.
fabricOntology	Referencia de documento de Fabric Ontology.
mcpServer	Referencia de documento del servidor MCP.
file	Archivo de referencia de documentos.
indexedSql	Referencia indexada de documentos SQL.

KnowledgeBaseRemoteSharePointActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad remota de recuperación de SharePoint.

Nombre	Tipo	Description
filterExpressionAddOn	string	El complemento de expresión de filtro para la actividad de recuperación.
search	string	La cadena de búsqueda se utiliza para consultar la fuente de conocimiento remota de SharePoint.

KnowledgeBaseRemoteSharePointActivityRecord

Objeto

Representa un registro remoto de actividad de recuperación de SharePoint.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
remoteSharePointArguments	KnowledgeBaseRemoteSharePointActivityArguments	Los argumentos de SharePoint remoto para la actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: remoteSharePoint	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseRemoteSharePointReference

Objeto

Representa una referencia de documento remoto de SharePoint.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	La información de la etiqueta de sensibilidad para la referencia.
sourceData		Los datos fuente para la referencia.
type	string: remoteSharePoint	El tipo de referencia.
webUrl	string (uri)	La URL de la que se originaron los datos de referencia.

KnowledgeBaseRetrievalRequest

Objeto

El contrato de entrada para la solicitud de recuperación.

Nombre	Tipo	Description
includeActivity	boolean	Indica que los resultados de la recuperación deben incluir información de la actividad.
intents	KnowledgeRetrievalIntent[]: KnowledgeRetrievalSemanticIntent[]	Una lista de consultas previstas para ejecutar sin planear consultas de modelo.
knowledgeSourceParams	KnowledgeSourceParams[]: AzureBlobKnowledgeSourceParams[] FabricDataAgentKnowledgeSourceParams[] FabricOntologyKnowledgeSourceParams[] FileKnowledgeSourceParams[] IndexedOneLakeKnowledgeSourceParams[] IndexedSharePointKnowledgeSourceParams[] IndexedSqlKnowledgeSourceParams[] McpServerKnowledgeSourceParams[] RemoteSharePointKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[] WorkIQKnowledgeSourceParams[]	Una lista de parámetros de tiempo de ejecución para los orígenes de conocimiento.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos en la salida.
maxOutputSize	integer (int32)	Limita el tamaño máximo del contenido de la salida.
maxOutputSizeInTokens	integer (int32)	Limita el tamaño máximo del contenido de la salida.
maxRuntimeInSeconds	integer (int32)	El tiempo máximo de ejecución en segundos.
messages	KnowledgeBaseMessage[]	Una lista de entradas de estilo de mensajes de chat.
outputMode	KnowledgeRetrievalOutputMode	La configuración de salida para esta recuperación.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalAutoReasoningEffort KnowledgeRetrievalLowReasoningEffort KnowledgeRetrievalMediumReasoningEffort KnowledgeRetrievalMinimalReasoningEffort	La configuración del esfuerzo de razonamiento de recuperación.

KnowledgeBaseRetrievalResponse

Objeto

El contrato de salida para la respuesta de recuperación.

Nombre	Tipo	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseFabricDataAgentActivityRecord[] KnowledgeBaseFabricOntologyActivityRecord[] KnowledgeBaseFileActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseIndexedSharePointActivityRecord[] KnowledgeBaseIndexedSqlActivityRecord[] KnowledgeBaseMcpServerActivityRecord[] KnowledgeBaseModelAnswerSynthesisActivityRecord[] KnowledgeBaseModelQueryPlanningActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseRemoteSharePointActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[] KnowledgeBaseWorkIQActivityRecord[]	Los registros de actividad para realizar un seguimiento del progreso y las implicaciones de facturación.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseFabricDataAgentReference[] KnowledgeBaseFabricOntologyReference[] KnowledgeBaseFileReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseIndexedSharePointReference[] KnowledgeBaseIndexedSqlReference[] KnowledgeBaseMcpServerReference[] KnowledgeBaseRemoteSharePointReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[] KnowledgeBaseWorkIQReference[]	Las referencias de los datos de recuperación utilizados en la respuesta.
response	KnowledgeBaseMessage[]	Los mensajes de respuesta.
responseSensitivityLabelInfo	PurviewSensitivityLabelInfo	La información de la etiqueta de sensibilidad para la respuesta global.

KnowledgeBaseSearchIndexActivityArguments

Objeto

Representa los argumentos con los que se ejecutó la actividad de recuperación del índice de búsqueda.

Nombre	Tipo	Description
filter	string	Cadena de filtro.
queryType	QueryType	La sintaxis de la consulta utilizada para ejecutar la búsqueda. Las pistas de consulta pueden hacer que las consultas semánticas usen la sintaxis completa de la consulta.
search	string	La cadena de búsqueda utilizada para consultar el índice de búsqueda.
searchFields	SearchIndexFieldReference[]	Contra qué campos se buscaron.
semanticConfigurationName	string	¿Qué configuración semántica se utilizó del índice de búsqueda?
sourceDataFields	SearchIndexFieldReference[]	¿Qué campos se seleccionaron para la búsqueda?

KnowledgeBaseSearchIndexActivityRecord

Objeto

Representa un registro de actividad de recuperación de índice de búsqueda.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryHintProcessing	KnowledgeBaseQueryHintProcessing	Detalles sobre las expresiones generadas a partir de las pistas de consulta para esta actividad.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Los argumentos del índice de búsqueda para la actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: searchIndex	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.

KnowledgeBaseSearchIndexReference

Objeto

Representa una referencia de documento de Búsqueda de Azure.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
citationUrl	string (uri)	Una URL propiedad de Search, que apunta al documento de respaldo de esta referencia, utilizable como objetivo de cita.
docKey	string	La clave de documento para la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	La información de la etiqueta de sensibilidad para la referencia.
sourceData		Los datos fuente para la referencia.
type	string: searchIndex	El tipo de referencia.

KnowledgeBaseWebActivityArguments

Objeto

Representa los argumentos con los que se llevó a cabo la actividad de recuperación web.

Nombre	Tipo	Description
count	integer (int32)	El número de resultados web devueltos.
freshness	string	La frescura para la actividad de recuperación.
language	string	El lenguaje para la actividad de recuperación.
market	string	El mercado para la actividad de recuperación.
search	string	La cadena de búsqueda utilizada para consultar la web.

KnowledgeBaseWebActivityRecord

Objeto

Representa un registro de actividad de recuperación web.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: web	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.
webArguments	KnowledgeBaseWebActivityArguments	Los argumentos web a favor de la actividad de recuperación.

KnowledgeBaseWebReference

Objeto

Representa una referencia de documento web.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
sourceData		Los datos fuente para la referencia.
title	string	El título del documento web.
type	string: web	El tipo de referencia.
url	string (uri)	La URL de la que se originaron los datos de referencia.

KnowledgeBaseWorkIQActivityArguments

Objeto

Representa los argumentos con los que se realizó la actividad de recuperación de WorkIQ.

Nombre	Tipo	Description
search	string	La cadena de búsqueda utilizada para consultar la fuente de conocimiento de WorkIQ.

KnowledgeBaseWorkIQActivityRecord

Objeto

Representa un registro de actividad de recuperación WorkIQ.

Nombre	Tipo	Description
completedAt	string (date-time)	El momento en que se completó la actividad.
count	integer (int32)	El recuento de documentos recuperados que fueron lo suficientemente relevantes como para pasar el umbral del reranker.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
error	KnowledgeBaseErrorDetail	El detalle del error que explica por qué falló la operación. Esta propiedad solo se incluye cuando la actividad no se realiza correctamente.
id	integer (int32)	El ID del registro de actividad.
imageServing	ImageServingStatistics	Estadísticas sobre la función de imagen para esta actividad de recuperación
knowledgeSourceName	string	La fuente de conocimiento para la actividad de recuperación.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
startedAt	string (date-time)	La hora en la que empezó la actividad.
type	string: workIQ	El tipo de registro de actividad.
warning	string	Un mensaje de advertencia que revela posibles problemas de configuración observados durante la actividad, como documentos que se pierden debido al umbral de puntuación, truncamiento del límite de token o condiciones de tiempo de espera.
workIQArguments	KnowledgeBaseWorkIQActivityArguments	Los argumentos de WorkIQ a favor de la actividad de recuperación.

KnowledgeBaseWorkIQReference

Objeto

Representa una referencia de un documento WorkIQ.

Nombre	Tipo	Description
activitySource	integer (int32)	El identificador de actividad de origen de la referencia.
id	string	El ID de la referencia.
rerankerScore	number (float)	La puntuación del reranker para la referencia del documento.
searchSensitivityLabelInfo	PurviewSensitivityLabelInfo	La información de la etiqueta de sensibilidad para la referencia.
sourceData		Los datos fuente para la referencia.
type	string: workIQ	El tipo de referencia.

KnowledgeRetrievalAutoReasoningEffort

Objeto

Selecciona automáticamente el esfuerzo de razonamiento durante la recuperación. El servicio siembra cada solicitud en el nivel más barato y escala solo hasta donde sea necesario, hasta el nivel máximo disponible del servicio.

Nombre	Tipo	Description
kind	string: auto	El tipo de esfuerzo de razonamiento.

KnowledgeRetrievalIntentType

Enumeración

El tipo de configuración de la base de conocimiento que se va a usar.

Valor	Description
semantic	Una intención de consulta semántica de lenguaje natural.

KnowledgeRetrievalLowReasoningEffort

Objeto

Ejecute la recuperación de conocimientos con poco esfuerzo de razonamiento.

Nombre	Tipo	Description
kind	string: low	El tipo de esfuerzo de razonamiento.

KnowledgeRetrievalMediumReasoningEffort

Objeto

Ejecute la recuperación de conocimientos con un esfuerzo de razonamiento medio.

Nombre	Tipo	Description
kind	string: medium	El tipo de esfuerzo de razonamiento.

KnowledgeRetrievalMinimalReasoningEffort

Objeto

Realiza la recuperación de conocimiento con un esfuerzo mínimo de razonamiento.

Nombre	Tipo	Description
kind	string: minimal	El tipo de esfuerzo de razonamiento.

KnowledgeRetrievalOutputMode

Enumeración

La configuración de salida para esta recuperación.

Valor	Description
extractiveData	Devolver datos de las fuentes de conocimiento directamente sin alteración generativa.
answerSynthesis	Sintetiza una respuesta para la carga útil de respuesta.

KnowledgeRetrievalReasoningEffortKind

Enumeración

La cantidad de esfuerzo que se debe utilizar durante la recuperación.

Valor	Description
minimal	No realiza ninguna selección de origen, planeación de consultas ni búsqueda iterativa.
low	Utilice un razonamiento bajo durante la recuperación.
medium	Use una cantidad moderada de razonamiento durante la recuperación.
auto	Selecciona automáticamente el esfuerzo de razonamiento durante la recuperación, escalando desde el nivel más barato solo hasta donde sea necesario.

KnowledgeRetrievalSemanticIntent

Objeto

Una intención de consulta semántica.

Nombre	Tipo	Description
search	string	La consulta semántica que se va a ejecutar
type	string: semantic	El tipo de intención.

KnowledgeSourceKind

Enumeración

El tipo de fuente de conocimiento.

Valor	Description
searchIndex	Un origen de conocimiento que lee datos de un índice de búsqueda.
azureBlob	Un origen de conocimiento que lee e ingiere datos de Azure Blob Storage en un índice de búsqueda.
indexedSharePoint	Una fuente de conocimiento que lee datos de SharePoint indexado.
indexedOneLake	Una fuente de conocimiento que lee datos de OneLake indexado.
indexedSql	Una fuente de conocimiento que recupera e ingirte datos de Azure SQL Database o SQL Managed Instance a un Índice de Búsqueda.
web	Una fuente de conocimiento que lee datos de la web.
remoteSharePoint	Una fuente de conocimiento que lee datos de SharePoint remoto.
workIQ	Una fuente de conocimiento que lee datos de IQ en el trabajo
file	Una fuente de conocimiento que soporta la subida e indexación directa de archivos.
mcpServer	Una fuente de conocimiento respaldada por un servidor MCP (Model Context Protocol).
fabricDataAgent	Una fuente de conocimiento que recupera datos de un Fabric Data Agent.
fabricOntology	Una fuente de conocimiento que recupera datos de las ontologías de Microsoft Fabric Ontology.

KnowledgeSourceResultsProcessing

Enumeración

Controla si los resultados de una fuente de conocimiento se reclasifican.

Valor	Description
rerank	Los resultados de esta fuente de conocimiento pasan por la cadena de reclasificación. Este es el comportamiento predeterminado.
none	Los resultados de esta fuente de conocimiento evitan la reclasificación y preservan su orden subyacente.

McpServerKnowledgeSourceParams

Objeto

Especifica parámetros de ejecución para una fuente de conocimiento de servidor MCP

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: mcpServer	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

PurviewSensitivityLabelInfo

Objeto

Información sobre la etiqueta de sensibilidad aplicada a un documento

Nombre	Tipo	Description
color	string	El color que la interfaz de usuario debe mostrar para la etiqueta, si está configurado.
displayName	string	Nombre para mostrar de la etiqueta de confidencialidad.
isEncrypted	boolean	Indica si la etiqueta de confidencialidad aplica el cifrado.
priority	integer (int32)	Prioridad en la que se aplica la etiqueta de confidencialidad.
sensitivityLabelId	string	El id. de la etiqueta de confidencialidad.
toolTip	string	Información sobre herramientas que debe mostrarse para la etiqueta en una interfaz de usuario.

QueryType

Enumeración

Especifica la sintaxis de la consulta de búsqueda. El valor predeterminado es "simple". Use 'full' si su consulta usa la sintaxis de consulta de Lucene y 'semántica' si no se necesita la sintaxis de consulta.

Valor	Description
simple	Usa la sintaxis de consulta simple para las búsquedas. El texto de búsqueda se interpreta utilizando un lenguaje de consulta simple que permite símbolos como +, * y "". Las consultas se evalúan en todos los campos que se pueden buscar de forma predeterminada, a menos que se especifique el parámetro searchFields.
full	Utiliza la sintaxis de consulta completa de Lucene para las búsquedas. El texto de búsqueda se interpreta utilizando el lenguaje de consulta Lucene que permite búsquedas ponderadas y específicas de campo, así como otras funciones avanzadas.
semantic	Más adecuado para consultas expresadas en lenguaje natural en lugar de palabras clave. Mejora la precisión de los resultados de búsqueda al volver a clasificar los principales resultados de búsqueda mediante un modelo de clasificación entrenado en el corpus web.

RemoteSharePointKnowledgeSourceParams

Objeto

Especifica parámetros en tiempo de ejecución para un origen de conocimiento remoto de SharePoint

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
filterExpressionAddOn	string	Una condición de filtro aplicada al origen de datos de SharePoint. Debe especificarse en la sintaxis del lenguaje de consulta de palabras clave. Se combinará como una combinación con la expresión de filtro especificada en la definición de la fuente de conocimiento.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: remoteSharePoint	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

SearchIndexFieldReference

Objeto

Referencia de campo para un índice de búsqueda.

Nombre	Tipo	Description
name	string	Nombre del campo.

SearchIndexKnowledgeSourceBoostKind

Enumeración

El tipo de consejo de impulso para una fuente de conocimiento de un índice de búsqueda.

Valor	Description
fieldValue	Mejora los documentos basándote en un valor de campo.
multiWordExpression	Mejora documentos basados en una expresión de varias palabras.

SearchIndexKnowledgeSourceFieldValueBoost

Objeto

Una pista que mejora documentos basándose en el valor de un campo.

Nombre	Tipo	Description
boost	number (double)	Un multiplicador para la puntuación del documento. Debe ser un número positivo no igual a 1,0.
boostInstructions	string	Instrucciones en lenguaje natural que expliquen cuándo y cómo aplicar el impulso.
field	string minLength: 1	El nombre del campo índice de búsqueda.
fieldValues	string[]	Valores representativos para el campo.
kind	string: fieldValue	Ese tipo de pista de impulso.

SearchIndexKnowledgeSourceFilterHint

Objeto

Una pista que identifica un campo y valores representativos que el planificador de consultas puede usar al construir un filtro.

Nombre	Tipo	Description
field	string minLength: 1	El nombre del campo índice de búsqueda filtrable.
fieldValues	string[]	Valores representativos para el campo.
filterInstructions	string	Instrucciones en lenguaje natural que expliquen cuándo y cómo filtrar en el campo.

SearchIndexKnowledgeSourceMultiWordExpressionBoost

Objeto

Una pista que mejora los documentos basándose en una expresión de varias palabras.

Nombre	Tipo	Description
boost	number (double)	Un multiplicador para la puntuación del documento. Debe ser un número positivo no igual a 1,0.
boostInstructions	string	Instrucciones en lenguaje natural que expliquen cuándo y cómo aplicar el impulso.
fieldValues	string[]	Valores representativos para el impulso.
kind	string: multiWordExpression	Ese tipo de pista de impulso.

SearchIndexKnowledgeSourceParams

Objeto

Especifica parámetros de tiempo de ejecución para un origen de conocimiento de índice de búsqueda

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
filterAddOn	string	Una condición de filtro aplicada al índice (por ejemplo, 'State eq VA').
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: searchIndex	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
queryHintOverrides	SearchIndexKnowledgeSourceQueryHints	Consejos que guían la planificación de consultas hacia filtros y mejoras útiles. Si se especifica, este objeto reemplaza el conjunto completo de pistas de consulta configuradas en la fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

SearchIndexKnowledgeSourceQueryHints

Objeto

Consejos que guían la planificación de consultas hacia filtros útiles y mejoras para una fuente de conocimiento de índice de búsqueda.

Nombre	Tipo	Description
boosts	SearchIndexKnowledgeSourceBoost[]: SearchIndexKnowledgeSourceFieldValueBoost[] SearchIndexKnowledgeSourceMultiWordExpressionBoost[]	Potenciar las pistas que identifican condiciones que el planificador de consultas puede usar para influir en el posicionamiento de los documentos.
filters	SearchIndexKnowledgeSourceFilterHint[]	Pistas de filtro que identifican campos y valores representativos que el planificador de consultas puede usar al construir filtros.

ServedImage

Objeto

Describe una única imagen que el modelo seleccionó para ser servida durante una actividad de recuperación.

Nombre	Tipo	Description
imageId	string	La etiqueta de la imagen extraída del documento original mediante enriquecimiento de Comprensión de Contenido. Corresponde a la numeración de la cifra en el documento original.
imagePath	string	La ruta relativa a la imagen dentro del asset store.
sizeBytes	integer (int64)	El tamaño en bytes de esta imagen enviado al modelo.

WebKnowledgeSourceParams

Objeto

Especifica parámetros de tiempo de ejecución para un origen de conocimiento web

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
count	integer (int32)	El número de resultados web que se van a devolver.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
freshness	string	La frescura de los resultados web.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: web	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
language	string	El idioma de los resultados web.
market	string	El mercado de resultados web.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.

WorkIQKnowledgeSourceParams

Objeto

Especifica parámetros de ejecución para una fuente de conocimiento WorkIQ

Nombre	Tipo	Description
alwaysQuerySource	boolean	Indica que este origen de conocimiento debe omitir la selección de origen y consultarse siempre en el momento de la recuperación.
enableImageServing	boolean	Indica si se debe habilitar el servicio de imágenes para esta fuente de conocimiento en el momento de la recuperación. Cuando es cierto, las imágenes extraídas durante la ingestión se entregan a modelos posteriores.
failOnError	boolean	Indica que toda la solicitud de recuperación debería fallar si la recuperación de esta fuente de conocimiento encuentra un error. El valor predeterminado es False.
includeReferenceSourceData	boolean	Indica si las referencias deben incluir los datos estructurados obtenidos durante la recuperación en su carga útil.
includeReferences	boolean	Indica si se deben incluir referencias para los datos recuperados de este origen.
kind	string: workIQ	El tipo de fuente de conocimiento.
knowledgeSourceName	string	Nombre del índice al que se aplican los parámetros.
maxOutputDocuments	integer (int32)	Limita el número máximo de documentos devueltos desde esta fuente de conocimiento.
neverQuerySource	boolean	Indica que esta fuente de conocimiento debe excluirse del conjunto de candidatos de la solicitud y nunca ser consultada en el momento de la recuperación. La exclusión es request-local y no modifica la membresía de la base de conocimiento. No se puede combinar con alwaysQuerySource en la misma fuente de conocimiento.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.
resultsProcessing	KnowledgeSourceResultsProcessing	Anula los resultados almacenados de la fuente de conocimiento Processing solo para esta llamada de recuperación. Cuando se omite, se aplica el valor de la fuente de conocimiento almacenado.