Knowledge Sources - Get Status

Servicio:: Search Service

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

Recupera el estado de una fuente de conocimiento.

GET {endpoint}/knowledgesources('{sourceName}')/status?api-version=2026-08-01-preview

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
endpoint	path	True	string (uri)	La dirección URL del punto de conexión del servicio de búsqueda.
sourceName	path	True	string	El nombre de la fuente 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.

Respuestas

Nombre	Tipo	Description
200 OK	KnowledgeSourceStatus	La solicitud se ha realizado correctamente.
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

SearchServiceGetKnowledgeSourceStatus

Solicitud de ejemplo

HTTP

GET https://typespecpreviewexampleservice.search.windows.net/knowledgesources('ks-preview-test')/status?api-version=2026-08-01-preview

Respuesta de muestra

status code:: 200

{
  "kind": "azureBlob",
  "synchronizationStatus": "active",
  "synchronizationInterval": "1d",
  "currentSynchronizationState": {
    "startTime": "2024-11-26T03:37:18.853Z",
    "itemsUpdatesProcessed": 10,
    "itemsUpdatesFailed": 2,
    "itemsSkipped": 1,
    "errors": []
  },
  "lastSynchronizationState": {
    "startTime": "2024-11-25T03:37:18.853Z",
    "endTime": "2024-11-25T03:38:19.012Z",
    "itemsUpdatesProcessed": 8,
    "itemsUpdatesFailed": 1,
    "itemsSkipped": 0
  },
  "statistics": {
    "totalSynchronization": 5,
    "averageSynchronizationDuration": "PT30M",
    "averageItemsProcessedPerSynchronization": 100
  }
}

Definiciones

Nombre	Description
Accept	El encabezado Aceptar.
CompletedSynchronizationState	Representa el estado completado de la última sincronización.
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).
KnowledgeSourceKind	El tipo de fuente de conocimiento.
KnowledgeSourceStatistics	Información estadística sobre el historial de sincronización de fuentes de conocimiento.
KnowledgeSourceStatus	Representa el estado y el historial de sincronización de un origen de conocimiento.
KnowledgeSourceSynchronizationError	Representa un error de indexación a nivel de documento encontrado durante una ejecución de sincronización de fuente de conocimiento.
KnowledgeSourceSynchronizationStatus	El estado de sincronización actual del origen de conocimiento.
SynchronizationState	Representa el estado actual de una sincronización en curso que abarca varias ejecuciones del indexador.

Accept

Enumeración

El encabezado Aceptar.

Valor	Description
application/json;odata.metadata=minimal

CompletedSynchronizationState

Objeto

Representa el estado completado de la última sincronización.

Nombre	Tipo	Description
endTime	string (date-time)	La hora de finalización de la última sincronización completada.
itemsSkipped	integer (int32)	El número de elementos omitidos en la última sincronización.
itemsUpdatesFailed	integer (int32)	El número de actualizaciones de elementos que fallaron en la última sincronización.
itemsUpdatesProcessed	integer (int32)	El número de actualizaciones de elementos procesadas correctamente en la última sincronización.
startTime	string (date-time)	La hora de inicio de la última sincronización completada.

ErrorAdditionalInfo

Objeto

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

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

ErrorDetail

Objeto

Detalle del error.

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

ErrorResponse

Objeto

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

Nombre	Tipo	Description
error	ErrorDetail	Objeto de error.

KnowledgeSourceKind

Enumeración

El tipo de fuente de conocimiento.

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

KnowledgeSourceStatistics

Objeto

Información estadística sobre el historial de sincronización de fuentes de conocimiento.

Nombre	Tipo	Description
averageItemsProcessedPerSynchronization	integer (int32)	Elementos promedio procesados por sincronización.
averageSynchronizationDuration	string	Duración media de sincronización en formato HH:MM:SS.
totalSynchronization	integer (int32)	Número total de sincronizaciones.

KnowledgeSourceStatus

Objeto

Representa el estado y el historial de sincronización de un origen de conocimiento.

Nombre	Tipo	Description
currentSynchronizationState	SynchronizationState	Estado de sincronización actual que abarca varias ejecuciones del indexador.
kind	KnowledgeSourceKind	Identifica el tipo Fuente de Conocimiento directamente a partir de la respuesta de Estado.
lastSynchronizationState	CompletedSynchronizationState	Detalles de la última sincronización completada. Nulo en la primera sincronización.
statistics	KnowledgeSourceStatistics	Información estadística sobre el historial de sincronización de la fuente de conocimiento. Nulo en la primera sincronización.
synchronizationInterval	string	El intervalo de sincronización (por ejemplo, '1d' para diario). Nulo si no se configura ninguna programación.
synchronizationStatus	KnowledgeSourceSynchronizationStatus	El estado actual de sincronización.

KnowledgeSourceSynchronizationError

Objeto

Representa un error de indexación a nivel de documento encontrado durante una ejecución de sincronización de fuente de conocimiento.

Nombre	Tipo	Description
details	string	Información contextual adicional sobre el fallo.
docId	string	El identificador único del documento o elemento fallido dentro de la ejecución de sincronización.
documentationLink	string	Un enlace a la documentación relevante para la resolución de problemas.
errorMessage	string	Mensaje de error legible para humanos, visible para el cliente.
name	string	Nombre del componente de ingestión o procesamiento que informa del error.
statusCode	integer (int32)	Código de estado similar a HTTP que representa la categoría de fallo (por ejemplo, 400).

KnowledgeSourceSynchronizationStatus

Enumeración

El estado de sincronización actual del origen de conocimiento.

Valor	Description
creating	Se está aprovisionando el origen de conocimiento.
active	El origen de conocimiento está activo y se están produciendo ejecuciones de sincronización.
deleting	El origen de conocimiento se está eliminando y la sincronización está en pausa.

SynchronizationState

Objeto

Representa el estado actual de una sincronización en curso que abarca varias ejecuciones del indexador.

Nombre	Tipo	Description
errors	KnowledgeSourceSynchronizationError[]	Colección de errores de indexación a nivel de documento encontrados durante la ejecución actual de sincronización. Solo se devuelve cuando hay errores presentes.
itemsSkipped	integer (int32)	El número de elementos omitidos en la sincronización actual.
itemsUpdatesFailed	integer (int32)	El número de actualizaciones de elementos que fallaron en la sincronización actual.
itemsUpdatesProcessed	integer (int32)	El número de actualizaciones de elementos procesadas correctamente en la sincronización actual.
startTime	string (date-time)	La hora de inicio de la sincronización actual.