Add Egain for certification(initial submission)

certified-connectors/Egain/apiDefinition.swagger.json

@@ -0,0 +1,273 @@
+{
+  "swagger": "2.0",
+  "info": {
+    "title": "eGain Connector",
+    "description": "This connector enables Copilot to securely call the eGain V3 API, providing seamless integration for customer engagement data. It supports authentication, data retrieval, and action execution, simplifying workflows and enhancing real-time insights across eGain services.",
+    "version": "1.0"
+  },
+  "host": "@environmentVariables(\"new_eGainAPIHost\")",
+  "basePath": "/",
+  "schemes": [
+    "https"
+  ],
+  "consumes": [],
+  "produces": [],
+  "paths": {
+    "/core/aiservices/v3/internal/instantanswers/{portalId}/search": {
+      "get": {
+        "responses": {
+          "default": {
+            "description": "default",
+            "schema": {}
+          }
+        },
+        "summary": "Get the best search results for a user query",
+        "description": "Get the best search results for a user query. It is not applicable for release 21.x.x.x",
+        "operationId": "Search-V3",
+        "parameters": [
+          {
+            "name": "portalId",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "The portal ID for the eGain knowledge management portal"
+          },
+          {
+            "name": "languageCode",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Locale code for the search results (e.g., 'en-us', 'es-es', 'fr-fr')"
+          },
+          {
+            "name": "q",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Search query or question to find relevant answers"
+          },
+          {
+            "name": "personalizationProfileId",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "description": "Optional personalization profile ID for customized results"
+          },
+          {
+            "name": "authToken",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Authentication token for eGain API access"
+          },
+          {
+            "name": "baseUrl",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Base URL for the eGain knowledge management portal"
+          },
+          {
+            "name": "shortName",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Short name identifier for the knowledge management portal"
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "required": false,
+            "type": "string",
+            "description": "Content type accepted by the API"
+          }
+        ]
+      }
+    },
+    "/core/aiservices/v3/internal/instantanswers/generative": {
+      "get": {
+        "responses": {
+          "default": {
+            "description": "default",
+            "schema": {}
+          }
+        },
+        "summary": "Service retrieves answers for a given scope, defined by data sources, eGain KB Portal, language, and personalisation profile id.",
+        "description": "The service will retrieve a set of answers for a given scope. A scope is a collection of data sources or an eGain KB Portal with a specific language and personalization profile id.",
+        "operationId": "Generative-V3",
+        "parameters": [
+          {
+            "name": "q",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Question or search term for generative AI responses"
+          },
+          {
+            "name": "departmentId",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "description": "Optional department ID for department-specific results"
+          },
+          {
+            "name": "userId",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "description": "Optional user ID for personalized results"
+          },
+          {
+            "name": "portalId",
+            "in": "query",
+            "required": true,
+            "type": "integer",
+            "description": "The portal ID for the eGain knowledge management portal"
+          },
+          {
+            "name": "languageCode",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Locale code for the search results (e.g., 'en-us', 'es-es', 'fr-fr')"
+          },
+          {
+            "name": "personalizationProfileId",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "description": "Optional personalization profile ID for customized results"
+          },
+          {
+            "name": "authToken",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Authentication token for eGain API access"
+          },
+          {
+            "name": "baseUrl",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Base URL for the eGain knowledge management portal"
+          },
+          {
+            "name": "shortName",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Short name identifier for the knowledge management portal"
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "required": false,
+            "type": "string",
+            "description": "Content type accepted by the API"
+          }
+        ]
+      }
+    },
+    "/knowledge/portalmgr/v3/internal/portals/{portalId}/search/kb": {
+      "get": {
+        "responses": {
+          "default": {
+            "description": "default",
+            "schema": {}
+          }
+        },
+        "summary": "Returns KB search result for eGain R21",
+        "operationId": "Kb-search",
+        "parameters": [
+          {
+            "name": "portalId",
+            "in": "path",
+            "required": true,
+            "type": "string",
+            "description": "The portal ID for the eGain knowledge management portal"
+          },
+          {
+            "name": "q",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Search query for knowledge base search"
+          },
+          {
+            "name": "$lang",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Locale code for the knowledge base search (e.g., 'en-us', 'es-es', 'fr-fr')"
+          },
+          {
+            "name": "$attribute",
+            "in": "query",
+            "required": false,
+            "type": "string",
+            "description": "Optional attribute filter for search results"
+          },
+          {
+            "name": "$pagenum",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "description": "Page number for paginated results"
+          },
+          {
+            "name": "$pagesize",
+            "in": "query",
+            "required": false,
+            "type": "integer",
+            "description": "Number of results per page"
+          },
+          {
+            "name": "authToken",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Authentication token for eGain API access"
+          },
+          {
+            "name": "baseUrl",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Base URL for the eGain knowledge management portal"
+          },
+          {
+            "name": "shortName",
+            "in": "query",
+            "required": true,
+            "type": "string",
+            "description": "Short name identifier for the knowledge management portal"
+          },
+          {
+            "name": "Accept-language",
+            "in": "header",
+            "required": true,
+            "type": "string",
+            "default": "en-us",
+            "description": "Language preference for the API response"
+          },
+          {
+            "name": "Accept",
+            "in": "header",
+            "required": true,
+            "type": "string",
+            "default": "application/json",
+            "description": "Content type accepted by the API"
+          }
+        ],
+        "description": "It is only available for eGain installation on release 21.x.x.x"
+      }
+    }
+  },
+  "definitions": {},
+  "parameters": {},
+  "responses": {},
+  "securityDefinitions": {},
+  "security": [],
+  "tags": []
+}

certified-connectors/Egain/apiProperties.json

@@ -0,0 +1,9 @@
+{
+  "properties": {
+    "capabilities": [],
+    "connectionParameters": {},
+    "iconBrandColor": "#FEF0FD",
+    "publisher": "eGain Corporation ",
+    "stackOwner": "eGain Corporation"
+  }
+}