Planos compatíveis com este recurso: Business Enterprise
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
Para saber mais sobre os idiomas suportados pelo Eddy AI, click here.
Usando a API pública
Navegue até Configurações () na barra de navegação esquerda no Portal da base de conhecimento.
No painel de navegação esquerdo, navegue até Recursos de IA > Eddy AI.
Expanda o acordeão do pacote de pesquisa de IA .
Na seção Pesquisa assistiva de IA , marque a caixa de seleção API pública .
NOTA
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.
Se a API pública não estiver ativada, você receberá um "erro de código de resposta 500" ou um "erro de acesso à API 400 desativado" ao usar a API Ask Eddy AI.
Cada chamada de API reduzirá sua contagem total de crédito em um.
Crie um token de API de autorização.
NOTA
No portal da Base de Dados de Conhecimento, navegue até Configurações () na barra de navegação à esquerda.
No painel de navegação esquerdo, navegue até Portal da Base de Dados de Conhecimento > Tokens de API.
Clique em Criar token de API, insira o nome do token e especifique o método POST.
Clique em Criar e copie o token de API gerado.
Você pode encontrar a estrutura da API no API hub.
Experimente a API pública do Eddy AI em nossos documentos de API
Navegue até o API documentationdo Document360 .
No lado direito da página, clique na seção Experimentar .
No campo Token , insira o token de API gerado a partir do seu projeto do Document360.
Insira os valores desejados na seção Corpo . 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.
Código de idioma: especifique o código de idioma desejado para a entrada.
Clique em Experimente e veja a resposta e a resposta será gerada.
Experimente a API pública do Eddy AI no Swagger
Navegue até o API hubSwagger . Em versões do projeto, você pode encontrar a API Ask Eddy AI.
No canto superior direito do hub da API do Swagger e clique em Autorizar.
O painel Autorizações disponíveis será exibido, solicitando que você insira o token da API.
Cole o token da API no painel Autorizações disponíveis e clique em Autorizar.
Depois de autorizado, navegue até o >
/v2/ProjectVersions/ask-Eddy AI
de versões do Project e clique em Experimentar.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.
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.
Perguntas Freqüentes
Por que há uma discrepância nos artigos de origem entre a API pública Ask Eddy e a pesquisa Eddy AI no site do usuário?
A discrepância nos artigos de origem pode ocorrer se você estiver recuperando detalhes usando o articleID
para um artigo do tipo "Pagecategory". Nesses casos, campos como article_id
, article_title
, e article_slug
retornarão null na resposta da API.
Para artigos "Pagecategory", os detalhes devem ser buscados usando o categoryID
. articleID
Aqui está um exemplo de como seria a resposta da API para um artigo "Pagecategory":
{
"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
}
Para resolver esse problema, verifique se você está usando categoryID
para recuperar informações de artigos "Pagecategory" ao usar a API Eddy.