Seguimiento del estado de trabajos de base de conocimientos en tiempo real mediante GetIndexJobStatus - Model Studio - Alibaba Cloud_Alibaba Cloud Model Studio(Model Studio) - Alibaba Cloud Model Studio

Consulta el estado actual de una tarea de creación de base de conocimientos o de una tarea de adición de documentos a la base de conocimientos especificada.

Descripción de la operación

Los usuarios de Resource Access Management (RAM) deben obtener primero los permisos de API para Alibaba Cloud Model Studio (AliyunBailianDataFullAccess o AliyunBailianDataReadOnlyAccess, ambos incluyen el permiso sfm:GetIndexJobStatus), y unirse a un espacio de trabajo antes de invocar esta operación. Las cuentas de Alibaba Cloud pueden invocar esta operación directamente sin autorización. Utilice el último SDK de Alibaba Cloud Model Studio para invocar esta operación.
Debe tener un trabajo de base de conocimientos en curso. Puede crear una tarea de creación de base de conocimientos invocando la operación SubmitIndexJob, o crear una tarea de adición de documentos a la base de conocimientos invocando la operación SubmitIndexAddDocumentsJob. Obtenga el JobId correspondiente.
Invoque esta operación a intervalos de 5 segundos o más.
Esta operación admite idempotencia.

Probar ahora

Pruebe esta API en OpenAPI Explorer; no es necesaria la firma manual. Las llamadas exitosas generan automáticamente código SDK que coincide con sus parámetros. Descárguelo con seguridad de credenciales integrada para uso local.

Prueba

Autorización de RAM

La siguiente tabla describe la autorización necesaria para llamar a esta API. Puede definirla en una política de Resource Access Management (RAM). Las columnas de la tabla se detallan a continuación:

Action: Las acciones se pueden utilizar en el elemento Action de las declaraciones de políticas de permisos de RAM para otorgar permisos para realizar la operación.
API: La API que puede llamar para realizar la acción.
Nivel de acceso: El nivel de acceso predefinido otorgado para cada API. Valores válidos: create, list, get, update y delete.
Tipo de recurso: El tipo de recurso que admite la autorización para realizar la acción. Indica si la acción admite permisos a nivel de recurso. El recurso especificado debe ser compatible con la acción. De lo contrario, la política será ineficaz.
- Para las API con permisos a nivel de recurso, los tipos de recursos requeridos están marcados con un asterisco (*). Especifique el Nombre de recurso de Alibaba Cloud (ARN) correspondiente en el elemento Resource de la política.
- Para las API sin permisos a nivel de recurso, se muestra como Todos los recursos. Utilice un asterisco (*) en el elemento Resource de la política.
Clave de condición: Las claves de condición definidas por el servicio. La clave permite un control granular, aplicándose ya sea solo a acciones o a acciones asociadas con recursos específicos. Además de las claves de condición específicas del servicio, Alibaba Cloud proporciona un conjunto de claves de condición comunes aplicables a todos los servicios compatibles con RAM.
Acción dependiente: Las acciones dependientes necesarias para ejecutar la acción. Para completar la acción, el usuario de RAM o el rol de RAM debe tener los permisos para realizar todas las acciones dependientes.

Acción	Nivel de acceso	Tipo de recurso	Clave de condición	Acción dependiente
sfm:GetIndexJobStatus	get	Todos los recursos ``	None	None

Acción

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sfm:GetIndexJobStatus

get

*Todos los recursos

*

None

Sintaxis de la solicitud

GET /{WorkspaceId}/index/job/status HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del espacio de trabajo. Asegúrese de que la base de conocimientos que want operar se encuentre en este espacio de trabajo. Para obtener información sobre cómo obtener el ID del espacio de trabajo, consulte Cómo usar un espacio de trabajo.	llm-3z7uw7fwz0vexxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
JobId	string	Sí	El ID del trabajo de la base de conocimientos, que es el `Data.Id` devuelto por la operación SubmitIndexJob o SubmitIndexAddDocumentsJob.	20230718xxxx-146c93bf
IndexId	string	Sí	El ID de la base de conocimientos, que es el `Data.Id` devuelto por la operación CreateIndex.	79c0alxxxx
PageNumber	integer	No	Tanto las operaciones SubmitIndexJob como SubmitIndexAddDocumentsJob admiten la importación masiva de archivos. Esta operación devuelve el estado general del trabajo de la base de conocimientos (`Status`) y el estado de importación de cada archivo (`Document.Status`). Si hay muchos archivos, utilice el parámetro `PageNumber` para realizar una consulta paginada. Valor mínimo: 1. Valor predeterminado: 1.	1
pageSize	integer	No	El número de tareas de importación de archivos que se mostrarán por página en una consulta paginada. Sin límite máximo. Valor predeterminado: 10.	10

Elementos de respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta
Code	string	El código de estado de error.	Index.Forbidden
Data	object	El campo de datos devuelto por la operación.
Documents	array<object>	La lista de archivos importados en este trabajo.
	object	El objeto de archivo.
Code	string	El código de error.	Index.Document.ChunkError
DocId	string	El ID del archivo.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
DocName	string	El nombre del archivo.	Introducción al producto XXX
Message	string	El mensaje de error.	Error de análisis de documento
Status	string	El estado de importación del archivo. Valores válidos: INSERT_ERROR: Error en la importación del archivo. RUNNING: El archivo se está importando. DELETED: El archivo ha sido eliminado. FINISH: El archivo fue importado.	RUNNING
GmtModified	integer
JobId	string	El ID del trabajo.	66122af12a4e45ddae6bd6c84555xxxx
Status	string	El estado actual del trabajo de la base de conocimientos. Valores válidos: COMPLETED: Ejecución exitosa. FAILED: Error en la ejecución. RUNNING: Ejecución en curso. PENDING: Esperando ejecución. Valores válidos: COMPLETED : Ejecución exitosa. FAILED : Error en la ejecución. RUNNING : Ejecución en curso. PENDING : Esperando ejecución.	PENDING
Message	string	El mensaje de error.	Usuario no autorizado para operar en el recurso especificado.
RequestId	string	El ID de la solicitud.	17204B98-xxxx-4F9A-8464-2446A84821CA
Status	string	El código de estado devuelto por la operación.	200
Success	boolean	Indica si la operación fue exitosa. Valores válidos: true: Exitoso. false: Fallido.	true

Ejemplos

Respuesta exitosa

Formato JSON

{
  "Code": "Index.Forbidden",
  "Data": {
    "Documents": [
      {
        "Code": "Index.Document.ChunkError",
        "DocId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
        "DocName": "XXX产品介绍",
        "Message": "document parse error",
        "Status": "RUNNING",
        "GmtModified": 0
      }
    ],
    "JobId": "66122af12a4e45ddae6bd6c84555xxxx",
    "Status": "PENDING"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Códigos de error

Consulte Códigos de error para obtener una lista completa.

Notas de lanzamiento

Consulte Notas de lanzamiento para obtener una lista completa.