Knowledge Retrieval - Retrieve

KnowledgeBase recupera datos relevantes de los almacenes de respaldo.

POST {endpoint}/knowledgebases('{knowledgeBaseName}')/retrieve?api-version=2026-05-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 Requerido 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-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[]:

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:

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
KnowledgeBaseRetrieveWithIntents

KnowledgeBaseRetrieve

Solicitud de ejemplo

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-05-01-preview



{
  "messages": [
    {
      "role": "user",
      "content": [
        {
          "text": "hello world",
          "type": "text"
        }
      ]
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "low"
  },
  "includeActivity": true,
  "outputMode": "answerSynthesis",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": false,
      "failOnError": false,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Respuesta de muestra

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "queryTime": "2025-01-01T00:08:45.045Z",
      "count": 2,
      "elapsedMs": 1234,
      "warning": "6 additional documents were dropped because rerankerThreshold filtered them out during reranking. Adjust the threshold if higher recall is desired.",
      "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-preview-test",
      "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,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "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"
    }
  ],
  "responseSensitivityLabelInfo": {
    "displayName": "Confidential",
    "sensitivityLabelId": "00000000-0000-0000-0000-000000000001",
    "toolTip": "This content is confidential.",
    "priority": 2,
    "color": "#FF0000",
    "isEncrypted": false
  }
}
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "modelQueryPlanning",
      "id": 0,
      "inputTokens": 11,
      "outputTokens": 22,
      "elapsedMs": 10
    },
    {
      "type": "searchIndex",
      "id": 1,
      "knowledgeSourceName": "ks-preview-test",
      "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,
      "retrievalReasoningEffort": {
        "kind": "low"
      },
      "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

POST https://previewexampleservice.search.windows.net/knowledgebases('base-preview-test')/retrieve?api-version=2026-05-01-preview



{
  "intents": [
    {
      "search": "foo",
      "type": "semantic"
    }
  ],
  "maxRuntimeInSeconds": 60,
  "maxOutputSize": 100000,
  "maxOutputDocuments": 50,
  "retrievalReasoningEffort": {
    "kind": "minimal"
  },
  "includeActivity": true,
  "outputMode": "extractiveData",
  "knowledgeSourceParams": [
    {
      "filterAddOn": "foo eq bar",
      "knowledgeSourceName": "ks-preview-test",
      "includeReferences": true,
      "includeReferenceSourceData": true,
      "alwaysQuerySource": true,
      "failOnError": true,
      "rerankerThreshold": 2.1,
      "kind": "searchIndex"
    }
  ]
}

Respuesta de muestra

{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "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,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "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"
    }
  ]
}
{
  "response": [
    {
      "content": [
        {
          "type": "text",
          "text": "[{...}]"
        }
      ]
    }
  ],
  "activity": [
    {
      "type": "searchIndex",
      "id": 0,
      "knowledgeSourceName": "ks-preview-test",
      "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,
      "retrievalReasoningEffort": {
        "kind": "minimal"
      },
      "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 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

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.

KnowledgeBaseReferenceType

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.

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.

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

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.

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

WorkIQAttribution

Información de atribución para una referencia de WorkIQ.

WorkIQKnowledgeSourceParams

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

Accept

El encabezado Aceptar.

Valor Description
application/json;odata.metadata=minimal

AzureBlobKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

ErrorAdditionalInfo

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

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

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

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

FabricOntologyKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

FileKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

ImageServingStatistics

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.

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

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

IndexedSharePointKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

IndexedSqlKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

KnowledgeBaseActivityRecordType

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

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:

La configuración del esfuerzo de razonamiento de recuperación.

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

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

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.

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.

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

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.

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

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

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

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

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

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.

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.

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

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

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

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

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.

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.

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

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

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

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

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.

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.

queryTime

string (date-time)

El tiempo de consulta para esta actividad de recuperación.

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

Representa una referencia a un documento de archivo.

Nombre Tipo Description
activitySource

integer (int32)

El identificador de actividad de origen de la referencia.

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

Contenido de la imagen.

Nombre Tipo Description
url

string (uri)

Dirección URL de la imagen.

KnowledgeBaseIndexedOneLakeActivityArguments

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

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.

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.

queryTime

string (date-time)

El tiempo de consulta para esta actividad de recuperación.

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

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.

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

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

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

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.

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.

queryTime

string (date-time)

El tiempo de consulta para esta actividad de recuperación.

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

Representa una referencia indexada de un documento de SharePoint.

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.

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

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

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

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.

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.

queryTime

string (date-time)

El tiempo de consulta para esta actividad de recuperación.

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

Representa una referencia de documento Azure SQL.

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:

indexedSql

El tipo de referencia.

KnowledgeBaseMcpServerActivityArguments

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

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

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.

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.

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

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

El objeto de estilo de mensaje de lenguaje natural.

Nombre Tipo Description
content KnowledgeBaseMessageContent[]:

Contenido del mensaje.

role

string

El papel de la respuesta de la herramienta.

KnowledgeBaseMessageContentType

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

Tipo de mensaje de imagen.

Nombre Tipo Description
image

KnowledgeBaseImageContent

El contenido de la imagen.

type string:

image

El tipo de mensaje

KnowledgeBaseMessageTextContent

Tipo de mensaje de texto.

Nombre Tipo Description
text

string

Contenido de texto.

type string:

text

El tipo de mensaje

KnowledgeBaseModelAnswerSynthesisActivityRecord

Representa un registro de actividad de síntesis de respuestas 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 síntesis de respuestas LLM.

modelName

string

El nombre del modelo utilizado para la actividad de síntesis de respuestas del LLM.

outputTokens

integer (int32)

El número de tokens de salida para la actividad de síntesis de respuestas LLM.

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

Representa un registro de actividad de planeación de consultas 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)

Número de tokens de entrada para la actividad de planeación de consultas LLM.

modelName

string

El nombre del 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.

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

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.

modelName

string

El nombre del 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.

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.

KnowledgeBaseReferenceType

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

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

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

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.

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.

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

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

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[]:

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:

La configuración del esfuerzo de razonamiento de recuperación.

KnowledgeBaseRetrievalResponse

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

Nombre Tipo Description
activity KnowledgeBaseActivityRecord[]:

Los registros de actividad para realizar un seguimiento del progreso y las implicaciones de facturación.

references KnowledgeBaseReference[]:

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

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

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.

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.

searchIndexArguments

KnowledgeBaseSearchIndexActivityArguments

Los argumentos del índice de búsqueda para la actividad de recuperación.

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

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.

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

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

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.

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.

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

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

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

Representa un registro de actividad de recuperación WorkIQ.

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.

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.

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

Representa una referencia de un documento WorkIQ.

Nombre Tipo Description
activitySource

integer (int32)

El identificador de actividad de origen de la referencia.

attributions

WorkIQAttribution[]

Las atribuciones 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:

workIQ

El tipo de referencia.

KnowledgeRetrievalIntentType

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

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

Nombre Tipo Description
kind string:

low

El tipo de esfuerzo de razonamiento.

KnowledgeRetrievalMediumReasoningEffort

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

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

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

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.

KnowledgeRetrievalSemanticIntent

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

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.

McpServerKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

PurviewSensitivityLabelInfo

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

Nombre Tipo Description
color

string

Color que la interfaz de usuario debe mostrar para la etiqueta, si está configurada.

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

Identificador de la etiqueta de confidencialidad.

toolTip

string

Información sobre herramientas que se debe mostrar para la etiqueta en una interfaz de usuario.

RemoteSharePointKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

SearchIndexFieldReference

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

Nombre Tipo Description
name

string

Nombre del campo.

SearchIndexKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

WebKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.

WorkIQAttribution

Información de atribución para una referencia de WorkIQ.

Nombre Tipo Description
seeMoreWebUrl

string (uri)

Dirección URL de la atribución.

WorkIQKnowledgeSourceParams

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.

rerankerThreshold

number (float)

El umbral de reranker que deben cumplir todos los documentos recuperados para ser incluidos en la respuesta.