@sermas/api-client 1.0.0-alpha.112 → 1.0.0-alpha.114
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 +79 -21
- package/index.d.ts +79 -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,50 @@ 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
|
+
*/
|
|
442
|
+
chatModeEnabled: boolean;
|
|
443
|
+
/**
|
|
444
|
+
* Toggle the free chat mode, enabled by default
|
|
445
|
+
*/
|
|
427
446
|
avatar: string;
|
|
447
|
+
/**
|
|
448
|
+
* Default interaction language such as en-GB
|
|
449
|
+
*/
|
|
428
450
|
language?: string;
|
|
451
|
+
/**
|
|
452
|
+
* LLM models settings
|
|
453
|
+
*/
|
|
429
454
|
llm?: LLMSettingsDto;
|
|
455
|
+
/**
|
|
456
|
+
* Kisok background image ID
|
|
457
|
+
*/
|
|
430
458
|
background: string;
|
|
459
|
+
/**
|
|
460
|
+
* Application prompt to describe the scope of the application
|
|
461
|
+
*/
|
|
431
462
|
prompt?: AppPromptDto;
|
|
463
|
+
/**
|
|
464
|
+
* Toggle the welcome message sent at the start of a session
|
|
465
|
+
*/
|
|
432
466
|
skipWelcomeMessage?: boolean;
|
|
433
467
|
interactionStart?: InteractionStartTypes;
|
|
468
|
+
/**
|
|
469
|
+
* Kiosk colors theme
|
|
470
|
+
*/
|
|
434
471
|
theme?: Record<string, unknown>;
|
|
435
472
|
};
|
|
436
473
|
type TaskIntentDto = {
|
|
@@ -612,6 +649,10 @@ type DialogueTaskDto = {
|
|
|
612
649
|
* Task name
|
|
613
650
|
*/
|
|
614
651
|
name: string;
|
|
652
|
+
/**
|
|
653
|
+
* Task label
|
|
654
|
+
*/
|
|
655
|
+
label: string;
|
|
615
656
|
/**
|
|
616
657
|
* Task description
|
|
617
658
|
*/
|
|
@@ -953,6 +994,10 @@ type DialogueTextToSpeechDto = {
|
|
|
953
994
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
954
995
|
*/
|
|
955
996
|
chunkId?: string;
|
|
997
|
+
/**
|
|
998
|
+
* Toggle TTS rendering for this message
|
|
999
|
+
*/
|
|
1000
|
+
ttsEnabled?: boolean;
|
|
956
1001
|
/**
|
|
957
1002
|
* SSML markup to render as speech.
|
|
958
1003
|
*/
|
|
@@ -1009,6 +1054,10 @@ type DialogueMessageDto = {
|
|
|
1009
1054
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
1010
1055
|
*/
|
|
1011
1056
|
chunkId?: string;
|
|
1057
|
+
/**
|
|
1058
|
+
* Toggle TTS rendering for this message
|
|
1059
|
+
*/
|
|
1060
|
+
ttsEnabled?: boolean;
|
|
1012
1061
|
};
|
|
1013
1062
|
/**
|
|
1014
1063
|
* role of the message provider
|
|
@@ -1642,6 +1691,7 @@ type TextUIContentDto = {
|
|
|
1642
1691
|
chunkId?: string;
|
|
1643
1692
|
};
|
|
1644
1693
|
type QuizAnswerDto = {
|
|
1694
|
+
answerId: string;
|
|
1645
1695
|
answer: string;
|
|
1646
1696
|
reason: string;
|
|
1647
1697
|
correct: boolean;
|
|
@@ -2543,6 +2593,10 @@ type TDataText = {
|
|
|
2543
2593
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
2544
2594
|
*/
|
|
2545
2595
|
chunkId?: string;
|
|
2596
|
+
/**
|
|
2597
|
+
* Toggle TTS rendering for this message
|
|
2598
|
+
*/
|
|
2599
|
+
ttsEnabled?: boolean;
|
|
2546
2600
|
file?: Blob | File;
|
|
2547
2601
|
};
|
|
2548
2602
|
sampleRate: number;
|
|
@@ -3371,19 +3425,22 @@ interface PlatformAppChangedDto {
|
|
|
3371
3425
|
sessionId?: string;
|
|
3372
3426
|
record: PlatformAppDto;
|
|
3373
3427
|
}
|
|
3374
|
-
interface
|
|
3428
|
+
interface anonymous_schema_86 {
|
|
3429
|
+
text: string;
|
|
3430
|
+
}
|
|
3431
|
+
interface anonymous_schema_103 {
|
|
3375
3432
|
auth?: string;
|
|
3376
|
-
basic?:
|
|
3377
|
-
bearer?:
|
|
3433
|
+
basic?: anonymous_schema_105;
|
|
3434
|
+
bearer?: anonymous_schema_108;
|
|
3378
3435
|
moduleId: string;
|
|
3379
3436
|
url: string;
|
|
3380
3437
|
headers?: Record<string, any>;
|
|
3381
3438
|
}
|
|
3382
|
-
interface
|
|
3439
|
+
interface anonymous_schema_105 {
|
|
3383
3440
|
username?: string;
|
|
3384
3441
|
password: string;
|
|
3385
3442
|
}
|
|
3386
|
-
interface
|
|
3443
|
+
interface anonymous_schema_108 {
|
|
3387
3444
|
clientType?: string;
|
|
3388
3445
|
clientId?: string;
|
|
3389
3446
|
clientSecret?: string;
|
|
@@ -3393,17 +3450,17 @@ interface anonymous_schema_105 {
|
|
|
3393
3450
|
tokenUrl: string;
|
|
3394
3451
|
refreshUrl?: string;
|
|
3395
3452
|
}
|
|
3396
|
-
interface
|
|
3453
|
+
interface anonymous_schema_156 {
|
|
3397
3454
|
triggerOnce?: boolean;
|
|
3398
3455
|
removeRecord?: boolean;
|
|
3399
3456
|
enableTool?: boolean;
|
|
3400
|
-
toolOptions?:
|
|
3457
|
+
toolOptions?: anonymous_schema_160;
|
|
3401
3458
|
repositoryId?: string;
|
|
3402
3459
|
list?: boolean;
|
|
3403
3460
|
oncePerSession?: boolean;
|
|
3404
3461
|
matchOrRemove?: boolean;
|
|
3405
3462
|
}
|
|
3406
|
-
interface
|
|
3463
|
+
interface anonymous_schema_160 {
|
|
3407
3464
|
triggerOnce?: boolean;
|
|
3408
3465
|
exclusive?: boolean;
|
|
3409
3466
|
}
|
|
@@ -3464,7 +3521,7 @@ interface StringInferenceValue {
|
|
|
3464
3521
|
probability: number;
|
|
3465
3522
|
value: string;
|
|
3466
3523
|
}
|
|
3467
|
-
type
|
|
3524
|
+
type anonymous_schema_222 = 'start' | 'stop';
|
|
3468
3525
|
interface UserCharacterizationEventDto {
|
|
3469
3526
|
appId: string;
|
|
3470
3527
|
clientId?: string;
|
|
@@ -3548,21 +3605,22 @@ interface DialogueTaskChangedDto {
|
|
|
3548
3605
|
}
|
|
3549
3606
|
interface DialogueTaskProgressDto {
|
|
3550
3607
|
type: TaskEventType;
|
|
3551
|
-
task:
|
|
3552
|
-
record:
|
|
3608
|
+
task: anonymous_schema_292;
|
|
3609
|
+
record: anonymous_schema_293;
|
|
3553
3610
|
}
|
|
3554
|
-
interface
|
|
3611
|
+
interface anonymous_schema_292 {
|
|
3555
3612
|
taskId: string;
|
|
3556
3613
|
appId: string;
|
|
3557
3614
|
sessionId?: string;
|
|
3558
3615
|
name: string;
|
|
3616
|
+
label: string;
|
|
3559
3617
|
description?: string;
|
|
3560
3618
|
intents?: TaskIntentDto[];
|
|
3561
3619
|
events?: TaskEventDto[];
|
|
3562
3620
|
fields: TaskFieldDto[];
|
|
3563
|
-
options?:
|
|
3621
|
+
options?: anonymous_schema_156;
|
|
3564
3622
|
}
|
|
3565
|
-
interface
|
|
3623
|
+
interface anonymous_schema_293 {
|
|
3566
3624
|
recordId: string;
|
|
3567
3625
|
taskId: string;
|
|
3568
3626
|
appId: string;
|
|
@@ -3589,9 +3647,9 @@ interface DialogueTaskRecordHandlerDto {
|
|
|
3589
3647
|
sessionId?: string;
|
|
3590
3648
|
taskId: string;
|
|
3591
3649
|
recordId: string;
|
|
3592
|
-
field:
|
|
3650
|
+
field: anonymous_schema_314;
|
|
3593
3651
|
}
|
|
3594
|
-
interface
|
|
3652
|
+
interface anonymous_schema_314 {
|
|
3595
3653
|
name: string;
|
|
3596
3654
|
label?: string;
|
|
3597
3655
|
order?: number;
|
|
@@ -3629,10 +3687,10 @@ interface DialogueToolsRepositoryRecordDto {
|
|
|
3629
3687
|
ts?: string;
|
|
3630
3688
|
sessionId?: string;
|
|
3631
3689
|
repositoryId?: string;
|
|
3632
|
-
options?:
|
|
3690
|
+
options?: anonymous_schema_333;
|
|
3633
3691
|
tools?: any[][];
|
|
3634
3692
|
}
|
|
3635
|
-
interface
|
|
3693
|
+
interface anonymous_schema_333 {
|
|
3636
3694
|
triggerOnce?: boolean;
|
|
3637
3695
|
exclusive?: boolean;
|
|
3638
3696
|
}
|
|
@@ -3701,11 +3759,11 @@ interface UIAssetChangedDto {
|
|
|
3701
3759
|
sessionId?: string;
|
|
3702
3760
|
record: UIAssetDto;
|
|
3703
3761
|
}
|
|
3704
|
-
interface
|
|
3762
|
+
interface anonymous_schema_415 {
|
|
3705
3763
|
repositoryId?: string;
|
|
3706
3764
|
additionalProperties?: Record<string, any>;
|
|
3707
3765
|
}
|
|
3708
|
-
interface
|
|
3766
|
+
interface anonymous_schema_418 {
|
|
3709
3767
|
clearScreen?: boolean;
|
|
3710
3768
|
ttsEnabled?: boolean;
|
|
3711
3769
|
stopSpeech?: boolean;
|
|
@@ -4194,4 +4252,4 @@ declare class SermasApiClient {
|
|
|
4194
4252
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
4195
4253
|
}
|
|
4196
4254
|
|
|
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
|
|
4255
|
+
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_103, type anonymous_schema_105, type anonymous_schema_108, type anonymous_schema_156, type anonymous_schema_160, type anonymous_schema_222, type anonymous_schema_292, type anonymous_schema_293, type anonymous_schema_314, type anonymous_schema_333, type anonymous_schema_415, type anonymous_schema_418, type anonymous_schema_86, 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,50 @@ 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
|
+
*/
|
|
442
|
+
chatModeEnabled: boolean;
|
|
443
|
+
/**
|
|
444
|
+
* Toggle the free chat mode, enabled by default
|
|
445
|
+
*/
|
|
427
446
|
avatar: string;
|
|
447
|
+
/**
|
|
448
|
+
* Default interaction language such as en-GB
|
|
449
|
+
*/
|
|
428
450
|
language?: string;
|
|
451
|
+
/**
|
|
452
|
+
* LLM models settings
|
|
453
|
+
*/
|
|
429
454
|
llm?: LLMSettingsDto;
|
|
455
|
+
/**
|
|
456
|
+
* Kisok background image ID
|
|
457
|
+
*/
|
|
430
458
|
background: string;
|
|
459
|
+
/**
|
|
460
|
+
* Application prompt to describe the scope of the application
|
|
461
|
+
*/
|
|
431
462
|
prompt?: AppPromptDto;
|
|
463
|
+
/**
|
|
464
|
+
* Toggle the welcome message sent at the start of a session
|
|
465
|
+
*/
|
|
432
466
|
skipWelcomeMessage?: boolean;
|
|
433
467
|
interactionStart?: InteractionStartTypes;
|
|
468
|
+
/**
|
|
469
|
+
* Kiosk colors theme
|
|
470
|
+
*/
|
|
434
471
|
theme?: Record<string, unknown>;
|
|
435
472
|
};
|
|
436
473
|
type TaskIntentDto = {
|
|
@@ -612,6 +649,10 @@ type DialogueTaskDto = {
|
|
|
612
649
|
* Task name
|
|
613
650
|
*/
|
|
614
651
|
name: string;
|
|
652
|
+
/**
|
|
653
|
+
* Task label
|
|
654
|
+
*/
|
|
655
|
+
label: string;
|
|
615
656
|
/**
|
|
616
657
|
* Task description
|
|
617
658
|
*/
|
|
@@ -953,6 +994,10 @@ type DialogueTextToSpeechDto = {
|
|
|
953
994
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
954
995
|
*/
|
|
955
996
|
chunkId?: string;
|
|
997
|
+
/**
|
|
998
|
+
* Toggle TTS rendering for this message
|
|
999
|
+
*/
|
|
1000
|
+
ttsEnabled?: boolean;
|
|
956
1001
|
/**
|
|
957
1002
|
* SSML markup to render as speech.
|
|
958
1003
|
*/
|
|
@@ -1009,6 +1054,10 @@ type DialogueMessageDto = {
|
|
|
1009
1054
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
1010
1055
|
*/
|
|
1011
1056
|
chunkId?: string;
|
|
1057
|
+
/**
|
|
1058
|
+
* Toggle TTS rendering for this message
|
|
1059
|
+
*/
|
|
1060
|
+
ttsEnabled?: boolean;
|
|
1012
1061
|
};
|
|
1013
1062
|
/**
|
|
1014
1063
|
* role of the message provider
|
|
@@ -1642,6 +1691,7 @@ type TextUIContentDto = {
|
|
|
1642
1691
|
chunkId?: string;
|
|
1643
1692
|
};
|
|
1644
1693
|
type QuizAnswerDto = {
|
|
1694
|
+
answerId: string;
|
|
1645
1695
|
answer: string;
|
|
1646
1696
|
reason: string;
|
|
1647
1697
|
correct: boolean;
|
|
@@ -2543,6 +2593,10 @@ type TDataText = {
|
|
|
2543
2593
|
* Unique sortable ID used to sort chunks from the same messageId
|
|
2544
2594
|
*/
|
|
2545
2595
|
chunkId?: string;
|
|
2596
|
+
/**
|
|
2597
|
+
* Toggle TTS rendering for this message
|
|
2598
|
+
*/
|
|
2599
|
+
ttsEnabled?: boolean;
|
|
2546
2600
|
file?: Blob | File;
|
|
2547
2601
|
};
|
|
2548
2602
|
sampleRate: number;
|
|
@@ -3371,19 +3425,22 @@ interface PlatformAppChangedDto {
|
|
|
3371
3425
|
sessionId?: string;
|
|
3372
3426
|
record: PlatformAppDto;
|
|
3373
3427
|
}
|
|
3374
|
-
interface
|
|
3428
|
+
interface anonymous_schema_86 {
|
|
3429
|
+
text: string;
|
|
3430
|
+
}
|
|
3431
|
+
interface anonymous_schema_103 {
|
|
3375
3432
|
auth?: string;
|
|
3376
|
-
basic?:
|
|
3377
|
-
bearer?:
|
|
3433
|
+
basic?: anonymous_schema_105;
|
|
3434
|
+
bearer?: anonymous_schema_108;
|
|
3378
3435
|
moduleId: string;
|
|
3379
3436
|
url: string;
|
|
3380
3437
|
headers?: Record<string, any>;
|
|
3381
3438
|
}
|
|
3382
|
-
interface
|
|
3439
|
+
interface anonymous_schema_105 {
|
|
3383
3440
|
username?: string;
|
|
3384
3441
|
password: string;
|
|
3385
3442
|
}
|
|
3386
|
-
interface
|
|
3443
|
+
interface anonymous_schema_108 {
|
|
3387
3444
|
clientType?: string;
|
|
3388
3445
|
clientId?: string;
|
|
3389
3446
|
clientSecret?: string;
|
|
@@ -3393,17 +3450,17 @@ interface anonymous_schema_105 {
|
|
|
3393
3450
|
tokenUrl: string;
|
|
3394
3451
|
refreshUrl?: string;
|
|
3395
3452
|
}
|
|
3396
|
-
interface
|
|
3453
|
+
interface anonymous_schema_156 {
|
|
3397
3454
|
triggerOnce?: boolean;
|
|
3398
3455
|
removeRecord?: boolean;
|
|
3399
3456
|
enableTool?: boolean;
|
|
3400
|
-
toolOptions?:
|
|
3457
|
+
toolOptions?: anonymous_schema_160;
|
|
3401
3458
|
repositoryId?: string;
|
|
3402
3459
|
list?: boolean;
|
|
3403
3460
|
oncePerSession?: boolean;
|
|
3404
3461
|
matchOrRemove?: boolean;
|
|
3405
3462
|
}
|
|
3406
|
-
interface
|
|
3463
|
+
interface anonymous_schema_160 {
|
|
3407
3464
|
triggerOnce?: boolean;
|
|
3408
3465
|
exclusive?: boolean;
|
|
3409
3466
|
}
|
|
@@ -3464,7 +3521,7 @@ interface StringInferenceValue {
|
|
|
3464
3521
|
probability: number;
|
|
3465
3522
|
value: string;
|
|
3466
3523
|
}
|
|
3467
|
-
type
|
|
3524
|
+
type anonymous_schema_222 = 'start' | 'stop';
|
|
3468
3525
|
interface UserCharacterizationEventDto {
|
|
3469
3526
|
appId: string;
|
|
3470
3527
|
clientId?: string;
|
|
@@ -3548,21 +3605,22 @@ interface DialogueTaskChangedDto {
|
|
|
3548
3605
|
}
|
|
3549
3606
|
interface DialogueTaskProgressDto {
|
|
3550
3607
|
type: TaskEventType;
|
|
3551
|
-
task:
|
|
3552
|
-
record:
|
|
3608
|
+
task: anonymous_schema_292;
|
|
3609
|
+
record: anonymous_schema_293;
|
|
3553
3610
|
}
|
|
3554
|
-
interface
|
|
3611
|
+
interface anonymous_schema_292 {
|
|
3555
3612
|
taskId: string;
|
|
3556
3613
|
appId: string;
|
|
3557
3614
|
sessionId?: string;
|
|
3558
3615
|
name: string;
|
|
3616
|
+
label: string;
|
|
3559
3617
|
description?: string;
|
|
3560
3618
|
intents?: TaskIntentDto[];
|
|
3561
3619
|
events?: TaskEventDto[];
|
|
3562
3620
|
fields: TaskFieldDto[];
|
|
3563
|
-
options?:
|
|
3621
|
+
options?: anonymous_schema_156;
|
|
3564
3622
|
}
|
|
3565
|
-
interface
|
|
3623
|
+
interface anonymous_schema_293 {
|
|
3566
3624
|
recordId: string;
|
|
3567
3625
|
taskId: string;
|
|
3568
3626
|
appId: string;
|
|
@@ -3589,9 +3647,9 @@ interface DialogueTaskRecordHandlerDto {
|
|
|
3589
3647
|
sessionId?: string;
|
|
3590
3648
|
taskId: string;
|
|
3591
3649
|
recordId: string;
|
|
3592
|
-
field:
|
|
3650
|
+
field: anonymous_schema_314;
|
|
3593
3651
|
}
|
|
3594
|
-
interface
|
|
3652
|
+
interface anonymous_schema_314 {
|
|
3595
3653
|
name: string;
|
|
3596
3654
|
label?: string;
|
|
3597
3655
|
order?: number;
|
|
@@ -3629,10 +3687,10 @@ interface DialogueToolsRepositoryRecordDto {
|
|
|
3629
3687
|
ts?: string;
|
|
3630
3688
|
sessionId?: string;
|
|
3631
3689
|
repositoryId?: string;
|
|
3632
|
-
options?:
|
|
3690
|
+
options?: anonymous_schema_333;
|
|
3633
3691
|
tools?: any[][];
|
|
3634
3692
|
}
|
|
3635
|
-
interface
|
|
3693
|
+
interface anonymous_schema_333 {
|
|
3636
3694
|
triggerOnce?: boolean;
|
|
3637
3695
|
exclusive?: boolean;
|
|
3638
3696
|
}
|
|
@@ -3701,11 +3759,11 @@ interface UIAssetChangedDto {
|
|
|
3701
3759
|
sessionId?: string;
|
|
3702
3760
|
record: UIAssetDto;
|
|
3703
3761
|
}
|
|
3704
|
-
interface
|
|
3762
|
+
interface anonymous_schema_415 {
|
|
3705
3763
|
repositoryId?: string;
|
|
3706
3764
|
additionalProperties?: Record<string, any>;
|
|
3707
3765
|
}
|
|
3708
|
-
interface
|
|
3766
|
+
interface anonymous_schema_418 {
|
|
3709
3767
|
clearScreen?: boolean;
|
|
3710
3768
|
ttsEnabled?: boolean;
|
|
3711
3769
|
stopSpeech?: boolean;
|
|
@@ -4194,4 +4252,4 @@ declare class SermasApiClient {
|
|
|
4194
4252
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
4195
4253
|
}
|
|
4196
4254
|
|
|
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
|
|
4255
|
+
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_103, type anonymous_schema_105, type anonymous_schema_108, type anonymous_schema_156, type anonymous_schema_160, type anonymous_schema_222, type anonymous_schema_292, type anonymous_schema_293, type anonymous_schema_314, type anonymous_schema_333, type anonymous_schema_415, type anonymous_schema_418, type anonymous_schema_86, sleep };
|