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

Consulta as informações básicas de um arquivo nos dados do aplicativo, incluindo o nome, o tipo e o status do arquivo.

Descrição da operação

Um usuário do Resource Access Management (RAM) deve primeiro obter as permissões de API do Model Studio (AliyunBailianDataFullAccess ou AliyunBailianDataReadOnlyAccess, que incluem a permissão sfm:DescribeFile) e ingressar em um workspace antes de invocar esta operação. Uma conta Alibaba Cloud pode invocar esta operação diretamente, sem necessidade de autorização. Use a versão mais recente do SDK do Model Studio para invocar esta operação.
Esta operação é idempotente.

Limitação de taxa: Esta operação sofre limitação de taxa se for chamada com muita frequência. Não exceda 10 chamadas por segundo. Se sofrer limitação, 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.

Testar

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:DescribeFile

none

*All Resource

*

Nenhuma

Sintaxe da solicitação

GET /{WorkspaceId}/datacenter/file/{FileId}/ HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
WorkspaceId	string	Sim	O ID do workspace ao qual o arquivo pertence. Para obter mais informações sobre como obter o ID do workspace, consulte Como usar um workspace.	llm-3shx2gu255oqxxxx
FileId	string	Sim	O ID do arquivo, que é o `FileId` retornado pela operação AddFile. Você também pode obter o ID do arquivo clicando no ícone de ID ao lado do nome do arquivo na guia Dados do aplicativo - Arquivos.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx

Parâmetros da solicitação

Parâmetro

Tipo

Obrigatório

Descrição

Exemplo

Nenhum parâmetro necessário.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da resposta.
Code	string	O código de status de erro.	Success
Data	object	O campo de dados retornado pela operação.
CategoryId	string	O ID da categoria à qual o arquivo pertence.	cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx
CreateTime	string	O carimbo de data e hora de quando o arquivo foi adicionado ao Model Studio. Formato: yyyy-MM-dd HH:mm:ss. Fuso horário: UTC+8.	2024-09-09 12:45:43
FileId	string	O ID do arquivo.	file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx
FileName	string	O nome do arquivo.	XXX产品介绍.pdf
FileType	string	O tipo de arquivo (extensão). Valores possíveis: pdf, docx, doc, txt, md, pptx, ppt, xlsx, xls, html, png, jpg, jpeg, bmp e gif.	pdf
Parser	string	O tipo de parser usado para analisar o arquivo. Valores possíveis: DASHSCOPE_DOCMIND: o parser de documentos padrão.	DASHSCOPE_DOCMIND
SizeInBytes	integer	O tamanho do arquivo, em bytes.	1234
Status	string	Para arquivos usados em bases de conhecimento não estruturadas (tipo: UNSTRUCTURED), valores possíveis: INIT: Análise pendente. IN_PARSE_QUEUE: Na fila para análise. PARSING: Sendo analisado. PARSE_SUCCESS: Análise concluída. Nota O documento só pode ser importado para uma base de conhecimento após o status mudar para PARSE_SUCCESS. PARSE_FAILED: Falha na análise.	PARSE_SUCCESS
Tags	array	A lista de tags associadas ao arquivo. Um arquivo pode ser associado a várias tags.
	string	A tag do arquivo.	产品介绍
ParseResultDownloadUrl	string
ParseErrorMessage	string	O motivo da falha na análise.	Error Message
Message	string	A mensagem de erro.	Requests throttling triggered.
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 chamada foi bem-sucedida. Valores válidos: true: Bem-sucedida. false: Falha.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Code": "Success",
  "Data": {
    "CategoryId": "cate_cdd11b1b79a74e8bbd675c356a91ee3xxxxxxxx",
    "CreateTime": "2024-09-09 12:45:43",
    "FileId": "file_9a65732555b54d5ea10796ca5742ba22_xxxxxxxx",
    "FileName": "XXX产品介绍.pdf",
    "FileType": "pdf",
    "Parser": "DASHSCOPE_DOCMIND",
    "SizeInBytes": 1234,
    "Status": "PARSE_SUCCESS",
    "Tags": [
      "产品介绍"
    ],
    "ParseResultDownloadUrl": "",
    "ParseErrorMessage": "Error Message"
  },
  "Message": "Requests throttling triggered.",
  "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.