Anexa arquivos analisados a uma base de conhecimento especificada.
Descrição da operação
- Esta operação não suporta bases de conhecimento de consulta de dados ou perguntas e respostas por imagem. Para obter informações sobre como atualizar bases de conhecimento de consulta de dados ou perguntas e respostas por imagem, consulte as instruções de atualização da base de conhecimento em Base de conhecimento.
- Os usuários do Resource Access Management (RAM) devem primeiro obter permissões de API para o Model Studio (requerendo
AliyunBailianDataFullAccess, que inclui a permissão sfm:SubmitIndexAddDocumentsJob) e ingressar em um workspace antes de invocar esta operação. As 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). - Antes de invocar esta operação, invoque a operação AddFile para carregar os arquivos que você deseja anexar ao Model Studio.
- Após invocar esta operação, o nó requer tempo para execução e pode levar várias horas durante períodos de pico. Não envie solicitações duplicadas antes que o nó seja concluído. Para consultar o status de execução do nó, invoque a operação GetIndexJobStatus. A lista de arquivos
Documentsretornada por esta operação contém todos os arquivos neste trabalho de anexo (identificados exclusivamente pelojob_idfornecido), e você pode verificar se cada arquivo foi importado (analisado) com sucesso. Observe que invocar GetIndexJobStatus com muita frequência acionará limitação de taxa. Não exceda uma frequência de 20 vezes por minuto. - Após esta operação ser invocada com sucesso, ela leva algum tempo para ser executada. Não envie solicitações duplicadas antes que a resposta seja retornada. Esta operação não possui idempotência.
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
Actiondas 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
Resourceda política. - Para APIs sem permissões em nível de recurso, é exibido como Todos os Recursos. Use um asterisco (*) no elemento
Resourceda política.
- 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
- 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:SubmitIndexAddDocumentsJob | create | *Todos os recursos.
| Nenhuma | Nenhuma |
Sintaxe da solicitação
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-3shx2gu255oqxxxx |
Parâmetros da solicitação
Parâmetro | Tipo | Obrigatório | Descrição | Exemplo |
|---|---|---|---|---|
| IndexId | string | Sim | O ID da base de conhecimento, que é o | 79c0alxxxx |
| SourceType | string | Sim | O tipo de fonte de dados. Valores válidos:
Se este parâmetro for definido como DATA_CENTER_CATEGORY, você deve especificar o parâmetro Valores válidos:
| DATA_CENTER_FILE |
| DocumentIds | array | Não | A lista de IDs de arquivos. | |
string | Não | O ID do arquivo, que é o | doc_ea4a504d9ce545508d8aa6d90371bf54xxxxxxxx | |
| CategoryIds | array | Não | A lista de IDs de categorias. | |
string | Não | O ID da categoria, que é o | cate_21a407a3372c4ba7aedc649709143f0cxxxxxxxx | |
| ChunkMode | string | Não | Este parâmetro ainda não está disponível. Não especifique este parâmetro. | length |
| Separator | string | Não | Este parâmetro ainda não está disponível. Não especifique este parâmetro. | (?<=。) |
| ChunkSize | integer | Não | Este parâmetro ainda não está disponível. Não especifique este parâmetro. | 128 |
| OverlapSize | integer | Não | Este parâmetro ainda não está disponível. Não especifique este parâmetro. | 16 |
| EnableHeaders | boolean | Não | Especifica se a montagem de cabeçalhos para arquivos Excel deve ser ativada. Quando ativada, a base de conhecimento trata a primeira linha de todos os arquivos xlsx e xls como cabeçalhos e os anexa automaticamente a cada trecho de texto (linha de dados), impedindo que o modelo de linguagem grande trate os cabeçalhos como linhas de dados comuns. Ative este recurso apenas quando todos os arquivos importados estiverem no formato xlsx ou xls e contiverem cabeçalhos. Caso contrário, deixe-o desativado. Valores válidos:
Valor padrão: false. Valores válidos:
| false |
| Extra | object | Não | ||
| uniqueId | string | Não |
Elementos de resposta
Elemento | Tipo | Descrição | Exemplo |
|---|---|---|---|
object | Esquema da resposta. | ||
| RequestId | string | O ID da solicitação. | 778C0B3B-xxxx-5FC1-A947-36EDD13606AB |
| Data | object | Os dados comerciais retornados pela operação. | |
| Id | string | O ID da tarefa, também conhecido como | 42687eb254a34802bed398357f5498ae |
| 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 |
| Message | string | A mensagem de erro. | Required parameter(%s) missing or invalid, please check the request parameters |
| Code | string | O código de erro. | Index.InvalidParameter |
Exemplos
Resposta de sucesso
JSON formato
Códigos de erro
Código de status HTTP | Código de erro | Mensagem de erro | Descrição |
|---|---|---|---|
| 400 | IdempotentParameterMismatch | The request uses the same client token as a previous, but non-identical request. Do not reuse a client token with different requests, unless the requests are identical. |