CreateSemanticJob - DataWorks: Central de Documentação do Alibaba Cloud

Salva uma definição de job semântico reutilizável. Se você utilizar uma origem de arquivo único, solicite e conclua o upload do anexo primeiro. Após a criação, chame RunSemanticJob com o Name retornado.

Descrição da operação

Cenários

Cria e salva uma definição de job semântico reutilizável. Esta operação salva apenas as configurações de origem de dados, grupo de recursos e arquivos de referência, sem executar o job imediatamente.

Fluxo de trabalho recomendado

Quando Source.type=singleTableFile, chame UploadSemanticFile primeiro, use o Data.UploadUrl retornado para concluir o upload PUT e, em seguida, especifique Data.FileId em ReferenceFileIds. Alternativamente, você pode fornecer um único URI acessível.
Configure Source, ProjectId e ResourceGroupId e, em seguida, chame esta operação para salvar o job.
Use o Data.Name da resposta para chamar RunSemanticJob. Após a conclusão do job, use DownloadSemanticResults para recuperar a saída.

Antes de começar

O Name deve ser exclusivo no locatário atual. As regras de quantidade de arquivos de referência diferem entre origens de arquivo único e outras origens. Para obter detalhes, consulte as descrições dos campos ReferenceFileIds e ReferenceFileUris.

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

dataworks:CreateSemanticJob

create

*All Resource

*

Nenhuma

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
Name	string	Sim	O nome do job semântico, que também serve como identificador do job para chamadas subsequentes a RunSemanticJob, DeleteSemanticJob, ListSemanticJobRuns e DownloadSemanticResults. O nome deve ser exclusivo no locatário atual.	semantic-job-demo
ProjectId	integer	Não	O ID do espaço de trabalho do DataWorks. Este parâmetro é obrigatório para todos os valores de Source.type, exceto singleTableFile. O Data.ProjectId no resultado da criação pode ser reutilizado para GetSemanticJobDetail, GetSemanticJobLog e KillSemanticJob.	100
ResourceGroupId	string	Sim	O ID do grupo de recursos usado para executar o job semântico. O RunSemanticJob não aceita este parâmetro e, em vez disso, usa o grupo de recursos salvo durante a criação.	rg-demo
Source	object	Sim	A configuração da origem de dados de entrada para o nó semântico. O campo type é obrigatório. Este parâmetro especifica os dados a serem analisados e não é a saída YAML do semantic_model. O campo domain é uma string de caracteres que serve como identidade do domínio de negócios e foco do nó, como vendas. Tipos suportados: 1) maxcompute: Use pinnedScopeInfo para especificar o escopo. Os elementos da matriz contêm type e name. Quando type=project, name é o nome do projeto MaxCompute. Quando type=schema, project é o nome do projeto e name é o nome do schema. Para o escopo no nível de tabela, project é o nome do projeto, schema é opcional e name é o nome da tabela. 2) holo ou starrocks: Além de type, você deve especificar dataSourceName e dataSourceEnv, e passar ProjectId no nível superior da solicitação. Você pode usar pinnedScopeInfo para limitar o escopo a schemas ou tabelas. O elemento name é o nome do schema ou da tabela, e o elemento schema para o escopo no nível de tabela é o banco de dados ou schema. 3) singleTableFile: ProjectId não é obrigatório. Para regras de referência de arquivo, consulte ReferenceFileIds e ReferenceFileUris. Após a execução bem-sucedida do nó, use DownloadSemanticResults para recuperar o YAML do semantic_model e outros arquivos de resultado. O exemplo mostra um escopo no nível de projeto do MaxCompute.	{"type":"maxcompute","domain":"sales","pinnedScopeInfo":[{"type":"project","name":"mc_project"}]}
ReferenceFileIds	array	Não	A lista de IDs de arquivos de referência carregados. Quando Source.type=singleTableFile, use este parâmetro ou ReferenceFileUris, e a matriz selecionada deve conter exatamente um elemento não vazio. O ID deve vir do Data.FileId retornado por UploadSemanticFile, e apenas arquivos CSV ou XLSX são suportados. Para outros valores de Source.type, você pode passar vários IDs. O serviço valida cada ID durante a criação, e você também pode passar ReferenceFileUris ao mesmo tempo.
	string	Não	A lista de IDs opcionais de arquivos de referência carregados.	semantic-job-value
ReferenceFileUris	array	Não	A lista de URIs de arquivos de referência acessíveis pelo chamador. Quando Source.type=singleTableFile, use este parâmetro ou ReferenceFileIds, e a matriz selecionada deve conter exatamente um URI não vazio. Para outros valores de Source.type, você pode passar vários URIs e também passar ReferenceFileIds ao mesmo tempo. Ao usar o caminho de upload do UploadSemanticFile, passe Data.FileId após a conclusão do upload PUT, em vez do UploadUrl de curta duração.
	string	Não	A lista de URIs opcionais de arquivos de referência acessíveis.	semantic-job-value

Construa os parâmetros de chamada com base nas descrições de cada campo de solicitação.

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object	A resposta padrão para a criação de um job semântico. Data contém a definição do job salva. Chamadas subsequentes usam o Name, ProjectId e as informações do arquivo de referência de Data.
RequestId	string	O ID da solicitação. Usado para localizar logs e solucionar problemas.	676271D6-53B4-57BE-89FA-72F7AE1418DF
Success	boolean	Indica se a solicitação foi bem-sucedida.
Data	object	A definição do job semântico salva. Use Data.Name para chamar RunSemanticJob, DeleteSemanticJob, ListSemanticJobRuns e DownloadSemanticResults.
Id	integer	O ID exclusivo interno da definição do job, que identifica o job criado por esta chamada.	1
Name	string	O nome do job salvo. Use este valor para operações subsequentes, como execução, exclusão, consulta de registros de execução e download de resultados.	semantic-job-demo
UserId	string	O identificador do usuário que criou o job.	user-demo
Creator	string	O identificador do criador do job, equivalente a UserId, usado para exibir a propriedade da criação.	user-demo
ProjectId	integer	O ID do espaço de trabalho do DataWorks ao qual o job pertence. Use este valor como o ProjectId para GetSemanticJobDetail, GetSemanticJobLog e KillSemanticJob.	100
Type	string	O tipo de origem de dados Source.type salvo, usado para identificar rapidamente o tipo de entrada do job.	maxcompute
Source	object	A configuração da origem de dados de entrada salva, correspondente ao Source na solicitação de criação. O escopo dos dados a serem analisados é determinado com base nesta configuração no tempo de execução.
ReferenceFileIds	array	A lista de IDs de arquivos carregados associados. Para singleTableFile, o único arquivo nesta lista é lido no tempo de execução.
	string	O FileId retornado por UploadSemanticFile para um arquivo cujo upload PUT foi concluído.	FID1
ReferenceFileUris	array	A lista de URIs de arquivos de referência externos associados. Para singleTableFile, o único arquivo nesta lista é lido no tempo de execução.
	string	O URI do arquivo de referência acessível fornecido pelo chamador.	https://example.com/reference.pdf
GmtCreate	integer	A hora de criação da definição do job, expressa como um carimbo de data/hora UNIX em milissegundos.	1700000000000
GmtModified	integer	A hora da última modificação da definição do job, expressa como um carimbo de data/hora UNIX em milissegundos.	1700000000000
ResourceGroupId	string	O ID do grupo de recursos que é usado ao executar este job.	rg-demo

Para os significados dos campos de resposta e suas relações com chamadas subsequentes, consulte as descrições individuais dos campos.

Exemplos

Resposta de sucesso

JSON formato

{
  "RequestId": "676271D6-53B4-57BE-89FA-72F7AE1418DF",
  "Success": false,
  "Data": {
    "Id": 1,
    "Name": "semantic-job-demo",
    "UserId": "user-demo",
    "Creator": "user-demo",
    "ProjectId": 100,
    "Type": "maxcompute",
    "Source": {
      "test": "test",
      "test2": 1
    },
    "ReferenceFileIds": [
      "FID1"
    ],
    "ReferenceFileUris": [
      "https://example.com/reference.pdf"
    ],
    "GmtCreate": 1700000000000,
    "GmtModified": 1700000000000,
    "ResourceGroupId": "rg-demo"
  }
}

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.