agents.json: uma especificação de código aberto para que as inteligências interajam com APIs por meio de linguagem natural

Introdução geral

O agents.json é uma especificação de código aberto desenvolvida pela equipe de IA da Wildcard, com base no padrão OpenAPI, que visa permitir que as inteligências se comuniquem de forma eficiente com as APIs por meio de linguagem natural. Ele define o contrato de interação entre as inteligências e as APIs por meio de arquivos JSON estruturados, otimiza a descoberta de pontos de extremidade e a geração de parâmetros e resolve o problema da ordem caótica e da baixa precisão quando as inteligências chamam as APIs. O projeto está na versão 0.1.0, hospedado no GitHub (https://github.com/wild-card-ai/agents-json) sob a licença Apache 2.0, e a participação da comunidade é incentivada. Com o pacote Wildcard Bridge Python, os desenvolvedores podem carregar, analisar e executar arquivos agents.json para automatizar facilmente chamadas de API em várias etapas.

O Agents.json é uma especificação JSON de código aberto que descreve formalmente o contrato para a interação entre a API e a inteligência de IA, com base no padrão OpenAPI.

Lista de funções

• Chamadas de API orientadas por linguagem naturalIntelligentsia aciona operações de API em linguagem cotidiana.
• Extensões baseadas na OpenAPINovas regras de interação na OpenAPI para otimizar o uso de inteligências.
• Fluxos de tarefas e linksDefinição de fluxos de tarefas em várias etapas (fluxos) e links de ação (links) para garantir a ordem das chamadas.
• design sem estadoStatus de gerenciamento de clientes para dar suporte às implementações de infraestrutura existentes.
• Suporte a SDKWildcard Bridge: o Wildcard Bridge carrega e executa arquivos de especificação para simplificar o desenvolvimento.

Usando a Ajuda

Acesso e preparação

O agents.json é um arquivo de especificação que deve ser usado em conjunto com o SDK ou escrito manualmente. Veja como ele funciona:

1. obtenha o arquivo agents.json

• exemplo oficial::
  Obtenha o Quick Start Notebook da Wildcard AI, por exemplo:
  • Reenviar:reenviar.ipynb
  • Listrado:single.ipynb
  • Google Sheets, etc:multiple-dynamic.ipynb
• Redação personalizada::
  solo Esquema completoque cria o arquivo. Por exemplo:

  {
  "apiVersion": "0.1.0",
  "baseUrl": "https://api.example.com",
  "chains": {
  "get_data": {
  "description": "Obter dados especificados",
  "agent_instructions": "Extrair dados com base na entrada do usuário",
  "steps": [{"endpoint": "/data", "method": "GET"}]
  }
  }
  }

Recomenda-se colocar o /.well-known/agents.json caminhos para serem facilmente descobertos pela intelligentsia.

2. instalação da ponte Wildcard

• solicitaçãoPython 3.10+.
• mover::
  1. Executar comando:

     pip install wildcard-bridge
     

  2. Validação:

     python -c "import wildcard_bridge; print(wildcard_bridge.__version__)"
     

3. ambiente de configuração

• Suporte à certificaçãoAutenticação básica, ApiKey e Bearer são suportadas. Exemplo:

  from wildcard_bridge import Bridge
  bridge = Bridge(auth={{"type": "ApiKey", "key": "your-api-key"})
  

• Inteligência conectadaAcesso a LLMs compatíveis (por exemplo, OpenAI) e preparação de prompts de base.

Operação das principais funções

Função 1: Carregar e analisar o arquivo de especificação

• mover::
  1. Carregar arquivo:

     bridge.load_agents_json("path/to/agents.json")
     

  2. Visualizar a cadeia de tarefas:

     chains = bridge.get_available_chains()
     print(chains) # Tarefas de saída disponíveis, por exemplo, ["get_data"]
     

• usoCompreensão das operações suportadas, pronto para ser executado.

Função 2: Execução de fluxos de tarefas

• mover::
  1. Execute a tarefa:

     result = bridge.run_chain("get_data", {"query": "sales report"})
     print(result) Resultados de retorno da API de saída do #
     

  2. Verifique os dados de retorno.
• tomarO usuário diz "Give me the sales report" e o smart body chama automaticamente a API.

Função 3: Depuração e otimização

• ajustar os componentes durante o teste::

  bridge.enable_debug()
  resultado = bridge.run_chain("get_data", {"query": "test"})
  

  Verifique os registros para ter certeza de que cada etapa está correta.

• otimização: Ajustes instruções_do_agente ou exemplos para melhorar a precisão da intelligentsia.

Operação da função em destaque

Fluxo de tarefas e design de links

• fluxo de trabalho::
  1. Definir fluxos de tarefas em várias etapas, como respostas do Gmail:

     {
     "chains": {
     "reply_email": {
     "description": "Respostas a e-mails",
     "agent_instructions": "Responde a e-mails com base nas entradas do usuário",
     "etapas": [
     {"endpoint": "/threads/{threadId}", "method": "GET"}, {"endpoint": "/threads/{threadId}", "method": "GET"}, }
     {"endpoint": "/messages/send", "method": "POST"}
     ]
     }
     }
     }
     

  2. Em execução:

     bridge.run_chain("reply_email", {"threadId": "123", "reply": "received"})
     

• ponto brilhanteOs fluxos e os links garantem que as chamadas estejam na ordem correta e que a inteligência não tenha que raciocinar sobre elas.

Compatibilidade sem estado com os sistemas existentes

• perceber::
  O SDK é executado no lado do cliente e é adaptado para ambientes sem servidor:

  def lambda_handler(event, context).
  bridge = Bridge(auth={"type": "Bearer", "token": event["token"]})
  bridge.load_agents_json("s3://bucket/agents.json")
  return bridge.run_chain("task", event["args"])
  

• de pontaNão há necessidade de alterar o servidor de API, basta usá-lo.

Exemplo: Consulta sobre pagamento com Stripe

• agentes.json::

  {
  "baseUrl": "https://api.stripe.com/v1",
  "chains": {
  "check_payment": {
  "description": "Verificar status do pagamento",
  "agent_instructions": "Retorna o status com base na ID do pagamento",
  "steps": [{"endpoint": "/charges/{chargeId}", "method": "GET"}]
  }
  }
  }
  

• estar em movimento::

  result = bridge.run_chain("check_payment", {"chargeId": "ch_123"})
  print(result)
  

• efeitoO corpo inteligente retorna o status do pagamento diretamente, o que é simples e eficiente.

advertência

• garantiaChave: A chave é armazenada em uma variável de ambiente para evitar vazamentos.
• comunal: Participe Discórdia Obtenha suporte.
• Arquivo (de computador): Referência documento oficial.