Alibaba Cloud Model Studio:SubmitIndexJob

Envía una tarea CreateIndex especificada para completar la creación de la base de conocimientos.

Descripción de la operación

• Los usuarios de Resource Access Management (RAM) deben obtener primero permisos de API para Model Studio (lo cual requiere AliyunBailianDataFullAccess, que incluye el permiso sfm:SubmitIndexJob) 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 la versión más reciente del SDK de Model Studio para invocar esta operación.
• Antes de invocar esta operación, debe invocar la operación CreateIndex y obtener el IndexId correspondiente.
• Después de invocar esta operación, el nodo requiere tiempo para ejecutarse y puede tardar varias horas durante los períodos pico. No envíe solicitudes duplicadas antes de que el nodo se complete. Para consultar el estado de ejecución del nodo, invoque la operación GetIndexJobStatus.
• Una vez creada la base de conocimientos, puede asociarla con una aplicación de agente en el mismo espacio de trabajo a través de Gestión de aplicaciones (o pasar el IndexID mediante rag_options en Llamadas de aplicación) para complementar su aplicación Model Studio con conocimiento privado e información actualizada. También puede optar por no utilizar una aplicación Model Studio y consultar directamente la base de conocimientos invocando la operación Retrieve.
• Esta operación no admite idempotencia.

Límite de tasa: Esta operación se limita si se llama con demasiada frecuencia. No exceda las 10 llamadas por segundo. Si se limita la tasa, reinténtelo más tarde.

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:SubmitIndexJob	create	*Todos los recursos *	None	None

Sintaxis de la solicitud

POST /{WorkspaceId}/index/submit_index_job HTTP/1.1

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del espacio de trabajo al que pertenece la base de conocimientos. Para obtener información sobre cómo conseguir el ID del espacio de trabajo, consulte Cómo usar un espacio de trabajo.	llm-3shx2gu255oqxxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
IndexId	string	Sí	El ID de la base de conocimientos, que es el Data.Id devuelto por la operación CreateIndex.	79c0alxxxx

Elementos de respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta
Code	string	El código de error.	Index.InvalidParameter
Data	object	Los datos comerciales devueltos por la operación.
Id	string	El ID de la tarea, que es el JobId requerido al llamar a la operación GetIndexJobStatus.	eFDr2fGRzP9gdDZWAdo3xxxx
IndexId	string	El ID de la base de conocimientos.	79c0alxxxx
Message	string	El mensaje de error.	Falta el parámetro obligatorio (%s) o no es válido; compruebe los parámetros de la solicitud.
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.InvalidParameter",
  "Data": {
    "Id": "eFDr2fGRzP9gdDZWAdo3xxxx",
    "IndexId": "79c0alxxxx"
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Status": "200",
  "Success": true
}

Códigos de error

Código de estado HTTP	Código de error	Mensaje de error	Descripción
400	RagIndex.IdempotentParameterMismatch	La solicitud utiliza el mismo token de cliente que una solicitud anterior, pero no idéntica. No reutilice un token de cliente con solicitudes diferentes, a menos que las solicitudes sean idénticas.	Esta solicitud utiliza el mismo token de cliente que la solicitud anterior, pero diferente. No reutilice tokens de cliente con solicitudes diferentes a menos que la solicitud sea la misma.

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

Notas de lanzamiento

Consulte Notas de lanzamiento para obtener una lista completa.