Ask Eddy AI API

A API é um recurso inestimável projetado para aprimorar a funcionalidade e a flexibilidade do nosso recurso de busca Eddy AI. A API Pública da Eddy AI é particularmente útil para empresas que desejam integrar profundamente capacidades de busca impulsionadas por IA diretamente em suas próprias plataformas ou serviços. Ao incorporar o Eddy AI ao seu produto, você oferece aos usuários a capacidade de acessar funcionalidades poderosas de busca sem precisar acessar 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, nomes e posicionamento para alinhar com sua marca e experiência do usuário. Com essa integração perfeita, a Eddy AI se torna uma extensão natural do seu produto, aprimorando as interações dos usuários e a eficiência das buscas. Ao expor os endpoints da API, você pode incorporá-los às suas plataformas, extrair respostas do Eddy AI com facilidade e construir uma experiência de busca personalizada.

NOTA

Para saber mais sobre as linguagens suportadas pela Eddy AI, clique aqui.

Usando a API Pública

1. Navegue até Configurações () na barra de navegação à esquerda do Portal da base de conhecimento.

2. No painel de navegação esquerdo, navegue até Recursos de IA > Eddy AI.

3. Expanda o conjunto de busca de IA acordeão.

4. Na seção de busca assistida por IA , selecione a caixa de seleção da API Pública .

NOTA

1. Certifique-se de que pelo menos uma das caixas de seleção esteja selecionada. Caso contrário, o botão de busca assistida por IA será automaticamente desativado.

2. Se a API Pública não estiver ativada, você receberá um 'erro de código de resposta 500' ou 'erro de acesso desabilitado à API 400' ao usar a API Ask Eddy AI.

3. Cada chamada de API reduzirá seu total de créditos em um.

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

NOTA

1. No portal da Base de Conhecimento, navegue até Configurações () na barra de navegação da esquerda.

2. No painel de navegação à esquerda, navegue até o Portal da Base de Conhecimento > Tokens da API.

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

4. Clique em Criar e copie o token da API gerado.

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

Tente a API Pública da Eddy AI na nossa documentação da API

1. Navegue até a documentação da API do Document360.

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

3. No campo Token , insira o token da API gerado pelo seu projeto Document360.

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

   1. Prompt: Insira a pergunta ou consulta.

   2. ID de Versão: Obtenha o ID de versão atual.

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

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

Experimente a API pública da Eddy AI no Swagger

1. Navegue até o hub da API do Swagger. Nas versões do projeto, você pode encontrar a API de IA do Ask Eddy.

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

3. O painel de Autorizações Disponíveis aparecerá, solicitando que você insira o token da API.

4. Cole o token da API no painel de Autorizações Disponíveis e clique em Autorizar.

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

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

• Prompt: Insira a pergunta ou consulta.

• ID de versão: Obtenha o ID de 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, certifique-se de que a API Pública esteja ativada 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
}