@egain/egain-mcp-server 1.0.21 → 1.0.22

package/src/models/{postportalidretrieveop.ts → retrievechunksop.ts}

@@ -4,9 +4,9 @@
 
 import * as z from "zod";
 import {
-  LanguageCodeParameter,
-  LanguageCodeParameter$zodSchema,
-} from "./languagecodeparameter.js";
+  RequiredLanguageCode,
+  RequiredLanguageCode$zodSchema,
+} from "./requiredlanguagecode.js";
 import {
   RetrieveRequest,
   RetrieveRequest$zodSchema,
@@ -15,31 +15,37 @@ import {
   RetrieveResponse,
   RetrieveResponse$zodSchema,
 } from "./retrieveresponse.js";
-import { WSErrorCommon, WSErrorCommon$zodSchema } from "./wserrorcommon.js";
 
-export type PostPortalIDRetrieveRequest = {
+export type RetrieveChunksRequest = {
   q: string;
   portalID: string;
   dollarFilterUserProfileID?: string | undefined;
-  Dollar_lang?: LanguageCodeParameter | undefined;
+  Dollar_lang: RequiredLanguageCode;
   dollarFilterTags?: { [k: string]: Array<string> } | undefined;
   dollarFilterTopicIds?: Array<string> | undefined;
   RetrieveRequest?: RetrieveRequest | undefined;
 };
 
-export const PostPortalIDRetrieveRequest$zodSchema: z.ZodType<
-  PostPortalIDRetrieveRequest,
+export const RetrieveChunksRequest$zodSchema: z.ZodType<
+  RetrieveChunksRequest,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  Dollar_lang: LanguageCodeParameter$zodSchema.default("en-US"),
+  Dollar_lang: RequiredLanguageCode$zodSchema,
   RetrieveRequest: RetrieveRequest$zodSchema.optional(),
   dollarFilterTags: z.record(z.array(z.string())).describe(
     "An object where each key is a **Category Tag ID** (numeric string),  \n"
       + "and each value is an array of **Tag IDs** for that category.\n"
+      + " **Note**:\n"
+      + "  - The '$filter[tags]' query parameter JSON value should be url encoded.\n"
+      + "  - Some developer tools for invoking APIs may not url encode the '$filter[tags]' query parameter JSON value by default. Ensure that only url encoded values are used.\n"
+      + "  - Example of JSON value: {\"BASE-40845\":[\"BASE-40849\",\"BASE-40853\"]}\n"
+      + "  - Example of URL encoded value: %7B%22BASE-40845%22%3A%5B%22BASE-40849%22%2C%22BASE-40853%22%5D%7D\n"
       + "",
   ).optional(),
-  dollarFilterTopicIds: z.array(z.string()).optional(),
+  dollarFilterTopicIds: z.array(z.string()).describe(
+    "An array of topic IDs. It is used to restrict search results to specific topics.",
+  ).optional(),
   dollarFilterUserProfileID: z.string().optional(),
   portalID: z.string().describe(
     "The ID of the portal being accessed.<br><br>A portal ID is composed of a 2-4 letter prefix, followed by a dash and 4-15 digits.",
@@ -47,16 +53,15 @@ export const PostPortalIDRetrieveRequest$zodSchema: z.ZodType<
   q: z.string().describe("The search query string."),
 });
 
-export type PostPortalIDRetrieveResponse = {
+export type RetrieveChunksResponse = {
   ContentType: string;
   StatusCode: number;
   RawResponse: Response;
   RetrieveResponse?: RetrieveResponse | undefined;
-  WSErrorCommon?: WSErrorCommon | undefined;
 };
 
-export const PostPortalIDRetrieveResponse$zodSchema: z.ZodType<
-  PostPortalIDRetrieveResponse,
+export const RetrieveChunksResponse$zodSchema: z.ZodType<
+  RetrieveChunksResponse,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -64,5 +69,4 @@ export const PostPortalIDRetrieveResponse$zodSchema: z.ZodType<
   RawResponse: z.instanceof(Response),
   RetrieveResponse: RetrieveResponse$zodSchema.optional(),
   StatusCode: z.number().int(),
-  WSErrorCommon: WSErrorCommon$zodSchema.optional(),
 });

package/src/models/retrieverequest.ts

@@ -33,6 +33,7 @@ export const RetrieveRequestChannel$zodSchema: z.ZodType<
 export type RetrieveRequest = {
   channel?: RetrieveRequestChannel | undefined;
   eventId?: string | undefined;
+  clientSessionId?: string | undefined;
   sessionId?: string | undefined;
 };
 
@@ -42,6 +43,7 @@ export const RetrieveRequest$zodSchema: z.ZodType<
   unknown
 > = z.object({
   channel: z.lazy(() => RetrieveRequestChannel$zodSchema).optional(),
+  clientSessionId: z.string().optional(),
   eventId: z.string().optional(),
   sessionId: z.string().optional(),
 });

package/src/models/retrieveresponse.ts

@@ -27,7 +27,7 @@ export type RetrieveResponseAnswer = {
   answerValue: string;
   references: Array<ReferenceResponse>;
   answerType: RetrieveResponseAnswerType;
-  relevanceScore: number;
+  relevanceScore?: number | undefined;
 };
 
 export const RetrieveResponseAnswer$zodSchema: z.ZodType<
@@ -38,7 +38,7 @@ export const RetrieveResponseAnswer$zodSchema: z.ZodType<
   answerType: RetrieveResponseAnswerType$zodSchema,
   answerValue: z.string(),
   references: z.array(ReferenceResponse$zodSchema),
-  relevanceScore: z.number(),
+  relevanceScore: z.number().optional(),
 }).describe(
   "If a certified answer is given. The answer object will be present. <br><br> This will be shown only if certified answers are configured and the certified answer meets the configured threshold.",
 );
@@ -76,6 +76,7 @@ export type RetrieveResponse = {
   searchResults: Array<SearchResult>;
   channel?: RetrieveResponseChannel | undefined;
   eventId?: string | undefined;
+  clientSessionId?: string | undefined;
   sessionId: string;
 };
 
@@ -86,6 +87,7 @@ export const RetrieveResponse$zodSchema: z.ZodType<
 > = z.object({
   answer: z.lazy(() => RetrieveResponseAnswer$zodSchema).optional(),
   channel: z.lazy(() => RetrieveResponseChannel$zodSchema).optional(),
+  clientSessionId: z.string().optional(),
   eventId: z.string().optional(),
   searchResults: z.array(SearchResult$zodSchema),
   sessionId: z.string(),

package/src/models/schemastags.ts

@@ -0,0 +1,19 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type SchemasTags = {
+  id?: string | undefined;
+  tags?: Array<string> | undefined;
+};
+
+export const SchemasTags$zodSchema: z.ZodType<
+  SchemasTags,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string().optional(),
+  tags: z.array(z.string()).optional(),
+});

package/src/models/searchresult.ts

@@ -4,9 +4,9 @@
 
 import * as z from "zod";
 import {
-  TopicBreadcrumb,
-  TopicBreadcrumb$zodSchema,
-} from "./topicbreadcrumb.js";
+  AITopicBreadcrumb,
+  AITopicBreadcrumb$zodSchema,
+} from "./aitopicbreadcrumb.js";
 
 /**
  * Format of the source document (HTML, DOCX, PPTX, or PDF).
@@ -21,13 +21,13 @@ export const SearchResultDocType$zodSchema = z.enum([
 export type SearchResultDocType = z.infer<typeof SearchResultDocType$zodSchema>;
 
 /**
- * The repository or system where the content originated (e.g., eGain, SharePoint).
+ * The repository or system where the content originated (e.g., eGain Article, eGain Attachment).
  */
 export const SearchResultSource$zodSchema = z.enum([
   "eGain Article",
   "eGain Attachment",
 ]).describe(
-  "The repository or system where the content originated (e.g., eGain, SharePoint).",
+  "The repository or system where the content originated (e.g., eGain Article, eGain Attachment).",
 );
 
 export type SearchResultSource = z.infer<typeof SearchResultSource$zodSchema>;
@@ -42,8 +42,10 @@ export type SearchResult = {
   docType: SearchResultDocType;
   source: SearchResultSource;
   snippet: string;
-  relevanceScore: number;
-  topicBreadcrumb?: Array<TopicBreadcrumb> | undefined;
+  contextualSummary?: string | undefined;
+  relevanceScore?: number | undefined;
+  normalizedScore?: number | undefined;
+  topicBreadcrumb?: Array<AITopicBreadcrumb> | undefined;
 };
 
 export const SearchResult$zodSchema: z.ZodType<
@@ -51,14 +53,16 @@ export const SearchResult$zodSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  contextualSummary: z.string().optional(),
   docName: z.string().optional(),
   docType: SearchResultDocType$zodSchema,
   id: z.string(),
   name: z.string(),
-  relevanceScore: z.number(),
+  normalizedScore: z.number().optional(),
+  relevanceScore: z.number().optional(),
   snippet: z.string(),
   source: SearchResultSource$zodSchema,
-  topicBreadcrumb: z.array(TopicBreadcrumb$zodSchema).optional(),
+  topicBreadcrumb: z.array(AITopicBreadcrumb$zodSchema).optional(),
 }).describe(
   "Represents a single document or snippet returned by search, along with its metadata and relevance score.",
 );

package/src/models/tag.ts

@@ -0,0 +1,12 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type Tag = { name?: string | undefined; id?: string | undefined };
+
+export const Tag$zodSchema: z.ZodType<Tag, z.ZodTypeDef, unknown> = z.object({
+  id: z.string().optional(),
+  name: z.string().optional(),
+});

package/src/models/tags.ts

@@ -3,13 +3,10 @@
  */
 
 import * as z from "zod";
+import { Tag, Tag$zodSchema } from "./tag.js";
 
-export type Tags = {
-  id?: string | undefined;
-  tags?: Array<string> | undefined;
-};
+export type Tags = { tag?: Array<Tag> | undefined };
 
 export const Tags$zodSchema: z.ZodType<Tags, z.ZodTypeDef, unknown> = z.object({
-  id: z.string().optional(),
-  tags: z.array(z.string()).optional(),
+  tag: z.array(Tag$zodSchema).optional(),
 });

package/src/models/topicsummary.ts

@@ -3,6 +3,7 @@
  */
 
 import * as z from "zod";
+import { Link, Link$zodSchema } from "./link.js";
 
 /**
  * This schema contains the topic ID and name of the topics. This is used by TopicBreadcrumb.
@@ -10,6 +11,7 @@ import * as z from "zod";
 export type TopicSummary = {
   id?: string | undefined;
   name?: string | undefined;
+  link?: Link | undefined;
 };
 
 export const TopicSummary$zodSchema: z.ZodType<
@@ -18,6 +20,7 @@ export const TopicSummary$zodSchema: z.ZodType<
   unknown
 > = z.object({
   id: z.string().optional(),
+  link: Link$zodSchema.optional(),
   name: z.string().optional(),
 }).describe(
   "This schema contains the topic ID and name of the topics. This is used by TopicBreadcrumb.",

package/src/models/wserrorcommon.ts

@@ -13,7 +13,7 @@ export const Detail$zodSchema: z.ZodType<Detail, z.ZodTypeDef, unknown> = z
   });
 
 /**
- * Error Schema
+ * Bad Request
  */
 export type WSErrorCommon = {
   code: string;
@@ -31,4 +31,4 @@ export const WSErrorCommon$zodSchema: z.ZodType<
   details: z.array(z.lazy(() => Detail$zodSchema)).optional(),
   developerMessage: z.string(),
   userMessage: z.string().optional(),
-}).describe("Error Schema");
+}).describe("Bad Request");

package/src/models/searchresponse.ts

@@ -1,34 +0,0 @@
-/*
- * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
- */
-
-import * as z from "zod";
-import {
-  ArticleSearchResult,
-  ArticleSearchResult$zodSchema,
-} from "./articlesearchresult.js";
-
-/**
- * Top search results with relevance scores
- */
-export type SearchResults = {
-  article?: Array<ArticleSearchResult> | undefined;
-};
-
-export const SearchResults$zodSchema: z.ZodType<
-  SearchResults,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  article: z.array(ArticleSearchResult$zodSchema).optional(),
-}).describe("Top search results with relevance scores");
-
-export type SearchResponse = { searchResults: SearchResults };
-
-export const SearchResponse$zodSchema: z.ZodType<
-  SearchResponse,
-  z.ZodTypeDef,
-  unknown
-> = z.object({
-  searchResults: z.lazy(() => SearchResults$zodSchema),
-});