Resumen de la API ListIndices para recuperación de bases de conocimiento - Model Studio - Alibaba Cloud_Alibaba Cloud Model Studio(Model Studio) - Alibaba Cloud Model Studio

Recupera la lista de bases de conocimiento en un espacio de trabajo especificado.

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 (requiere AliyunBailianDataFullAccess, que incluye el permiso sfm:ListIndex), antes de invocar esta operación. Las cuentas de Alibaba Cloud pueden invocar esta operación directamente sin autorización. Utilice el SDK de Alibaba Cloud Model Studio más reciente para invocar esta operación.
Esta operación tiene idempotencia.

Límite de velocidad: Esta operación se limita si se llama con demasiada frecuencia. No exceda 10 llamadas por segundo. Si se aplica la limitación, inténtelo de nuevo 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:ListIndex	list	Todos los recursos ``	None	None

Acción

Nivel de acceso

Tipo de recurso

Clave de condición

Acción dependiente

sfm:ListIndex

list

*Todos los recursos

*

None

Sintaxis de la solicitud

GET /{WorkspaceId}/index/list_indices 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-3shx2gu255oq6xxxx

Parámetros de solicitud

Parámetro	Tipo	Obligatorio	Descripción	Ejemplo
IndexName	string	No	El nombre de la base de conocimiento. Puede buscar una base de conocimiento por su nombre. El nombre debe tener entre 1 y 20 caracteres de longitud y puede contener caracteres de la categoría de letras Unicode (incluidas letras del alfabeto inglés, caracteres chinos y dígitos). El nombre también puede contener dos puntos (:), guiones bajos (_), puntos (.) o guiones (-). Valor predeterminado: vacío, lo que consulta todas las bases de conocimiento en el espacio de trabajo especificado.	idx_status_score
PageNumber	string	No	El número de página a consultar. Valor mínimo: 1. Valor predeterminado: 1.	1
PageSize	string	No	El número de bases de conocimiento 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
RequestId	string	El ID de la solicitud.	17204B98-xxxx-4F9A-8464-2446A84821CA
Data	object	Los datos devueltos.
PageNumber	integer	El número de página especificado.	1
PageSize	integer	El número especificado de entradas por página.	10
TotalCount	integer	El número total de entradas devueltas.	48
Indices	array<object>	La lista de bases de conocimientos.
	array<object>	El objeto de la base de conocimientos.
Id	string	El ID de la base de conocimientos, que es el `Data.Id` devuelto por la operación CreateIndex.	lecxr5xxxx
Name	string	El nombre de la base de conocimientos.	XXXX Product List
Descripción	string	La descripción de la base de conocimientos.	Products in this list are mainly for overseas customers
StructureType	string	El tipo de base de conocimientos. Valores válidos: UNSTRUCTURED: búsqueda de documentos.	UNSTRUCTURED
ChunkSize	integer	El tamaño estimado del fragmento. Valores válidos: de 1 a 2048.	5
OverlapSize	integer	El tamaño de superposición de fragmentos. Valores válidos: de 0 a 1024.	10
Separator	string	El separador de oraciones. Si se utilizan múltiples separadores, estos se separan mediante \|. Valores válidos: : salto de línea ，: coma china ,: coma inglesa 。: punto chino .: punto inglés ！: signo de exclamación chino !: signo de exclamación inglés ；: punto y coma chino ;: punto y coma inglés ？: signo de interrogación chino ?: signo de interrogación inglés	\n
EmbeddingModelName	string	El nombre del modelo de incrustación. Valores válidos: text-embedding-v2: modelo text-embedding-v2.	text-embedding-v2
RerankModelName	string	El nombre del modelo de reclasificación. Valores válidos: gte-rerank-hybrid: reclasificación oficial. gte-rerank: reclasificación gte-rerank.	gte-rerank-hybrid
RerankMinScore	string	El umbral de similitud. Valores válidos: de 0.01 a 1.00.	0.01
SourceType	string	El tipo de datos en Datos de la aplicación de Alibaba Cloud Model Studio. Para bases de conocimientos de búsqueda de documentos, los valores válidos son: DATA_CENTER_CATEGORY: tipo de categoría. DATA_CENTER_FILE: tipo de archivo. Para bases de conocimiento de consulta de datos o preguntas y respuestas sobre imágenes, los valores válidos son: DATA_CENTER_STRUCTURED_TABLE: tipo de tabla de datos.	DATA_CENTER_FILE
DocumentIds	array	La lista de IDs de archivos.
	string	El ID del archivo.	file_8c67b438043848199ffaa903d29addd4_xxxxxxxx
SinkType	string	El tipo de almacenamiento vectorial de la base de conocimientos. Valores válidos: ES: base de datos vectorial integrada. BUILT_IN: base de datos vectorial integrada. ADB: base de datos AnalyticDB for PostgreSQL.	BUILT_IN
SinkInstanceId	string	El ID de instancia del almacenamiento vectorial para la base de conocimientos.	gp-bp1gq62t1788yxxxx
SinkRegion	string	La región de la instancia de almacenamiento vectorial para la base de conocimientos.	cn-hangzhou
ConfgModel	string	El modo de configuración utilizado por esta base de conocimiento. Valores válidos: recommend: configuración recomendada. user-defined: configuración personalizada.	recommend
EnableRewrite	boolean	Indica si la reescritura de conversaciones de múltiples turnos está habilitada para esta base de conocimiento. Valores válidos: true: Habilitado. false: Deshabilitado.	false
StructuredIndexConfig	array<object>
	object
Name	string		nombre
Tipo	string	Valores válidos: datetime : datetime string : string double : double image_url : image_url long : long	string
IsSearch	boolean	Valores válidos: true : true false : false	true
IsRecall	boolean	Valores válidos: true : true false : false	true
Code	string	El código de estado de error.	Index.InvalidParameter
Message	string	El mensaje de error.	Falta el parámetro obligatorio (%s) o no es válido; compruebe los parámetros de la solicitud.
Success	boolean	Indica si la operación fue exitosa. Valores válidos: true: Exitoso. false: Fallido.	true
Status	string	El código de estado devuelto por la operación.	200

Ejemplos

Respuesta exitosa

Formato JSON

{
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "Data": {
    "PageNumber": 1,
    "PageSize": 10,
    "TotalCount": 48,
    "Indices": [
      {
        "Id": "lecxr5xxxx",
        "Name": "XXXX Product List",
        "Description": "Products in this list are mainly for overseas customers",
        "StructureType": "UNSTRUCTURED",
        "ChunkSize": 5,
        "OverlapSize": 10,
        "Separator": "\\n",
        "EmbeddingModelName": "text-embedding-v2",
        "RerankModelName": "gte-rerank-hybrid",
        "RerankMinScore": "0.01",
        "SourceType": "DATA_CENTER_FILE",
        "DocumentIds": [
          "file_8c67b438043848199ffaa903d29addd4_xxxxxxxx"
        ],
        "SinkType": "BUILT_IN",
        "SinkInstanceId": "gp-bp1gq62t1788yxxxx",
        "SinkRegion": "cn-hangzhou",
        "ConfgModel": "recommend",
        "EnableRewrite": false,
        "StructuredIndexConfig": [
          {
            "Name": "name",
            "Type": "string",
            "IsSearch": true,
            "IsRecall": true
          }
        ]
      }
    ]
  },
  "Code": "Index.InvalidParameter",
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "Success": true,
  "Status": "200"
}

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.