Alibaba Cloud Model Studio:GetParseSettings

Consulta as configurações de análise de dados em uma categoria especificada.

Descrição da operação

• Os usuários RAM (subcontas) precisam primeiro obter as permissões de API do Alibaba Cloud Bailian (AliyunBailianDataFullAccess ou AliyunBailianDataReadOnlyAccess são aceitáveis, ambas incluem o ponto de permissão sfm:GetParseSettings) e entrar em um espaço de trabalho antes de poderem chamar esta API. As contas Alibaba Cloud (contas principais) podem chamar esta API diretamente sem autorização. Recomendamos que você chame esta API por meio da versão mais recente do SDK do Alibaba Cloud Bailian.
• Esta API é idempotente.

Descrição da limitação de taxa: Chamadas frequentes a esta API estarão sujeitas à limitação de taxa. A frequência não deve exceder 10 chamadas por segundo. Em caso de 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.

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:GetParseSettings	get	*All Resource *	Nenhuma	Nenhuma

Sintaxe da solicitação

GET /{WorkspaceId}/datacenter/parser/settings HTTP/1.1

Parâmetros de caminho

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
WorkspaceId	string	Não	O ID do espaço de trabalho ao qual o arquivo pertence. Para mais informações, consulte Usar espaços de trabalho.	llm-3shx2gu255oqxxxx

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
CategoryId	string	Não	O ID da categoria, que é o CategoryId retornado por AddCategory. Para visualizar o ID da categoria, clique no ícone de ID ao lado do nome da categoria na guia Dados Não Estruturados da página Dados do Aplicativo.	cate_cdd11b1b79a74e8bbd675c356a91ee35xxxxxxxx

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	Esquema da Resposta.
RequestId	string	O ID da solicitação.	35A267BF-xxxx-54DB-8394-AA3B0742D833
Data	array<object>	Os campos de dados retornados.
	array<object>	Os dados retornados.
FileType	string	O tipo de arquivo. Valores válidos: pdf, docx, doc, etc. Todos os tipos de arquivo suportados na categoria estão listados aqui.	pdf
ParserDisplayName	string	O nome de exibição do método de análise.	电子文档解析
ParserConfig	object	A configuração do analisador. Atualmente, isso está disponível apenas para análise Qwen VL.
ModelName	string	The model name. Valores válidos: qwen-vl-max : qwen-vl-max qwen-vl-plus : qwen-vl-plus	qwen-vl-max
ModelPrompt	string	The prompt used for parsing.	#角色 你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。 # 任务目标 请结合输入图片，详细描述图片中的内容。
Parser	string	O analisador usado para arquivos do tipo atual. Valores válidos: DOCMIND (Análise inteligente) DOCMIND_DIGITAL (Análise digital) DOCMIND_LLM_VERSION (Análise LLM) DASH_QWEN_VL_PARSER (Análise Qwen VL)	DOCMIND
Status	string	O código de status HTTP retornado.	200
Success	boolean	Indica se a chamada foi bem-sucedida. Valores válidos: true false	True
Message	string	A mensagem de erro.	workspace id is null or invalid.
Code	string	O código de status.	success

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "35A267BF-xxxx-54DB-8394-AA3B0742D833",
  "Data": [
    {
      "FileType": "pdf",
      "ParserDisplayName": "电子文档解析",
      "ParserConfig": {
        "ModelName": "qwen-vl-max",
        "ModelPrompt": "#角色\n你是一个专业的图片内容标注人员，擅长识别并描述出图片中的内容。\n# 任务目标\n请结合输入图片，详细描述图片中的内容。"
      },
      "Parser": "DOCMIND"
    }
  ],
  "Status": "200",
  "Success": true,
  "Message": "workspace id is null or invalid.",
  "Code": "success"
}

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.