@sermas/api-client 1.0.0-alpha.112 → 1.0.0-alpha.113
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/index.cjs.map +1 -1
- package/index.d.cts +75 -21
- package/index.d.ts +75 -21
- package/index.js.map +1 -1
- package/package.json +1 -1
package/index.d.cts
CHANGED
|
@@ -413,6 +413,9 @@ type LLMSettingsDto = {};
|
|
|
413
413
|
type AppPromptDto = {
|
|
414
414
|
text: string;
|
|
415
415
|
};
|
|
416
|
+
/**
|
|
417
|
+
* An interaction modality to start a session
|
|
418
|
+
*/
|
|
416
419
|
type InteractionStartTypes = 'on-load' | 'touch' | 'speak' | 'intent-detection';
|
|
417
420
|
declare const InteractionStartTypesEnum: {
|
|
418
421
|
readonly ON_LOAD: "on-load";
|
|
@@ -421,16 +424,46 @@ declare const InteractionStartTypesEnum: {
|
|
|
421
424
|
readonly INTENT_DETECTION: "intent-detection";
|
|
422
425
|
};
|
|
423
426
|
type AppSettingsDto = {
|
|
427
|
+
/**
|
|
428
|
+
* Skip the default tools response as generated by the LLM
|
|
429
|
+
*/
|
|
424
430
|
skipToolResponse?: boolean;
|
|
431
|
+
/**
|
|
432
|
+
* Toggle text to speech (TTS) rendering
|
|
433
|
+
*/
|
|
425
434
|
ttsEnabled?: boolean;
|
|
435
|
+
/**
|
|
436
|
+
* App requires login
|
|
437
|
+
*/
|
|
426
438
|
login?: boolean;
|
|
439
|
+
/**
|
|
440
|
+
* Avatar ID
|
|
441
|
+
*/
|
|
427
442
|
avatar: string;
|
|
443
|
+
/**
|
|
444
|
+
* Default interaction language such as en-GB
|
|
445
|
+
*/
|
|
428
446
|
language?: string;
|
|
447
|
+
/**
|
|
448
|
+
* LLM models settings
|
|
449
|
+
*/
|
|
429
450
|
llm?: LLMSettingsDto;
|
|
451
|
+
/**
|
|
452
|
+
* Kisok background image ID
|
|
453
|
+
*/
|
|
430
454
|
background: string;
|
|
455
|
+
/**
|
|
456
|
+
* Application prompt to describe the scope of the application
|
|
457
|
+
*/
|
|
431
458
|
prompt?: AppPromptDto;
|
|
459
|
+
/**
|
|
460
|
+
* Toggle the welcome message sent at the start of a session
|
|
461
|
+
*/
|
|
432
462
|
skipWelcomeMessage?: boolean;
|
|
433
463
|
interactionStart?: InteractionStartTypes;
|
|
464
|
+
/**
|
|
465
|
+
* Kiosk colors theme
|
|
466
|
+
*/
|
|
434
467
|
theme?: Record<string, unknown>;
|
|
435
468
|
};
|
|
436
469
|
type TaskIntentDto = {
|
|
@@ -612,6 +645,10 @@ type DialogueTaskDto = {
|
|
|
612
645
|
* Task name
|
|
613
646
|
*/
|
|
614
647
|
name: string;
|
|
648
|
+
/**
|
|
649
|
+
* Task label
|
|
650
|
+
*/
|
|
651
|
+
label: string;
|
|
615
652
|
/**
|
|
616
653
|
* Task description
|
|
617
654
|
*/
|
|
@@ -953,6 +990,10 @@ type DialogueTextToSpeechDto = {
|
|
|
953
990
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
954
991
|
*/
|
|
955
992
|
chunkId?: string;
|
|
993
|
+
/**
|
|
994
|
+
* Toggle TTS rendering for this message
|
|
995
|
+
*/
|
|
996
|
+
ttsEnabled?: boolean;
|
|
956
997
|
/**
|
|
957
998
|
* SSML markup to render as speech.
|
|
958
999
|
*/
|
|
@@ -1009,6 +1050,10 @@ type DialogueMessageDto = {
|
|
|
1009
1050
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
1010
1051
|
*/
|
|
1011
1052
|
chunkId?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* Toggle TTS rendering for this message
|
|
1055
|
+
*/
|
|
1056
|
+
ttsEnabled?: boolean;
|
|
1012
1057
|
};
|
|
1013
1058
|
/**
|
|
1014
1059
|
* role of the message provider
|
|
@@ -1642,6 +1687,7 @@ type TextUIContentDto = {
|
|
|
1642
1687
|
chunkId?: string;
|
|
1643
1688
|
};
|
|
1644
1689
|
type QuizAnswerDto = {
|
|
1690
|
+
answerId: string;
|
|
1645
1691
|
answer: string;
|
|
1646
1692
|
reason: string;
|
|
1647
1693
|
correct: boolean;
|
|
@@ -2543,6 +2589,10 @@ type TDataText = {
|
|
|
2543
2589
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
2544
2590
|
*/
|
|
2545
2591
|
chunkId?: string;
|
|
2592
|
+
/**
|
|
2593
|
+
* Toggle TTS rendering for this message
|
|
2594
|
+
*/
|
|
2595
|
+
ttsEnabled?: boolean;
|
|
2546
2596
|
file?: Blob | File;
|
|
2547
2597
|
};
|
|
2548
2598
|
sampleRate: number;
|
|
@@ -3371,19 +3421,22 @@ interface PlatformAppChangedDto {
|
|
|
3371
3421
|
sessionId?: string;
|
|
3372
3422
|
record: PlatformAppDto;
|
|
3373
3423
|
}
|
|
3374
|
-
interface
|
|
3424
|
+
interface anonymous_schema_85 {
|
|
3425
|
+
text: string;
|
|
3426
|
+
}
|
|
3427
|
+
interface anonymous_schema_102 {
|
|
3375
3428
|
auth?: string;
|
|
3376
|
-
basic?:
|
|
3377
|
-
bearer?:
|
|
3429
|
+
basic?: anonymous_schema_104;
|
|
3430
|
+
bearer?: anonymous_schema_107;
|
|
3378
3431
|
moduleId: string;
|
|
3379
3432
|
url: string;
|
|
3380
3433
|
headers?: Record<string, any>;
|
|
3381
3434
|
}
|
|
3382
|
-
interface
|
|
3435
|
+
interface anonymous_schema_104 {
|
|
3383
3436
|
username?: string;
|
|
3384
3437
|
password: string;
|
|
3385
3438
|
}
|
|
3386
|
-
interface
|
|
3439
|
+
interface anonymous_schema_107 {
|
|
3387
3440
|
clientType?: string;
|
|
3388
3441
|
clientId?: string;
|
|
3389
3442
|
clientSecret?: string;
|
|
@@ -3393,17 +3446,17 @@ interface anonymous_schema_105 {
|
|
|
3393
3446
|
tokenUrl: string;
|
|
3394
3447
|
refreshUrl?: string;
|
|
3395
3448
|
}
|
|
3396
|
-
interface
|
|
3449
|
+
interface anonymous_schema_155 {
|
|
3397
3450
|
triggerOnce?: boolean;
|
|
3398
3451
|
removeRecord?: boolean;
|
|
3399
3452
|
enableTool?: boolean;
|
|
3400
|
-
toolOptions?:
|
|
3453
|
+
toolOptions?: anonymous_schema_159;
|
|
3401
3454
|
repositoryId?: string;
|
|
3402
3455
|
list?: boolean;
|
|
3403
3456
|
oncePerSession?: boolean;
|
|
3404
3457
|
matchOrRemove?: boolean;
|
|
3405
3458
|
}
|
|
3406
|
-
interface
|
|
3459
|
+
interface anonymous_schema_159 {
|
|
3407
3460
|
triggerOnce?: boolean;
|
|
3408
3461
|
exclusive?: boolean;
|
|
3409
3462
|
}
|
|
@@ -3464,7 +3517,7 @@ interface StringInferenceValue {
|
|
|
3464
3517
|
probability: number;
|
|
3465
3518
|
value: string;
|
|
3466
3519
|
}
|
|
3467
|
-
type
|
|
3520
|
+
type anonymous_schema_221 = 'start' | 'stop';
|
|
3468
3521
|
interface UserCharacterizationEventDto {
|
|
3469
3522
|
appId: string;
|
|
3470
3523
|
clientId?: string;
|
|
@@ -3548,21 +3601,22 @@ interface DialogueTaskChangedDto {
|
|
|
3548
3601
|
}
|
|
3549
3602
|
interface DialogueTaskProgressDto {
|
|
3550
3603
|
type: TaskEventType;
|
|
3551
|
-
task:
|
|
3552
|
-
record:
|
|
3604
|
+
task: anonymous_schema_291;
|
|
3605
|
+
record: anonymous_schema_292;
|
|
3553
3606
|
}
|
|
3554
|
-
interface
|
|
3607
|
+
interface anonymous_schema_291 {
|
|
3555
3608
|
taskId: string;
|
|
3556
3609
|
appId: string;
|
|
3557
3610
|
sessionId?: string;
|
|
3558
3611
|
name: string;
|
|
3612
|
+
label: string;
|
|
3559
3613
|
description?: string;
|
|
3560
3614
|
intents?: TaskIntentDto[];
|
|
3561
3615
|
events?: TaskEventDto[];
|
|
3562
3616
|
fields: TaskFieldDto[];
|
|
3563
|
-
options?:
|
|
3617
|
+
options?: anonymous_schema_155;
|
|
3564
3618
|
}
|
|
3565
|
-
interface
|
|
3619
|
+
interface anonymous_schema_292 {
|
|
3566
3620
|
recordId: string;
|
|
3567
3621
|
taskId: string;
|
|
3568
3622
|
appId: string;
|
|
@@ -3589,9 +3643,9 @@ interface DialogueTaskRecordHandlerDto {
|
|
|
3589
3643
|
sessionId?: string;
|
|
3590
3644
|
taskId: string;
|
|
3591
3645
|
recordId: string;
|
|
3592
|
-
field:
|
|
3646
|
+
field: anonymous_schema_313;
|
|
3593
3647
|
}
|
|
3594
|
-
interface
|
|
3648
|
+
interface anonymous_schema_313 {
|
|
3595
3649
|
name: string;
|
|
3596
3650
|
label?: string;
|
|
3597
3651
|
order?: number;
|
|
@@ -3629,10 +3683,10 @@ interface DialogueToolsRepositoryRecordDto {
|
|
|
3629
3683
|
ts?: string;
|
|
3630
3684
|
sessionId?: string;
|
|
3631
3685
|
repositoryId?: string;
|
|
3632
|
-
options?:
|
|
3686
|
+
options?: anonymous_schema_332;
|
|
3633
3687
|
tools?: any[][];
|
|
3634
3688
|
}
|
|
3635
|
-
interface
|
|
3689
|
+
interface anonymous_schema_332 {
|
|
3636
3690
|
triggerOnce?: boolean;
|
|
3637
3691
|
exclusive?: boolean;
|
|
3638
3692
|
}
|
|
@@ -3701,11 +3755,11 @@ interface UIAssetChangedDto {
|
|
|
3701
3755
|
sessionId?: string;
|
|
3702
3756
|
record: UIAssetDto;
|
|
3703
3757
|
}
|
|
3704
|
-
interface
|
|
3758
|
+
interface anonymous_schema_414 {
|
|
3705
3759
|
repositoryId?: string;
|
|
3706
3760
|
additionalProperties?: Record<string, any>;
|
|
3707
3761
|
}
|
|
3708
|
-
interface
|
|
3762
|
+
interface anonymous_schema_417 {
|
|
3709
3763
|
clearScreen?: boolean;
|
|
3710
3764
|
ttsEnabled?: boolean;
|
|
3711
3765
|
stopSpeech?: boolean;
|
|
@@ -4194,4 +4248,4 @@ declare class SermasApiClient {
|
|
|
4194
4248
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
4195
4249
|
}
|
|
4196
4250
|
|
|
4197
|
-
export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, type AgentEvaluatePromptDto, type AgentEvaluatePromptFormat, AgentEvaluatePromptFormatEnum, type AgentEvaluatePromptOptionsDto, type AgentEvaluatePromptResponseDto, type AgentHeartBeatEventDto, type AgentStatus, AgentStatusEnum, type AppClientDto, type AppModuleConfigDto, type AppPromptDto, type AppSettingsDto, type AppToolsDTO, type AppUserDto, type AudioClassificationEventDto, type AudioClassificationValue, type AuthJwtUser, type AuthorizationUser, type AvatarCameraConfig, type AvatarTTSOptions, type BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DatasetRecordDto, type DatasetRecordFilterDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTaskChangedDto, type DialogueTaskDto, type DialogueTaskProgressDto, type DialogueTaskRecordChangedDto, type DialogueTaskRecordDto, type DialogueTaskRecordHandlerDto, type DialogueTextToSpeechDto, type DialogueToolNotMatchingEventDto, type DialogueToolTriggeredEventDto, type DialogueToolsRepositoryChanged, type DialogueToolsRepositoryDto, type DialogueToolsRepositoryOptionsDto, type DialogueToolsRepositoryRecordDto, type EmailContentDto, type EmailUIContentDto, type HtmlContentDto, type HtmlUIContentDto, type ImageContentDto, type ImageUIContentDto, type InitialPoseDto, type InitialPoseEventDto, type InteractionStartTypes, InteractionStartTypesEnum, InteractionTypeEnum, type JwtTokenDto, type KeycloakCredentials, type KeycloakJwtTokenResourceAccess, type LLMProvider, LLMProviderEnum, type LLMRole, LLMRoleEnum, type LLMSettingsDto, type LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LogType, LogTypeEnum, Logger, type LoggerService, type LoginRequestDto, type LoginResponseDto, type MemoryMessageType, MemoryMessageTypeEnum, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MonitoringRecordDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, type OperationalStateDto, type OperationalStateEventDto, type OptionSelection, type OrientationDto, type PdfContentDto, type PdfUIContentDto, type PlatformAppChangedDto, type PlatformAppClientChangedDto, type PlatformAppDto, type PlatformAppExportFilterDto, type PlatformAppModuleConfigEventDto, type PlatformModuleConfigDto, type PlatformSettingsDto, type PlatformTokenDto, type Point3D, type PoseDto, type PositionDto, type QRCodeEventDto, type QrCodeDto, type QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, type RagDocumentsDto, type RagWebsiteDto, type RefreshTokenRequestDto, type RegistrationRequestDto, type RegistrationResponseDto, type RepositoryAnimationDto, type RepositoryAssetMetadataDto, type RepositoryAssetTypes, RepositoryAssetTypesEnum, type RepositoryAvatarDto, type RepositoryBackgroundDto, type RepositoryBackgroundMetadataDto, type RepositoryConfigDto, type RepositoryDocumentDto, type RepositoryRobotModelDto, type RobotMapDto, type SentimentAnalysisRequest, SermasApiClient, type SermasApiClientConfig, type SermasBaseDto, type SermasEnvType, type SermasSessionDto, type SessionChangedDto, type SessionDto, type SessionProperties, type SessionSearchFilter, type SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TaskEventDto, type TaskEventTriggerDto, type TaskEventType, TaskEventTypeEnum, type TaskFieldDto, type TaskIntentDto, type TaskOptionsDto, type TaskSchemaDataType, TaskSchemaDataTypeEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, type UIAssetChangedDto, type UIAssetDto, type UIContentDto, type UIContentMetadataDto, type UIContentOptionsDto, type UIInteractionDTO, type UIInteractionEventDto, type UIModelMapBlendShapesRequestDto, type UIModelMapBlendShapesResponseDto, type UiInteractionButtonDto, type UpdateUserEventDto, type UpdateUserRequestDto, type UserAgeValue, type UserCharacterizationDto, type UserCharacterizationEventDto, type UserDetectionDto, type UserDetectionEventDto, type UserEmotionValue, type UserInteractionIntentionDto, type VelocityDto, type VideoContentDto, type VideoUIContentDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type
|
|
4251
|
+
export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, type AgentEvaluatePromptDto, type AgentEvaluatePromptFormat, AgentEvaluatePromptFormatEnum, type AgentEvaluatePromptOptionsDto, type AgentEvaluatePromptResponseDto, type AgentHeartBeatEventDto, type AgentStatus, AgentStatusEnum, type AppClientDto, type AppModuleConfigDto, type AppPromptDto, type AppSettingsDto, type AppToolsDTO, type AppUserDto, type AudioClassificationEventDto, type AudioClassificationValue, type AuthJwtUser, type AuthorizationUser, type AvatarCameraConfig, type AvatarTTSOptions, type BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DatasetRecordDto, type DatasetRecordFilterDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTaskChangedDto, type DialogueTaskDto, type DialogueTaskProgressDto, type DialogueTaskRecordChangedDto, type DialogueTaskRecordDto, type DialogueTaskRecordHandlerDto, type DialogueTextToSpeechDto, type DialogueToolNotMatchingEventDto, type DialogueToolTriggeredEventDto, type DialogueToolsRepositoryChanged, type DialogueToolsRepositoryDto, type DialogueToolsRepositoryOptionsDto, type DialogueToolsRepositoryRecordDto, type EmailContentDto, type EmailUIContentDto, type HtmlContentDto, type HtmlUIContentDto, type ImageContentDto, type ImageUIContentDto, type InitialPoseDto, type InitialPoseEventDto, type InteractionStartTypes, InteractionStartTypesEnum, InteractionTypeEnum, type JwtTokenDto, type KeycloakCredentials, type KeycloakJwtTokenResourceAccess, type LLMProvider, LLMProviderEnum, type LLMRole, LLMRoleEnum, type LLMSettingsDto, type LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LogType, LogTypeEnum, Logger, type LoggerService, type LoginRequestDto, type LoginResponseDto, type MemoryMessageType, MemoryMessageTypeEnum, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MonitoringRecordDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, type OperationalStateDto, type OperationalStateEventDto, type OptionSelection, type OrientationDto, type PdfContentDto, type PdfUIContentDto, type PlatformAppChangedDto, type PlatformAppClientChangedDto, type PlatformAppDto, type PlatformAppExportFilterDto, type PlatformAppModuleConfigEventDto, type PlatformModuleConfigDto, type PlatformSettingsDto, type PlatformTokenDto, type Point3D, type PoseDto, type PositionDto, type QRCodeEventDto, type QrCodeDto, type QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, type RagDocumentsDto, type RagWebsiteDto, type RefreshTokenRequestDto, type RegistrationRequestDto, type RegistrationResponseDto, type RepositoryAnimationDto, type RepositoryAssetMetadataDto, type RepositoryAssetTypes, RepositoryAssetTypesEnum, type RepositoryAvatarDto, type RepositoryBackgroundDto, type RepositoryBackgroundMetadataDto, type RepositoryConfigDto, type RepositoryDocumentDto, type RepositoryRobotModelDto, type RobotMapDto, type SentimentAnalysisRequest, SermasApiClient, type SermasApiClientConfig, type SermasBaseDto, type SermasEnvType, type SermasSessionDto, type SessionChangedDto, type SessionDto, type SessionProperties, type SessionSearchFilter, type SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TaskEventDto, type TaskEventTriggerDto, type TaskEventType, TaskEventTypeEnum, type TaskFieldDto, type TaskIntentDto, type TaskOptionsDto, type TaskSchemaDataType, TaskSchemaDataTypeEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, type UIAssetChangedDto, type UIAssetDto, type UIContentDto, type UIContentMetadataDto, type UIContentOptionsDto, type UIInteractionDTO, type UIInteractionEventDto, type UIModelMapBlendShapesRequestDto, type UIModelMapBlendShapesResponseDto, type UiInteractionButtonDto, type UpdateUserEventDto, type UpdateUserRequestDto, type UserAgeValue, type UserCharacterizationDto, type UserCharacterizationEventDto, type UserDetectionDto, type UserDetectionEventDto, type UserEmotionValue, type UserInteractionIntentionDto, type VelocityDto, type VideoContentDto, type VideoUIContentDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_102, type anonymous_schema_104, type anonymous_schema_107, type anonymous_schema_155, type anonymous_schema_159, type anonymous_schema_221, type anonymous_schema_291, type anonymous_schema_292, type anonymous_schema_313, type anonymous_schema_332, type anonymous_schema_414, type anonymous_schema_417, type anonymous_schema_85, sleep };
|
package/index.d.ts
CHANGED
|
@@ -413,6 +413,9 @@ type LLMSettingsDto = {};
|
|
|
413
413
|
type AppPromptDto = {
|
|
414
414
|
text: string;
|
|
415
415
|
};
|
|
416
|
+
/**
|
|
417
|
+
* An interaction modality to start a session
|
|
418
|
+
*/
|
|
416
419
|
type InteractionStartTypes = 'on-load' | 'touch' | 'speak' | 'intent-detection';
|
|
417
420
|
declare const InteractionStartTypesEnum: {
|
|
418
421
|
readonly ON_LOAD: "on-load";
|
|
@@ -421,16 +424,46 @@ declare const InteractionStartTypesEnum: {
|
|
|
421
424
|
readonly INTENT_DETECTION: "intent-detection";
|
|
422
425
|
};
|
|
423
426
|
type AppSettingsDto = {
|
|
427
|
+
/**
|
|
428
|
+
* Skip the default tools response as generated by the LLM
|
|
429
|
+
*/
|
|
424
430
|
skipToolResponse?: boolean;
|
|
431
|
+
/**
|
|
432
|
+
* Toggle text to speech (TTS) rendering
|
|
433
|
+
*/
|
|
425
434
|
ttsEnabled?: boolean;
|
|
435
|
+
/**
|
|
436
|
+
* App requires login
|
|
437
|
+
*/
|
|
426
438
|
login?: boolean;
|
|
439
|
+
/**
|
|
440
|
+
* Avatar ID
|
|
441
|
+
*/
|
|
427
442
|
avatar: string;
|
|
443
|
+
/**
|
|
444
|
+
* Default interaction language such as en-GB
|
|
445
|
+
*/
|
|
428
446
|
language?: string;
|
|
447
|
+
/**
|
|
448
|
+
* LLM models settings
|
|
449
|
+
*/
|
|
429
450
|
llm?: LLMSettingsDto;
|
|
451
|
+
/**
|
|
452
|
+
* Kisok background image ID
|
|
453
|
+
*/
|
|
430
454
|
background: string;
|
|
455
|
+
/**
|
|
456
|
+
* Application prompt to describe the scope of the application
|
|
457
|
+
*/
|
|
431
458
|
prompt?: AppPromptDto;
|
|
459
|
+
/**
|
|
460
|
+
* Toggle the welcome message sent at the start of a session
|
|
461
|
+
*/
|
|
432
462
|
skipWelcomeMessage?: boolean;
|
|
433
463
|
interactionStart?: InteractionStartTypes;
|
|
464
|
+
/**
|
|
465
|
+
* Kiosk colors theme
|
|
466
|
+
*/
|
|
434
467
|
theme?: Record<string, unknown>;
|
|
435
468
|
};
|
|
436
469
|
type TaskIntentDto = {
|
|
@@ -612,6 +645,10 @@ type DialogueTaskDto = {
|
|
|
612
645
|
* Task name
|
|
613
646
|
*/
|
|
614
647
|
name: string;
|
|
648
|
+
/**
|
|
649
|
+
* Task label
|
|
650
|
+
*/
|
|
651
|
+
label: string;
|
|
615
652
|
/**
|
|
616
653
|
* Task description
|
|
617
654
|
*/
|
|
@@ -953,6 +990,10 @@ type DialogueTextToSpeechDto = {
|
|
|
953
990
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
954
991
|
*/
|
|
955
992
|
chunkId?: string;
|
|
993
|
+
/**
|
|
994
|
+
* Toggle TTS rendering for this message
|
|
995
|
+
*/
|
|
996
|
+
ttsEnabled?: boolean;
|
|
956
997
|
/**
|
|
957
998
|
* SSML markup to render as speech.
|
|
958
999
|
*/
|
|
@@ -1009,6 +1050,10 @@ type DialogueMessageDto = {
|
|
|
1009
1050
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
1010
1051
|
*/
|
|
1011
1052
|
chunkId?: string;
|
|
1053
|
+
/**
|
|
1054
|
+
* Toggle TTS rendering for this message
|
|
1055
|
+
*/
|
|
1056
|
+
ttsEnabled?: boolean;
|
|
1012
1057
|
};
|
|
1013
1058
|
/**
|
|
1014
1059
|
* role of the message provider
|
|
@@ -1642,6 +1687,7 @@ type TextUIContentDto = {
|
|
|
1642
1687
|
chunkId?: string;
|
|
1643
1688
|
};
|
|
1644
1689
|
type QuizAnswerDto = {
|
|
1690
|
+
answerId: string;
|
|
1645
1691
|
answer: string;
|
|
1646
1692
|
reason: string;
|
|
1647
1693
|
correct: boolean;
|
|
@@ -2543,6 +2589,10 @@ type TDataText = {
|
|
|
2543
2589
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
2544
2590
|
*/
|
|
2545
2591
|
chunkId?: string;
|
|
2592
|
+
/**
|
|
2593
|
+
* Toggle TTS rendering for this message
|
|
2594
|
+
*/
|
|
2595
|
+
ttsEnabled?: boolean;
|
|
2546
2596
|
file?: Blob | File;
|
|
2547
2597
|
};
|
|
2548
2598
|
sampleRate: number;
|
|
@@ -3371,19 +3421,22 @@ interface PlatformAppChangedDto {
|
|
|
3371
3421
|
sessionId?: string;
|
|
3372
3422
|
record: PlatformAppDto;
|
|
3373
3423
|
}
|
|
3374
|
-
interface
|
|
3424
|
+
interface anonymous_schema_85 {
|
|
3425
|
+
text: string;
|
|
3426
|
+
}
|
|
3427
|
+
interface anonymous_schema_102 {
|
|
3375
3428
|
auth?: string;
|
|
3376
|
-
basic?:
|
|
3377
|
-
bearer?:
|
|
3429
|
+
basic?: anonymous_schema_104;
|
|
3430
|
+
bearer?: anonymous_schema_107;
|
|
3378
3431
|
moduleId: string;
|
|
3379
3432
|
url: string;
|
|
3380
3433
|
headers?: Record<string, any>;
|
|
3381
3434
|
}
|
|
3382
|
-
interface
|
|
3435
|
+
interface anonymous_schema_104 {
|
|
3383
3436
|
username?: string;
|
|
3384
3437
|
password: string;
|
|
3385
3438
|
}
|
|
3386
|
-
interface
|
|
3439
|
+
interface anonymous_schema_107 {
|
|
3387
3440
|
clientType?: string;
|
|
3388
3441
|
clientId?: string;
|
|
3389
3442
|
clientSecret?: string;
|
|
@@ -3393,17 +3446,17 @@ interface anonymous_schema_105 {
|
|
|
3393
3446
|
tokenUrl: string;
|
|
3394
3447
|
refreshUrl?: string;
|
|
3395
3448
|
}
|
|
3396
|
-
interface
|
|
3449
|
+
interface anonymous_schema_155 {
|
|
3397
3450
|
triggerOnce?: boolean;
|
|
3398
3451
|
removeRecord?: boolean;
|
|
3399
3452
|
enableTool?: boolean;
|
|
3400
|
-
toolOptions?:
|
|
3453
|
+
toolOptions?: anonymous_schema_159;
|
|
3401
3454
|
repositoryId?: string;
|
|
3402
3455
|
list?: boolean;
|
|
3403
3456
|
oncePerSession?: boolean;
|
|
3404
3457
|
matchOrRemove?: boolean;
|
|
3405
3458
|
}
|
|
3406
|
-
interface
|
|
3459
|
+
interface anonymous_schema_159 {
|
|
3407
3460
|
triggerOnce?: boolean;
|
|
3408
3461
|
exclusive?: boolean;
|
|
3409
3462
|
}
|
|
@@ -3464,7 +3517,7 @@ interface StringInferenceValue {
|
|
|
3464
3517
|
probability: number;
|
|
3465
3518
|
value: string;
|
|
3466
3519
|
}
|
|
3467
|
-
type
|
|
3520
|
+
type anonymous_schema_221 = 'start' | 'stop';
|
|
3468
3521
|
interface UserCharacterizationEventDto {
|
|
3469
3522
|
appId: string;
|
|
3470
3523
|
clientId?: string;
|
|
@@ -3548,21 +3601,22 @@ interface DialogueTaskChangedDto {
|
|
|
3548
3601
|
}
|
|
3549
3602
|
interface DialogueTaskProgressDto {
|
|
3550
3603
|
type: TaskEventType;
|
|
3551
|
-
task:
|
|
3552
|
-
record:
|
|
3604
|
+
task: anonymous_schema_291;
|
|
3605
|
+
record: anonymous_schema_292;
|
|
3553
3606
|
}
|
|
3554
|
-
interface
|
|
3607
|
+
interface anonymous_schema_291 {
|
|
3555
3608
|
taskId: string;
|
|
3556
3609
|
appId: string;
|
|
3557
3610
|
sessionId?: string;
|
|
3558
3611
|
name: string;
|
|
3612
|
+
label: string;
|
|
3559
3613
|
description?: string;
|
|
3560
3614
|
intents?: TaskIntentDto[];
|
|
3561
3615
|
events?: TaskEventDto[];
|
|
3562
3616
|
fields: TaskFieldDto[];
|
|
3563
|
-
options?:
|
|
3617
|
+
options?: anonymous_schema_155;
|
|
3564
3618
|
}
|
|
3565
|
-
interface
|
|
3619
|
+
interface anonymous_schema_292 {
|
|
3566
3620
|
recordId: string;
|
|
3567
3621
|
taskId: string;
|
|
3568
3622
|
appId: string;
|
|
@@ -3589,9 +3643,9 @@ interface DialogueTaskRecordHandlerDto {
|
|
|
3589
3643
|
sessionId?: string;
|
|
3590
3644
|
taskId: string;
|
|
3591
3645
|
recordId: string;
|
|
3592
|
-
field:
|
|
3646
|
+
field: anonymous_schema_313;
|
|
3593
3647
|
}
|
|
3594
|
-
interface
|
|
3648
|
+
interface anonymous_schema_313 {
|
|
3595
3649
|
name: string;
|
|
3596
3650
|
label?: string;
|
|
3597
3651
|
order?: number;
|
|
@@ -3629,10 +3683,10 @@ interface DialogueToolsRepositoryRecordDto {
|
|
|
3629
3683
|
ts?: string;
|
|
3630
3684
|
sessionId?: string;
|
|
3631
3685
|
repositoryId?: string;
|
|
3632
|
-
options?:
|
|
3686
|
+
options?: anonymous_schema_332;
|
|
3633
3687
|
tools?: any[][];
|
|
3634
3688
|
}
|
|
3635
|
-
interface
|
|
3689
|
+
interface anonymous_schema_332 {
|
|
3636
3690
|
triggerOnce?: boolean;
|
|
3637
3691
|
exclusive?: boolean;
|
|
3638
3692
|
}
|
|
@@ -3701,11 +3755,11 @@ interface UIAssetChangedDto {
|
|
|
3701
3755
|
sessionId?: string;
|
|
3702
3756
|
record: UIAssetDto;
|
|
3703
3757
|
}
|
|
3704
|
-
interface
|
|
3758
|
+
interface anonymous_schema_414 {
|
|
3705
3759
|
repositoryId?: string;
|
|
3706
3760
|
additionalProperties?: Record<string, any>;
|
|
3707
3761
|
}
|
|
3708
|
-
interface
|
|
3762
|
+
interface anonymous_schema_417 {
|
|
3709
3763
|
clearScreen?: boolean;
|
|
3710
3764
|
ttsEnabled?: boolean;
|
|
3711
3765
|
stopSpeech?: boolean;
|
|
@@ -4194,4 +4248,4 @@ declare class SermasApiClient {
|
|
|
4194
4248
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
4195
4249
|
}
|
|
4196
4250
|
|
|
4197
|
-
export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, type AgentEvaluatePromptDto, type AgentEvaluatePromptFormat, AgentEvaluatePromptFormatEnum, type AgentEvaluatePromptOptionsDto, type AgentEvaluatePromptResponseDto, type AgentHeartBeatEventDto, type AgentStatus, AgentStatusEnum, type AppClientDto, type AppModuleConfigDto, type AppPromptDto, type AppSettingsDto, type AppToolsDTO, type AppUserDto, type AudioClassificationEventDto, type AudioClassificationValue, type AuthJwtUser, type AuthorizationUser, type AvatarCameraConfig, type AvatarTTSOptions, type BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DatasetRecordDto, type DatasetRecordFilterDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTaskChangedDto, type DialogueTaskDto, type DialogueTaskProgressDto, type DialogueTaskRecordChangedDto, type DialogueTaskRecordDto, type DialogueTaskRecordHandlerDto, type DialogueTextToSpeechDto, type DialogueToolNotMatchingEventDto, type DialogueToolTriggeredEventDto, type DialogueToolsRepositoryChanged, type DialogueToolsRepositoryDto, type DialogueToolsRepositoryOptionsDto, type DialogueToolsRepositoryRecordDto, type EmailContentDto, type EmailUIContentDto, type HtmlContentDto, type HtmlUIContentDto, type ImageContentDto, type ImageUIContentDto, type InitialPoseDto, type InitialPoseEventDto, type InteractionStartTypes, InteractionStartTypesEnum, InteractionTypeEnum, type JwtTokenDto, type KeycloakCredentials, type KeycloakJwtTokenResourceAccess, type LLMProvider, LLMProviderEnum, type LLMRole, LLMRoleEnum, type LLMSettingsDto, type LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LogType, LogTypeEnum, Logger, type LoggerService, type LoginRequestDto, type LoginResponseDto, type MemoryMessageType, MemoryMessageTypeEnum, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MonitoringRecordDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, type OperationalStateDto, type OperationalStateEventDto, type OptionSelection, type OrientationDto, type PdfContentDto, type PdfUIContentDto, type PlatformAppChangedDto, type PlatformAppClientChangedDto, type PlatformAppDto, type PlatformAppExportFilterDto, type PlatformAppModuleConfigEventDto, type PlatformModuleConfigDto, type PlatformSettingsDto, type PlatformTokenDto, type Point3D, type PoseDto, type PositionDto, type QRCodeEventDto, type QrCodeDto, type QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, type RagDocumentsDto, type RagWebsiteDto, type RefreshTokenRequestDto, type RegistrationRequestDto, type RegistrationResponseDto, type RepositoryAnimationDto, type RepositoryAssetMetadataDto, type RepositoryAssetTypes, RepositoryAssetTypesEnum, type RepositoryAvatarDto, type RepositoryBackgroundDto, type RepositoryBackgroundMetadataDto, type RepositoryConfigDto, type RepositoryDocumentDto, type RepositoryRobotModelDto, type RobotMapDto, type SentimentAnalysisRequest, SermasApiClient, type SermasApiClientConfig, type SermasBaseDto, type SermasEnvType, type SermasSessionDto, type SessionChangedDto, type SessionDto, type SessionProperties, type SessionSearchFilter, type SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TaskEventDto, type TaskEventTriggerDto, type TaskEventType, TaskEventTypeEnum, type TaskFieldDto, type TaskIntentDto, type TaskOptionsDto, type TaskSchemaDataType, TaskSchemaDataTypeEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, type UIAssetChangedDto, type UIAssetDto, type UIContentDto, type UIContentMetadataDto, type UIContentOptionsDto, type UIInteractionDTO, type UIInteractionEventDto, type UIModelMapBlendShapesRequestDto, type UIModelMapBlendShapesResponseDto, type UiInteractionButtonDto, type UpdateUserEventDto, type UpdateUserRequestDto, type UserAgeValue, type UserCharacterizationDto, type UserCharacterizationEventDto, type UserDetectionDto, type UserDetectionEventDto, type UserEmotionValue, type UserInteractionIntentionDto, type VelocityDto, type VideoContentDto, type VideoUIContentDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type
|
|
4251
|
+
export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, type AgentEvaluatePromptDto, type AgentEvaluatePromptFormat, AgentEvaluatePromptFormatEnum, type AgentEvaluatePromptOptionsDto, type AgentEvaluatePromptResponseDto, type AgentHeartBeatEventDto, type AgentStatus, AgentStatusEnum, type AppClientDto, type AppModuleConfigDto, type AppPromptDto, type AppSettingsDto, type AppToolsDTO, type AppUserDto, type AudioClassificationEventDto, type AudioClassificationValue, type AuthJwtUser, type AuthorizationUser, type AvatarCameraConfig, type AvatarTTSOptions, type BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DatasetRecordDto, type DatasetRecordFilterDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTaskChangedDto, type DialogueTaskDto, type DialogueTaskProgressDto, type DialogueTaskRecordChangedDto, type DialogueTaskRecordDto, type DialogueTaskRecordHandlerDto, type DialogueTextToSpeechDto, type DialogueToolNotMatchingEventDto, type DialogueToolTriggeredEventDto, type DialogueToolsRepositoryChanged, type DialogueToolsRepositoryDto, type DialogueToolsRepositoryOptionsDto, type DialogueToolsRepositoryRecordDto, type EmailContentDto, type EmailUIContentDto, type HtmlContentDto, type HtmlUIContentDto, type ImageContentDto, type ImageUIContentDto, type InitialPoseDto, type InitialPoseEventDto, type InteractionStartTypes, InteractionStartTypesEnum, InteractionTypeEnum, type JwtTokenDto, type KeycloakCredentials, type KeycloakJwtTokenResourceAccess, type LLMProvider, LLMProviderEnum, type LLMRole, LLMRoleEnum, type LLMSettingsDto, type LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LogType, LogTypeEnum, Logger, type LoggerService, type LoginRequestDto, type LoginResponseDto, type MemoryMessageType, MemoryMessageTypeEnum, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MonitoringRecordDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, type OperationalStateDto, type OperationalStateEventDto, type OptionSelection, type OrientationDto, type PdfContentDto, type PdfUIContentDto, type PlatformAppChangedDto, type PlatformAppClientChangedDto, type PlatformAppDto, type PlatformAppExportFilterDto, type PlatformAppModuleConfigEventDto, type PlatformModuleConfigDto, type PlatformSettingsDto, type PlatformTokenDto, type Point3D, type PoseDto, type PositionDto, type QRCodeEventDto, type QrCodeDto, type QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, type RagDocumentsDto, type RagWebsiteDto, type RefreshTokenRequestDto, type RegistrationRequestDto, type RegistrationResponseDto, type RepositoryAnimationDto, type RepositoryAssetMetadataDto, type RepositoryAssetTypes, RepositoryAssetTypesEnum, type RepositoryAvatarDto, type RepositoryBackgroundDto, type RepositoryBackgroundMetadataDto, type RepositoryConfigDto, type RepositoryDocumentDto, type RepositoryRobotModelDto, type RobotMapDto, type SentimentAnalysisRequest, SermasApiClient, type SermasApiClientConfig, type SermasBaseDto, type SermasEnvType, type SermasSessionDto, type SessionChangedDto, type SessionDto, type SessionProperties, type SessionSearchFilter, type SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TaskEventDto, type TaskEventTriggerDto, type TaskEventType, TaskEventTypeEnum, type TaskFieldDto, type TaskIntentDto, type TaskOptionsDto, type TaskSchemaDataType, TaskSchemaDataTypeEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, type UIAssetChangedDto, type UIAssetDto, type UIContentDto, type UIContentMetadataDto, type UIContentOptionsDto, type UIInteractionDTO, type UIInteractionEventDto, type UIModelMapBlendShapesRequestDto, type UIModelMapBlendShapesResponseDto, type UiInteractionButtonDto, type UpdateUserEventDto, type UpdateUserRequestDto, type UserAgeValue, type UserCharacterizationDto, type UserCharacterizationEventDto, type UserDetectionDto, type UserDetectionEventDto, type UserEmotionValue, type UserInteractionIntentionDto, type VelocityDto, type VideoContentDto, type VideoUIContentDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_102, type anonymous_schema_104, type anonymous_schema_107, type anonymous_schema_155, type anonymous_schema_159, type anonymous_schema_221, type anonymous_schema_291, type anonymous_schema_292, type anonymous_schema_313, type anonymous_schema_332, type anonymous_schema_414, type anonymous_schema_417, type anonymous_schema_85, sleep };
|