Skip to main content
Base de conhecimento

ListIndices

Obtém a lista de bases de conhecimento em um workspace especificado.

Descrição da operação

  • Os usuários do Resource Access Management (RAM) devem primeiro obter permissões de API para o Alibaba Cloud Model Studio (requer AliyunBailianDataFullAccess, que inclui a permissão sfm:ListIndex), antes de invocar esta operação. Contas Alibaba Cloud podem invocar esta operação diretamente sem autorização. Use o SDK do Alibaba Cloud Model Studio mais recente para invocar esta operação.
  • Esta operação possui idempotência.
Limite de taxa: Esta operação é limitada se chamada com muita frequência. Não exceda 10 chamadas por segundo. Se for limitada, tente novamente mais tarde.

Experimente agora

Experimente esta API no OpenAPI Explorer, sem necessidade de assinatura manual. Chamadas bem-sucedidas geram automaticamente código SDK correspondente aos seus parâmetros. Faça o download com segurança de credenciais integrada para uso local.

Autorização RAM

A tabela abaixo descreve a autorização necessária para chamar esta API. Você pode defini-la em uma política do Resource Access Management (RAM). As colunas da tabela estão detalhadas abaixo:
  • Ação: As ações que podem ser usadas no elemento Action das instruções de política de permissão do RAM para conceder permissões para executar a operação.
  • API: A API que você pode chamar para executar a ação.
  • Nível de acesso: O nível de acesso predefinido concedido para cada API. Valores válidos: create, list, get, update e delete.
  • Tipo de recurso: O tipo de recurso que suporta autorização para executar a ação. Indica se a ação suporta permissão em nível de recurso. O recurso especificado deve ser compatível com a ação. Caso contrário, a política será ineficaz.
    • Para APIs com permissões em nível de recurso, os tipos de recursos obrigatórios são marcados com um asterisco (*). Especifique o Nome de Recurso Alibaba Cloud (ARN) correspondente no elemento Resource da política.
    • Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento Resource da política.
  • Chave de condição: As chaves de condição definidas pelo serviço. A chave permite controle granular, aplicando-se somente a ações ou a ações associadas a recursos específicos. Além das chaves de condição específicas do serviço, o Alibaba Cloud fornece um conjunto de chaves de condição comuns aplicáveis a todos os serviços compatíveis com RAM.
  • Ação dependente: As ações dependentes necessárias para executar a ação. Para concluir a ação, o usuário RAM ou a função RAM deve ter permissões para executar todas as ações dependentes.

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sfm:ListIndex

list

*Todos os recursos.

*

NenhumaNenhuma

Sintaxe da solicitação 

GET /{WorkspaceId}/index/list_indices HTTP/1.1

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

WorkspaceId

string

Sim

O ID do workspace ao qual a base de conhecimento pertence. Para obter informações sobre como obter o ID do workspace, consulte Como usar um workspace.

llm-3shx2gu255oq6xxxx

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

IndexName

string

Não

O nome da base de conhecimento. Você pode pesquisar uma base de conhecimento pelo nome. O nome deve ter de 1 a 20 caracteres e pode conter caracteres da categoria de letras Unicode (incluindo letras em inglês, caracteres chineses e dígitos). O nome também pode conter dois-pontos (:), sublinhados (_), pontos (.) ou hifens (-).

Valor padrão: vazio, que consulta todas as bases de conhecimento no workspace especificado.

idx_status_score

PageNumber

string

Não

O número da página a ser consultada. Valor mínimo: 1. Valor padrão: 1.

1

PageSize

string

Não

O número de bases de conhecimento a serem exibidas por página em uma consulta paginada. Sem limite máximo. Valor padrão: 10.

10

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Esquema da resposta.

RequestId

string

O ID da solicitação.

17204B98-xxxx-4F9A-8464-2446A84821CA

Data

object

Os dados retornados.

PageNumber

integer

O número da página especificado.

1

PageSize

integer

O número especificado de entradas por página.

10

TotalCount

integer

O número total de entradas retornadas.

48

Indices

array<object>

A lista de bases de conhecimento.

array<object>

O objeto da base de conhecimento.

Id

string

O ID da base de conhecimento, que é o Data.Id retornado pela operação CreateIndex.

lecxr5xxxx

Name

string

O nome da base de conhecimento.

XXXX Product List

Description

string

A descrição da base de conhecimento.

Products in this list are mainly for overseas customers

StructureType

string

O tipo da base de conhecimento. Valores válidos:

  • UNSTRUCTURED: pesquisa de documentos.

UNSTRUCTURED

ChunkSize

integer

O tamanho estimado do chunk. Valores válidos: 1 a 2048.

5

OverlapSize

integer

O tamanho de sobreposição do chunk. Valores válidos: 0 a 1024.

10

Separator

string

O separador de frases. Se múltiplos separadores forem usados, eles são separados por |. Valores válidos:


  • : quebra de linha

  • ，: vírgula chinesa

  • ,: vírgula inglesa

  • 。: ponto final chinês

  • .: ponto final inglês

  • ！: ponto de exclamação chinês

  • !: ponto de exclamação inglês

  • ；: ponto e vírgula chinês

  • ;: ponto e vírgula inglês

  • ？: ponto de interrogação chinês

  • ?: ponto de interrogação inglês

\n

EmbeddingModelName

string

O nome do modelo de embedding. Valores válidos:

  • text-embedding-v2: modelo text-embedding-v2.

text-embedding-v2

RerankModelName

string

O nome do modelo de rerank. Valores válidos:

  • gte-rerank-hybrid: reranking oficial.

  • gte-rerank: reranking gte-rerank.

gte-rerank-hybrid

RerankMinScore

string

O limiar de similaridade. Valores válidos: 0,01 a 1,00.

0.01

SourceType

string

O tipo de dados nos Dados do aplicativo do Alibaba Cloud Model Studio.

Para bases de conhecimento de pesquisa de documentos, valores válidos:

  • DATA_CENTER_CATEGORY: tipo de categoria.

  • DATA_CENTER_FILE: tipo de arquivo.

Para bases de conhecimento de consulta de dados/perguntas e respostas de imagens, valores válidos:

  • DATA_CENTER_STRUCTURED_TABLE: tipo de tabela de dados.

DATA_CENTER_FILE

DocumentIds

array

A lista de IDs de arquivos.

string

O ID do arquivo.

file_8c67b438043848199ffaa903d29addd4_xxxxxxxx

SinkType

string

O tipo de armazenamento vetorial da base de conhecimento. Valores válidos:

  • ES: banco de dados vetorial integrado.

  • BUILT_IN: banco de dados vetorial integrado.

  • ADB: banco de dados AnalyticDB for PostgreSQL.

BUILT_IN

SinkInstanceId

string

O ID da instância de armazenamento vetorial da base de conhecimento.

gp-bp1gq62t1788yxxxx

SinkRegion

string

A região da instância de armazenamento vetorial da base de conhecimento.

cn-hangzhou

ConfgModel

string

O modo de configuração usado por esta base de conhecimento. Valores válidos:

  • recommend: configuração recomendada.

  • user-defined: configuração personalizada.

recommend

EnableRewrite

boolean

Indica se a reescrita de conversas de múltiplas rodadas está ativada para esta base de conhecimento. Valores válidos:

  • true: Ativado.

  • false: Desativado.

false

StructuredIndexConfig

array<object>

object

Name

string

name

Type

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

O código de status de erro.

Index.InvalidParameter

Message

string

A mensagem de erro.

Required parameter(%s) missing or invalid, please check the request parameters

Success

boolean

Indica se a operação foi bem-sucedida. Valores válidos:

  • true: Bem-sucedido.

  • false: Falha.

true

Status

string

O código de status retornado pela operação.

200

Exemplos

Resposta de sucesso JSON formato 
{
  "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 erro

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.
Chamada de Aplicação
Componentes do aplicativo
Assistant API (Deprecated)
Mais