@semantha/sdk 11.11.0 → 12.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.mts CHANGED
@@ -236,6 +236,16 @@ interface Char {
236
236
  area?: Rect;
237
237
  }
238
238
 
239
+ /**
240
+ * @author semantha
241
+ *
242
+ * This is a generated file do not change manually!
243
+ */
244
+ interface McpApprovalDecision {
245
+ approvalRequestId: string;
246
+ approve: boolean;
247
+ }
248
+
239
249
  /**
240
250
  * @author semantha
241
251
  *
@@ -273,6 +283,7 @@ interface Chat {
273
283
  temperature?: number;
274
284
  conversationId?: string;
275
285
  mcpServers?: McpServerRequest[];
286
+ mcpApprovals?: McpApprovalDecision[];
276
287
  }
277
288
 
278
289
  /**
@@ -287,6 +298,19 @@ interface ChatConversation {
287
298
  lastUsedAt?: number;
288
299
  }
289
300
 
301
+ /**
302
+ * The tool call this message is asking about. Present exactly on APPROVAL_REQUEST messages.
303
+ * @author semantha
304
+ *
305
+ * This is a generated file do not change manually!
306
+ */
307
+ interface McpApprovalRequest {
308
+ id: string;
309
+ toolName: string;
310
+ serverLabel?: string;
311
+ arguments?: string;
312
+ }
313
+
290
314
  /**
291
315
  * @author semantha
292
316
  *
@@ -298,6 +322,8 @@ interface MessageResponse {
298
322
  metadata?: {
299
323
  [key: string]: any;
300
324
  };
325
+ type?: MessageResponseTypeEnum;
326
+ approvalRequest?: McpApprovalRequest;
301
327
  }
302
328
 
303
329
  /**
@@ -1224,6 +1250,20 @@ declare const MatcherTypeEnumValues: readonly ["REGEX", "ANDREGEX", "ANDNOTREGEX
1224
1250
  type MatcherTypeEnum = (typeof MatcherTypeEnumValues)[number];
1225
1251
  declare function isMatcherTypeEnumValue(value: any): value is MatcherTypeEnum;
1226
1252
 
1253
+ /**
1254
+ * @author semantha
1255
+ *
1256
+ * This is a generated file do not change manually!
1257
+ */
1258
+ interface McpCapability {
1259
+ name?: string;
1260
+ title?: string;
1261
+ description?: string;
1262
+ readOnly?: boolean;
1263
+ destructive?: boolean;
1264
+ examples?: string[];
1265
+ }
1266
+
1227
1267
  /**
1228
1268
  * @author semantha
1229
1269
  *
@@ -1234,6 +1274,7 @@ interface McpToolDescriptor {
1234
1274
  description?: string;
1235
1275
  allowedTools?: string[];
1236
1276
  auth?: McpToolDescriptorAuthEnum;
1277
+ capabilities?: McpCapability[];
1237
1278
  }
1238
1279
 
1239
1280
  /**
@@ -1254,6 +1295,15 @@ declare const MessageResponseRoleEnumValues: readonly ["USER", "ASSISTANT", "SYS
1254
1295
  type MessageResponseRoleEnum = (typeof MessageResponseRoleEnumValues)[number];
1255
1296
  declare function isMessageResponseRoleEnumValue(value: any): value is MessageResponseRoleEnum;
1256
1297
 
1298
+ /**
1299
+ * @author semantha
1300
+ *
1301
+ * This is a generated file do not change manually!
1302
+ */
1303
+ declare const MessageResponseTypeEnumValues: readonly ["ANSWER", "REASONING", "ERROR", "APPROVAL_REQUEST"];
1304
+ type MessageResponseTypeEnum = (typeof MessageResponseTypeEnumValues)[number];
1305
+ declare function isMessageResponseTypeEnumValue(value: any): value is MessageResponseTypeEnum;
1306
+
1257
1307
  /**
1258
1308
  * @author semantha
1259
1309
  *
@@ -1428,7 +1478,7 @@ interface PromptExecution {
1428
1478
  *
1429
1479
  * This is a generated file do not change manually!
1430
1480
  */
1431
- declare const PromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS"];
1481
+ declare const PromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS", "INTERNAL"];
1432
1482
  type PromptLabelEnum = (typeof PromptLabelEnumValues)[number];
1433
1483
  declare function isPromptLabelEnumValue(value: any): value is PromptLabelEnum;
1434
1484
 
@@ -1452,7 +1502,7 @@ interface PromptOverview {
1452
1502
  *
1453
1503
  * This is a generated file do not change manually!
1454
1504
  */
1455
- declare const PromptOverviewPromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS"];
1505
+ declare const PromptOverviewPromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS", "INTERNAL"];
1456
1506
  type PromptOverviewPromptLabelEnum = (typeof PromptOverviewPromptLabelEnumValues)[number];
1457
1507
  declare function isPromptOverviewPromptLabelEnumValue(value: any): value is PromptOverviewPromptLabelEnum;
1458
1508
 
@@ -1461,7 +1511,7 @@ declare function isPromptOverviewPromptLabelEnumValue(value: any): value is Prom
1461
1511
  *
1462
1512
  * This is a generated file do not change manually!
1463
1513
  */
1464
- declare const PromptPromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS"];
1514
+ declare const PromptPromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS", "INTERNAL"];
1465
1515
  type PromptPromptLabelEnum = (typeof PromptPromptLabelEnumValues)[number];
1466
1516
  declare function isPromptPromptLabelEnumValue(value: any): value is PromptPromptLabelEnum;
1467
1517
 
@@ -2361,7 +2411,7 @@ declare class SseEndpoint {
2361
2411
  constructor(restClient: RestClient, parentEndpoint: string);
2362
2412
  /**
2363
2413
  * Stream a chat response via Server-Sent Events
2364
- * Streaming variant of the chat endpoint with identical semantics (same {id} prompt-variant selection, request body, and Polarion header credentials). The response is a text/event-stream: an 'event: delta' per output-text chunk (data: {"content":"..."}), a terminal 'event: done' carrying the conversationId (data: {"conversationId":"..."}), and 'event: error' (data: {"message":"..."}) if generation fails after the stream has started. Requires a generative model that supports streaming (the stateful Responses backend).
2414
+ * Streaming variant of the chat endpoint with identical semantics (same {id} prompt-variant selection, request body, and Polarion header credentials). The response is a text/event-stream: an 'event: delta' per message chunk (data: {"content":"...","type":"ANSWER"}), a terminal 'event: done' carrying the conversationId (data: {"conversationId":"..."}), and 'event: error' (data: {"message":"..."}) if the stream itself fails after it has started. A turn that failed upstream is not a stream failure: it streams a delta of type ERROR carrying a message for the user, followed by 'event: done'. When the domain's generative model is configured to show reasoning (gpt service option 'showReasoning', on by default when 'reasoningEffort' is set), the model's reasoning streams as deltas of type REASONING, typically before the answer; it is not part of the answer and must be shown apart from it or hidden. Absent or unknown types must be read as ANSWER. Requires a generative model that supports streaming (the stateful Responses backend).
2365
2415
  *
2366
2416
  * @param body Chat? -
2367
2417
  * @param xPolarionAccessToken string? - Polarion personal access token; must be provided together with the base url header. Takes precedence over the deprecated ChatDTO body fields.
@@ -2385,7 +2435,7 @@ declare class ChatEndpoint {
2385
2435
  sse(): SseEndpoint;
2386
2436
  /**
2387
2437
  * Chat with the generative model
2388
- * The chat endpoint allows you to interact with the generative model in a conversational manner. The path {id} selects the chat variant: pass '00000000-0000-0000-0000-000000000001' for document QA (attributes required) or '00000000-0000-0000-0000-000000000002' for MCP-augmented chat (attributes optional). Other values are treated as legacy and fall back to document QA. Callers that authenticate via Polarion pass their credentials in the X-Polarion-Access-Token and X-Polarion-Base-Url headers (same contract as the conversation GET endpoints). MCP servers are attached per request via the ChatDTO mcpServers entries (label plus optional authToken and tools subset).
2438
+ * The chat endpoint allows you to interact with the generative model in a conversational manner. The path {id} selects the chat variant: pass '00000000-0000-0000-0000-000000000001' for document QA (attributes required) or '00000000-0000-0000-0000-000000000002' for MCP-augmented chat (attributes optional). Other values are treated as legacy and fall back to document QA. Callers that authenticate via Polarion pass their credentials in the X-Polarion-Access-Token and X-Polarion-Base-Url headers (same contract as the conversation GET endpoints). MCP servers are attached per request via the ChatDTO mcpServers entries (label plus optional authToken and tools subset). Each returned message is typed: the ANSWER, an ERROR explaining a failed turn, an APPROVAL_REQUEST, or - when the domain's generative model is configured to show reasoning (gpt service option 'showReasoning', on by default when 'reasoningEffort' is set) - the model's REASONING, which precedes the answer and must be shown apart from it or hidden.
2389
2439
  *
2390
2440
  * @param body Chat? -
2391
2441
  * @param xPolarionAccessToken string? - Polarion personal access token; must be provided together with the base url header.
@@ -2408,7 +2458,7 @@ declare class ConversationEndpoint {
2408
2458
  constructor(restClient: RestClient, parentEndpoint: string, conversationid: string);
2409
2459
  /**
2410
2460
  * Retrieve the message history of a chat conversation
2411
- * Returns the full message history (oldest first) of the conversation identified by the conversationId that was returned from the chat endpoint, so a UI can restore a chat window after it was closed. Only the owner of the conversation may read it. Callers that authenticate via Polarion pass their credentials in the X-Polarion-Access-Token and X-Polarion-Base-Url headers; other callers are identified by their security context.
2461
+ * Returns the full message history (oldest first) of the conversation identified by the conversationId that was returned from the chat endpoint, so a UI can restore a chat window after it was closed. Messages are typed as in the chat endpoint, so a turn's REASONING, if the model reported any, is restored before its answer. Only the owner of the conversation may read it. Callers that authenticate via Polarion pass their credentials in the X-Polarion-Access-Token and X-Polarion-Base-Url headers; other callers are identified by their security context.
2412
2462
  *
2413
2463
  * @param xPolarionAccessToken string? - Polarion personal access token; must be provided together with the base url header.
2414
2464
  * @param xPolarionBaseUrl string? - Base url of the Polarion instance to validate the token against.
@@ -3084,8 +3134,14 @@ declare class McptoolsEndpoint {
3084
3134
  /**
3085
3135
  * List MCP tools activated for this domain.
3086
3136
  * Returns the MCP servers that have been activated for the given domain. Chat callers may reference any of these by `label` in the `enabledMcpTools` field of the chat request body. The list is the intersection of the platform's global MCP server pool and the domain's activation set. The activation set is managed via the `enabledMcpServerTools` field of the domain settings endpoint or seeded in the domain's configuration before server start.
3137
+ *
3138
+ * @param includeCapabilities boolean? - Describe every allowed tool in human-readable form, for callers that show capabilities rather than tool names. The platform asks each activated MCP server once and caches the answer, so the first such request per server is slower; an unreachable server yields entries with a name and nothing else.
3139
+ * @param includeExamples boolean? - Add generated example questions to every capability. Implies `includeCapabilities`, since the examples belong to a capability. They are written by the domain's generative model from the tool descriptions alone and cached per tool set, so the first such request per tool set costs a model call; a domain without a generative model yields capabilities without examples.
3087
3140
  */
3088
- get(): Promise<McpToolDescriptor[]>;
3141
+ get(params?: {
3142
+ includeCapabilities?: boolean;
3143
+ includeExamples?: boolean;
3144
+ }): Promise<McpToolDescriptor[]>;
3089
3145
  }
3090
3146
 
3091
3147
  /**
@@ -5055,4 +5111,4 @@ declare class SemanthaAPI {
5055
5111
  model(): ModelEndpoint;
5056
5112
  }
5057
5113
 
5058
- export { type AnnotationCell, type AnnotationPage, type Answer, type AnswerReference, AnswersEndpoint, type Area, type Argument, type Attachment, type Attribute, type AttributeDatatypeEnum, AttributeDatatypeEnumValues, type AttributeOverview, type AttributeOverviewDatatypeEnum, AttributeOverviewDatatypeEnumValues, BulkDomainsEndpoint, BulkEndpoint, BulkModelEndpoint, BulkdomainsDocumentclassesEndpoint, BulkdomainsDocumenttypesEndpoint, BulkdomainsDomainEndpoint, BulkdomainsReferencedocumentsEndpoint, BulkdomainsReferencesEndpoint, BulkmodelClassEndpoint, BulkmodelClassesEndpoint, BulkmodelDatapropertiesEndpoint, BulkmodelDomainEndpoint, BulkmodelDomainsEndpoint, BulkmodelInstancesEndpoint, BulkmodelMetadataEndpoint, BulkmodelNamedentitiesEndpoint, BulkmodelRulesEndpoint, BulkmodelSynonymsEndpoint, BulkmodelclassInstancesEndpoint, type CellType, CelltypesEndpoint, type Char, type Chat, type ChatConversation, ChatEndpoint, type ChatResponse, ChatsEndpoint, ChildExtractorclassesEndpoint, type Class, type ClassBulk, type ClassBulkDatatypeEnum, ClassBulkDatatypeEnumValues, type ClassesOverview, CloneEndpoint, type ComplexProperty, type Condition, type ConditionValue, ConversationEndpoint, ConversationsEndpoint, ConversionsEndpoint, type CurrentUser, CurrentuserEndpoint, type CustomField, type DataProperty, DiffEndpoint, type Difference, type DifferenceOperationEnum, DifferenceOperationEnumValues, type Distance, DocclassCustomfieldsEndpoint, DocclassDocumentclassesEndpoint, DocclassReferencedocumentsEndpoint, DocclassTagsEndpoint, type Document, type DocumentClass, type DocumentClassBulk, type DocumentClassNode, type DocumentInformation, type DocumentMetaData, type DocumentNamedEntity, type DocumentTable, type DocumentType, type DocumentTypeChange, type DocumentTypeConfig, DocumentannotationsEndpoint, DocumentclassEndpoint, DocumentclassesEndpoint, type DocumentmodeEnum, DocumentmodeEnumValues, DocumentsEndpoint, DocumenttypeEndpoint, DocumenttypesEndpoint, type Domain, DomainEndpoint, type DomainInfo, DomainsEndpoint, type Entity, type ErrorContainer, type ErrorField, type ErrorFieldCodeEnum, ErrorFieldCodeEnumValues, type Expression, type ExtractionArea, type ExtractionFile, type ExtractionReference, type Extractor, type ExtractorAttribute, type ExtractorAttributeDatatypeEnum, ExtractorAttributeDatatypeEnumValues, type ExtractorClass, type ExtractorClassOverview, type ExtractorTypeEnum, ExtractorTypeEnumValues, type Features, type Field, type FieldTypeEnum, FieldTypeEnumValues, type FileReference, type Finding, type FormatInformation, type Formatter, ImageEndpoint, ImagesEndpoint, type Info, InfoEndpoint, type Instance, type InstanceChild, type InstanceOverview, type Label, type LanguageDetection, LanguagesEndpoint, type Link, type LinkedInstance, type LinkedValue, MarkdownEndpoint, type Matcher, type MatcherTypeEnum, MatcherTypeEnumValues, type McpServerRequest, type McpToolDescriptor, type McpToolDescriptorAuthEnum, McpToolDescriptorAuthEnumValues, McptoolsEndpoint, MediaType, type Message, type MessageResponse, type MessageResponseRoleEnum, MessageResponseRoleEnumValues, type MessageRoleEnum, MessageRoleEnumValues, type MetaInfoPage, type Metadata, type MetadataValue, type ModeEnum, ModeEnumValues, ModelAttributesEndpoint, type ModelClass, ModelDatapropertiesEndpoint, ModelDatapropertyEndpoint, ModelDatatypesEndpoint, ModelDomainEndpoint, ModelDomainsEndpoint, ModelEndpoint, ModelExtractorclassEndpoint, ModelExtractorclassesEndpoint, ModelExtractorsEndpoint, ModelExtractortypesEndpoint, ModelFormattersEndpoint, type ModelInstance, type ModelMetadata, ModelMetadataEndpoint, ModelMetadatatypesEndpoint, ModelNamedentitiesEndpoint, ModelNamedentityEndpoint, ModelObjectpropertiesEndpoint, ModelOnemetadataEndpoint, ModelRegexEndpoint, ModelRegexesEndpoint, ModelRelationEndpoint, ModelRelationsEndpoint, ModelRuleEndpoint, ModelRulefunctionsEndpoint, ModelRulesEndpoint, ModelSynonymEndpoint, ModelSynonymsEndpoint, ModelclassesEndpoint, ModelinstancesEndpoint, ModelontAttributeEndpoint, ModelontAttributesEndpoint, ModelontClassEndpoint, ModelontClassesEndpoint, ModelontInstanceEndpoint, ModelontInstancesEndpoint, ModelontclassInstancesEndpoint, type Name, type NamedEntity, NamedentitiesEndpoint, type Overview, type Page, type PageContent, type Paragraph, ParagraphEndpoint, type ParagraphPreview, type ParagraphUpdate, ParagraphsEndpoint, type ProcessInformation, type Prompt, PromptEndpoint, type PromptExecution, type PromptLabelEnum, PromptLabelEnumValues, type PromptOverview, type PromptOverviewPromptLabelEnum, PromptOverviewPromptLabelEnumValues, type PromptPromptLabelEnum, PromptPromptLabelEnumValues, type PromptResponse, PromptValidationEndpoint, type PromptValidationRequest, type PromptValidationResponse, type PromptValidationResult, type PromptValidationTemplate, PromptsEndpoint, type Range, type Rect, type Reference, type ReferenceDocumentsResponseContainer, ReferencedocumentEndpoint, ReferencedocumentsEndpoint, ReferencedocumentsStreamEndpoint, ReferencesEndpoint, type Regex, type Relation, type RelationCondition, type ResponseMetaInfo, RestClient, RestResponse, RolesEndpoint, type Row, type Rule, type RuleFunction, type RuleFunctionTypeEnum, RuleFunctionTypeEnumValues, type RuleOverview, SemanthaAPI, type SemanticModel, type Sentence, SentenceEndpoint, SentencesEndpoint, ServerSentEvent, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, SseEndpoint, type Statistic, StatisticEndpoint, type Synonym, type TableCell, type TableInstance, type TagDocs, TagEndpoint, TagReferencedocumentsEndpoint, TagsEndpoint, type TextType, TexttypesEndpoint, type Translation, type TranslationResponse, TranslationsEndpoint, TreeEndpoint, type TypeEnum, TypeEnumValues, ValidationEndpoint, type Version, isAttributeDatatypeEnumValue, isAttributeOverviewDatatypeEnumValue, isClassBulkDatatypeEnumValue, isDifferenceOperationEnumValue, isDocumentmodeEnumValue, isErrorFieldCodeEnumValue, isExtractorAttributeDatatypeEnumValue, isExtractorTypeEnumValue, isFieldTypeEnumValue, isMatcherTypeEnumValue, isMcpToolDescriptorAuthEnumValue, isMessageResponseRoleEnumValue, isMessageRoleEnumValue, isModeEnumValue, isPromptLabelEnumValue, isPromptOverviewPromptLabelEnumValue, isPromptPromptLabelEnumValue, isRuleFunctionTypeEnumValue, isSettingsDefaultSimilarityModeEnumValue, isSettingsExtractionStrategyEnumValue, isSettingsTaggingStrategyEnumValue, isTypeEnumValue, parseServerSentEvents };
5114
+ export { type AnnotationCell, type AnnotationPage, type Answer, type AnswerReference, AnswersEndpoint, type Area, type Argument, type Attachment, type Attribute, type AttributeDatatypeEnum, AttributeDatatypeEnumValues, type AttributeOverview, type AttributeOverviewDatatypeEnum, AttributeOverviewDatatypeEnumValues, BulkDomainsEndpoint, BulkEndpoint, BulkModelEndpoint, BulkdomainsDocumentclassesEndpoint, BulkdomainsDocumenttypesEndpoint, BulkdomainsDomainEndpoint, BulkdomainsReferencedocumentsEndpoint, BulkdomainsReferencesEndpoint, BulkmodelClassEndpoint, BulkmodelClassesEndpoint, BulkmodelDatapropertiesEndpoint, BulkmodelDomainEndpoint, BulkmodelDomainsEndpoint, BulkmodelInstancesEndpoint, BulkmodelMetadataEndpoint, BulkmodelNamedentitiesEndpoint, BulkmodelRulesEndpoint, BulkmodelSynonymsEndpoint, BulkmodelclassInstancesEndpoint, type CellType, CelltypesEndpoint, type Char, type Chat, type ChatConversation, ChatEndpoint, type ChatResponse, ChatsEndpoint, ChildExtractorclassesEndpoint, type Class, type ClassBulk, type ClassBulkDatatypeEnum, ClassBulkDatatypeEnumValues, type ClassesOverview, CloneEndpoint, type ComplexProperty, type Condition, type ConditionValue, ConversationEndpoint, ConversationsEndpoint, ConversionsEndpoint, type CurrentUser, CurrentuserEndpoint, type CustomField, type DataProperty, DiffEndpoint, type Difference, type DifferenceOperationEnum, DifferenceOperationEnumValues, type Distance, DocclassCustomfieldsEndpoint, DocclassDocumentclassesEndpoint, DocclassReferencedocumentsEndpoint, DocclassTagsEndpoint, type Document, type DocumentClass, type DocumentClassBulk, type DocumentClassNode, type DocumentInformation, type DocumentMetaData, type DocumentNamedEntity, type DocumentTable, type DocumentType, type DocumentTypeChange, type DocumentTypeConfig, DocumentannotationsEndpoint, DocumentclassEndpoint, DocumentclassesEndpoint, type DocumentmodeEnum, DocumentmodeEnumValues, DocumentsEndpoint, DocumenttypeEndpoint, DocumenttypesEndpoint, type Domain, DomainEndpoint, type DomainInfo, DomainsEndpoint, type Entity, type ErrorContainer, type ErrorField, type ErrorFieldCodeEnum, ErrorFieldCodeEnumValues, type Expression, type ExtractionArea, type ExtractionFile, type ExtractionReference, type Extractor, type ExtractorAttribute, type ExtractorAttributeDatatypeEnum, ExtractorAttributeDatatypeEnumValues, type ExtractorClass, type ExtractorClassOverview, type ExtractorTypeEnum, ExtractorTypeEnumValues, type Features, type Field, type FieldTypeEnum, FieldTypeEnumValues, type FileReference, type Finding, type FormatInformation, type Formatter, ImageEndpoint, ImagesEndpoint, type Info, InfoEndpoint, type Instance, type InstanceChild, type InstanceOverview, type Label, type LanguageDetection, LanguagesEndpoint, type Link, type LinkedInstance, type LinkedValue, MarkdownEndpoint, type Matcher, type MatcherTypeEnum, MatcherTypeEnumValues, type McpApprovalDecision, type McpApprovalRequest, type McpCapability, type McpServerRequest, type McpToolDescriptor, type McpToolDescriptorAuthEnum, McpToolDescriptorAuthEnumValues, McptoolsEndpoint, MediaType, type Message, type MessageResponse, type MessageResponseRoleEnum, MessageResponseRoleEnumValues, type MessageResponseTypeEnum, MessageResponseTypeEnumValues, type MessageRoleEnum, MessageRoleEnumValues, type MetaInfoPage, type Metadata, type MetadataValue, type ModeEnum, ModeEnumValues, ModelAttributesEndpoint, type ModelClass, ModelDatapropertiesEndpoint, ModelDatapropertyEndpoint, ModelDatatypesEndpoint, ModelDomainEndpoint, ModelDomainsEndpoint, ModelEndpoint, ModelExtractorclassEndpoint, ModelExtractorclassesEndpoint, ModelExtractorsEndpoint, ModelExtractortypesEndpoint, ModelFormattersEndpoint, type ModelInstance, type ModelMetadata, ModelMetadataEndpoint, ModelMetadatatypesEndpoint, ModelNamedentitiesEndpoint, ModelNamedentityEndpoint, ModelObjectpropertiesEndpoint, ModelOnemetadataEndpoint, ModelRegexEndpoint, ModelRegexesEndpoint, ModelRelationEndpoint, ModelRelationsEndpoint, ModelRuleEndpoint, ModelRulefunctionsEndpoint, ModelRulesEndpoint, ModelSynonymEndpoint, ModelSynonymsEndpoint, ModelclassesEndpoint, ModelinstancesEndpoint, ModelontAttributeEndpoint, ModelontAttributesEndpoint, ModelontClassEndpoint, ModelontClassesEndpoint, ModelontInstanceEndpoint, ModelontInstancesEndpoint, ModelontclassInstancesEndpoint, type Name, type NamedEntity, NamedentitiesEndpoint, type Overview, type Page, type PageContent, type Paragraph, ParagraphEndpoint, type ParagraphPreview, type ParagraphUpdate, ParagraphsEndpoint, type ProcessInformation, type Prompt, PromptEndpoint, type PromptExecution, type PromptLabelEnum, PromptLabelEnumValues, type PromptOverview, type PromptOverviewPromptLabelEnum, PromptOverviewPromptLabelEnumValues, type PromptPromptLabelEnum, PromptPromptLabelEnumValues, type PromptResponse, PromptValidationEndpoint, type PromptValidationRequest, type PromptValidationResponse, type PromptValidationResult, type PromptValidationTemplate, PromptsEndpoint, type Range, type Rect, type Reference, type ReferenceDocumentsResponseContainer, ReferencedocumentEndpoint, ReferencedocumentsEndpoint, ReferencedocumentsStreamEndpoint, ReferencesEndpoint, type Regex, type Relation, type RelationCondition, type ResponseMetaInfo, RestClient, RestResponse, RolesEndpoint, type Row, type Rule, type RuleFunction, type RuleFunctionTypeEnum, RuleFunctionTypeEnumValues, type RuleOverview, SemanthaAPI, type SemanticModel, type Sentence, SentenceEndpoint, SentencesEndpoint, ServerSentEvent, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, SseEndpoint, type Statistic, StatisticEndpoint, type Synonym, type TableCell, type TableInstance, type TagDocs, TagEndpoint, TagReferencedocumentsEndpoint, TagsEndpoint, type TextType, TexttypesEndpoint, type Translation, type TranslationResponse, TranslationsEndpoint, TreeEndpoint, type TypeEnum, TypeEnumValues, ValidationEndpoint, type Version, isAttributeDatatypeEnumValue, isAttributeOverviewDatatypeEnumValue, isClassBulkDatatypeEnumValue, isDifferenceOperationEnumValue, isDocumentmodeEnumValue, isErrorFieldCodeEnumValue, isExtractorAttributeDatatypeEnumValue, isExtractorTypeEnumValue, isFieldTypeEnumValue, isMatcherTypeEnumValue, isMcpToolDescriptorAuthEnumValue, isMessageResponseRoleEnumValue, isMessageResponseTypeEnumValue, isMessageRoleEnumValue, isModeEnumValue, isPromptLabelEnumValue, isPromptOverviewPromptLabelEnumValue, isPromptPromptLabelEnumValue, isRuleFunctionTypeEnumValue, isSettingsDefaultSimilarityModeEnumValue, isSettingsExtractionStrategyEnumValue, isSettingsTaggingStrategyEnumValue, isTypeEnumValue, parseServerSentEvents };
package/dist/index.d.ts CHANGED
@@ -236,6 +236,16 @@ interface Char {
236
236
  area?: Rect;
237
237
  }
238
238
 
239
+ /**
240
+ * @author semantha
241
+ *
242
+ * This is a generated file do not change manually!
243
+ */
244
+ interface McpApprovalDecision {
245
+ approvalRequestId: string;
246
+ approve: boolean;
247
+ }
248
+
239
249
  /**
240
250
  * @author semantha
241
251
  *
@@ -273,6 +283,7 @@ interface Chat {
273
283
  temperature?: number;
274
284
  conversationId?: string;
275
285
  mcpServers?: McpServerRequest[];
286
+ mcpApprovals?: McpApprovalDecision[];
276
287
  }
277
288
 
278
289
  /**
@@ -287,6 +298,19 @@ interface ChatConversation {
287
298
  lastUsedAt?: number;
288
299
  }
289
300
 
301
+ /**
302
+ * The tool call this message is asking about. Present exactly on APPROVAL_REQUEST messages.
303
+ * @author semantha
304
+ *
305
+ * This is a generated file do not change manually!
306
+ */
307
+ interface McpApprovalRequest {
308
+ id: string;
309
+ toolName: string;
310
+ serverLabel?: string;
311
+ arguments?: string;
312
+ }
313
+
290
314
  /**
291
315
  * @author semantha
292
316
  *
@@ -298,6 +322,8 @@ interface MessageResponse {
298
322
  metadata?: {
299
323
  [key: string]: any;
300
324
  };
325
+ type?: MessageResponseTypeEnum;
326
+ approvalRequest?: McpApprovalRequest;
301
327
  }
302
328
 
303
329
  /**
@@ -1224,6 +1250,20 @@ declare const MatcherTypeEnumValues: readonly ["REGEX", "ANDREGEX", "ANDNOTREGEX
1224
1250
  type MatcherTypeEnum = (typeof MatcherTypeEnumValues)[number];
1225
1251
  declare function isMatcherTypeEnumValue(value: any): value is MatcherTypeEnum;
1226
1252
 
1253
+ /**
1254
+ * @author semantha
1255
+ *
1256
+ * This is a generated file do not change manually!
1257
+ */
1258
+ interface McpCapability {
1259
+ name?: string;
1260
+ title?: string;
1261
+ description?: string;
1262
+ readOnly?: boolean;
1263
+ destructive?: boolean;
1264
+ examples?: string[];
1265
+ }
1266
+
1227
1267
  /**
1228
1268
  * @author semantha
1229
1269
  *
@@ -1234,6 +1274,7 @@ interface McpToolDescriptor {
1234
1274
  description?: string;
1235
1275
  allowedTools?: string[];
1236
1276
  auth?: McpToolDescriptorAuthEnum;
1277
+ capabilities?: McpCapability[];
1237
1278
  }
1238
1279
 
1239
1280
  /**
@@ -1254,6 +1295,15 @@ declare const MessageResponseRoleEnumValues: readonly ["USER", "ASSISTANT", "SYS
1254
1295
  type MessageResponseRoleEnum = (typeof MessageResponseRoleEnumValues)[number];
1255
1296
  declare function isMessageResponseRoleEnumValue(value: any): value is MessageResponseRoleEnum;
1256
1297
 
1298
+ /**
1299
+ * @author semantha
1300
+ *
1301
+ * This is a generated file do not change manually!
1302
+ */
1303
+ declare const MessageResponseTypeEnumValues: readonly ["ANSWER", "REASONING", "ERROR", "APPROVAL_REQUEST"];
1304
+ type MessageResponseTypeEnum = (typeof MessageResponseTypeEnumValues)[number];
1305
+ declare function isMessageResponseTypeEnumValue(value: any): value is MessageResponseTypeEnum;
1306
+
1257
1307
  /**
1258
1308
  * @author semantha
1259
1309
  *
@@ -1428,7 +1478,7 @@ interface PromptExecution {
1428
1478
  *
1429
1479
  * This is a generated file do not change manually!
1430
1480
  */
1431
- declare const PromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS"];
1481
+ declare const PromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS", "INTERNAL"];
1432
1482
  type PromptLabelEnum = (typeof PromptLabelEnumValues)[number];
1433
1483
  declare function isPromptLabelEnumValue(value: any): value is PromptLabelEnum;
1434
1484
 
@@ -1452,7 +1502,7 @@ interface PromptOverview {
1452
1502
  *
1453
1503
  * This is a generated file do not change manually!
1454
1504
  */
1455
- declare const PromptOverviewPromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS"];
1505
+ declare const PromptOverviewPromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS", "INTERNAL"];
1456
1506
  type PromptOverviewPromptLabelEnum = (typeof PromptOverviewPromptLabelEnumValues)[number];
1457
1507
  declare function isPromptOverviewPromptLabelEnumValue(value: any): value is PromptOverviewPromptLabelEnum;
1458
1508
 
@@ -1461,7 +1511,7 @@ declare function isPromptOverviewPromptLabelEnumValue(value: any): value is Prom
1461
1511
  *
1462
1512
  * This is a generated file do not change manually!
1463
1513
  */
1464
- declare const PromptPromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS"];
1514
+ declare const PromptPromptLabelEnumValues: readonly ["COMPARE", "SEARCH", "LIBRARY", "POLARION", "AITASKS", "INTERNAL"];
1465
1515
  type PromptPromptLabelEnum = (typeof PromptPromptLabelEnumValues)[number];
1466
1516
  declare function isPromptPromptLabelEnumValue(value: any): value is PromptPromptLabelEnum;
1467
1517
 
@@ -2361,7 +2411,7 @@ declare class SseEndpoint {
2361
2411
  constructor(restClient: RestClient, parentEndpoint: string);
2362
2412
  /**
2363
2413
  * Stream a chat response via Server-Sent Events
2364
- * Streaming variant of the chat endpoint with identical semantics (same {id} prompt-variant selection, request body, and Polarion header credentials). The response is a text/event-stream: an 'event: delta' per output-text chunk (data: {"content":"..."}), a terminal 'event: done' carrying the conversationId (data: {"conversationId":"..."}), and 'event: error' (data: {"message":"..."}) if generation fails after the stream has started. Requires a generative model that supports streaming (the stateful Responses backend).
2414
+ * Streaming variant of the chat endpoint with identical semantics (same {id} prompt-variant selection, request body, and Polarion header credentials). The response is a text/event-stream: an 'event: delta' per message chunk (data: {"content":"...","type":"ANSWER"}), a terminal 'event: done' carrying the conversationId (data: {"conversationId":"..."}), and 'event: error' (data: {"message":"..."}) if the stream itself fails after it has started. A turn that failed upstream is not a stream failure: it streams a delta of type ERROR carrying a message for the user, followed by 'event: done'. When the domain's generative model is configured to show reasoning (gpt service option 'showReasoning', on by default when 'reasoningEffort' is set), the model's reasoning streams as deltas of type REASONING, typically before the answer; it is not part of the answer and must be shown apart from it or hidden. Absent or unknown types must be read as ANSWER. Requires a generative model that supports streaming (the stateful Responses backend).
2365
2415
  *
2366
2416
  * @param body Chat? -
2367
2417
  * @param xPolarionAccessToken string? - Polarion personal access token; must be provided together with the base url header. Takes precedence over the deprecated ChatDTO body fields.
@@ -2385,7 +2435,7 @@ declare class ChatEndpoint {
2385
2435
  sse(): SseEndpoint;
2386
2436
  /**
2387
2437
  * Chat with the generative model
2388
- * The chat endpoint allows you to interact with the generative model in a conversational manner. The path {id} selects the chat variant: pass '00000000-0000-0000-0000-000000000001' for document QA (attributes required) or '00000000-0000-0000-0000-000000000002' for MCP-augmented chat (attributes optional). Other values are treated as legacy and fall back to document QA. Callers that authenticate via Polarion pass their credentials in the X-Polarion-Access-Token and X-Polarion-Base-Url headers (same contract as the conversation GET endpoints). MCP servers are attached per request via the ChatDTO mcpServers entries (label plus optional authToken and tools subset).
2438
+ * The chat endpoint allows you to interact with the generative model in a conversational manner. The path {id} selects the chat variant: pass '00000000-0000-0000-0000-000000000001' for document QA (attributes required) or '00000000-0000-0000-0000-000000000002' for MCP-augmented chat (attributes optional). Other values are treated as legacy and fall back to document QA. Callers that authenticate via Polarion pass their credentials in the X-Polarion-Access-Token and X-Polarion-Base-Url headers (same contract as the conversation GET endpoints). MCP servers are attached per request via the ChatDTO mcpServers entries (label plus optional authToken and tools subset). Each returned message is typed: the ANSWER, an ERROR explaining a failed turn, an APPROVAL_REQUEST, or - when the domain's generative model is configured to show reasoning (gpt service option 'showReasoning', on by default when 'reasoningEffort' is set) - the model's REASONING, which precedes the answer and must be shown apart from it or hidden.
2389
2439
  *
2390
2440
  * @param body Chat? -
2391
2441
  * @param xPolarionAccessToken string? - Polarion personal access token; must be provided together with the base url header.
@@ -2408,7 +2458,7 @@ declare class ConversationEndpoint {
2408
2458
  constructor(restClient: RestClient, parentEndpoint: string, conversationid: string);
2409
2459
  /**
2410
2460
  * Retrieve the message history of a chat conversation
2411
- * Returns the full message history (oldest first) of the conversation identified by the conversationId that was returned from the chat endpoint, so a UI can restore a chat window after it was closed. Only the owner of the conversation may read it. Callers that authenticate via Polarion pass their credentials in the X-Polarion-Access-Token and X-Polarion-Base-Url headers; other callers are identified by their security context.
2461
+ * Returns the full message history (oldest first) of the conversation identified by the conversationId that was returned from the chat endpoint, so a UI can restore a chat window after it was closed. Messages are typed as in the chat endpoint, so a turn's REASONING, if the model reported any, is restored before its answer. Only the owner of the conversation may read it. Callers that authenticate via Polarion pass their credentials in the X-Polarion-Access-Token and X-Polarion-Base-Url headers; other callers are identified by their security context.
2412
2462
  *
2413
2463
  * @param xPolarionAccessToken string? - Polarion personal access token; must be provided together with the base url header.
2414
2464
  * @param xPolarionBaseUrl string? - Base url of the Polarion instance to validate the token against.
@@ -3084,8 +3134,14 @@ declare class McptoolsEndpoint {
3084
3134
  /**
3085
3135
  * List MCP tools activated for this domain.
3086
3136
  * Returns the MCP servers that have been activated for the given domain. Chat callers may reference any of these by `label` in the `enabledMcpTools` field of the chat request body. The list is the intersection of the platform's global MCP server pool and the domain's activation set. The activation set is managed via the `enabledMcpServerTools` field of the domain settings endpoint or seeded in the domain's configuration before server start.
3137
+ *
3138
+ * @param includeCapabilities boolean? - Describe every allowed tool in human-readable form, for callers that show capabilities rather than tool names. The platform asks each activated MCP server once and caches the answer, so the first such request per server is slower; an unreachable server yields entries with a name and nothing else.
3139
+ * @param includeExamples boolean? - Add generated example questions to every capability. Implies `includeCapabilities`, since the examples belong to a capability. They are written by the domain's generative model from the tool descriptions alone and cached per tool set, so the first such request per tool set costs a model call; a domain without a generative model yields capabilities without examples.
3087
3140
  */
3088
- get(): Promise<McpToolDescriptor[]>;
3141
+ get(params?: {
3142
+ includeCapabilities?: boolean;
3143
+ includeExamples?: boolean;
3144
+ }): Promise<McpToolDescriptor[]>;
3089
3145
  }
3090
3146
 
3091
3147
  /**
@@ -5055,4 +5111,4 @@ declare class SemanthaAPI {
5055
5111
  model(): ModelEndpoint;
5056
5112
  }
5057
5113
 
5058
- export { type AnnotationCell, type AnnotationPage, type Answer, type AnswerReference, AnswersEndpoint, type Area, type Argument, type Attachment, type Attribute, type AttributeDatatypeEnum, AttributeDatatypeEnumValues, type AttributeOverview, type AttributeOverviewDatatypeEnum, AttributeOverviewDatatypeEnumValues, BulkDomainsEndpoint, BulkEndpoint, BulkModelEndpoint, BulkdomainsDocumentclassesEndpoint, BulkdomainsDocumenttypesEndpoint, BulkdomainsDomainEndpoint, BulkdomainsReferencedocumentsEndpoint, BulkdomainsReferencesEndpoint, BulkmodelClassEndpoint, BulkmodelClassesEndpoint, BulkmodelDatapropertiesEndpoint, BulkmodelDomainEndpoint, BulkmodelDomainsEndpoint, BulkmodelInstancesEndpoint, BulkmodelMetadataEndpoint, BulkmodelNamedentitiesEndpoint, BulkmodelRulesEndpoint, BulkmodelSynonymsEndpoint, BulkmodelclassInstancesEndpoint, type CellType, CelltypesEndpoint, type Char, type Chat, type ChatConversation, ChatEndpoint, type ChatResponse, ChatsEndpoint, ChildExtractorclassesEndpoint, type Class, type ClassBulk, type ClassBulkDatatypeEnum, ClassBulkDatatypeEnumValues, type ClassesOverview, CloneEndpoint, type ComplexProperty, type Condition, type ConditionValue, ConversationEndpoint, ConversationsEndpoint, ConversionsEndpoint, type CurrentUser, CurrentuserEndpoint, type CustomField, type DataProperty, DiffEndpoint, type Difference, type DifferenceOperationEnum, DifferenceOperationEnumValues, type Distance, DocclassCustomfieldsEndpoint, DocclassDocumentclassesEndpoint, DocclassReferencedocumentsEndpoint, DocclassTagsEndpoint, type Document, type DocumentClass, type DocumentClassBulk, type DocumentClassNode, type DocumentInformation, type DocumentMetaData, type DocumentNamedEntity, type DocumentTable, type DocumentType, type DocumentTypeChange, type DocumentTypeConfig, DocumentannotationsEndpoint, DocumentclassEndpoint, DocumentclassesEndpoint, type DocumentmodeEnum, DocumentmodeEnumValues, DocumentsEndpoint, DocumenttypeEndpoint, DocumenttypesEndpoint, type Domain, DomainEndpoint, type DomainInfo, DomainsEndpoint, type Entity, type ErrorContainer, type ErrorField, type ErrorFieldCodeEnum, ErrorFieldCodeEnumValues, type Expression, type ExtractionArea, type ExtractionFile, type ExtractionReference, type Extractor, type ExtractorAttribute, type ExtractorAttributeDatatypeEnum, ExtractorAttributeDatatypeEnumValues, type ExtractorClass, type ExtractorClassOverview, type ExtractorTypeEnum, ExtractorTypeEnumValues, type Features, type Field, type FieldTypeEnum, FieldTypeEnumValues, type FileReference, type Finding, type FormatInformation, type Formatter, ImageEndpoint, ImagesEndpoint, type Info, InfoEndpoint, type Instance, type InstanceChild, type InstanceOverview, type Label, type LanguageDetection, LanguagesEndpoint, type Link, type LinkedInstance, type LinkedValue, MarkdownEndpoint, type Matcher, type MatcherTypeEnum, MatcherTypeEnumValues, type McpServerRequest, type McpToolDescriptor, type McpToolDescriptorAuthEnum, McpToolDescriptorAuthEnumValues, McptoolsEndpoint, MediaType, type Message, type MessageResponse, type MessageResponseRoleEnum, MessageResponseRoleEnumValues, type MessageRoleEnum, MessageRoleEnumValues, type MetaInfoPage, type Metadata, type MetadataValue, type ModeEnum, ModeEnumValues, ModelAttributesEndpoint, type ModelClass, ModelDatapropertiesEndpoint, ModelDatapropertyEndpoint, ModelDatatypesEndpoint, ModelDomainEndpoint, ModelDomainsEndpoint, ModelEndpoint, ModelExtractorclassEndpoint, ModelExtractorclassesEndpoint, ModelExtractorsEndpoint, ModelExtractortypesEndpoint, ModelFormattersEndpoint, type ModelInstance, type ModelMetadata, ModelMetadataEndpoint, ModelMetadatatypesEndpoint, ModelNamedentitiesEndpoint, ModelNamedentityEndpoint, ModelObjectpropertiesEndpoint, ModelOnemetadataEndpoint, ModelRegexEndpoint, ModelRegexesEndpoint, ModelRelationEndpoint, ModelRelationsEndpoint, ModelRuleEndpoint, ModelRulefunctionsEndpoint, ModelRulesEndpoint, ModelSynonymEndpoint, ModelSynonymsEndpoint, ModelclassesEndpoint, ModelinstancesEndpoint, ModelontAttributeEndpoint, ModelontAttributesEndpoint, ModelontClassEndpoint, ModelontClassesEndpoint, ModelontInstanceEndpoint, ModelontInstancesEndpoint, ModelontclassInstancesEndpoint, type Name, type NamedEntity, NamedentitiesEndpoint, type Overview, type Page, type PageContent, type Paragraph, ParagraphEndpoint, type ParagraphPreview, type ParagraphUpdate, ParagraphsEndpoint, type ProcessInformation, type Prompt, PromptEndpoint, type PromptExecution, type PromptLabelEnum, PromptLabelEnumValues, type PromptOverview, type PromptOverviewPromptLabelEnum, PromptOverviewPromptLabelEnumValues, type PromptPromptLabelEnum, PromptPromptLabelEnumValues, type PromptResponse, PromptValidationEndpoint, type PromptValidationRequest, type PromptValidationResponse, type PromptValidationResult, type PromptValidationTemplate, PromptsEndpoint, type Range, type Rect, type Reference, type ReferenceDocumentsResponseContainer, ReferencedocumentEndpoint, ReferencedocumentsEndpoint, ReferencedocumentsStreamEndpoint, ReferencesEndpoint, type Regex, type Relation, type RelationCondition, type ResponseMetaInfo, RestClient, RestResponse, RolesEndpoint, type Row, type Rule, type RuleFunction, type RuleFunctionTypeEnum, RuleFunctionTypeEnumValues, type RuleOverview, SemanthaAPI, type SemanticModel, type Sentence, SentenceEndpoint, SentencesEndpoint, ServerSentEvent, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, SseEndpoint, type Statistic, StatisticEndpoint, type Synonym, type TableCell, type TableInstance, type TagDocs, TagEndpoint, TagReferencedocumentsEndpoint, TagsEndpoint, type TextType, TexttypesEndpoint, type Translation, type TranslationResponse, TranslationsEndpoint, TreeEndpoint, type TypeEnum, TypeEnumValues, ValidationEndpoint, type Version, isAttributeDatatypeEnumValue, isAttributeOverviewDatatypeEnumValue, isClassBulkDatatypeEnumValue, isDifferenceOperationEnumValue, isDocumentmodeEnumValue, isErrorFieldCodeEnumValue, isExtractorAttributeDatatypeEnumValue, isExtractorTypeEnumValue, isFieldTypeEnumValue, isMatcherTypeEnumValue, isMcpToolDescriptorAuthEnumValue, isMessageResponseRoleEnumValue, isMessageRoleEnumValue, isModeEnumValue, isPromptLabelEnumValue, isPromptOverviewPromptLabelEnumValue, isPromptPromptLabelEnumValue, isRuleFunctionTypeEnumValue, isSettingsDefaultSimilarityModeEnumValue, isSettingsExtractionStrategyEnumValue, isSettingsTaggingStrategyEnumValue, isTypeEnumValue, parseServerSentEvents };
5114
+ export { type AnnotationCell, type AnnotationPage, type Answer, type AnswerReference, AnswersEndpoint, type Area, type Argument, type Attachment, type Attribute, type AttributeDatatypeEnum, AttributeDatatypeEnumValues, type AttributeOverview, type AttributeOverviewDatatypeEnum, AttributeOverviewDatatypeEnumValues, BulkDomainsEndpoint, BulkEndpoint, BulkModelEndpoint, BulkdomainsDocumentclassesEndpoint, BulkdomainsDocumenttypesEndpoint, BulkdomainsDomainEndpoint, BulkdomainsReferencedocumentsEndpoint, BulkdomainsReferencesEndpoint, BulkmodelClassEndpoint, BulkmodelClassesEndpoint, BulkmodelDatapropertiesEndpoint, BulkmodelDomainEndpoint, BulkmodelDomainsEndpoint, BulkmodelInstancesEndpoint, BulkmodelMetadataEndpoint, BulkmodelNamedentitiesEndpoint, BulkmodelRulesEndpoint, BulkmodelSynonymsEndpoint, BulkmodelclassInstancesEndpoint, type CellType, CelltypesEndpoint, type Char, type Chat, type ChatConversation, ChatEndpoint, type ChatResponse, ChatsEndpoint, ChildExtractorclassesEndpoint, type Class, type ClassBulk, type ClassBulkDatatypeEnum, ClassBulkDatatypeEnumValues, type ClassesOverview, CloneEndpoint, type ComplexProperty, type Condition, type ConditionValue, ConversationEndpoint, ConversationsEndpoint, ConversionsEndpoint, type CurrentUser, CurrentuserEndpoint, type CustomField, type DataProperty, DiffEndpoint, type Difference, type DifferenceOperationEnum, DifferenceOperationEnumValues, type Distance, DocclassCustomfieldsEndpoint, DocclassDocumentclassesEndpoint, DocclassReferencedocumentsEndpoint, DocclassTagsEndpoint, type Document, type DocumentClass, type DocumentClassBulk, type DocumentClassNode, type DocumentInformation, type DocumentMetaData, type DocumentNamedEntity, type DocumentTable, type DocumentType, type DocumentTypeChange, type DocumentTypeConfig, DocumentannotationsEndpoint, DocumentclassEndpoint, DocumentclassesEndpoint, type DocumentmodeEnum, DocumentmodeEnumValues, DocumentsEndpoint, DocumenttypeEndpoint, DocumenttypesEndpoint, type Domain, DomainEndpoint, type DomainInfo, DomainsEndpoint, type Entity, type ErrorContainer, type ErrorField, type ErrorFieldCodeEnum, ErrorFieldCodeEnumValues, type Expression, type ExtractionArea, type ExtractionFile, type ExtractionReference, type Extractor, type ExtractorAttribute, type ExtractorAttributeDatatypeEnum, ExtractorAttributeDatatypeEnumValues, type ExtractorClass, type ExtractorClassOverview, type ExtractorTypeEnum, ExtractorTypeEnumValues, type Features, type Field, type FieldTypeEnum, FieldTypeEnumValues, type FileReference, type Finding, type FormatInformation, type Formatter, ImageEndpoint, ImagesEndpoint, type Info, InfoEndpoint, type Instance, type InstanceChild, type InstanceOverview, type Label, type LanguageDetection, LanguagesEndpoint, type Link, type LinkedInstance, type LinkedValue, MarkdownEndpoint, type Matcher, type MatcherTypeEnum, MatcherTypeEnumValues, type McpApprovalDecision, type McpApprovalRequest, type McpCapability, type McpServerRequest, type McpToolDescriptor, type McpToolDescriptorAuthEnum, McpToolDescriptorAuthEnumValues, McptoolsEndpoint, MediaType, type Message, type MessageResponse, type MessageResponseRoleEnum, MessageResponseRoleEnumValues, type MessageResponseTypeEnum, MessageResponseTypeEnumValues, type MessageRoleEnum, MessageRoleEnumValues, type MetaInfoPage, type Metadata, type MetadataValue, type ModeEnum, ModeEnumValues, ModelAttributesEndpoint, type ModelClass, ModelDatapropertiesEndpoint, ModelDatapropertyEndpoint, ModelDatatypesEndpoint, ModelDomainEndpoint, ModelDomainsEndpoint, ModelEndpoint, ModelExtractorclassEndpoint, ModelExtractorclassesEndpoint, ModelExtractorsEndpoint, ModelExtractortypesEndpoint, ModelFormattersEndpoint, type ModelInstance, type ModelMetadata, ModelMetadataEndpoint, ModelMetadatatypesEndpoint, ModelNamedentitiesEndpoint, ModelNamedentityEndpoint, ModelObjectpropertiesEndpoint, ModelOnemetadataEndpoint, ModelRegexEndpoint, ModelRegexesEndpoint, ModelRelationEndpoint, ModelRelationsEndpoint, ModelRuleEndpoint, ModelRulefunctionsEndpoint, ModelRulesEndpoint, ModelSynonymEndpoint, ModelSynonymsEndpoint, ModelclassesEndpoint, ModelinstancesEndpoint, ModelontAttributeEndpoint, ModelontAttributesEndpoint, ModelontClassEndpoint, ModelontClassesEndpoint, ModelontInstanceEndpoint, ModelontInstancesEndpoint, ModelontclassInstancesEndpoint, type Name, type NamedEntity, NamedentitiesEndpoint, type Overview, type Page, type PageContent, type Paragraph, ParagraphEndpoint, type ParagraphPreview, type ParagraphUpdate, ParagraphsEndpoint, type ProcessInformation, type Prompt, PromptEndpoint, type PromptExecution, type PromptLabelEnum, PromptLabelEnumValues, type PromptOverview, type PromptOverviewPromptLabelEnum, PromptOverviewPromptLabelEnumValues, type PromptPromptLabelEnum, PromptPromptLabelEnumValues, type PromptResponse, PromptValidationEndpoint, type PromptValidationRequest, type PromptValidationResponse, type PromptValidationResult, type PromptValidationTemplate, PromptsEndpoint, type Range, type Rect, type Reference, type ReferenceDocumentsResponseContainer, ReferencedocumentEndpoint, ReferencedocumentsEndpoint, ReferencedocumentsStreamEndpoint, ReferencesEndpoint, type Regex, type Relation, type RelationCondition, type ResponseMetaInfo, RestClient, RestResponse, RolesEndpoint, type Row, type Rule, type RuleFunction, type RuleFunctionTypeEnum, RuleFunctionTypeEnumValues, type RuleOverview, SemanthaAPI, type SemanticModel, type Sentence, SentenceEndpoint, SentencesEndpoint, ServerSentEvent, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, SseEndpoint, type Statistic, StatisticEndpoint, type Synonym, type TableCell, type TableInstance, type TagDocs, TagEndpoint, TagReferencedocumentsEndpoint, TagsEndpoint, type TextType, TexttypesEndpoint, type Translation, type TranslationResponse, TranslationsEndpoint, TreeEndpoint, type TypeEnum, TypeEnumValues, ValidationEndpoint, type Version, isAttributeDatatypeEnumValue, isAttributeOverviewDatatypeEnumValue, isClassBulkDatatypeEnumValue, isDifferenceOperationEnumValue, isDocumentmodeEnumValue, isErrorFieldCodeEnumValue, isExtractorAttributeDatatypeEnumValue, isExtractorTypeEnumValue, isFieldTypeEnumValue, isMatcherTypeEnumValue, isMcpToolDescriptorAuthEnumValue, isMessageResponseRoleEnumValue, isMessageResponseTypeEnumValue, isMessageRoleEnumValue, isModeEnumValue, isPromptLabelEnumValue, isPromptOverviewPromptLabelEnumValue, isPromptPromptLabelEnumValue, isRuleFunctionTypeEnumValue, isSettingsDefaultSimilarityModeEnumValue, isSettingsExtractionStrategyEnumValue, isSettingsTaggingStrategyEnumValue, isTypeEnumValue, parseServerSentEvents };