Pergunte à API de IA do Eddy

Planos compatíveis com o uso da API de IA do Ask Eddy

O Eddy AI Public API é um recurso inestimável projetado para aprimorar a funcionalidade e a flexibilidade do nosso recurso de pesquisa Eddy AI. A API pública do Eddy AI é particularmente útil para empresas que buscam integrar profundamente os recursos de pesquisa orientados por IA diretamente em suas próprias plataformas ou serviços. Ao incorporar o Eddy AI em seu produto, você fornece aos usuários a capacidade de acessar uma poderosa funcionalidade de pesquisa sem precisar visitar seu site de documentação.

Essa API oferece maior flexibilidade na personalização da interface do usuário, permitindo que você personalize aspectos como cor, nomenclatura e posicionamento para se alinhar à sua marca e experiência do usuário. Com essa integração perfeita, o Eddy AI se torna uma extensão natural do seu produto, aprimorando as interações do usuário e melhorando a eficiência da pesquisa. Ao expor os endpoints da API, você pode incorporá-los às suas plataformas, extrair respostas do Eddy AI sem esforço e criar uma experiência de pesquisa personalizada.

NOTA

Além do inglês (en-US, en-GB), a API pública do Eddy AI oferece suporte a mais cinco idiomas, como

Francês (fr)

Espanhol (es)

Alemão (de)

Norueguês (não)

Holandês (nl)

Usando a API pública

1. Navegue até Configurações () > Recursos de IA > Eddy AI no portal da base de conhecimento.

2. Na pesquisa assistiva de IA, marque a caixa de seleção API pública .

NOTA

1. Certifique-se de que pelo menos uma das caixas de seleção esteja marcada. Caso contrário, a alternância de pesquisa assistiva de IA será desativada automaticamente.

2. Se a API pública não estiver habilitada, você receberá um erro de código de resposta 500 ao usar a API Ask Eddy AI.

3. Cada chamada de API reduzirá sua contagem total de crédito em um.

3. Crie um token de API de autorização.

NOTA

1. No portal da Base de Dados de Conhecimento, navegue até Configurações () > Portal da Base de Dados de Conhecimento > Tokens de API.

2. Clique em Criar token de API, insira o nome do token e especifique o método POST.

3. Clique em Criar e copie o token de API gerado.

4. Você pode encontrar a estrutura da API no API hub.

Experimente a API pública do Eddy AI em nossos documentos de API

1. Navegue até o API documentationdo Document360 .

2. No lado direito da página, clique na seção Experimentar .

3. No campo Token , insira o token de API gerado a partir do seu projeto do Document360.

4. Insira os valores desejados na seção Corpo . A caixa de solicitação padrão aparecerá da seguinte maneira:

   1. Prompt: Insira a pergunta ou consulta.

   2. ID da versão: obtenha a ID da versão atual.

   3. Código de idioma: especifique o código de idioma desejado para a entrada.

5. Clique em Experimente e veja a resposta e a resposta será gerada.

Experimente a API pública do Eddy AI no Swagger

1. Navegue até o API hubSwagger . Em versões do projeto, você pode encontrar a API Ask Eddy AI.

2. No canto superior direito do hub da API do Swagger e clique em Autorizar.

3. O painel Autorizações disponíveis será exibido, solicitando que você insira o token da API.

4. Cole o token de API na janela Autorizações Disponíveis e clique em Autorizar.

5. Depois de autorizado, navegue até o > /v2/ProjectVersions/ask-Eddy AI de versões do Project e clique em Experimentar.

6. A caixa de solicitação padrão aparecerá da seguinte maneira:

• Prompt: Insira a pergunta ou consulta.

• ID da versão: obtenha a ID da versão atual do /v2/ProjectVersions endpoint.

  

• Código de idioma: Especifique o código de idioma desejado.

7. Clique em Executar para receber uma resposta bem-sucedida contendo todas as informações necessárias.

NOTA

Se você receber uma mensagem de serviço indisponível, verifique se a API pública está habilitada nas configurações.

{
  "category_id": "_categoryid",
  "category_title": "Title",
  "category_slug": "slug",
  "version_name": "v1",
  "version_slug": "v1",
  "article_id": null,
  "article_title": null,
  "article_slug": null,
  "version_display_name": null
}