@semantha/sdk 11.8.0 → 11.8.1
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 +50 -50
- package/dist/index.d.ts +50 -50
- package/dist/index.js +1 -1
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +1 -1
- package/dist/index.mjs.map +1 -1
- package/package.json +4 -4
package/dist/index.d.mts
CHANGED
|
@@ -213,19 +213,6 @@ declare const AttributeOverviewDatatypeEnumValues: readonly ["STRING", "CURRENCY
|
|
|
213
213
|
type AttributeOverviewDatatypeEnum = (typeof AttributeOverviewDatatypeEnumValues)[number];
|
|
214
214
|
declare function isAttributeOverviewDatatypeEnumValue(value: any): value is AttributeOverviewDatatypeEnum;
|
|
215
215
|
|
|
216
|
-
/**
|
|
217
|
-
* @author semantha
|
|
218
|
-
*
|
|
219
|
-
* This is a generated file do not change manually!
|
|
220
|
-
*/
|
|
221
|
-
interface BoostWord {
|
|
222
|
-
id?: string;
|
|
223
|
-
word?: string;
|
|
224
|
-
regex?: string;
|
|
225
|
-
tags?: string[];
|
|
226
|
-
label?: string;
|
|
227
|
-
}
|
|
228
|
-
|
|
229
216
|
/**
|
|
230
217
|
* @author semantha
|
|
231
218
|
*
|
|
@@ -268,6 +255,10 @@ interface McpServerRequest {
|
|
|
268
255
|
interface Message {
|
|
269
256
|
role?: MessageRoleEnum;
|
|
270
257
|
content?: string;
|
|
258
|
+
metadata?: {
|
|
259
|
+
[key: string]: any;
|
|
260
|
+
};
|
|
261
|
+
context?: string;
|
|
271
262
|
}
|
|
272
263
|
|
|
273
264
|
/**
|
|
@@ -297,13 +288,26 @@ interface ChatConversation {
|
|
|
297
288
|
lastUsedAt?: number;
|
|
298
289
|
}
|
|
299
290
|
|
|
291
|
+
/**
|
|
292
|
+
* @author semantha
|
|
293
|
+
*
|
|
294
|
+
* This is a generated file do not change manually!
|
|
295
|
+
*/
|
|
296
|
+
interface MessageResponse {
|
|
297
|
+
role?: MessageResponseRoleEnum;
|
|
298
|
+
content?: string;
|
|
299
|
+
metadata?: {
|
|
300
|
+
[key: string]: any;
|
|
301
|
+
};
|
|
302
|
+
}
|
|
303
|
+
|
|
300
304
|
/**
|
|
301
305
|
* @author semantha
|
|
302
306
|
*
|
|
303
307
|
* This is a generated file do not change manually!
|
|
304
308
|
*/
|
|
305
309
|
interface ChatResponse {
|
|
306
|
-
messages?:
|
|
310
|
+
messages?: MessageResponse[];
|
|
307
311
|
conversationId?: string;
|
|
308
312
|
}
|
|
309
313
|
|
|
@@ -1244,6 +1248,15 @@ declare const McpToolDescriptorAuthEnumValues: readonly ["REQUIRED", "OPTIONAL",
|
|
|
1244
1248
|
type McpToolDescriptorAuthEnum = (typeof McpToolDescriptorAuthEnumValues)[number];
|
|
1245
1249
|
declare function isMcpToolDescriptorAuthEnumValue(value: any): value is McpToolDescriptorAuthEnum;
|
|
1246
1250
|
|
|
1251
|
+
/**
|
|
1252
|
+
* @author semantha
|
|
1253
|
+
*
|
|
1254
|
+
* This is a generated file do not change manually!
|
|
1255
|
+
*/
|
|
1256
|
+
declare const MessageResponseRoleEnumValues: readonly ["USER", "ASSISTANT", "SYSTEM"];
|
|
1257
|
+
type MessageResponseRoleEnum = (typeof MessageResponseRoleEnumValues)[number];
|
|
1258
|
+
declare function isMessageResponseRoleEnumValue(value: any): value is MessageResponseRoleEnum;
|
|
1259
|
+
|
|
1247
1260
|
/**
|
|
1248
1261
|
* @author semantha
|
|
1249
1262
|
*
|
|
@@ -1904,13 +1917,6 @@ declare class BulkmodelBoostwordsEndpoint {
|
|
|
1904
1917
|
private readonly parentEndpoint;
|
|
1905
1918
|
private readonly ENDPOINT;
|
|
1906
1919
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1907
|
-
/**
|
|
1908
|
-
* Create one or more boostwords
|
|
1909
|
-
* This is the quiet version of 'post /api/domains/{domainname}/boostwords'
|
|
1910
|
-
*
|
|
1911
|
-
* @param body BoostWord[]? -
|
|
1912
|
-
*/
|
|
1913
|
-
post(body?: BoostWord[]): Promise<void>;
|
|
1914
1920
|
}
|
|
1915
1921
|
|
|
1916
1922
|
/**
|
|
@@ -2380,6 +2386,19 @@ declare class CelltypesEndpoint {
|
|
|
2380
2386
|
get(): Promise<CellType[]>;
|
|
2381
2387
|
}
|
|
2382
2388
|
|
|
2389
|
+
/**
|
|
2390
|
+
* @author semantha
|
|
2391
|
+
*
|
|
2392
|
+
* Class to access resource "/api/domains/{domainname}/chats/{id}/sse"
|
|
2393
|
+
* This is a generated file do not change manually!
|
|
2394
|
+
*/
|
|
2395
|
+
declare class SseEndpoint {
|
|
2396
|
+
private readonly restClient;
|
|
2397
|
+
private readonly parentEndpoint;
|
|
2398
|
+
private readonly ENDPOINT;
|
|
2399
|
+
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2400
|
+
}
|
|
2401
|
+
|
|
2383
2402
|
/**
|
|
2384
2403
|
* @author semantha
|
|
2385
2404
|
*
|
|
@@ -2392,6 +2411,7 @@ declare class ChatEndpoint {
|
|
|
2392
2411
|
private readonly id;
|
|
2393
2412
|
private readonly ENDPOINT;
|
|
2394
2413
|
constructor(restClient: RestClient, parentEndpoint: string, id: string);
|
|
2414
|
+
sse(): SseEndpoint;
|
|
2395
2415
|
/**
|
|
2396
2416
|
* Chat with the generative model
|
|
2397
2417
|
* 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).
|
|
@@ -2423,6 +2443,14 @@ declare class ConversationEndpoint {
|
|
|
2423
2443
|
* @param xPolarionBaseUrl string? - Base url of the Polarion instance to validate the token against.
|
|
2424
2444
|
*/
|
|
2425
2445
|
get(xPolarionAccessToken?: string, xPolarionBaseUrl?: string): Promise<ChatResponse>;
|
|
2446
|
+
/**
|
|
2447
|
+
* Delete a chat conversation
|
|
2448
|
+
* Deletes the conversation identified by the conversationId that was returned from the chat endpoint and removes it from the caller's conversation list. Returns 204 No Content. The delete is idempotent: deleting a conversation the platform no longer knows (already deleted, expired, or an id that never existed for this caller) also returns 204. A conversation owned by a different user returns 403 - only the owner may delete 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.
|
|
2449
|
+
*
|
|
2450
|
+
* @param xPolarionAccessToken string? - Polarion personal access token; must be provided together with the base url header.
|
|
2451
|
+
* @param xPolarionBaseUrl string? - Base url of the Polarion instance to validate the token against.
|
|
2452
|
+
*/
|
|
2453
|
+
delete(xPolarionAccessToken?: string, xPolarionBaseUrl?: string): Promise<RestResponse<void>>;
|
|
2426
2454
|
}
|
|
2427
2455
|
|
|
2428
2456
|
/**
|
|
@@ -4231,20 +4259,6 @@ declare class ModelBoostwordEndpoint {
|
|
|
4231
4259
|
private readonly id;
|
|
4232
4260
|
private readonly ENDPOINT;
|
|
4233
4261
|
constructor(restClient: RestClient, parentEndpoint: string, id: string);
|
|
4234
|
-
/**
|
|
4235
|
-
* Read one entity.
|
|
4236
|
-
*/
|
|
4237
|
-
get(): Promise<BoostWord>;
|
|
4238
|
-
/**
|
|
4239
|
-
* Delete one entity. Needs roles: 'Domain Admin' or 'Expert User'
|
|
4240
|
-
*/
|
|
4241
|
-
delete(): Promise<RestResponse<void>>;
|
|
4242
|
-
/**
|
|
4243
|
-
* Change one entity. Needs roles: 'Domain Admin' or 'Expert User'
|
|
4244
|
-
*
|
|
4245
|
-
* @param body BoostWord -
|
|
4246
|
-
*/
|
|
4247
|
-
put(body: BoostWord): Promise<BoostWord>;
|
|
4248
4262
|
}
|
|
4249
4263
|
|
|
4250
4264
|
/**
|
|
@@ -4258,20 +4272,6 @@ declare class ModelBoostwordsEndpoint {
|
|
|
4258
4272
|
private readonly parentEndpoint;
|
|
4259
4273
|
private readonly ENDPOINT;
|
|
4260
4274
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
4261
|
-
/**
|
|
4262
|
-
* Read all available entities.
|
|
4263
|
-
*/
|
|
4264
|
-
get(): Promise<BoostWord[]>;
|
|
4265
|
-
/**
|
|
4266
|
-
* Delete all available entities. Needs roles: 'Domain Admin' or 'Expert User'
|
|
4267
|
-
*/
|
|
4268
|
-
delete(): Promise<RestResponse<void>>;
|
|
4269
|
-
/**
|
|
4270
|
-
* Create a new entity. Needs roles: 'Domain Admin' or 'Expert User'
|
|
4271
|
-
*
|
|
4272
|
-
* @param body BoostWord? -
|
|
4273
|
-
*/
|
|
4274
|
-
post(body?: BoostWord): Promise<BoostWord>;
|
|
4275
4275
|
}
|
|
4276
4276
|
|
|
4277
4277
|
/**
|
|
@@ -5212,4 +5212,4 @@ declare class SemanthaAPI {
|
|
|
5212
5212
|
model(): ModelEndpoint;
|
|
5213
5213
|
}
|
|
5214
5214
|
|
|
5215
|
-
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,
|
|
5215
|
+
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, BulkmodelBoostwordsEndpoint, BulkmodelClassEndpoint, BulkmodelClassesEndpoint, BulkmodelDatapropertiesEndpoint, BulkmodelDomainEndpoint, BulkmodelDomainsEndpoint, BulkmodelInstancesEndpoint, BulkmodelMetadataEndpoint, BulkmodelNamedentitiesEndpoint, BulkmodelRulesEndpoint, BulkmodelStopwordsEndpoint, 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, ModelBoostwordEndpoint, ModelBoostwordsEndpoint, 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, ModelStopwordEndpoint, ModelStopwordsEndpoint, 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, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, SseEndpoint, type Statistic, StatisticEndpoint, type StopWord, type Summarization, SummarizationsEndpoint, type SummarylengthEnum, SummarylengthEnumValues, 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, isSummarylengthEnumValue, isTypeEnumValue };
|
package/dist/index.d.ts
CHANGED
|
@@ -213,19 +213,6 @@ declare const AttributeOverviewDatatypeEnumValues: readonly ["STRING", "CURRENCY
|
|
|
213
213
|
type AttributeOverviewDatatypeEnum = (typeof AttributeOverviewDatatypeEnumValues)[number];
|
|
214
214
|
declare function isAttributeOverviewDatatypeEnumValue(value: any): value is AttributeOverviewDatatypeEnum;
|
|
215
215
|
|
|
216
|
-
/**
|
|
217
|
-
* @author semantha
|
|
218
|
-
*
|
|
219
|
-
* This is a generated file do not change manually!
|
|
220
|
-
*/
|
|
221
|
-
interface BoostWord {
|
|
222
|
-
id?: string;
|
|
223
|
-
word?: string;
|
|
224
|
-
regex?: string;
|
|
225
|
-
tags?: string[];
|
|
226
|
-
label?: string;
|
|
227
|
-
}
|
|
228
|
-
|
|
229
216
|
/**
|
|
230
217
|
* @author semantha
|
|
231
218
|
*
|
|
@@ -268,6 +255,10 @@ interface McpServerRequest {
|
|
|
268
255
|
interface Message {
|
|
269
256
|
role?: MessageRoleEnum;
|
|
270
257
|
content?: string;
|
|
258
|
+
metadata?: {
|
|
259
|
+
[key: string]: any;
|
|
260
|
+
};
|
|
261
|
+
context?: string;
|
|
271
262
|
}
|
|
272
263
|
|
|
273
264
|
/**
|
|
@@ -297,13 +288,26 @@ interface ChatConversation {
|
|
|
297
288
|
lastUsedAt?: number;
|
|
298
289
|
}
|
|
299
290
|
|
|
291
|
+
/**
|
|
292
|
+
* @author semantha
|
|
293
|
+
*
|
|
294
|
+
* This is a generated file do not change manually!
|
|
295
|
+
*/
|
|
296
|
+
interface MessageResponse {
|
|
297
|
+
role?: MessageResponseRoleEnum;
|
|
298
|
+
content?: string;
|
|
299
|
+
metadata?: {
|
|
300
|
+
[key: string]: any;
|
|
301
|
+
};
|
|
302
|
+
}
|
|
303
|
+
|
|
300
304
|
/**
|
|
301
305
|
* @author semantha
|
|
302
306
|
*
|
|
303
307
|
* This is a generated file do not change manually!
|
|
304
308
|
*/
|
|
305
309
|
interface ChatResponse {
|
|
306
|
-
messages?:
|
|
310
|
+
messages?: MessageResponse[];
|
|
307
311
|
conversationId?: string;
|
|
308
312
|
}
|
|
309
313
|
|
|
@@ -1244,6 +1248,15 @@ declare const McpToolDescriptorAuthEnumValues: readonly ["REQUIRED", "OPTIONAL",
|
|
|
1244
1248
|
type McpToolDescriptorAuthEnum = (typeof McpToolDescriptorAuthEnumValues)[number];
|
|
1245
1249
|
declare function isMcpToolDescriptorAuthEnumValue(value: any): value is McpToolDescriptorAuthEnum;
|
|
1246
1250
|
|
|
1251
|
+
/**
|
|
1252
|
+
* @author semantha
|
|
1253
|
+
*
|
|
1254
|
+
* This is a generated file do not change manually!
|
|
1255
|
+
*/
|
|
1256
|
+
declare const MessageResponseRoleEnumValues: readonly ["USER", "ASSISTANT", "SYSTEM"];
|
|
1257
|
+
type MessageResponseRoleEnum = (typeof MessageResponseRoleEnumValues)[number];
|
|
1258
|
+
declare function isMessageResponseRoleEnumValue(value: any): value is MessageResponseRoleEnum;
|
|
1259
|
+
|
|
1247
1260
|
/**
|
|
1248
1261
|
* @author semantha
|
|
1249
1262
|
*
|
|
@@ -1904,13 +1917,6 @@ declare class BulkmodelBoostwordsEndpoint {
|
|
|
1904
1917
|
private readonly parentEndpoint;
|
|
1905
1918
|
private readonly ENDPOINT;
|
|
1906
1919
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
1907
|
-
/**
|
|
1908
|
-
* Create one or more boostwords
|
|
1909
|
-
* This is the quiet version of 'post /api/domains/{domainname}/boostwords'
|
|
1910
|
-
*
|
|
1911
|
-
* @param body BoostWord[]? -
|
|
1912
|
-
*/
|
|
1913
|
-
post(body?: BoostWord[]): Promise<void>;
|
|
1914
1920
|
}
|
|
1915
1921
|
|
|
1916
1922
|
/**
|
|
@@ -2380,6 +2386,19 @@ declare class CelltypesEndpoint {
|
|
|
2380
2386
|
get(): Promise<CellType[]>;
|
|
2381
2387
|
}
|
|
2382
2388
|
|
|
2389
|
+
/**
|
|
2390
|
+
* @author semantha
|
|
2391
|
+
*
|
|
2392
|
+
* Class to access resource "/api/domains/{domainname}/chats/{id}/sse"
|
|
2393
|
+
* This is a generated file do not change manually!
|
|
2394
|
+
*/
|
|
2395
|
+
declare class SseEndpoint {
|
|
2396
|
+
private readonly restClient;
|
|
2397
|
+
private readonly parentEndpoint;
|
|
2398
|
+
private readonly ENDPOINT;
|
|
2399
|
+
constructor(restClient: RestClient, parentEndpoint: string);
|
|
2400
|
+
}
|
|
2401
|
+
|
|
2383
2402
|
/**
|
|
2384
2403
|
* @author semantha
|
|
2385
2404
|
*
|
|
@@ -2392,6 +2411,7 @@ declare class ChatEndpoint {
|
|
|
2392
2411
|
private readonly id;
|
|
2393
2412
|
private readonly ENDPOINT;
|
|
2394
2413
|
constructor(restClient: RestClient, parentEndpoint: string, id: string);
|
|
2414
|
+
sse(): SseEndpoint;
|
|
2395
2415
|
/**
|
|
2396
2416
|
* Chat with the generative model
|
|
2397
2417
|
* 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).
|
|
@@ -2423,6 +2443,14 @@ declare class ConversationEndpoint {
|
|
|
2423
2443
|
* @param xPolarionBaseUrl string? - Base url of the Polarion instance to validate the token against.
|
|
2424
2444
|
*/
|
|
2425
2445
|
get(xPolarionAccessToken?: string, xPolarionBaseUrl?: string): Promise<ChatResponse>;
|
|
2446
|
+
/**
|
|
2447
|
+
* Delete a chat conversation
|
|
2448
|
+
* Deletes the conversation identified by the conversationId that was returned from the chat endpoint and removes it from the caller's conversation list. Returns 204 No Content. The delete is idempotent: deleting a conversation the platform no longer knows (already deleted, expired, or an id that never existed for this caller) also returns 204. A conversation owned by a different user returns 403 - only the owner may delete 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.
|
|
2449
|
+
*
|
|
2450
|
+
* @param xPolarionAccessToken string? - Polarion personal access token; must be provided together with the base url header.
|
|
2451
|
+
* @param xPolarionBaseUrl string? - Base url of the Polarion instance to validate the token against.
|
|
2452
|
+
*/
|
|
2453
|
+
delete(xPolarionAccessToken?: string, xPolarionBaseUrl?: string): Promise<RestResponse<void>>;
|
|
2426
2454
|
}
|
|
2427
2455
|
|
|
2428
2456
|
/**
|
|
@@ -4231,20 +4259,6 @@ declare class ModelBoostwordEndpoint {
|
|
|
4231
4259
|
private readonly id;
|
|
4232
4260
|
private readonly ENDPOINT;
|
|
4233
4261
|
constructor(restClient: RestClient, parentEndpoint: string, id: string);
|
|
4234
|
-
/**
|
|
4235
|
-
* Read one entity.
|
|
4236
|
-
*/
|
|
4237
|
-
get(): Promise<BoostWord>;
|
|
4238
|
-
/**
|
|
4239
|
-
* Delete one entity. Needs roles: 'Domain Admin' or 'Expert User'
|
|
4240
|
-
*/
|
|
4241
|
-
delete(): Promise<RestResponse<void>>;
|
|
4242
|
-
/**
|
|
4243
|
-
* Change one entity. Needs roles: 'Domain Admin' or 'Expert User'
|
|
4244
|
-
*
|
|
4245
|
-
* @param body BoostWord -
|
|
4246
|
-
*/
|
|
4247
|
-
put(body: BoostWord): Promise<BoostWord>;
|
|
4248
4262
|
}
|
|
4249
4263
|
|
|
4250
4264
|
/**
|
|
@@ -4258,20 +4272,6 @@ declare class ModelBoostwordsEndpoint {
|
|
|
4258
4272
|
private readonly parentEndpoint;
|
|
4259
4273
|
private readonly ENDPOINT;
|
|
4260
4274
|
constructor(restClient: RestClient, parentEndpoint: string);
|
|
4261
|
-
/**
|
|
4262
|
-
* Read all available entities.
|
|
4263
|
-
*/
|
|
4264
|
-
get(): Promise<BoostWord[]>;
|
|
4265
|
-
/**
|
|
4266
|
-
* Delete all available entities. Needs roles: 'Domain Admin' or 'Expert User'
|
|
4267
|
-
*/
|
|
4268
|
-
delete(): Promise<RestResponse<void>>;
|
|
4269
|
-
/**
|
|
4270
|
-
* Create a new entity. Needs roles: 'Domain Admin' or 'Expert User'
|
|
4271
|
-
*
|
|
4272
|
-
* @param body BoostWord? -
|
|
4273
|
-
*/
|
|
4274
|
-
post(body?: BoostWord): Promise<BoostWord>;
|
|
4275
4275
|
}
|
|
4276
4276
|
|
|
4277
4277
|
/**
|
|
@@ -5212,4 +5212,4 @@ declare class SemanthaAPI {
|
|
|
5212
5212
|
model(): ModelEndpoint;
|
|
5213
5213
|
}
|
|
5214
5214
|
|
|
5215
|
-
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,
|
|
5215
|
+
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, BulkmodelBoostwordsEndpoint, BulkmodelClassEndpoint, BulkmodelClassesEndpoint, BulkmodelDatapropertiesEndpoint, BulkmodelDomainEndpoint, BulkmodelDomainsEndpoint, BulkmodelInstancesEndpoint, BulkmodelMetadataEndpoint, BulkmodelNamedentitiesEndpoint, BulkmodelRulesEndpoint, BulkmodelStopwordsEndpoint, 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, ModelBoostwordEndpoint, ModelBoostwordsEndpoint, 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, ModelStopwordEndpoint, ModelStopwordsEndpoint, 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, type Settings, type SettingsDefaultSimilarityModeEnum, SettingsDefaultSimilarityModeEnumValues, SettingsEndpoint, type SettingsExtractionStrategyEnum, SettingsExtractionStrategyEnumValues, type SettingsTaggingStrategyEnum, SettingsTaggingStrategyEnumValues, type SimpleProperty, SseEndpoint, type Statistic, StatisticEndpoint, type StopWord, type Summarization, SummarizationsEndpoint, type SummarylengthEnum, SummarylengthEnumValues, 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, isSummarylengthEnumValue, isTypeEnumValue };
|