Todos los productos
Search

Este producto

    Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

    Centro de documentos

    Alibaba Cloud Model Studio:SubmitIndexAddDocumentsJob

    Última actualización: Oct 12, 2026

    Agrega archivos analizados a una base de conocimientos especificada.

    Descripción de la operación

    • Esta operación no admite bases de conocimientos de consulta de datos ni de preguntas y respuestas con imágenes. Para obtener información sobre cómo actualizar bases de conocimientos de consulta de datos o de preguntas y respuestas con imágenes, consulte las instrucciones de actualización de bases de conocimientos en Base de conocimientos.
    • 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:SubmitIndexAddDocumentsJob) 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, asegúrese de que su base de conocimientos se haya creado y no se haya eliminado (es decir, que el ID de la base de conocimientos IndexId sea válido).
    • Antes de invocar esta operación, invoque la operación AddFile para cargar los archivos que want agregar a Model Studio.
    • 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. La lista de archivos Documents devuelta por esta operación contiene todos los archivos en este trabajo de adición (identificados de forma única por el job_id que proporcione), y puede verificar si cada archivo se importó (analizó) correctamente. Tenga en cuenta que invocar GetIndexJobStatus con demasiada frecuencia activará límites de velocidad. No exceda una frecuencia de 20 veces por minuto.
    • Después de invocar esta operación correctamente, se requiere tiempo para su ejecución. No envíe solicitudes duplicadas antes de recibir la respuesta. Esta operación no es idempotente.

    Límite de velocidad: Las llamadas frecuentes a esta operación serán limitadas. No exceda las 10 llamadas por segundo. Si se limita la velocidad, 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:SubmitIndexAddDocumentsJob

    create

    *Todos los recursos

    *

    		NoneNone

    Sintaxis de la solicitud 

    POST /{WorkspaceId}/index/add_documents_to_index 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

    SourceType

    string

    Sí

    El tipo de origen de datos. Valores válidos:

    • DATA_CENTER_CATEGORY: tipo de categoría. Importa todos los documentos bajo las categorías especificadas en Datos de la aplicación. Se admiten varias categorías.

    • DATA_CENTER_FILE: tipo de documento. Importa archivos especificados desde Datos de la aplicación. Se admiten varios archivos.

    Si este parámetro se establece en DATA_CENTER_CATEGORY, debe especificar el parámetro CategoryIds. Si este parámetro se establece en DATA_CENTER_FILE, debe especificar el parámetro DocumentIds.

    Valores válidos:

    • DATA_CENTER_CATEGORY :

      tipo de categoría.

    • DATA_CENTER_FILE :

      tipo de documento.

    DATA_CENTER_FILE

    DocumentIds

    array

    No

    La lista de IDs de archivos.

    string

    No

    El ID del archivo, que es el FileId devuelto por la operación AddFile. También puede obtener el ID del archivo en la página Datos de la aplicación haciendo clic en el icono de ID junto al nombre del archivo.

    doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx

    CategoryIds

    array

    No

    La lista de IDs de categorías.

    string

    No

    El ID de la categoría, que es el CategoryId devuelto por la operación AddCategory. También puede obtener el ID de la categoría en la pestaña Archivos de Datos de la aplicación haciendo clic en el icono de ID junto a la categoría.

    cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx

    ChunkMode

    string

    No

    Este parámetro aún no está disponible. No especifique este parámetro.

    longitud

    Separator

    string

    No

    Este parámetro aún no está disponible. No especifique este parámetro.

    (?<=。)

    ChunkSize

    integer

    No

    Este parámetro aún no está disponible. No especifique este parámetro.

    128

    OverlapSize

    integer

    No

    Este parámetro aún no está disponible. No especifique este parámetro.

    16

    EnableHeaders

    boolean

    No

    Especifica si se debe habilitar el ensamblaje de encabezados para archivos de Excel. Cuando está habilitado, la base de conocimientos trata la primera fila de todos los archivos xlsx y xls como encabezados y los agrega automáticamente a cada fragmento de texto (fila de datos), evitando que el modelo de lenguaje grande trate los encabezados como filas de datos normales.

    Habilite esta función solo cuando todos los archivos importados estén en formato xlsx o xls y contengan encabezados. De lo contrario, déjela deshabilitada.

    Valores válidos:

    • true: Habilitado.

    • false: Deshabilitado.

    Valor predeterminado: false.

    Valores válidos:

    • true :

      Habilitado.

    • false :

      Deshabilitado.

    false

    Extra

    object

    No

    uniqueId

    string

    No

    Elementos de respuesta

    Elemento

    Tipo

    Descripción

    Ejemplo

    object

    Esquema de la respuesta

    RequestId

    string

    El ID de la solicitud.

    778C0B3B-xxxx-5FC1-A947-36EDD13606AB

    Data

    object

    Los datos comerciales devueltos por la operación.

    Id

    string

    El ID de la tarea, también conocido como JobId.

    42687eb254a34802bed398357f5498ae

    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

    Message

    string

    El mensaje de error.

    Falta el parámetro obligatorio (%s) o no es válido; compruebe los parámetros de la solicitud.

    Code

    string

    El código de error.

    Index.InvalidParameter

    Ejemplos

    Respuesta exitosa

    Formato JSON

    {
  "RequestId": "778C0B3B-xxxx-5FC1-A947-36EDD13606AB",
  "Data": {
    "Id": "42687eb254a34802bed398357f5498ae"
  },
  "Status": "200",
  "Success": true,
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Code": "Index.InvalidParameter"
}

    Códigos de error

    Código de estado HTTP

    Código de error

    Mensaje de error

    Descripción

    400IdempotentParameterMismatchLa 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.

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

    Notas de lanzamiento

    Consulte Notas de lanzamiento para obtener una lista completa.