{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":[]},"type":"markdown"},"seo":{"title":"Developer Guide for eGain Composer Platform","llmstxt":{"hide":false,"sections":[{"title":"Table of contents","includeFiles":["**/*"],"excludeFiles":[]}],"excludeFiles":[]}},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"developer-guide-for-egain-composer-platform","__idx":0},"children":["Developer Guide for eGain Composer Platform"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"overview","__idx":1},"children":["Overview"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This guide covers eGain Composer, a comprehensive AI-powered knowledge management and retrieval engine that enables intelligent content discovery, agentic workflows, and personalized user experiences across multiple interfaces. It outlines how you, as a developer, can interact with eGain’s services—from ingestion to delivery—across various channels such as web portals, help centers, and conversational apps."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"architecture","__idx":2},"children":["Architecture"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"img","attributes":{"src":"/assets/ai-cx-automation.f731f9cce68bcde98db31f0ba904140a34a147a62cfb0bae739a52674e8ed13b.afe294b5.png","alt":"Composer Architecture","title":"Composer Architecture"},"children":[]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"data-sources","__idx":3},"children":["Data Sources"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The platform ingests content from three primary sources:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversations"]},": User interactions, call and chat transcripts"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content"]},": Documents, articles, and media files"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data"]},": Structured datasets and databases"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These sources feed into a centralized ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content/Data Lake"]}," that serves as the foundation for all downstream services."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"core-platform-components","__idx":4},"children":["Core Platform Components"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"contentdata-lake","__idx":5},"children":["Content/Data Lake"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Purpose"]},": Centralized repository for all ingested content and data"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Features"]},":",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Scalable storage for multi-format content"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Data preprocessing and normalization"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Version control and content lifecycle management"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Integration"]},": Feeds processed content to retrieval engine"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"retrieval-engine","__idx":6},"children":["Retrieval Engine"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Purpose"]},": Intelligent content discovery and matching engine"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Capabilities"]},":",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Vector-based semantic search"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Hybrid search combining keywords and embeddings"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Real-time indexing and updates"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Relevance scoring and ranking"]}]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Output"]},": Provides relevant content chunks to downstream APIs"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"agentic-apps","__idx":7},"children":["Agentic Apps"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Purpose"]},": AI-powered autonomous applications that can take actions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Features"]},":",{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Goal-oriented task execution"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Multi-step reasoning and planning"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Integration with external tools and services"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Context-aware decision making"]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"api-layer","__idx":8},"children":["API Layer"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ingestion-apis","__idx":9},"children":["Ingestion APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Features"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Bulk Content Import"]},": Import large volumes of content from legacy knowledge management system"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content Validation"]},": Pre-import validation to ensure content quality and compliance"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Job Management"]},": Track and manage import operations with detailed status monitoring"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Scheduling"]},": Schedule imports for off-peak hours to minimize system impact"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Real-time Monitoring"]},": Monitor import progress and access detailed logs"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"knowledge-apis","__idx":10},"children":["Knowledge APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Features"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Access Controlled View"]},": Role-based permissions and content filtering"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Personalized"]},": User-specific content recommendations and customization"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Event-driven"]},": Real-time updates and notifications"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"search-apis","__idx":11},"children":["Search APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Features"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Content-aware Retrieval"]},": Understanding of document structure and context"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Chunks or Articles"]},": Flexible granularity for search results"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Relevance Rank"]},": Advanced scoring algorithms"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"answer-apis","__idx":12},"children":["Answer APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Features"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Consumable"]},": Ready-to-use formatted responses"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Best Answer"]},": Quality-ranked response selection"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Source(s) Attribution"]},": Transparent citation and provenance"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"agentic-apis","__idx":13},"children":["Agentic APIs"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Key Features"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Conversational Turns"]},": Multi-turn dialogue management"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Global Context"]},": Persistent memory across sessions"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Guided Actions"]},": Structured workflows and decision trees"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"experience-design-layer","__idx":14},"children":["Experience Design Layer"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"web-portals","__idx":15},"children":["Web Portals"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Target Users"]},": Agents, Customers, and Employees"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Features"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Web Page"]},": Responsive web interface"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Personalized"]},": Driven by user permissions, scopes, and preferences"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configurable Content/Look"]},": Themeable UI and layout options"]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"conversational-apps","__idx":16},"children":["Conversational Apps"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Target Users"]},": End users seeking interactive AI assistance"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Features"]},":"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Widget/Chatpage"]},": Embeddable chat interfaces"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Personalized"]},": Context-aware conversations"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Configurable Experience"]},": Customizable chat flows and responses"]}]}]},"headings":[{"value":"Developer Guide for eGain Composer Platform","id":"developer-guide-for-egain-composer-platform","depth":1},{"value":"Overview","id":"overview","depth":2},{"value":"Architecture","id":"architecture","depth":2},{"value":"Data Sources","id":"data-sources","depth":3},{"value":"Core Platform Components","id":"core-platform-components","depth":2},{"value":"Content/Data Lake","id":"contentdata-lake","depth":3},{"value":"Retrieval Engine","id":"retrieval-engine","depth":3},{"value":"Agentic Apps","id":"agentic-apps","depth":3},{"value":"API Layer","id":"api-layer","depth":2},{"value":"Ingestion APIs","id":"ingestion-apis","depth":3},{"value":"Knowledge APIs","id":"knowledge-apis","depth":3},{"value":"Search APIs","id":"search-apis","depth":3},{"value":"Answer APIs","id":"answer-apis","depth":3},{"value":"Agentic APIs","id":"agentic-apis","depth":3},{"value":"Experience Design Layer","id":"experience-design-layer","depth":2},{"value":"Web Portals","id":"web-portals","depth":3},{"value":"Conversational Apps","id":"conversational-apps","depth":3}],"frontmatter":{"seo":{"title":"Developer Guide for eGain Composer Platform"}},"lastModified":"2025-12-18T22:17:28.000Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}