@sermas/api-client 1.0.0-alpha.173 → 1.0.0-alpha.174
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 +57 -37
- package/index.d.ts +57 -37
- package/index.js.map +1 -1
- package/package.json +1 -1
package/index.d.cts
CHANGED
|
@@ -531,6 +531,24 @@ type TaskEventDto = {
|
|
|
531
531
|
*/
|
|
532
532
|
trigger?: Array<TaskEventTriggerDto>;
|
|
533
533
|
};
|
|
534
|
+
type UIContentOptionsDto = {
|
|
535
|
+
/**
|
|
536
|
+
* Clear the UI screen
|
|
537
|
+
*/
|
|
538
|
+
clearScreen?: boolean;
|
|
539
|
+
/**
|
|
540
|
+
* Enable agent reading the content (text to speech)
|
|
541
|
+
*/
|
|
542
|
+
ttsEnabled?: boolean;
|
|
543
|
+
/**
|
|
544
|
+
* Stop the agent speech
|
|
545
|
+
*/
|
|
546
|
+
stopSpeech?: boolean;
|
|
547
|
+
/**
|
|
548
|
+
* Define the language of the content, it will be translated based on the language selected by the user.
|
|
549
|
+
*/
|
|
550
|
+
language?: string;
|
|
551
|
+
};
|
|
534
552
|
/**
|
|
535
553
|
* Data type
|
|
536
554
|
*/
|
|
@@ -556,6 +574,10 @@ type OptionSelection = {
|
|
|
556
574
|
* Description for an option
|
|
557
575
|
*/
|
|
558
576
|
description?: string;
|
|
577
|
+
/**
|
|
578
|
+
* Addtional settings for this field
|
|
579
|
+
*/
|
|
580
|
+
options?: string;
|
|
559
581
|
};
|
|
560
582
|
type TaskFieldDto = {
|
|
561
583
|
/**
|
|
@@ -574,6 +596,14 @@ type TaskFieldDto = {
|
|
|
574
596
|
* Priority order (lower first)
|
|
575
597
|
*/
|
|
576
598
|
order?: number;
|
|
599
|
+
/**
|
|
600
|
+
* UI content options
|
|
601
|
+
*/
|
|
602
|
+
uiOptions?: UIContentOptionsDto;
|
|
603
|
+
/**
|
|
604
|
+
* Skip chat response
|
|
605
|
+
*/
|
|
606
|
+
skipResponse?: boolean;
|
|
577
607
|
type: TaskSchemaDataType;
|
|
578
608
|
/**
|
|
579
609
|
* Indicate if the field is required
|
|
@@ -1030,7 +1060,7 @@ type DialogueTextToSpeechDto = {
|
|
|
1030
1060
|
/**
|
|
1031
1061
|
* LLM engine to use
|
|
1032
1062
|
*/
|
|
1033
|
-
llm?:
|
|
1063
|
+
llm?: Record<string, unknown>;
|
|
1034
1064
|
/**
|
|
1035
1065
|
* The avatar id used for interaction
|
|
1036
1066
|
*/
|
|
@@ -1098,7 +1128,7 @@ type DialogueMessageDto = {
|
|
|
1098
1128
|
/**
|
|
1099
1129
|
* LLM engine to use
|
|
1100
1130
|
*/
|
|
1101
|
-
llm?:
|
|
1131
|
+
llm?: Record<string, unknown>;
|
|
1102
1132
|
/**
|
|
1103
1133
|
* The avatar id used for interaction
|
|
1104
1134
|
*/
|
|
@@ -1474,24 +1504,6 @@ type UIContentMetadataDto = {
|
|
|
1474
1504
|
repositoryId?: string;
|
|
1475
1505
|
chunks?: Array<Record<string, unknown>>;
|
|
1476
1506
|
};
|
|
1477
|
-
type UIContentOptionsDto = {
|
|
1478
|
-
/**
|
|
1479
|
-
* Clear the UI screen
|
|
1480
|
-
*/
|
|
1481
|
-
clearScreen?: boolean;
|
|
1482
|
-
/**
|
|
1483
|
-
* Enable agent reading the content (text to speech)
|
|
1484
|
-
*/
|
|
1485
|
-
ttsEnabled?: boolean;
|
|
1486
|
-
/**
|
|
1487
|
-
* Stop the agent speech
|
|
1488
|
-
*/
|
|
1489
|
-
stopSpeech?: boolean;
|
|
1490
|
-
/**
|
|
1491
|
-
* Define the language of the content, it will be translated based on the language selected by the user.
|
|
1492
|
-
*/
|
|
1493
|
-
language?: string;
|
|
1494
|
-
};
|
|
1495
1507
|
type SupportedContentTypes = 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'navigation-menu' | 'buttons' | 'quiz' | 'clear-screen' | 'qrcode-scanner' | 'background-audio';
|
|
1496
1508
|
declare const SupportedContentTypesEnum: {
|
|
1497
1509
|
readonly VIDEO: "video";
|
|
@@ -2971,7 +2983,7 @@ type TDataText = {
|
|
|
2971
2983
|
/**
|
|
2972
2984
|
* LLM engine to use
|
|
2973
2985
|
*/
|
|
2974
|
-
llm?:
|
|
2986
|
+
llm?: Record<string, unknown>;
|
|
2975
2987
|
/**
|
|
2976
2988
|
* The avatar id used for interaction
|
|
2977
2989
|
*/
|
|
@@ -3856,17 +3868,23 @@ interface anonymous_schema_112 {
|
|
|
3856
3868
|
tokenUrl: string;
|
|
3857
3869
|
refreshUrl?: string;
|
|
3858
3870
|
}
|
|
3859
|
-
interface
|
|
3871
|
+
interface anonymous_schema_152 {
|
|
3872
|
+
clearScreen?: boolean;
|
|
3873
|
+
ttsEnabled?: boolean;
|
|
3874
|
+
stopSpeech?: boolean;
|
|
3875
|
+
language?: string;
|
|
3876
|
+
}
|
|
3877
|
+
interface anonymous_schema_169 {
|
|
3860
3878
|
triggerOnce?: boolean;
|
|
3861
3879
|
removeRecord?: boolean;
|
|
3862
3880
|
enableTool?: boolean;
|
|
3863
|
-
toolOptions?:
|
|
3881
|
+
toolOptions?: anonymous_schema_173;
|
|
3864
3882
|
repositoryId?: string;
|
|
3865
3883
|
list?: boolean;
|
|
3866
3884
|
oncePerSession?: boolean;
|
|
3867
3885
|
matchOrRemove?: boolean;
|
|
3868
3886
|
}
|
|
3869
|
-
interface
|
|
3887
|
+
interface anonymous_schema_173 {
|
|
3870
3888
|
triggerOnce?: boolean;
|
|
3871
3889
|
exclusive?: boolean;
|
|
3872
3890
|
}
|
|
@@ -3931,7 +3949,7 @@ interface StringInferenceValue {
|
|
|
3931
3949
|
probability: number;
|
|
3932
3950
|
value: string;
|
|
3933
3951
|
}
|
|
3934
|
-
type
|
|
3952
|
+
type anonymous_schema_240 = 'start' | 'stop';
|
|
3935
3953
|
interface UserCharacterizationEventDto {
|
|
3936
3954
|
appId: string;
|
|
3937
3955
|
clientId?: string;
|
|
@@ -4052,10 +4070,10 @@ interface DialogueTaskChangedDto {
|
|
|
4052
4070
|
}
|
|
4053
4071
|
interface DialogueTaskProgressDto {
|
|
4054
4072
|
type: TaskEventType;
|
|
4055
|
-
task:
|
|
4056
|
-
record:
|
|
4073
|
+
task: anonymous_schema_342;
|
|
4074
|
+
record: anonymous_schema_343;
|
|
4057
4075
|
}
|
|
4058
|
-
interface
|
|
4076
|
+
interface anonymous_schema_342 {
|
|
4059
4077
|
taskId: string;
|
|
4060
4078
|
appId: string;
|
|
4061
4079
|
hint?: string;
|
|
@@ -4066,9 +4084,9 @@ interface anonymous_schema_335 {
|
|
|
4066
4084
|
intents?: TaskIntentDto[];
|
|
4067
4085
|
events?: TaskEventDto[];
|
|
4068
4086
|
fields: TaskFieldDto[];
|
|
4069
|
-
options?:
|
|
4087
|
+
options?: anonymous_schema_169;
|
|
4070
4088
|
}
|
|
4071
|
-
interface
|
|
4089
|
+
interface anonymous_schema_343 {
|
|
4072
4090
|
recordId: string;
|
|
4073
4091
|
taskId: string;
|
|
4074
4092
|
appId: string;
|
|
@@ -4097,13 +4115,15 @@ interface DialogueTaskRecordHandlerDto {
|
|
|
4097
4115
|
sessionId?: string;
|
|
4098
4116
|
taskId: string;
|
|
4099
4117
|
recordId: string;
|
|
4100
|
-
field:
|
|
4118
|
+
field: anonymous_schema_366;
|
|
4101
4119
|
}
|
|
4102
|
-
interface
|
|
4120
|
+
interface anonymous_schema_366 {
|
|
4103
4121
|
name: string;
|
|
4104
4122
|
label?: string;
|
|
4105
4123
|
hint?: string;
|
|
4106
4124
|
order?: number;
|
|
4125
|
+
uiOptions?: anonymous_schema_152;
|
|
4126
|
+
skipResponse?: boolean;
|
|
4107
4127
|
type: TaskSchemaDataType;
|
|
4108
4128
|
required?: boolean;
|
|
4109
4129
|
validation?: string;
|
|
@@ -4141,10 +4161,10 @@ interface DialogueToolsRepositoryRecordDto {
|
|
|
4141
4161
|
ts?: string;
|
|
4142
4162
|
sessionId?: string;
|
|
4143
4163
|
repositoryId?: string;
|
|
4144
|
-
options?:
|
|
4164
|
+
options?: anonymous_schema_388;
|
|
4145
4165
|
tools?: any[][];
|
|
4146
4166
|
}
|
|
4147
|
-
interface
|
|
4167
|
+
interface anonymous_schema_388 {
|
|
4148
4168
|
triggerOnce?: boolean;
|
|
4149
4169
|
exclusive?: boolean;
|
|
4150
4170
|
}
|
|
@@ -4219,12 +4239,12 @@ interface UIAssetChangedDto {
|
|
|
4219
4239
|
sessionId?: string;
|
|
4220
4240
|
record: UIAssetDto;
|
|
4221
4241
|
}
|
|
4222
|
-
interface
|
|
4242
|
+
interface anonymous_schema_479 {
|
|
4223
4243
|
repositoryId?: string;
|
|
4224
4244
|
chunks?: Record<string, any>[];
|
|
4225
4245
|
additionalProperties?: Record<string, any>;
|
|
4226
4246
|
}
|
|
4227
|
-
interface
|
|
4247
|
+
interface anonymous_schema_484 {
|
|
4228
4248
|
clearScreen?: boolean;
|
|
4229
4249
|
ttsEnabled?: boolean;
|
|
4230
4250
|
stopSpeech?: boolean;
|
|
@@ -4754,4 +4774,4 @@ declare class SermasApiClient {
|
|
|
4754
4774
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
4755
4775
|
}
|
|
4756
4776
|
|
|
4757
|
-
export { type AccessTokenRequestDto, type ActuationDto, type ActuationEventDto, type AdvancedDatasetRecordFilterDto, 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 BackgroundAudioDto, type BackgroundUIAudioDto, 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 DialogueAvatarSpeechControlDto, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueSessionRequestDto, type DialogueSessionRequestStatus, type DialogueSpeechToTextDto, 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 NavigationMenuContentDto, type NavigationMenuItemDto, type NavigationMenuUIContentDto, type NoiseEventDto, type ObjectContentDto, type ObjectContentDtoWrapper, 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 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 Supported3DTypes, Supported3DTypesEnum, type SupportedAudioTypes, SupportedAudioTypesEnum, 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_107, type anonymous_schema_109, type anonymous_schema_112, type
|
|
4777
|
+
export { type AccessTokenRequestDto, type ActuationDto, type ActuationEventDto, type AdvancedDatasetRecordFilterDto, 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 BackgroundAudioDto, type BackgroundUIAudioDto, 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 DialogueAvatarSpeechControlDto, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueSessionRequestDto, type DialogueSessionRequestStatus, type DialogueSpeechToTextDto, 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 NavigationMenuContentDto, type NavigationMenuItemDto, type NavigationMenuUIContentDto, type NoiseEventDto, type ObjectContentDto, type ObjectContentDtoWrapper, 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 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 Supported3DTypes, Supported3DTypesEnum, type SupportedAudioTypes, SupportedAudioTypesEnum, 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_107, type anonymous_schema_109, type anonymous_schema_112, type anonymous_schema_152, type anonymous_schema_169, type anonymous_schema_173, type anonymous_schema_240, type anonymous_schema_342, type anonymous_schema_343, type anonymous_schema_366, type anonymous_schema_388, type anonymous_schema_479, type anonymous_schema_484, type anonymous_schema_88, sleep };
|
package/index.d.ts
CHANGED
|
@@ -531,6 +531,24 @@ type TaskEventDto = {
|
|
|
531
531
|
*/
|
|
532
532
|
trigger?: Array<TaskEventTriggerDto>;
|
|
533
533
|
};
|
|
534
|
+
type UIContentOptionsDto = {
|
|
535
|
+
/**
|
|
536
|
+
* Clear the UI screen
|
|
537
|
+
*/
|
|
538
|
+
clearScreen?: boolean;
|
|
539
|
+
/**
|
|
540
|
+
* Enable agent reading the content (text to speech)
|
|
541
|
+
*/
|
|
542
|
+
ttsEnabled?: boolean;
|
|
543
|
+
/**
|
|
544
|
+
* Stop the agent speech
|
|
545
|
+
*/
|
|
546
|
+
stopSpeech?: boolean;
|
|
547
|
+
/**
|
|
548
|
+
* Define the language of the content, it will be translated based on the language selected by the user.
|
|
549
|
+
*/
|
|
550
|
+
language?: string;
|
|
551
|
+
};
|
|
534
552
|
/**
|
|
535
553
|
* Data type
|
|
536
554
|
*/
|
|
@@ -556,6 +574,10 @@ type OptionSelection = {
|
|
|
556
574
|
* Description for an option
|
|
557
575
|
*/
|
|
558
576
|
description?: string;
|
|
577
|
+
/**
|
|
578
|
+
* Addtional settings for this field
|
|
579
|
+
*/
|
|
580
|
+
options?: string;
|
|
559
581
|
};
|
|
560
582
|
type TaskFieldDto = {
|
|
561
583
|
/**
|
|
@@ -574,6 +596,14 @@ type TaskFieldDto = {
|
|
|
574
596
|
* Priority order (lower first)
|
|
575
597
|
*/
|
|
576
598
|
order?: number;
|
|
599
|
+
/**
|
|
600
|
+
* UI content options
|
|
601
|
+
*/
|
|
602
|
+
uiOptions?: UIContentOptionsDto;
|
|
603
|
+
/**
|
|
604
|
+
* Skip chat response
|
|
605
|
+
*/
|
|
606
|
+
skipResponse?: boolean;
|
|
577
607
|
type: TaskSchemaDataType;
|
|
578
608
|
/**
|
|
579
609
|
* Indicate if the field is required
|
|
@@ -1030,7 +1060,7 @@ type DialogueTextToSpeechDto = {
|
|
|
1030
1060
|
/**
|
|
1031
1061
|
* LLM engine to use
|
|
1032
1062
|
*/
|
|
1033
|
-
llm?:
|
|
1063
|
+
llm?: Record<string, unknown>;
|
|
1034
1064
|
/**
|
|
1035
1065
|
* The avatar id used for interaction
|
|
1036
1066
|
*/
|
|
@@ -1098,7 +1128,7 @@ type DialogueMessageDto = {
|
|
|
1098
1128
|
/**
|
|
1099
1129
|
* LLM engine to use
|
|
1100
1130
|
*/
|
|
1101
|
-
llm?:
|
|
1131
|
+
llm?: Record<string, unknown>;
|
|
1102
1132
|
/**
|
|
1103
1133
|
* The avatar id used for interaction
|
|
1104
1134
|
*/
|
|
@@ -1474,24 +1504,6 @@ type UIContentMetadataDto = {
|
|
|
1474
1504
|
repositoryId?: string;
|
|
1475
1505
|
chunks?: Array<Record<string, unknown>>;
|
|
1476
1506
|
};
|
|
1477
|
-
type UIContentOptionsDto = {
|
|
1478
|
-
/**
|
|
1479
|
-
* Clear the UI screen
|
|
1480
|
-
*/
|
|
1481
|
-
clearScreen?: boolean;
|
|
1482
|
-
/**
|
|
1483
|
-
* Enable agent reading the content (text to speech)
|
|
1484
|
-
*/
|
|
1485
|
-
ttsEnabled?: boolean;
|
|
1486
|
-
/**
|
|
1487
|
-
* Stop the agent speech
|
|
1488
|
-
*/
|
|
1489
|
-
stopSpeech?: boolean;
|
|
1490
|
-
/**
|
|
1491
|
-
* Define the language of the content, it will be translated based on the language selected by the user.
|
|
1492
|
-
*/
|
|
1493
|
-
language?: string;
|
|
1494
|
-
};
|
|
1495
1507
|
type SupportedContentTypes = 'video' | 'image' | 'pdf' | 'webpage' | 'object' | 'text' | 'email' | 'html' | 'link' | 'dialogue-message' | 'navigation' | 'navigation-menu' | 'buttons' | 'quiz' | 'clear-screen' | 'qrcode-scanner' | 'background-audio';
|
|
1496
1508
|
declare const SupportedContentTypesEnum: {
|
|
1497
1509
|
readonly VIDEO: "video";
|
|
@@ -2971,7 +2983,7 @@ type TDataText = {
|
|
|
2971
2983
|
/**
|
|
2972
2984
|
* LLM engine to use
|
|
2973
2985
|
*/
|
|
2974
|
-
llm?:
|
|
2986
|
+
llm?: Record<string, unknown>;
|
|
2975
2987
|
/**
|
|
2976
2988
|
* The avatar id used for interaction
|
|
2977
2989
|
*/
|
|
@@ -3856,17 +3868,23 @@ interface anonymous_schema_112 {
|
|
|
3856
3868
|
tokenUrl: string;
|
|
3857
3869
|
refreshUrl?: string;
|
|
3858
3870
|
}
|
|
3859
|
-
interface
|
|
3871
|
+
interface anonymous_schema_152 {
|
|
3872
|
+
clearScreen?: boolean;
|
|
3873
|
+
ttsEnabled?: boolean;
|
|
3874
|
+
stopSpeech?: boolean;
|
|
3875
|
+
language?: string;
|
|
3876
|
+
}
|
|
3877
|
+
interface anonymous_schema_169 {
|
|
3860
3878
|
triggerOnce?: boolean;
|
|
3861
3879
|
removeRecord?: boolean;
|
|
3862
3880
|
enableTool?: boolean;
|
|
3863
|
-
toolOptions?:
|
|
3881
|
+
toolOptions?: anonymous_schema_173;
|
|
3864
3882
|
repositoryId?: string;
|
|
3865
3883
|
list?: boolean;
|
|
3866
3884
|
oncePerSession?: boolean;
|
|
3867
3885
|
matchOrRemove?: boolean;
|
|
3868
3886
|
}
|
|
3869
|
-
interface
|
|
3887
|
+
interface anonymous_schema_173 {
|
|
3870
3888
|
triggerOnce?: boolean;
|
|
3871
3889
|
exclusive?: boolean;
|
|
3872
3890
|
}
|
|
@@ -3931,7 +3949,7 @@ interface StringInferenceValue {
|
|
|
3931
3949
|
probability: number;
|
|
3932
3950
|
value: string;
|
|
3933
3951
|
}
|
|
3934
|
-
type
|
|
3952
|
+
type anonymous_schema_240 = 'start' | 'stop';
|
|
3935
3953
|
interface UserCharacterizationEventDto {
|
|
3936
3954
|
appId: string;
|
|
3937
3955
|
clientId?: string;
|
|
@@ -4052,10 +4070,10 @@ interface DialogueTaskChangedDto {
|
|
|
4052
4070
|
}
|
|
4053
4071
|
interface DialogueTaskProgressDto {
|
|
4054
4072
|
type: TaskEventType;
|
|
4055
|
-
task:
|
|
4056
|
-
record:
|
|
4073
|
+
task: anonymous_schema_342;
|
|
4074
|
+
record: anonymous_schema_343;
|
|
4057
4075
|
}
|
|
4058
|
-
interface
|
|
4076
|
+
interface anonymous_schema_342 {
|
|
4059
4077
|
taskId: string;
|
|
4060
4078
|
appId: string;
|
|
4061
4079
|
hint?: string;
|
|
@@ -4066,9 +4084,9 @@ interface anonymous_schema_335 {
|
|
|
4066
4084
|
intents?: TaskIntentDto[];
|
|
4067
4085
|
events?: TaskEventDto[];
|
|
4068
4086
|
fields: TaskFieldDto[];
|
|
4069
|
-
options?:
|
|
4087
|
+
options?: anonymous_schema_169;
|
|
4070
4088
|
}
|
|
4071
|
-
interface
|
|
4089
|
+
interface anonymous_schema_343 {
|
|
4072
4090
|
recordId: string;
|
|
4073
4091
|
taskId: string;
|
|
4074
4092
|
appId: string;
|
|
@@ -4097,13 +4115,15 @@ interface DialogueTaskRecordHandlerDto {
|
|
|
4097
4115
|
sessionId?: string;
|
|
4098
4116
|
taskId: string;
|
|
4099
4117
|
recordId: string;
|
|
4100
|
-
field:
|
|
4118
|
+
field: anonymous_schema_366;
|
|
4101
4119
|
}
|
|
4102
|
-
interface
|
|
4120
|
+
interface anonymous_schema_366 {
|
|
4103
4121
|
name: string;
|
|
4104
4122
|
label?: string;
|
|
4105
4123
|
hint?: string;
|
|
4106
4124
|
order?: number;
|
|
4125
|
+
uiOptions?: anonymous_schema_152;
|
|
4126
|
+
skipResponse?: boolean;
|
|
4107
4127
|
type: TaskSchemaDataType;
|
|
4108
4128
|
required?: boolean;
|
|
4109
4129
|
validation?: string;
|
|
@@ -4141,10 +4161,10 @@ interface DialogueToolsRepositoryRecordDto {
|
|
|
4141
4161
|
ts?: string;
|
|
4142
4162
|
sessionId?: string;
|
|
4143
4163
|
repositoryId?: string;
|
|
4144
|
-
options?:
|
|
4164
|
+
options?: anonymous_schema_388;
|
|
4145
4165
|
tools?: any[][];
|
|
4146
4166
|
}
|
|
4147
|
-
interface
|
|
4167
|
+
interface anonymous_schema_388 {
|
|
4148
4168
|
triggerOnce?: boolean;
|
|
4149
4169
|
exclusive?: boolean;
|
|
4150
4170
|
}
|
|
@@ -4219,12 +4239,12 @@ interface UIAssetChangedDto {
|
|
|
4219
4239
|
sessionId?: string;
|
|
4220
4240
|
record: UIAssetDto;
|
|
4221
4241
|
}
|
|
4222
|
-
interface
|
|
4242
|
+
interface anonymous_schema_479 {
|
|
4223
4243
|
repositoryId?: string;
|
|
4224
4244
|
chunks?: Record<string, any>[];
|
|
4225
4245
|
additionalProperties?: Record<string, any>;
|
|
4226
4246
|
}
|
|
4227
|
-
interface
|
|
4247
|
+
interface anonymous_schema_484 {
|
|
4228
4248
|
clearScreen?: boolean;
|
|
4229
4249
|
ttsEnabled?: boolean;
|
|
4230
4250
|
stopSpeech?: boolean;
|
|
@@ -4754,4 +4774,4 @@ declare class SermasApiClient {
|
|
|
4754
4774
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
4755
4775
|
}
|
|
4756
4776
|
|
|
4757
|
-
export { type AccessTokenRequestDto, type ActuationDto, type ActuationEventDto, type AdvancedDatasetRecordFilterDto, 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 BackgroundAudioDto, type BackgroundUIAudioDto, 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 DialogueAvatarSpeechControlDto, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueSessionRequestDto, type DialogueSessionRequestStatus, type DialogueSpeechToTextDto, 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 NavigationMenuContentDto, type NavigationMenuItemDto, type NavigationMenuUIContentDto, type NoiseEventDto, type ObjectContentDto, type ObjectContentDtoWrapper, 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 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 Supported3DTypes, Supported3DTypesEnum, type SupportedAudioTypes, SupportedAudioTypesEnum, 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_107, type anonymous_schema_109, type anonymous_schema_112, type
|
|
4777
|
+
export { type AccessTokenRequestDto, type ActuationDto, type ActuationEventDto, type AdvancedDatasetRecordFilterDto, 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 BackgroundAudioDto, type BackgroundUIAudioDto, 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 DialogueAvatarSpeechControlDto, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMemoryMessageDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueSessionRequestDto, type DialogueSessionRequestStatus, type DialogueSpeechToTextDto, 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 NavigationMenuContentDto, type NavigationMenuItemDto, type NavigationMenuUIContentDto, type NoiseEventDto, type ObjectContentDto, type ObjectContentDtoWrapper, 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 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 Supported3DTypes, Supported3DTypesEnum, type SupportedAudioTypes, SupportedAudioTypesEnum, 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_107, type anonymous_schema_109, type anonymous_schema_112, type anonymous_schema_152, type anonymous_schema_169, type anonymous_schema_173, type anonymous_schema_240, type anonymous_schema_342, type anonymous_schema_343, type anonymous_schema_366, type anonymous_schema_388, type anonymous_schema_479, type anonymous_schema_484, type anonymous_schema_88, sleep };
|