GetIndexJobStatus - Alibaba Cloud Model Studio: Central de Documentação do Alibaba Cloud

Consulta o status atual de uma tarefa de criação de base de conhecimento ou de uma tarefa de adição de documentos à base de conhecimento especificada.

Descrição da operação

Os usuários do Resource Access Management (RAM) devem primeiro obter as permissões de API do Alibaba Cloud Model Studio (AliyunBailianDataFullAccess ou AliyunBailianDataReadOnlyAccess, que incluem a permissão sfm:GetIndexJobStatus) e ingressar em um workspace antes de invocar esta operação. As contas Alibaba Cloud podem invocar esta operação diretamente, sem necessidade de autorização. Use a versão mais recente do SDK do Alibaba Cloud Model Studio para invocar esta operação.
Você deve ter um job de base de conhecimento em andamento. Você pode criar uma tarefa de criação de base de conhecimento invocando a operação SubmitIndexJob, ou criar uma tarefa de adição de documentos à base de conhecimento invocando a operação SubmitIndexAddDocumentsJob. Obtenha o JobId correspondente.
Invoque esta operação em intervalos de 5 segundos ou mais.
Esta operação oferece suporte à 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 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:GetIndexJobStatus	get	全部资源 ``	Nenhuma	Nenhuma

Ação

Nível de acesso

Tipo de recurso

Chave de condição

Ação dependente

sfm:GetIndexJobStatus

get

*全部资源

*

Nenhuma

Sintaxe da solicitação

GET /{WorkspaceId}/index/job/status HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
WorkspaceId	string	Sim	O ID do workspace. Certifique-se de que a base de conhecimento que você deseja operar esteja neste workspace. Para obter informações sobre como obter o ID do workspace, consulte Como usar um workspace.	llm-3z7uw7fwz0vexxxx

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
JobId	string	Sim	O ID do job da base de conhecimento, que é o `Data.Id` retornado pela operação SubmitIndexJob ou SubmitIndexAddDocumentsJob.	20230718xxxx-146c93bf
IndexId	string	Sim	O ID da base de conhecimento, que é o `Data.Id` retornado pela operação CreateIndex.	79c0alxxxx
PageNumber	integer	Não	As operações SubmitIndexJob e SubmitIndexAddDocumentsJob oferecem suporte à importação de arquivos em lote. Esta operação retorna o status geral do job da base de conhecimento (`Status`) e o status de importação de cada arquivo (`Document.Status`). Se houver muitos arquivos, use o parâmetro `PageNumber` para consulta paginada. Valor mínimo: 1. Valor padrão: 1.	1
pageSize	integer	Não	O número de tarefas de importação de arquivos 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.
Code	string	O código de status de erro.	Index.Forbidden
Data	object	O campo de dados retornado pela operação.
Documents	array<object>	A lista de arquivos importados neste job.
	object	O objeto de arquivo.
Code	string	O código de erro.	Index.Document.ChunkError
DocId	string	O ID do arquivo.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
DocName	string	O nome do arquivo.	XXX产品介绍
Message	string	A mensagem de erro.	document parse error
Status	string	O status de importação do arquivo. Valores válidos: INSERT_ERROR: A importação do arquivo falhou. RUNNING: O arquivo está sendo importado. DELETED: O arquivo foi excluído. FINISH: O arquivo foi importado.	RUNNING
GmtModified	integer
JobId	string	O ID do job.	66122af12a4e45ddae6bd6c84555xxxx
Status	string	O status atual do job da base de conhecimento. Valores válidos: COMPLETED: Execução bem-sucedida. FAILED: Falha na execução. RUNNING: Execução em andamento. PENDING: Aguardando execução. Valores válidos: COMPLETED : Execução bem-sucedida. FAILED : Falha na execução. RUNNING : Execução em andamento. PENDING : Aguardando execução.	PENDING
Message	string	A mensagem de erro.	User not authorized to operate on the specified resource.
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: Bem-sucedida. false: Falha.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "Index.Forbidden",
  "Data": {
    "Documents": [
      {
        "Code": "Index.Document.ChunkError",
        "DocId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
        "DocName": "XXX产品介绍",
        "Message": "document parse error",
        "Status": "RUNNING",
        "GmtModified": 0
      }
    ],
    "JobId": "66122af12a4e45ddae6bd6c84555xxxx",
    "Status": "PENDING"
  },
  "Message": "User not authorized to operate on the specified resource.",
  "RequestId": "17204B98-xxxx-4F9A-8464-2446A84821CA",
  "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.