Submete uma tarefa CreateIndex especificada para concluir a criação da base de conhecimento.
Descrição da operação
- 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:SubmitIndexJob) 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, você deve invocar a operação CreateIndex e obter o
IndexIdcorrespondente. - 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 submeta solicitações duplicadas antes que o nó conclua. Para consultar o status de execução do nó, invoque a operação GetIndexJobStatus.
- Após a criação da base de conhecimento, você pode associá-la a uma aplicação de agente no mesmo workspace por meio do Gerenciamento de Aplicações (ou passar o
IndexIDpor meio derag_optionsem Chamadas de Aplicação) para complementar sua aplicação do Model Studio com conhecimento privado e informações atualizadas. Você também pode optar por não usar uma aplicação do Model Studio e consultar diretamente a base de conhecimento invocando a operação Retrieve. - Esta operação não suporta 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:SubmitIndexJob | create | *All Resource
| 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 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 |
Elementos de resposta
Elemento | Tipo | Descrição | Exemplo |
|---|---|---|---|
object | Schema da resposta. | ||
| Code | string | O código de erro. | Index.InvalidParameter |
| Data | object | Os dados de negócio retornados pela operação. | |
| Id | string | O ID da tarefa, que é o | eFDr2fGRzP9gdDZWAdo3xxxx |
| IndexId | string | O ID da base de conhecimento. | 79c0alxxxx |
| Message | string | A mensagem de erro. | Required parameter(%s) missing or invalid, please check the request parameters. |
| RequestId | string | O ID da solicitação. | 17204B98-xxxx-4F9A-8464-2446A84821CA |
| 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 |
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 | RagIndex.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. | This request uses the same client token as the previous but different request. Do not reuse client tokens with different requests unless the request is the same. |