Knowledge Retrieval - Retrieve

Servicio:: Search Service

Versión de la API:: 2025-05-01-preview

KnowledgeAgent recupera datos relevantes de los almacenes de respaldo.

POST {endpoint}/agents('{agentName}')/retrieve?api-version=2025-05-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
agentName	path	True	string	Nombre del agente.
endpoint	path	True	string (url)	Dirección URL del punto de conexión del servicio de búsqueda.
api-version	query	True	string	Versión de api de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
x-ms-client-request-id		string (uuid)	Identificador de seguimiento enviado con la solicitud para ayudar con la depuración.
x-ms-query-source-authorization		string	Token que identifica al usuario para el que se está ejecutando la consulta. Este token se utiliza para aplicar restricciones de seguridad en los documentos.

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
messages	True	KnowledgeAgentMessage[]	Objeto de estilo de mensaje en lenguaje natural.
targetIndexParams		KnowledgeAgentIndexParams[]

Respuestas

Nombre	Tipo	Description
200 OK	KnowledgeAgentRetrievalResponse	La respuesta de recuperación se devuelve correctamente.
Other Status Codes	ErrorResponse	Respuesta de error.

Ejemplos

KnowledgeAgentRetrieve

Solicitud de ejemplo

HTTP

POST https://previewexampleservice.search.windows.net/agents('agent-preview-test')/retrieve?api-version=2025-05-01-preview



{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "hello world",
          "type": "text"
        }
      ]
    }
  ],
  "targetIndexParams": [
    {
      "indexName": "preview-test",
      "filterAddOn": "foo eq bar",
      "maxDocsForReranker": 100,
      "rerankerThreshold": 2.5,
      "includeReferenceSourceData": true
    }
  ]
}

Respuesta de muestra

status code:: 200

{
  "response": [
    {
      "role": "assistant",
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "ModelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22
    },
    {
      "type": "AzureSearchQuery",
      "id": 1,
      "targetIndex": "preview-test",
      "query": {
        "search": "hello world",
        "filter": "foo eq bar"
      },
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234
    },
    {
      "type": "AzureSearchQuery",
      "id": 2,
      "targetIndex": "preview-test",
      "query": {
        "search": "hello world two",
        "filter": "foo eq bar"
      },
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234
    },
    {
      "type": "AzureSearchSemanticRanker",
      "id": 3,
      "inputTokens": 74
    }
  ],
  "references": [
    {
      "type": "AzureSearchDoc",
      "id": "83dd7d40",
      "activitySource": 1,
      "docKey": "myDocKey1",
      "sourceData": {
        "id": "myDocKey1",
        "title": "high_doc",
        "content": "hello world"
      }
    },
    {
      "type": "AzureSearchDoc",
      "id": "83dd7d41",
      "activitySource": 1,
      "docKey": "myDocKey2",
      "sourceData": {
        "id": "myDocKey2",
        "title": "low_doc",
        "content": "goodbye world"
      }
    }
  ]
}

Definiciones

Nombre	Description
ErrorAdditionalInfo	Información adicional sobre el error de administración de recursos.
ErrorDetail	Detalle del error.
ErrorResponse	Respuesta de error
Image
KnowledgeAgentAzureSearchDocReference	Representa una referencia de documento de Búsqueda de Azure.
KnowledgeAgentIndexParams
KnowledgeAgentMessage	Objeto de estilo de mensaje en lenguaje natural.
KnowledgeAgentMessageContentType	El tipo de contenido del mensaje.
KnowledgeAgentMessageImageContent	Tipo de mensaje de texto.
KnowledgeAgentMessageTextContent	Tipo de mensaje de texto.
KnowledgeAgentModelQueryPlanningActivityRecord	Representa un registro de actividad de planificación de consultas de LLM.
KnowledgeAgentRetrievalRequest	El contrato de entrada para la solicitud de recuperación.
KnowledgeAgentRetrievalResponse	El contrato de salida para la respuesta de recuperación.
KnowledgeAgentSearchActivityRecord	Representa un registro de actividad de recuperación.
KnowledgeAgentSemanticRankerActivityRecord	Representa un registro de actividad de clasificador semántico.
Query	Los detalles de la consulta de la actividad de recuperación.

ErrorAdditionalInfo

Objeto

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

Nombre	Tipo	Description
info	object	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

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

Image

Objeto

Nombre	Tipo	Description
url	string	La url de la imagen.

KnowledgeAgentAzureSearchDocReference

Objeto

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

Nombre	Tipo	Description
activitySource	integer (int32)	El ID de actividad de origen de la referencia.
docKey	string	La clave de documento para la referencia.
id	string	El ID de la referencia.
sourceData	object
type	string: AzureSearchDoc	El tipo de referencia.

KnowledgeAgentIndexParams

Objeto

Nombre	Tipo	Description
filterAddOn	string	Una condición de filtro aplicada al índice (por ejemplo, 'State eq VA').
includeReferenceSourceData	boolean	Indica si se deben incluir los datos de origen de referencia.
indexName	string	Nombre del índice al que se aplican los parámetros.
maxDocsForReranker	integer (int32)	Limita el número de documentos considerados para la clasificación.
rerankerThreshold	number (float) minimum: 0 maximum: 4	Un umbral para reclasificar los resultados (rango: 0-4).

KnowledgeAgentMessage

Objeto

Objeto de estilo de mensaje en lenguaje natural.

Nombre	Tipo	Description
content	KnowledgeAgentMessageContent[]: KnowledgeAgentMessageImageContent[] KnowledgeAgentMessageTextContent[]	Especifica el tipo de contenido del mensaje.
role	string	El papel de la respuesta de la herramienta.

KnowledgeAgentMessageContentType

Enumeración

El tipo de contenido del mensaje.

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

KnowledgeAgentMessageImageContent

Objeto

Tipo de mensaje de texto.

Nombre	Tipo	Description
image	Image
type	string: image	Tipo del mensaje

KnowledgeAgentMessageTextContent

Objeto

Tipo de mensaje de texto.

Nombre	Tipo	Description
text	string
type	string: text	Tipo del mensaje

KnowledgeAgentModelQueryPlanningActivityRecord

Objeto

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

Nombre	Tipo	Description
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad del modelo.
id	integer (int32)	El ID del registro de actividad.
inputTokens	integer (int32)	El número de tokens de entrada para la actividad de planeación de consultas de LLM.
outputTokens	integer (int32)	El número de tokens de salida para la actividad de planeación de consultas de LLM.
type	string: ModelQueryPlanning	El tipo de registro de actividad.

KnowledgeAgentRetrievalRequest

Objeto

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

Nombre	Tipo	Description
messages	KnowledgeAgentMessage[]	Objeto de estilo de mensaje en lenguaje natural.
targetIndexParams	KnowledgeAgentIndexParams[]

KnowledgeAgentRetrievalResponse

Objeto

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

Nombre	Tipo	Description
activity	KnowledgeAgentActivityRecord[]: KnowledgeAgentModelQueryPlanningActivityRecord[] KnowledgeAgentSearchActivityRecord[] KnowledgeAgentSemanticRankerActivityRecord[]	Los registros de actividad para realizar un seguimiento del progreso y las implicaciones de facturación.
references	KnowledgeAgentReference[]: KnowledgeAgentAzureSearchDocReference[]	Las referencias de los datos de recuperación utilizados en la respuesta.
response	KnowledgeAgentMessage[]	Objeto de estilo de mensaje en lenguaje natural.

KnowledgeAgentSearchActivityRecord

Objeto

Representa un registro de actividad de recuperación.

Nombre	Tipo	Description
count	integer (int32)	El recuento de documentos recuperados.
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad de recuperación.
id	integer (int32)	El ID del registro de actividad.
query	Query	Los detalles de la consulta de la actividad de recuperación.
queryTime	string (date-time)	El tiempo de consulta para esta actividad de recuperación.
targetIndex	string	Índice de destino de la actividad de recuperación.
type	string: AzureSearchQuery	El tipo de registro de actividad.

KnowledgeAgentSemanticRankerActivityRecord

Objeto

Representa un registro de actividad de clasificador semántico.

Nombre	Tipo	Description
elapsedMs	integer (int32)	El tiempo transcurrido en milisegundos para la actividad del modelo.
id	integer (int32)	El ID del registro de actividad.
inputTokens	integer (int32)	El número de tokens de entrada para la actividad de clasificador semántico.
type	string: AzureSearchSemanticRanker	El tipo de registro de actividad.

Query

Objeto

Los detalles de la consulta de la actividad de recuperación.

Nombre	Tipo	Description
filter	string	La cadena de filtro.
search	string	Cadena de búsqueda.