GetGenerateAgentDataSemanticsProgress - EventBridge: Central de Documentação do Alibaba Cloud

Obtém o progresso da geração de semântica de dados para um agente.

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

Nenhuma autorização necessária para esta operação. Se você encontrar problemas com esta operação, entre em contato com o suporte técnico.

Parâmetros da solicitação

Parâmetro	Tipo	Obrigatório	Descrição	Exemplo
AgentName	string	Sim	O nome do agente.	bakehouse_agent

Elementos de resposta

Elemento	Tipo	Descrição	Exemplo
	object
Message	string	A mensagem de resposta. Se a solicitação falhar, uma mensagem de erro será retornada.	Data semantics generation task not found
RequestId	string	O identificador exclusivo que o Alibaba Cloud gera para a solicitação.	5DAF96FB-A4DF-548C-B8A1-F2A8D2F4****
Data	object	Os detalhes do progresso da geração. Quando a geração inicial é concluída, um snapshot completo da rodada de geração atual é retornado. Quando a regeneração é concluída, as Métricas, Junções, Exemplos e novo Texto atuais são retornados. Para descartar uma regeneração, primeiro chame Get para recuperar a versão oficial atual e, em seguida, chame Save com os quatro tipos de conteúdo inalterados para limpar idempotentemente os resultados temporários.
Stage	string	O estágio geral atual.	GENERATE
Progress	array	O progresso do estágio de quatro fases. Este parâmetro pode não ser retornado quando a geração geral for concluída.
	AgentDataSemanticsStageProgress	O progresso de execução de uma única fase de geração.
ErrorCode	string	O código de erro retornado quando a tarefa de geração falha.	DataSemanticsGenerateFailed
ErrorMessage	string	A mensagem de erro retornada quando a tarefa de geração falha.	Failed to generate data semantics. Please retry later
Metrics	array	O conhecimento de expressão SQL retornado quando a geração é concluída. Um máximo de 100 itens pode ser retornado.
	AgentDataSemanticsMetric	Uma entrada única de conhecimento de expressão SQL.
Joins	array	O conhecimento de associação de dados retornado quando a geração é concluída. Um máximo de 100 itens pode ser retornado.
	AgentDataSemanticsJoin	Uma entrada única de conhecimento de associação de dados.
Examples	array	O conhecimento de exemplo SQL retornado quando a geração é concluída. Um máximo de 50 itens pode ser retornado.
	AgentDataSemanticsExample	Uma entrada única de conhecimento de exemplo SQL.
Text	AgentDataSemanticsText	O conhecimento de texto Markdown retornado quando a geração é concluída.
Code	string	O código de resposta da operação.	Success
Success	boolean	Indica se a chamada foi bem-sucedida.	true

Exemplos

Resposta de sucesso

JSON formato

{
  "Message": "Data semantics generation task not found.",
  "RequestId": "5DAF96FB-A4DF-548C-B8A1-F2A8D2F4****",
  "Data": {
    "Stage": "GENERATE",
    "Progress": [
      {
        "Stage": "PROFILE",
        "Status": "SUCCEEDED"
      }
    ],
    "ErrorCode": "DataSemanticsGenerateFailed",
    "ErrorMessage": "Failed to generate data semantics. Please retry later.",
    "Metrics": [
      {
        "Name": "总销售额",
        "Type": "measure",
        "SQLExpression": "SUM(sales_transactions.totalPrice)",
        "Synonyms": [
          "销售额"
        ],
        "Description": "使用 totalPrice 统计总销售额，用于销售表现对比。"
      }
    ],
    "Joins": [
      {
        "LeftTable": "samples.bakehouse.sales_transactions",
        "RightTable": "samples.bakehouse.customers",
        "Condition": {
          "Mode": "form",
          "LeftColumn": "customerID",
          "RightColumn": "customerID",
          "SQLExpression": "sales_transactions.customerID = customers.customerID"
        },
        "RelationshipType": "many_to_one",
        "Description": "分析销售交易对应的客户属性时使用这个 Join。"
      }
    ],
    "Examples": [
      {
        "Name": "任意一周销售额超过 150 的高价值客户",
        "SQLExpression": "SELECT customerID FROM sales_transactions",
        "Parameters": [
          {
            "Name": "start_date",
            "DataType": "date",
            "Value": "2025-01-01",
            "Description": "交易日期的下限"
          }
        ],
        "Description": "当用户询问按周统计的高价值客户时使用。"
      }
    ],
    "Text": {
      "Content": "## 数据说明"
    }
  },
  "Code": "Success",
  "Success": true
}

Códigos de erro

Código de status HTTP	Código de erro	Mensagem de erro
500	InternalError	Internal Server Error
403	ServiceNotEnable	Service not enable
403	EventHouseServiceNotEnable	EventHouse service not enable
404	AgentNotFound	Agent not found.
404	DataSemanticsGenerationNotExist	Data semantics generation task not found.

Consulte Códigos de Erro para uma lista completa.

Notas de versão

Consulte Notas de Versão para uma lista completa.