Pesquisador de artefatos

Editar online

A ferramenta Artifacts Searcher pesquisa e recupera informações detalhadas sobre API, objetos de origem do aplicativo e artefatos de tabela com base em consultas do usuário.

A ferramenta Artifacts Searcher oferece suporte à filtragem por tipo de fonte e fornece resultados estruturados em formato markdown com as seguintes colunas:

  • Nome
  • Tipo
  • Localização
  • ID de origem
Use essa ferramenta para localizar e recuperar rapidamente detalhes técnicos relevantes em vários domínios, inclusive:
APIs
Encontre a documentação da API e as diretrizes de uso armazenadas nas tabelas do banco de dados. Isso ajuda os desenvolvedores a entender como integrar e usar as APIs de forma eficaz.
Objetos de aplicativo
Os objetos de aplicativos referem-se a entidades e componentes em plataformas de software. Os exemplos incluem Salesforce e ServiceNow. Use a ferramenta para obter metadados sobre esses objetos, como suas propriedades e métodos.
Tabelas de banco de dados
As tabelas de banco de dados são unidades de armazenamento estruturadas que organizam e recuperam dados de forma eficiente. Você pode usar a ferramenta para:
  • Acesse a documentação da API armazenada em tabelas para referência rápida.
  • Recuperar detalhes do objeto do aplicativo, incluindo atributos e comportamentos.
  • Explorar estruturas de tabelas, como nomes de colunas e tipos de dados, para entender a organização dos dados.
Principais destaques
  • Pesquisa em endpoints de API, objetos de origem de aplicativos e tabelas de banco de dados.
  • Exibe metadados detalhados, incluindo localização e especificações da fonte.
  • Oferece suporte à filtragem por versões do OpenAPI e tipos de API.
  • Fornece tabelas de markdown formatadas para facilitar a leitura.
As seguintes operações são compatíveis com a ferramenta Artifacts Searcher:
Observação: quando você digita um comando para pesquisar uma API ou uma tabela de banco de dados e os resultados da pesquisa não são adequados. Faça a atualização manual para resolver esse problema.

Busca de artefatos de API

Quando você insere um prompt para pesquisar artefatos de origem do aplicativo, a ferramenta pesquisa APIs que correspondam aos critérios especificados e exibe informações detalhadas sobre suas especificações e locais.

Essa operação exibe uma tabela formatada em markdown contendo metadados da API.
Tabela 1. Parâmetros
Parâmetro Obrigatório Descrição
text True Consulta de pesquisa para nomes ou descrições de API.
source_type True Defina como "API" para essa operação.
Exemplos de prompts
  • List all APIs that support the OpenAPI 3 specification
  • Show me all APIs that have paths containing the word 'order'
  • What are all the APIs supporting user authentication operations?

Busca de artefatos de mesa

Quando você insere um prompt para procurar artefatos de tabela, a ferramenta procura tabelas de banco de dados que correspondam aos critérios especificados e exibe suas informações de esquema e metadados.
Observação: Quando você pesquisa um artefato, a ferramenta exibe apenas as cinco principais correspondências por padrão, mesmo que existam mais entradas no banco de dados para a sua consulta.
Esta operação exibe uma tabela formatada em markdown contendo metadados da tabela.
Tabela 2. Parâmetros
Parâmetro Obrigatório Descrição
text True Consulta de pesquisa para nomes ou descrições de tabelas.
source_type True Defina como "endpoint_schema" para essa operação.
Exemplos de prompts
  • search for available tables with name procurement_order
  • What are all the tables supporting order-related operations?
  • List all tables in the sales schema