Creación de una base de conocimientos mediante la API CreateIndex para RAG - Model Studio - Alibaba Cloud_Alibaba Cloud Model Studio(Model Studio) - Alibaba Cloud Model Studio

Crea una base de conocimientos, ya sea una base de conocimientos no estructurada basada en documentos o audio/video, o una base de conocimientos estructurada para consultas de datos o preguntas y respuestas basadas en imágenes.

Descripción de la operación

Requisitos de permisos:
- Usuario de Resource Access Management (RAM): Obtenga primero los permisos de API para Alibaba Cloud Model Studio (puede usar la política AliyunBailianDataFullAccess, que incluye el permiso sfm:CreateIndex requerido por esta operación), y únase a un espacio de trabajo antes de invocar esta operación.
- Cuenta de Alibaba Cloud: Tiene permisos de forma predeterminada y puede invocar esta operación directamente.
Método de llamada: Utilice el SDK de Alibaba Cloud Model Studio más reciente. El SDK ha encapsulado la lógica compleja de cálculo de firmas y simplifica el procedimiento de invocación.
Qué hacer a continuación: Esta operación solo realiza la inicialización del trabajo de creación de la base de conocimientos. Después de invocar esta operación, debe invocar la operación SubmitIndexJob para completar la creación (de lo contrario, obtendrá una base de conocimientos vacía). Para ejemplos de código, consulte la Guía de API de base de conocimientos.
Idempotencia: Esta operación no tiene idempotencia. Las invocaciones repetidas pueden crear múltiples bases de conocimientos con el mismo nombre. Implemente invocaciones idempotentes consultando primero y luego creando.

Límite de velocidad: Esta operación está sujeta a limitación de velocidad. 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:CreateIndex	create	Todos los recursos ``	None	None

Acción

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sfm:CreateIndex

create

*Todos los recursos

*

None

Sintaxis de la solicitud

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

Parámetros de ruta

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
WorkspaceId	string	Sí	El ID del espacio de trabajo, que especifica el espacio de trabajo en el que se creará la base de conocimientos. Para obtener más información, consulte Cómo usar espacios de trabajo.	llm-3z7uw7fwz0vexxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
Name	string	Sí	El nombre de la base de conocimientos. El nombre debe tener de 1 a 20 caracteres de longitud y puede contener caracteres chinos, letras, dígitos, guiones bajos (_), guiones (-), puntos (.) y dos puntos (:).	EnterpriseHelpDocLibrary.
StructureType	string	Sí	El tipo de base de conocimientos. Valores válidos: unstructured: Una base de conocimientos de búsqueda de documentos o de audio/video. El escenario predeterminado para el tipo de búsqueda de documentos es preguntas y respuestas básicas sobre documentos. El tipo de base de conocimientos no se puede cambiar después de la creación. Valores válidos: unstructured : unstructured	unstructured
EmbeddingModelName	string	No	El modelo de incrustación utilizado por la base de conocimientos. El modelo de incrustación transforma el prompt de entrada original y el texto de conocimiento en vectores numéricos para la comparación de similitud. El modelo predeterminado text-embedding-v2 (no se puede cambiar) admite chino, inglés y múltiples otros idiomas, y realiza normalización en los resultados vectoriales. Para obtener más información, consulte Vectorización. Valores válidos: text-embedding-v2 Valor predeterminado: vacío, lo que utiliza el modelo text-embedding-v2.	text-embedding-v4
RerankModelName	string	No	El modelo de reclasificación utilizado por la base de conocimientos. El modelo de reclasificación es un sistema de puntuación externo que calcula la puntuación de similitud entre la consulta del usuario y cada fragmento de texto en la base de conocimientos, los ordena en orden descendente y devuelve los K mejores fragmentos de texto con las puntuaciones más altas. Valores válidos: gte-rerank-hybrid: reclasificación oficial. gte-rerank: reclasificación gte-rerank. Valor predeterminado: vacío, lo que utiliza gte-rerank-hybrid. Si solo necesita reclasificación semántica, utilice `gte-rerank`. Si necesita tanto reclasificación semántica como funciones de coincidencia de texto para garantizar la relevancia, utilice `gte-rerank-hybrid`. Valores válidos: gte-rerank-hybrid : reordenamiento oficial. gte-rerank : reordenamiento gte-rerank.	gte-rerank-hybrid
RerankMinScore	number	No	El umbral de similitud. Solo se recuperan los fragmentos de texto con puntuaciones de similitud que superen este valor. Este parámetro filtra los fragmentos de texto devueltos por el modelo de reclasificación. Rango de valores: [0.01-1.00]. Si no se especifica, el valor predeterminado es 0.01.	0.20
ChunkSize	integer	No	El tamaño del fragmento, que especifica el número máximo de caracteres por fragmento de texto. Cuando se supera esta longitud, es probable que el texto se trunque. Rango de valores: [1-6000]. Si no se especifica, el valor predeterminado es 500. Si `ChunkSize` se establece en un valor menor que 100, también debe establecer `OverlapSize`. También puede dejar ambos parámetros sin especificar, y el sistema utilizará los valores predeterminados.	128
OverlapSize	integer	No	El tamaño de superposición de fragmentos, que especifica el número de caracteres superpuestos entre el fragmento de texto actual y el anterior. Rango de valores: [0-1024]. Si no se especifica, el valor predeterminado es 100. `OverlapSize` debe ser menor que `ChunkSize`. De lo contrario, se producirán excepciones de fragmentación.	16
Separator	string	No	Este parámetro no está disponible. No pase este parámetro.	(?<=。)
SourceType	string	No	Este parámetro es obligatorio en el SDK más reciente. De lo contrario, llamar a la operación SubmitIndexJob devuelve un error: Parámetro obligatorio (data_sources) faltante o no válido. El tipo de origen de datos. Valores válidos: DATA_CENTER_CATEGORY: Tipo de categoría. Importa todos los archivos bajo las categorías especificadas en Datos de la aplicación. Se pueden importar varias categorías simultáneamente. DATA_CENTER_FILE: Tipo de archivo. Importa archivos específicos desde Datos de la aplicación. Se pueden importar varios archivos simultáneamente. 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`. Para crear una base de conocimientos vacía, utilice una categoría vacía que no contenga archivos: establezca este parámetro en DATA_CENTER_CATEGORY y pase el ID de la categoría vacía en `CategoryIds`. Valores válidos: DATA_CENTER_CATEGORY : tipo de categoría. DATA_CENTER_FILE : tipo de archivo.	DATA_CENTER_FILE
DocumentIds	array	No	La lista de archivos para importar al crear la base de conocimientos. Especifique aquí los ID de los archivos. Recomendamos importar no más de 10,000 archivos. Para los archivos restantes, llame a la operación SubmitIndexAddDocumentsJob para continuar con la importación.
	string	No	El ID del archivo, que es el `FileId` devuelto por la operación AddFile, u obtenido haciendo clic en el icono de ID junto al nombre del archivo en la pestaña Archivos de Datos de la aplicación.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
CategoryIds	array	No	La lista de ID de categorías para importar al crear la base de conocimientos. Se importan todos los archivos bajo las categorías especificadas. Recomendamos importar no más de 500 archivos. Para los archivos restantes, llame a la operación SubmitIndexAddDocumentsJob para continuar con la importación.
	string	No	El ID de la categoría, que es el `CategoryId` devuelto por la operación AddCategory, u obtenido haciendo clic en el icono de ID junto al nombre de la categoría en la pestaña Archivos de Datos de la aplicación.	ca_hiu2383nfxxxx
TableIds	array	No	Este parámetro no está disponible. No pase este parámetro.
	string	No
SinkType	string	Sí	El tipo de almacenamiento vectorial de la base de conocimientos. Para obtener más información, consulte Base de conocimientos. Valores válidos: BUILT_IN: Los datos vectoriales se alojan en la plataforma Alibaba Cloud Model Studio. ADB: Base de datos AnalyticDB for PostgreSQL. Si necesita funciones avanzadas como gestión de bases de datos, auditoría y monitoreo, seleccione ADB. Si no ha utilizado el almacenamiento ADB en Alibaba Cloud Model Studio anteriormente, vaya a la página Crear base de conocimientos, seleccione ADB-PG como tipo de almacenamiento vectorial y complete la autorización según se le indique. Si utiliza ADB, debe especificar los parámetros `SinkInstanceId` y `SinkRegion`. Valores válidos: BUILT_IN : BUILT_IN ADB : ADB	BUILT_IN
SinkInstanceId	string	No	El ID de la instancia de AnalyticDB for PostgreSQL (requerido solo cuando `SinkType` se establece en ADB). Obtenga este ID de la página de Lista de instancias de AnalyticDB for PostgreSQL.	gp-bp32109xxxx
SinkRegion	string	No	La región de la instancia de AnalyticDB for PostgreSQL (requerida solo cuando `SinkType` se establece en ADB). Llame a DescribeRegions para obtener la lista de regiones.	cn-hangzhou
Columns	array<object>	No	Este parámetro no está disponible. No pase este parámetro.
	object	No	Este parámetro no está disponible. No pase este parámetro.
Column	string	No	Este parámetro no está disponible. No pase este parámetro.	school
IsRecall	boolean	No	Este parámetro no está disponible. No pase este parámetro.	true
IsSearch	boolean	No	Este parámetro no está disponible. No pase este parámetro.	true
Name	string	No	Este parámetro no está disponible. No pase este parámetro.	Escuela.
Type	string	No	Este parámetro no está disponible. No pase este parámetro.	string
Description	string	No	La descripción de la base de conocimientos. La descripción puede tener hasta 1000 caracteres de longitud. Valor predeterminado: vacío.	La biblioteca de documentos de ayuda empresarial incluye materiales importantes como políticas de la empresa y catálogos de productos.
metaExtractColumns	array<object>	No	La configuración de extracción de metadatos. Los metadatos son un conjunto de atributos adicionales relacionados con el contenido de datos no estructurados. Estos atributos se integran en los fragmentos de texto como pares clave-valor. Para obtener más información, consulte Base de conocimientos.
	object	No
Key	string	No	El campo de metadatos. El campo debe tener de 1 a 50 caracteres de longitud y solo puede contener letras y guiones bajos. Si se especifica este parámetro, también debe especificar los parámetros `Value` y `Type`.	author
Value	string	No	El valor del campo de metadatos.	Tim
Type	string	No	El método de extracción para el campo de metadatos. Valores válidos: constant: Constante. variable: Variable. custom_prompt: Modelo de lenguaje grande. regular: Expresión regular. keywords: Búsqueda por palabras clave. Valores válidos: constant : extracción constante. keywords : extracción de palabras clave. custom_prompt : modelo de lenguaje grande. variable : extracción variable. regular : expresión regular.	constant
Desc	string	No	La descripción en chino del campo de metadatos. La descripción puede tener hasta 1000 caracteres de longitud y puede contener caracteres chinos, letras, dígitos, guiones bajos (_), guiones (-), puntos (.) y dos puntos (:). Valor predeterminado: vacío.	AuthorName.
EnableLlm	boolean	No	Especifica si este campo de metadatos y su valor participan en el proceso de generación de respuestas del modelo de lenguaje grande junto con el contenido del fragmento de texto. Valores válidos: true: Habilitado. false: Deshabilitado. Valor predeterminado: false. Valores válidos: true : habilitado. false : deshabilitado.	false
EnableSearch	boolean	No	Especifica si este campo de metadatos y su valor participan en la recuperación de la base de conocimientos junto con el contenido del fragmento de texto. Valores válidos: true: Habilitado. false: Deshabilitado. Valor predeterminado: false. Valores válidos: true : habilitado. false : deshabilitado.	false
enableHeaders	boolean	No	Especifica si se debe tratar la primera fila de todos los archivos xlsx y xls como encabezados y concatenarlos en cada fragmento de texto, 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, no la habilite. Valores válidos: true: Habilitado. false: Deshabilitado. Si no se especifica, esta función está deshabilitada de forma predeterminada. Valores válidos: true : habilitado. false : deshabilitado.	false
chunkMode	string	No	Este parámetro no está disponible. No pase este parámetro. Valores válidos: regex : fragmentar por expresión regular. length : fragmentar por longitud. h1 : fragmentar por encabezados de primer nivel. h2 : fragmentar por encabezados de segundo nivel. page : fragmentar por página.	regex
EnableRewrite	boolean	No	Especifica si se debe habilitar la reescritura de conversaciones de múltiples turnos. Valores válidos: true: Habilitado. false: Deshabilitado. Si no se especifica, esta función está habilitada de forma predeterminada. Valores válidos: true : habilitado. false : deshabilitado.	true
CreateIndexType	string	No	Este parámetro no está disponible. No pase este parámetro.	standard
pipelineCommercialType	string	No	Este parámetro no está disponible. No pase este parámetro.	standard
pipelineCommercialCu	integer	No	Este parámetro no está disponible. No pase este parámetro.	1
pipelineRetrieveRateLimitStrategy	string	No	Este parámetro no está disponible. No pase este parámetro.	downgrade
knowledgeType	string	No	El código del origen de datos. Obligatorio al crear una base de conocimientos de consulta de datos. Se utiliza junto con los parámetros de tabla y base de datos. Esta operación no admite asociar bases de datos personalizadas. Utilice la consola de Alibaba Cloud Model Studio para crearlas.	260xxx
RerankMode	string	No	El nombre de la tabla de datos. Obligatorio al crear una base de conocimientos de consulta de datos. La tabla de datos debe existir en el origen de datos especificado por connectId o datasourceCode. Valores válidos: similar: Modo de similitud. : similar: Modo de similitud. custom: Modo personalizado. : custom: Modo personalizado. qa:(Predeterminado) Modo de preguntas y respuestas. : qa:(Predeterminado) Modo de preguntas y respuestas. similar: : similar: Modo de similitud. custom: : custom: Modo personalizado. : qa: (Predeterminado) Modo de preguntas y respuestas.	lance
RerankInstruct	string	No	El nombre de la base de datos. Obligatorio al crear una base de conocimientos de consulta de datos. La base de datos debe existir en el origen de datos especificado por datasourceCode.	database_a6eacabe6
		No	Este parámetro no está disponible. No pase este parámetro.	document
		No	Este parámetro no está disponible. No pase este parámetro.	basic_document_qa
		No	Este parámetro no está disponible. No pase este parámetro.	conn_mysql_xxx_xxx
		No		connector
		No	Este parámetro no está disponible. No pase este parámetro. [_single.params.RerankMode.enum.similar: Modo de similitud.]similar: Modo de similitud. [_single.params.RerankMode.enum.custom: Modo personalizado.]custom: Modo personalizado. [_single.params.RerankMode.enum.qa:(Predeterminado) Modo de preguntas y respuestas.]qa: (Predeterminado) Modo de preguntas y respuestas. [parameters.33.schema.enumValueTitles.similar: Modo de similitud.]similar: Modo de similitud. [parameters.33.schema.enumValueTitles.custom: Modo personalizado.]custom: Modo personalizado. [parameters.33.schema.enumValueTitles.qa:(Predeterminado) Modo de preguntas y respuestas.]qa: (Predeterminado) Modo de preguntas y respuestas. Valores válidos: similar: Modo de similitud. : similar: Modo de similitud. custom: Modo personalizado. : custom: Modo personalizado. qa:(Predeterminado) Modo de preguntas y respuestas. : qa:(Predeterminado) Modo de preguntas y respuestas.	qa
		No	Este parámetro no está disponible. No pase este parámetro.

Elementos de respuesta

Elemento	Tipo	Descripción	Ejemplo
	object	Esquema de la respuesta
Code	string	El código de estado de error.
Data	object	Los datos comerciales devueltos cuando la solicitud se realiza correctamente.
Id	string	El ID de la base de conocimientos, también conocido como `IndexId`. Este es el identificador único de la base de conocimientos creada. Guarde este valor adecuadamente. Es necesario para todas las operaciones de API posteriores relacionadas con esta base de conocimientos.	jkurxhxxxx
Message	string	El mensaje de error.
RequestId	string	El ID de la solicitud.	17204B98-xxxx-4F9A--2446A84821CA
Status	string	El código de estado devuelto por la operación.	"200"
Success	boolean	Indica si la solicitud fue exitosa. Valores válidos: true: Exitoso. false: Fallido.	true

Ejemplos

Respuesta exitosa

Formato JSON

{
  "Code": "",
  "Data": {
    "Id": "jkurxhxxxx"
  },
  "Message": "",
  "RequestId": "17204B98-xxxx-4F9A--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.