Skip to main content
Base de conhecimento

ListChunks

Consulta a lista e as informações de chunks de texto.

Descrição da operação

  • Para bases de conhecimento de pesquisa de documentos, esta operação consulta todos os chunks de um arquivo especificado. Para bases de conhecimento de consulta de dados ou Q&A de imagens, esta operação recupera informações sobre todos os chunks de texto.
  • Usuários do Resource Access Management (RAM) devem primeiro obter permissões de API para o Model Studio (requer AliyunBailianDataFullAccess, que inclui a permissão sfm:ChunkList) e ingressar em um workspace antes de invocar esta operação. Contas Alibaba Cloud podem invocar esta operação diretamente sem autorização. Use o SDK do Model Studio mais recente para invocar esta operação.
  • Antes de invocar esta operação, certifique-se de que sua base de conhecimento foi criada e não foi excluída (ou seja, o ID da base de conhecimento IndexId é válido).
  • 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 você for limitado, 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:ChunkList

list

*All Resource

*

NenhumaNenhuma

Sintaxe da solicitação

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

Parâmetros de caminho

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

WorkspaceId

string

Sim

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

llm-3z7uw7fwz0vxxxx

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

body

object

Não

O corpo dos parâmetros da solicitação.

Fields

array

Não

Um array de nomes de campos usado para filtrar campos não privados (aqueles sem o prefixo underscore _) no campo Metadata retornado por esta operação. Por padrão, Fields está vazio e todos os campos não privados em Metadata são retornados. Para retornar apenas campos não privados específicos em Metadata, como title, passe title neste parâmetro.

Valor padrão: vazio.

string

Não

O nome do campo.

name

Filed

string

Não

O campo de ID do arquivo no SDK legado do Model Studio. O uso e o valor padrão são idênticos aos do campo FileId. Se você estiver usando as seguintes versões (ou posteriores) do SDK do Model Studio, use o campo FileId em vez deste. Se você estiver usando o SDK SWIFT do Model Studio, continue usando este campo.

  • Java (async): 1.0.18

  • Java: 1.10.2

  • TypeScript: 1.10.2

  • Go: 1.10.2

  • PHP: 1.10.2

  • Python: 1.10.2

  • C#: 1.10.2

  • C++: 1.10.17

Como verificar a versão do SDK do Model Studio: Visite o centro do SDK do Model Studio, clique em "Instalar" no painel de navegação à esquerda, defina a versão da API como "2023-12-29", selecione sua linguagem de programação e clique em "Versões Anteriores" para visualizar a versão.

file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

FileId

string

Não

O ID do arquivo, que é o FileId retornado pela operação AddFile. Este campo não é obrigatório para bases de conhecimento de consulta de dados ou Q&A de imagens. Este campo é obrigatório para bases de conhecimento de pesquisa de documentos. Você também pode obter o ID do arquivo clicando no ícone de ID ao lado do nome do arquivo na aba Arquivos de Dados do Aplicativo. Você pode usar o ID do arquivo para filtrar os chunks retornados. Valor padrão: vazio.

.

file_5f03dfea56da4050ab68d61871fc4cb3_xxxxxxxx

IndexId

string

Sim

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

otoru9xxxx

PageNum

integer

Não

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

1

PageSize

integer

Não

O número de chunks de texto a exibir por página em uma consulta paginada. Valor máximo: 100. Valor padrão: 10.

10

Elementos de resposta

Elemento

Tipo

Descrição

Exemplo

object

Code

string

O código de status de erro.

Index.InvalidParameter

Data

object

Os dados de negócio retornados pela operação.

Nodes

array<object>

A lista de chunks de texto.

object

O objeto de chunk de texto.

Metadata

any

The metadata map of the text chunk.

The file_path field in the metadata map of document search knowledge bases is meaningless. Do not use it in your business code.

When retrieving a document search knowledge base, if a chunk contains an image, the image is returned through the image_url field in the metadata map, along with an expiration time.

.

{ "file_path": "https://bailian-***", "parent": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员,都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作,在 5分钟内开发出一款大模型应用,或在几小时内训练出一个专属模型,从而将更多精力专注于应用创新。", "is_displayed_chunk_content": "true", "image_url": [], "nid": "83***", "source": "0", "_score": 0, "title": "", "doc_id": "file_24e***", "content": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员,都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作,在 5分钟内开发出一款大模型应用,或在几小时内训练出一个专属模型,从而将更多精力专注于应用创新。", "_rc_score": 0, "workspace_id": "llm-zna***", "hier_title": "", "doc_name": "什么是阿里云百炼", "pipeline_id": "j6b***", "_id": "llm-zna5***" }

Score

number

The similarity score of the text chunk.

0

Text

string

The content of the text chunk.

阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员,都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作,在 5分钟内开发出一款大模型应用,或在几小时内训练出一个专属模型,从而将更多精力专注于应用创新。

Total

integer

O número total de resultados retornados.

1

Message

string

A mensagem de erro.

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

RequestId

string

O ID da solicitação.

8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1

Status

string

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

200

Success

boolean

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

  • true: Bem-sucedida.

  • false: Falhou.

true

Exemplos

Resposta de sucesso JSON formato
{
  "Code": "Index.InvalidParameter",
  "Data": {
    "Nodes": [
      {
        "Metadata": "{\n  \"file_path\": \"https://bailian-***\",\n  \"parent\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员,都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作,在 5分钟内开发出一款大模型应用,或在几小时内训练出一个专属模型,从而将更多精力专注于应用创新。\",\n  \"is_displayed_chunk_content\": \"true\",\n  \"image_url\": [],\n  \"nid\": \"83***\",\n  \"source\": \"0\",\n  \"_score\": 0,\n  \"title\": \"\",\n  \"doc_id\": \"file_24e***\",\n  \"content\": \"阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员,都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作,在 5分钟内开发出一款大模型应用,或在几小时内训练出一个专属模型,从而将更多精力专注于应用创新。\",\n  \"_rc_score\": 0,\n  \"workspace_id\": \"llm-zna***\",\n  \"hier_title\": \"\",\n  \"doc_name\": \"什么是阿里云百炼\",\n  \"pipeline_id\": \"j6b***\",\n  \"_id\": \"llm-zna5***\"\n}",
        "Score": 0,
        "Text": "阿里云百炼是一站式的大模型开发及应用构建平台。不论是开发者还是业务人员,都能深入参与大模型应用的设计和构建。您可以通过简单的界面操作,在 5分钟内开发出一款大模型应用,或在几小时内训练出一个专属模型,从而将更多精力专注于应用创新。"
      }
    ],
    "Total": 1
  },
  "Message": "Required parameter(%s) missing or invalid, please check the request parameters.",
  "RequestId": "8F97A63B-xxxx-527F-9D6E-467B6A7E8CF1",
  "Status": "200",
  "Success": true
}

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.