Knowledge Retrieval - Retrieve

Servicio:: Search Service

Versión de la API:: 2026-04-01

KnowledgeBase recupera datos relevantes de los almacenes de respaldo.

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

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	Requerido	Tipo	Description
Accept		Accept	El encabezado Aceptar.
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[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Una lista de parámetros de tiempo de ejecución para los orígenes de conocimiento.
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.

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

KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Solicitud de ejemplo

HTTP

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Respuesta de muestra

status code:: 200

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

status code:: 206

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

KnowledgeBaseRetrieveWithIntents

Solicitud de ejemplo

HTTP

POST https://exampleservice.search.windows.net/knowledgebases('base-example-index')/retrieve?api-version=2026-04-01


{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSizeInTokens": 100000,
  "includeActivity": true,
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-example-index",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Respuesta de muestra

status code:: 200

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

status code:: 206

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

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 común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).
IndexedOneLakeKnowledgeSourceParams	Especifica parámetros de tiempo de ejecución para un origen de conocimiento de OneLake indexado
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.
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.
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.
KnowledgeBaseModelWebSummarizationActivityRecord	Representa un registro de actividad de resumen web de LLM.
KnowledgeBaseReferenceType	Tipo de referencia.
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.
KnowledgeRetrievalIntentType	El tipo de configuración de la base de conocimiento que se va a usar.
KnowledgeRetrievalMinimalReasoningEffort	Realiza la recuperación de conocimiento con un esfuerzo mínimo de razonamiento.
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.
SearchIndexFieldReference	Referencia de campo para un índice de búsqueda.
SearchIndexKnowledgeSourceParams	Especifica parámetros de tiempo de ejecución para un origen de conocimiento de índice de búsqueda
WebKnowledgeSourceParams	Especifica parámetros de tiempo de ejecución para un origen de conocimiento web

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
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.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

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 común a errores para todas las APIs de Azure Resource Manager para devolver detalles de error por operaciones fallidas. (Esto también sigue el formato de respuesta de error de OData).

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

IndexedOneLakeKnowledgeSourceParams

Objeto

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

Nombre	Tipo	Description
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.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

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.
indexedOneLake	Actividad de recuperación indexada de OneLake.
web	Actividad de recuperación web.
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
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.
reasoningTokens	integer (int32)	El número de tokens de entrada para el razonamiento agente.
retrievalReasoningEffort	KnowledgeRetrievalReasoningEffort: KnowledgeRetrievalMinimalReasoningEffort	La configuración del esfuerzo de razonamiento de recuperación.
type	string: agenticReasoning	El tipo de registro de actividad.

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.
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.
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.
type	string: azureBlob	El tipo de registro de actividad.

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.
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: 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.

KnowledgeBaseImageContent

Objeto

Contenido de la imagen.

Nombre	Tipo	Description
url	string (uri)	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
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.
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.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
type	string: indexedOneLake	El tipo de registro de actividad.

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.
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: indexedOneLake	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	El tipo de mensaje

KnowledgeBaseMessageTextContent

Objeto

Tipo de mensaje de texto.

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

KnowledgeBaseModelWebSummarizationActivityRecord

Objeto

Representa un registro de actividad de resumen web de LLM.

Nombre	Tipo	Description
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.
outputTokens	integer (int32)	El número de tokens de salida para la actividad de resumen web de LLM.
type	string: modelWebSummarization	El tipo de registro de actividad.

KnowledgeBaseReferenceType

Enumeración

Tipo de referencia.

Valor	Description
searchIndex	Buscar índice de referencia de documentos.
azureBlob	Referencia de documento Azure Blob.
indexedOneLake	Referencia indexada de documentos OneLake.
web	Referencia de documentos web.

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[] IndexedOneLakeKnowledgeSourceParams[] SearchIndexKnowledgeSourceParams[] WebKnowledgeSourceParams[]	Una lista de parámetros de tiempo de ejecución para los orígenes de conocimiento.
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.

KnowledgeBaseRetrievalResponse

Objeto

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

Nombre	Tipo	Description
activity	KnowledgeBaseActivityRecord[]: KnowledgeBaseAgenticReasoningActivityRecord[] KnowledgeBaseAzureBlobActivityRecord[] KnowledgeBaseIndexedOneLakeActivityRecord[] KnowledgeBaseModelWebSummarizationActivityRecord[] KnowledgeBaseSearchIndexActivityRecord[] KnowledgeBaseWebActivityRecord[]	Los registros de actividad para realizar un seguimiento del progreso y las implicaciones de facturación.
references	KnowledgeBaseReference[]: KnowledgeBaseAzureBlobReference[] KnowledgeBaseIndexedOneLakeReference[] KnowledgeBaseSearchIndexReference[] KnowledgeBaseWebReference[]	Las referencias de los datos de recuperación utilizados en la respuesta.
response	KnowledgeBaseMessage[]	Los mensajes de respuesta.

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.
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
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.
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.
searchIndexArguments	KnowledgeBaseSearchIndexActivityArguments	Los argumentos del índice de búsqueda para la actividad de recuperación.
type	string: searchIndex	El tipo de registro de actividad.

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.
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.
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
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.
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.
type	string: web	El tipo de registro de actividad.
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.

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.

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.

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.

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.
indexedOneLake	Una fuente de conocimiento que lee datos de OneLake indexado.
web	Una fuente de conocimiento que lee datos de la web.

SearchIndexFieldReference

Objeto

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

Nombre	Tipo	Description
name	string	Nombre del campo.

SearchIndexKnowledgeSourceParams

Objeto

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

Nombre	Tipo	Description
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.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

WebKnowledgeSourceParams

Objeto

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

Nombre	Tipo	Description
count	integer (int32)	El número de resultados web que se van a devolver.
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.
rerankerThreshold	number (float)	El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.