{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Answers API Overview"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"answers-api-overview","__idx":0},"children":["Answers API Overview"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"introduction","__idx":1},"children":["Introduction"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Welcome to the eGain Answers API Guide. The ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Answers API"]}," allows enterprises to deliver fast, accurate, and contextual responses powered by their organizational knowledge. It supports two complementary approaches:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/answer/answers_certified"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Certified Answers"]}]},": Direct snippets retrieved from enterprise-authored content."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/answer/answers_generative"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generative Answers"]}]},": Natural language responses synthesized by a large language model (LLM)."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Every response includes supporting search results, references, and confidence scores—ensuring transparency, trust, and traceability. The API is built for secure, scalable integration across enterprise environments."]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"what-its-used-for","__idx":2},"children":["What It’s Used For"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Organizations use the Answers API to make knowledge more accessible and actionable across different channels. By leveraging both certified and generative answering modes, businesses can:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Provide consistent, trusted responses across web, mobile, chatbots, and portals."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Scale customer support without compromising accuracy."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Empower employees with instant access to critical knowledge."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Enforce compliance by grounding answers in approved content."]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-use-cases","__idx":3},"children":["Common Use Cases"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Customer Support Automation"]},": Power chatbots or virtual agents with context-driven answers—reducing costs and improving first-contact resolution."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Employee Knowledge Retrieval"]},": Help employees quickly access policies, technical guides, or internal procedures."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Self-Service Portals"]},": Enable customers to find answers directly in product manuals, help centers, or FAQs."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Compliance and Policy Access"]},": Ensure teams always see approved and up-to-date regulatory or policy information."]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Research and Analysis"]},": Surface insights from large collections of reports or reference material."]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overall-workflow","__idx":4},"children":["Overall Workflow"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Query Submitted"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["A request is sent to the Answers API, optionally including filters such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["topicIds"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["userProfileIds"]}," to narrow the scope."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Certified Answer Retrieval"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The API first checks for Certified Answers that meet or exceed the configured ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["certifiedAnswerThreshold"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The top result above the threshold is returned as the ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Certified Answer"]},", while additional qualifying results are provided in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["searchResults"]},"."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Fallback to Generative Answer"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["If no Certified Answer meets the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["certifiedAnswerThreshold"]},", the query is used to retrieve content using a ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["hybrid search"]}," retrieval approach."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The retrieved chunks along with the query are sent to the LLM. The LLM then generates a natural language response, grounded in retrieved content."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The generated answer is checked against a ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["generativeAnsweTthreshold"]},". If the confidence score falls below this threshold, a fallback message is returned instead of a potentially unreliable answer."]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Supporting Information"]}]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["All responses include metadata such as references, supporting snippets, and relevance scores to maintain transparency and traceability."]}]}]}]},{"$$mdtype":"Tag","name":"hr","attributes":{},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"next-steps","__idx":5},"children":["Next Steps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Take a deeper dive into the capabilities of the Answers API."]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/answer/answers_filtering"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Filters"]}]},": Understand how to narrow results using articleType, topicIds, tags, and user context for precise, personalized answers."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/answer/answers_certified"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Certified Answers"]}]},": Learn how the API processes queries through Certified and Generative pipelines, and how fallback logic ensures reliable results."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/guides/answer/answers_generative"},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Generative Answers"]}]},": Explore how the API generates natural language responses when certified answers are insufficient, using relevant content chunks and an LLM for contextual, traceable answers."]}]}]},"headings":[{"value":"Answers API Overview","id":"answers-api-overview","depth":1},{"value":"Introduction","id":"introduction","depth":2},{"value":"What It’s Used For","id":"what-its-used-for","depth":2},{"value":"Common Use Cases","id":"common-use-cases","depth":2},{"value":"Overall Workflow","id":"overall-workflow","depth":2},{"value":"Next Steps","id":"next-steps","depth":2}],"frontmatter":{"seo":{"title":"Answers API Overview"}},"lastModified":"2025-12-18T22:17:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/guides/answer/answers_overview","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}