@sermas/api-client 1.0.0-alpha.53 → 1.0.0-alpha.55
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 +1 -1
- package/index.cjs.map +1 -1
- package/index.d.cts +134 -42
- package/index.d.ts +134 -42
- package/index.js +1 -1
- package/index.js.map +1 -1
- package/package.json +1 -1
package/index.d.cts
CHANGED
|
@@ -781,6 +781,10 @@ type DialogueToolsRepositoryOptionsDto = {
|
|
|
781
781
|
* Trigger one of the tools in the list once, then remove the tools.
|
|
782
782
|
*/
|
|
783
783
|
triggerOnce?: boolean;
|
|
784
|
+
/**
|
|
785
|
+
* Alter the normal chat flow, assuming one of the available tools will provide an answer.
|
|
786
|
+
*/
|
|
787
|
+
exclusive?: boolean;
|
|
784
788
|
};
|
|
785
789
|
type DialogueToolsRepositoryDto = {
|
|
786
790
|
appId: string;
|
|
@@ -848,6 +852,40 @@ type SessionDto = {
|
|
|
848
852
|
settings?: AppSettingsDto;
|
|
849
853
|
properties?: SessionProperties;
|
|
850
854
|
};
|
|
855
|
+
type SessionSupportRequestDto = {
|
|
856
|
+
appId: string;
|
|
857
|
+
/**
|
|
858
|
+
* Reference to the authenticated client the request originated from
|
|
859
|
+
*/
|
|
860
|
+
clientId?: string;
|
|
861
|
+
/**
|
|
862
|
+
* Reference to the user interacting with the system
|
|
863
|
+
*/
|
|
864
|
+
userId?: string;
|
|
865
|
+
/**
|
|
866
|
+
* Reference date
|
|
867
|
+
*/
|
|
868
|
+
ts?: string;
|
|
869
|
+
sessionId: string;
|
|
870
|
+
code: string;
|
|
871
|
+
message: string;
|
|
872
|
+
};
|
|
873
|
+
type SessionSupportResponseDto = {
|
|
874
|
+
appId: string;
|
|
875
|
+
/**
|
|
876
|
+
* Reference to the authenticated client the request originated from
|
|
877
|
+
*/
|
|
878
|
+
clientId?: string;
|
|
879
|
+
/**
|
|
880
|
+
* Reference to the user interacting with the system
|
|
881
|
+
*/
|
|
882
|
+
userId?: string;
|
|
883
|
+
/**
|
|
884
|
+
* Reference date
|
|
885
|
+
*/
|
|
886
|
+
ts?: string;
|
|
887
|
+
supportId: string;
|
|
888
|
+
};
|
|
851
889
|
type AgentStatus = 'unavailable' | 'error' | 'not_ready' | 'ready' | 'loading' | 'interacting' | 'waiting' | 'processing';
|
|
852
890
|
declare const AgentStatusEnum: {
|
|
853
891
|
readonly UNAVAILABLE: "unavailable";
|
|
@@ -880,25 +918,43 @@ type AgentHeartBeatEventDto = {
|
|
|
880
918
|
moduleId: string;
|
|
881
919
|
status: AgentStatus;
|
|
882
920
|
};
|
|
883
|
-
type
|
|
884
|
-
appId: string;
|
|
921
|
+
type AgentEvaluatePromptOptionsDto = {
|
|
885
922
|
/**
|
|
886
|
-
*
|
|
923
|
+
* Include chat history
|
|
887
924
|
*/
|
|
888
|
-
|
|
925
|
+
history?: boolean;
|
|
889
926
|
/**
|
|
890
|
-
*
|
|
927
|
+
* Include contents from documents
|
|
891
928
|
*/
|
|
892
|
-
|
|
929
|
+
documents?: boolean;
|
|
893
930
|
/**
|
|
894
|
-
*
|
|
931
|
+
* Include application prompt
|
|
895
932
|
*/
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
933
|
+
app?: boolean;
|
|
934
|
+
/**
|
|
935
|
+
* Use specified avatar characterization prompt
|
|
936
|
+
*/
|
|
937
|
+
avatar?: string;
|
|
938
|
+
/**
|
|
939
|
+
* Provide response as JSON
|
|
940
|
+
*/
|
|
941
|
+
json?: boolean;
|
|
942
|
+
/**
|
|
943
|
+
* Response language
|
|
944
|
+
*/
|
|
945
|
+
language?: string;
|
|
900
946
|
};
|
|
901
|
-
|
|
947
|
+
/**
|
|
948
|
+
* LLM provider
|
|
949
|
+
*/
|
|
950
|
+
type LLMProvider = 'ollama' | 'openai' | 'groq' | 'antrophic';
|
|
951
|
+
declare const LLMProviderEnum: {
|
|
952
|
+
readonly OLLAMA: "ollama";
|
|
953
|
+
readonly OPENAI: "openai";
|
|
954
|
+
readonly GROQ: "groq";
|
|
955
|
+
readonly ANTROPHIC: "antrophic";
|
|
956
|
+
};
|
|
957
|
+
type AgentEvaluatePromptDto = {
|
|
902
958
|
appId: string;
|
|
903
959
|
/**
|
|
904
960
|
* Reference to the authenticated client the request originated from
|
|
@@ -912,7 +968,38 @@ type SessionSupportResponseDto = {
|
|
|
912
968
|
* Reference date
|
|
913
969
|
*/
|
|
914
970
|
ts?: string;
|
|
915
|
-
|
|
971
|
+
/**
|
|
972
|
+
* Id of the session
|
|
973
|
+
*/
|
|
974
|
+
sessionId?: string;
|
|
975
|
+
/**
|
|
976
|
+
* Prompt to evaluate
|
|
977
|
+
*/
|
|
978
|
+
prompt: string;
|
|
979
|
+
/**
|
|
980
|
+
* Prompt options
|
|
981
|
+
*/
|
|
982
|
+
options?: AgentEvaluatePromptOptionsDto;
|
|
983
|
+
provider?: LLMProvider;
|
|
984
|
+
/**
|
|
985
|
+
* LLM provider model name
|
|
986
|
+
*/
|
|
987
|
+
model?: string;
|
|
988
|
+
};
|
|
989
|
+
/**
|
|
990
|
+
* Response format (text,string)
|
|
991
|
+
*/
|
|
992
|
+
type AgentEvaluatePromptFormat = 'text' | 'string';
|
|
993
|
+
declare const AgentEvaluatePromptFormatEnum: {
|
|
994
|
+
readonly TEXT: "text";
|
|
995
|
+
readonly STRING: "string";
|
|
996
|
+
};
|
|
997
|
+
type AgentEvaluatePromptResponseDto = {
|
|
998
|
+
/**
|
|
999
|
+
* Result of the call
|
|
1000
|
+
*/
|
|
1001
|
+
result: Record<string, unknown>;
|
|
1002
|
+
format: AgentEvaluatePromptFormat;
|
|
916
1003
|
};
|
|
917
1004
|
type SessionStorageRecordDto = {
|
|
918
1005
|
appId: string;
|
|
@@ -2010,11 +2097,6 @@ declare class DialogueService {
|
|
|
2010
2097
|
* @throws ApiError
|
|
2011
2098
|
*/
|
|
2012
2099
|
listModels(): CancelablePromise<any>;
|
|
2013
|
-
/**
|
|
2014
|
-
* @returns any
|
|
2015
|
-
* @throws ApiError
|
|
2016
|
-
*/
|
|
2017
|
-
import1(): CancelablePromise<any>;
|
|
2018
2100
|
/**
|
|
2019
2101
|
* Save tools, overwriting existing ones.
|
|
2020
2102
|
* @returns any
|
|
@@ -2428,11 +2510,14 @@ type TDataCreateSession = {
|
|
|
2428
2510
|
type TDataUpdateSession = {
|
|
2429
2511
|
requestBody: SessionDto;
|
|
2430
2512
|
};
|
|
2513
|
+
type TDataSupport = {
|
|
2514
|
+
requestBody: SessionSupportRequestDto;
|
|
2515
|
+
};
|
|
2431
2516
|
type TDataAgentUpdate = {
|
|
2432
2517
|
requestBody: AgentHeartBeatEventDto;
|
|
2433
2518
|
};
|
|
2434
|
-
type
|
|
2435
|
-
requestBody:
|
|
2519
|
+
type TDataPrompt = {
|
|
2520
|
+
requestBody: AgentEvaluatePromptDto;
|
|
2436
2521
|
};
|
|
2437
2522
|
type TDataSetRecord = {
|
|
2438
2523
|
requestBody: SessionStorageRecordDto;
|
|
@@ -2479,6 +2564,12 @@ declare class SessionService {
|
|
|
2479
2564
|
* @throws ApiError
|
|
2480
2565
|
*/
|
|
2481
2566
|
updateSession(data: TDataUpdateSession): CancelablePromise<any>;
|
|
2567
|
+
/**
|
|
2568
|
+
* Request support from human
|
|
2569
|
+
* @returns SessionSupportResponseDto Human support requested
|
|
2570
|
+
* @throws ApiError
|
|
2571
|
+
*/
|
|
2572
|
+
support(data: TDataSupport): CancelablePromise<SessionSupportResponseDto>;
|
|
2482
2573
|
/**
|
|
2483
2574
|
* Notifies of an agent update
|
|
2484
2575
|
* @returns any
|
|
@@ -2486,11 +2577,11 @@ declare class SessionService {
|
|
|
2486
2577
|
*/
|
|
2487
2578
|
agentUpdate(data: TDataAgentUpdate): CancelablePromise<any>;
|
|
2488
2579
|
/**
|
|
2489
|
-
*
|
|
2490
|
-
* @returns
|
|
2580
|
+
* Evaluate a prompt within the session context
|
|
2581
|
+
* @returns AgentEvaluatePromptResponseDto
|
|
2491
2582
|
* @throws ApiError
|
|
2492
2583
|
*/
|
|
2493
|
-
|
|
2584
|
+
prompt(data: TDataPrompt): CancelablePromise<AgentEvaluatePromptResponseDto>;
|
|
2494
2585
|
/**
|
|
2495
2586
|
* Store user data
|
|
2496
2587
|
* @returns SessionStorageRecordDto Record stored
|
|
@@ -2896,6 +2987,7 @@ interface DialogueToolsRepositoryRecordDto {
|
|
|
2896
2987
|
}
|
|
2897
2988
|
interface anonymous_schema_253 {
|
|
2898
2989
|
triggerOnce?: boolean;
|
|
2990
|
+
exclusive?: boolean;
|
|
2899
2991
|
}
|
|
2900
2992
|
interface SessionChangedDto {
|
|
2901
2993
|
appId: string;
|
|
@@ -2906,6 +2998,16 @@ interface SessionChangedDto {
|
|
|
2906
2998
|
sessionId?: string;
|
|
2907
2999
|
record: SessionDto;
|
|
2908
3000
|
}
|
|
3001
|
+
interface SessionSupportEventDto {
|
|
3002
|
+
appId: string;
|
|
3003
|
+
clientId?: string;
|
|
3004
|
+
userId?: string;
|
|
3005
|
+
ts?: string;
|
|
3006
|
+
supportId: string;
|
|
3007
|
+
status: string;
|
|
3008
|
+
feedback: string;
|
|
3009
|
+
code: string;
|
|
3010
|
+
}
|
|
2909
3011
|
interface AgentDto {
|
|
2910
3012
|
appId: string;
|
|
2911
3013
|
clientId?: string;
|
|
@@ -2925,16 +3027,6 @@ interface AgentChangedDto {
|
|
|
2925
3027
|
moduleId: string;
|
|
2926
3028
|
record: AgentDto;
|
|
2927
3029
|
}
|
|
2928
|
-
interface SessionSupportEventDto {
|
|
2929
|
-
appId: string;
|
|
2930
|
-
clientId?: string;
|
|
2931
|
-
userId?: string;
|
|
2932
|
-
ts?: string;
|
|
2933
|
-
supportId: string;
|
|
2934
|
-
status: string;
|
|
2935
|
-
feedback: string;
|
|
2936
|
-
code: string;
|
|
2937
|
-
}
|
|
2938
3030
|
interface SessionStorageEventDto {
|
|
2939
3031
|
appId: string;
|
|
2940
3032
|
clientId?: string;
|
|
@@ -2953,11 +3045,11 @@ interface UIAssetChangedDto {
|
|
|
2953
3045
|
sessionId?: string;
|
|
2954
3046
|
record: UIAssetDto;
|
|
2955
3047
|
}
|
|
2956
|
-
interface
|
|
3048
|
+
interface anonymous_schema_329 {
|
|
2957
3049
|
repositoryId?: string;
|
|
2958
3050
|
additionalProperties?: Record<string, any>;
|
|
2959
3051
|
}
|
|
2960
|
-
interface
|
|
3052
|
+
interface anonymous_schema_332 {
|
|
2961
3053
|
clearScreen?: boolean;
|
|
2962
3054
|
ttsEnabled?: boolean;
|
|
2963
3055
|
stopSpeech?: boolean;
|
|
@@ -3176,6 +3268,12 @@ declare class Session {
|
|
|
3176
3268
|
appId?: string;
|
|
3177
3269
|
sessionId?: string;
|
|
3178
3270
|
}): Promise<() => void>;
|
|
3271
|
+
support(event: SessionSupportEventDto, params?: {
|
|
3272
|
+
appId?: string;
|
|
3273
|
+
}): Promise<boolean>;
|
|
3274
|
+
onSupport(fn: (event: SessionSupportEventDto) => void | Promise<void>, params?: {
|
|
3275
|
+
appId?: string;
|
|
3276
|
+
}): Promise<() => void>;
|
|
3179
3277
|
agentInteraction(event: AgentDto, params?: {
|
|
3180
3278
|
appId?: string;
|
|
3181
3279
|
}): Promise<boolean>;
|
|
@@ -3190,12 +3288,6 @@ declare class Session {
|
|
|
3190
3288
|
appId?: string;
|
|
3191
3289
|
agentId?: string;
|
|
3192
3290
|
}): Promise<() => void>;
|
|
3193
|
-
support(event: SessionSupportEventDto, params?: {
|
|
3194
|
-
appId?: string;
|
|
3195
|
-
}): Promise<boolean>;
|
|
3196
|
-
onSupport(fn: (event: SessionSupportEventDto) => void | Promise<void>, params?: {
|
|
3197
|
-
appId?: string;
|
|
3198
|
-
}): Promise<() => void>;
|
|
3199
3291
|
storageUpdated(event: SessionStorageEventDto, params?: {
|
|
3200
3292
|
appId?: string;
|
|
3201
3293
|
storageId?: string;
|
|
@@ -3374,4 +3466,4 @@ declare class SermasApiClient {
|
|
|
3374
3466
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
3375
3467
|
}
|
|
3376
3468
|
|
|
3377
|
-
export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, 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 BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTextToSpeechDto, 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 LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LoginRequestDto, type LoginResponseDto, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, 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 QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, 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 SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, TypeEnum, 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 ViewLogsRequestDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_101, type anonymous_schema_104, type anonymous_schema_174, type anonymous_schema_253, type
|
|
3469
|
+
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 BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTextToSpeechDto, 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 LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LoginRequestDto, type LoginResponseDto, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, 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 QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, 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 SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, TypeEnum, 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 ViewLogsRequestDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_101, type anonymous_schema_104, type anonymous_schema_174, type anonymous_schema_253, type anonymous_schema_329, type anonymous_schema_332, type anonymous_schema_99, sleep };
|
package/index.d.ts
CHANGED
|
@@ -781,6 +781,10 @@ type DialogueToolsRepositoryOptionsDto = {
|
|
|
781
781
|
* Trigger one of the tools in the list once, then remove the tools.
|
|
782
782
|
*/
|
|
783
783
|
triggerOnce?: boolean;
|
|
784
|
+
/**
|
|
785
|
+
* Alter the normal chat flow, assuming one of the available tools will provide an answer.
|
|
786
|
+
*/
|
|
787
|
+
exclusive?: boolean;
|
|
784
788
|
};
|
|
785
789
|
type DialogueToolsRepositoryDto = {
|
|
786
790
|
appId: string;
|
|
@@ -848,6 +852,40 @@ type SessionDto = {
|
|
|
848
852
|
settings?: AppSettingsDto;
|
|
849
853
|
properties?: SessionProperties;
|
|
850
854
|
};
|
|
855
|
+
type SessionSupportRequestDto = {
|
|
856
|
+
appId: string;
|
|
857
|
+
/**
|
|
858
|
+
* Reference to the authenticated client the request originated from
|
|
859
|
+
*/
|
|
860
|
+
clientId?: string;
|
|
861
|
+
/**
|
|
862
|
+
* Reference to the user interacting with the system
|
|
863
|
+
*/
|
|
864
|
+
userId?: string;
|
|
865
|
+
/**
|
|
866
|
+
* Reference date
|
|
867
|
+
*/
|
|
868
|
+
ts?: string;
|
|
869
|
+
sessionId: string;
|
|
870
|
+
code: string;
|
|
871
|
+
message: string;
|
|
872
|
+
};
|
|
873
|
+
type SessionSupportResponseDto = {
|
|
874
|
+
appId: string;
|
|
875
|
+
/**
|
|
876
|
+
* Reference to the authenticated client the request originated from
|
|
877
|
+
*/
|
|
878
|
+
clientId?: string;
|
|
879
|
+
/**
|
|
880
|
+
* Reference to the user interacting with the system
|
|
881
|
+
*/
|
|
882
|
+
userId?: string;
|
|
883
|
+
/**
|
|
884
|
+
* Reference date
|
|
885
|
+
*/
|
|
886
|
+
ts?: string;
|
|
887
|
+
supportId: string;
|
|
888
|
+
};
|
|
851
889
|
type AgentStatus = 'unavailable' | 'error' | 'not_ready' | 'ready' | 'loading' | 'interacting' | 'waiting' | 'processing';
|
|
852
890
|
declare const AgentStatusEnum: {
|
|
853
891
|
readonly UNAVAILABLE: "unavailable";
|
|
@@ -880,25 +918,43 @@ type AgentHeartBeatEventDto = {
|
|
|
880
918
|
moduleId: string;
|
|
881
919
|
status: AgentStatus;
|
|
882
920
|
};
|
|
883
|
-
type
|
|
884
|
-
appId: string;
|
|
921
|
+
type AgentEvaluatePromptOptionsDto = {
|
|
885
922
|
/**
|
|
886
|
-
*
|
|
923
|
+
* Include chat history
|
|
887
924
|
*/
|
|
888
|
-
|
|
925
|
+
history?: boolean;
|
|
889
926
|
/**
|
|
890
|
-
*
|
|
927
|
+
* Include contents from documents
|
|
891
928
|
*/
|
|
892
|
-
|
|
929
|
+
documents?: boolean;
|
|
893
930
|
/**
|
|
894
|
-
*
|
|
931
|
+
* Include application prompt
|
|
895
932
|
*/
|
|
896
|
-
|
|
897
|
-
|
|
898
|
-
|
|
899
|
-
|
|
933
|
+
app?: boolean;
|
|
934
|
+
/**
|
|
935
|
+
* Use specified avatar characterization prompt
|
|
936
|
+
*/
|
|
937
|
+
avatar?: string;
|
|
938
|
+
/**
|
|
939
|
+
* Provide response as JSON
|
|
940
|
+
*/
|
|
941
|
+
json?: boolean;
|
|
942
|
+
/**
|
|
943
|
+
* Response language
|
|
944
|
+
*/
|
|
945
|
+
language?: string;
|
|
900
946
|
};
|
|
901
|
-
|
|
947
|
+
/**
|
|
948
|
+
* LLM provider
|
|
949
|
+
*/
|
|
950
|
+
type LLMProvider = 'ollama' | 'openai' | 'groq' | 'antrophic';
|
|
951
|
+
declare const LLMProviderEnum: {
|
|
952
|
+
readonly OLLAMA: "ollama";
|
|
953
|
+
readonly OPENAI: "openai";
|
|
954
|
+
readonly GROQ: "groq";
|
|
955
|
+
readonly ANTROPHIC: "antrophic";
|
|
956
|
+
};
|
|
957
|
+
type AgentEvaluatePromptDto = {
|
|
902
958
|
appId: string;
|
|
903
959
|
/**
|
|
904
960
|
* Reference to the authenticated client the request originated from
|
|
@@ -912,7 +968,38 @@ type SessionSupportResponseDto = {
|
|
|
912
968
|
* Reference date
|
|
913
969
|
*/
|
|
914
970
|
ts?: string;
|
|
915
|
-
|
|
971
|
+
/**
|
|
972
|
+
* Id of the session
|
|
973
|
+
*/
|
|
974
|
+
sessionId?: string;
|
|
975
|
+
/**
|
|
976
|
+
* Prompt to evaluate
|
|
977
|
+
*/
|
|
978
|
+
prompt: string;
|
|
979
|
+
/**
|
|
980
|
+
* Prompt options
|
|
981
|
+
*/
|
|
982
|
+
options?: AgentEvaluatePromptOptionsDto;
|
|
983
|
+
provider?: LLMProvider;
|
|
984
|
+
/**
|
|
985
|
+
* LLM provider model name
|
|
986
|
+
*/
|
|
987
|
+
model?: string;
|
|
988
|
+
};
|
|
989
|
+
/**
|
|
990
|
+
* Response format (text,string)
|
|
991
|
+
*/
|
|
992
|
+
type AgentEvaluatePromptFormat = 'text' | 'string';
|
|
993
|
+
declare const AgentEvaluatePromptFormatEnum: {
|
|
994
|
+
readonly TEXT: "text";
|
|
995
|
+
readonly STRING: "string";
|
|
996
|
+
};
|
|
997
|
+
type AgentEvaluatePromptResponseDto = {
|
|
998
|
+
/**
|
|
999
|
+
* Result of the call
|
|
1000
|
+
*/
|
|
1001
|
+
result: Record<string, unknown>;
|
|
1002
|
+
format: AgentEvaluatePromptFormat;
|
|
916
1003
|
};
|
|
917
1004
|
type SessionStorageRecordDto = {
|
|
918
1005
|
appId: string;
|
|
@@ -2010,11 +2097,6 @@ declare class DialogueService {
|
|
|
2010
2097
|
* @throws ApiError
|
|
2011
2098
|
*/
|
|
2012
2099
|
listModels(): CancelablePromise<any>;
|
|
2013
|
-
/**
|
|
2014
|
-
* @returns any
|
|
2015
|
-
* @throws ApiError
|
|
2016
|
-
*/
|
|
2017
|
-
import1(): CancelablePromise<any>;
|
|
2018
2100
|
/**
|
|
2019
2101
|
* Save tools, overwriting existing ones.
|
|
2020
2102
|
* @returns any
|
|
@@ -2428,11 +2510,14 @@ type TDataCreateSession = {
|
|
|
2428
2510
|
type TDataUpdateSession = {
|
|
2429
2511
|
requestBody: SessionDto;
|
|
2430
2512
|
};
|
|
2513
|
+
type TDataSupport = {
|
|
2514
|
+
requestBody: SessionSupportRequestDto;
|
|
2515
|
+
};
|
|
2431
2516
|
type TDataAgentUpdate = {
|
|
2432
2517
|
requestBody: AgentHeartBeatEventDto;
|
|
2433
2518
|
};
|
|
2434
|
-
type
|
|
2435
|
-
requestBody:
|
|
2519
|
+
type TDataPrompt = {
|
|
2520
|
+
requestBody: AgentEvaluatePromptDto;
|
|
2436
2521
|
};
|
|
2437
2522
|
type TDataSetRecord = {
|
|
2438
2523
|
requestBody: SessionStorageRecordDto;
|
|
@@ -2479,6 +2564,12 @@ declare class SessionService {
|
|
|
2479
2564
|
* @throws ApiError
|
|
2480
2565
|
*/
|
|
2481
2566
|
updateSession(data: TDataUpdateSession): CancelablePromise<any>;
|
|
2567
|
+
/**
|
|
2568
|
+
* Request support from human
|
|
2569
|
+
* @returns SessionSupportResponseDto Human support requested
|
|
2570
|
+
* @throws ApiError
|
|
2571
|
+
*/
|
|
2572
|
+
support(data: TDataSupport): CancelablePromise<SessionSupportResponseDto>;
|
|
2482
2573
|
/**
|
|
2483
2574
|
* Notifies of an agent update
|
|
2484
2575
|
* @returns any
|
|
@@ -2486,11 +2577,11 @@ declare class SessionService {
|
|
|
2486
2577
|
*/
|
|
2487
2578
|
agentUpdate(data: TDataAgentUpdate): CancelablePromise<any>;
|
|
2488
2579
|
/**
|
|
2489
|
-
*
|
|
2490
|
-
* @returns
|
|
2580
|
+
* Evaluate a prompt within the session context
|
|
2581
|
+
* @returns AgentEvaluatePromptResponseDto
|
|
2491
2582
|
* @throws ApiError
|
|
2492
2583
|
*/
|
|
2493
|
-
|
|
2584
|
+
prompt(data: TDataPrompt): CancelablePromise<AgentEvaluatePromptResponseDto>;
|
|
2494
2585
|
/**
|
|
2495
2586
|
* Store user data
|
|
2496
2587
|
* @returns SessionStorageRecordDto Record stored
|
|
@@ -2896,6 +2987,7 @@ interface DialogueToolsRepositoryRecordDto {
|
|
|
2896
2987
|
}
|
|
2897
2988
|
interface anonymous_schema_253 {
|
|
2898
2989
|
triggerOnce?: boolean;
|
|
2990
|
+
exclusive?: boolean;
|
|
2899
2991
|
}
|
|
2900
2992
|
interface SessionChangedDto {
|
|
2901
2993
|
appId: string;
|
|
@@ -2906,6 +2998,16 @@ interface SessionChangedDto {
|
|
|
2906
2998
|
sessionId?: string;
|
|
2907
2999
|
record: SessionDto;
|
|
2908
3000
|
}
|
|
3001
|
+
interface SessionSupportEventDto {
|
|
3002
|
+
appId: string;
|
|
3003
|
+
clientId?: string;
|
|
3004
|
+
userId?: string;
|
|
3005
|
+
ts?: string;
|
|
3006
|
+
supportId: string;
|
|
3007
|
+
status: string;
|
|
3008
|
+
feedback: string;
|
|
3009
|
+
code: string;
|
|
3010
|
+
}
|
|
2909
3011
|
interface AgentDto {
|
|
2910
3012
|
appId: string;
|
|
2911
3013
|
clientId?: string;
|
|
@@ -2925,16 +3027,6 @@ interface AgentChangedDto {
|
|
|
2925
3027
|
moduleId: string;
|
|
2926
3028
|
record: AgentDto;
|
|
2927
3029
|
}
|
|
2928
|
-
interface SessionSupportEventDto {
|
|
2929
|
-
appId: string;
|
|
2930
|
-
clientId?: string;
|
|
2931
|
-
userId?: string;
|
|
2932
|
-
ts?: string;
|
|
2933
|
-
supportId: string;
|
|
2934
|
-
status: string;
|
|
2935
|
-
feedback: string;
|
|
2936
|
-
code: string;
|
|
2937
|
-
}
|
|
2938
3030
|
interface SessionStorageEventDto {
|
|
2939
3031
|
appId: string;
|
|
2940
3032
|
clientId?: string;
|
|
@@ -2953,11 +3045,11 @@ interface UIAssetChangedDto {
|
|
|
2953
3045
|
sessionId?: string;
|
|
2954
3046
|
record: UIAssetDto;
|
|
2955
3047
|
}
|
|
2956
|
-
interface
|
|
3048
|
+
interface anonymous_schema_329 {
|
|
2957
3049
|
repositoryId?: string;
|
|
2958
3050
|
additionalProperties?: Record<string, any>;
|
|
2959
3051
|
}
|
|
2960
|
-
interface
|
|
3052
|
+
interface anonymous_schema_332 {
|
|
2961
3053
|
clearScreen?: boolean;
|
|
2962
3054
|
ttsEnabled?: boolean;
|
|
2963
3055
|
stopSpeech?: boolean;
|
|
@@ -3176,6 +3268,12 @@ declare class Session {
|
|
|
3176
3268
|
appId?: string;
|
|
3177
3269
|
sessionId?: string;
|
|
3178
3270
|
}): Promise<() => void>;
|
|
3271
|
+
support(event: SessionSupportEventDto, params?: {
|
|
3272
|
+
appId?: string;
|
|
3273
|
+
}): Promise<boolean>;
|
|
3274
|
+
onSupport(fn: (event: SessionSupportEventDto) => void | Promise<void>, params?: {
|
|
3275
|
+
appId?: string;
|
|
3276
|
+
}): Promise<() => void>;
|
|
3179
3277
|
agentInteraction(event: AgentDto, params?: {
|
|
3180
3278
|
appId?: string;
|
|
3181
3279
|
}): Promise<boolean>;
|
|
@@ -3190,12 +3288,6 @@ declare class Session {
|
|
|
3190
3288
|
appId?: string;
|
|
3191
3289
|
agentId?: string;
|
|
3192
3290
|
}): Promise<() => void>;
|
|
3193
|
-
support(event: SessionSupportEventDto, params?: {
|
|
3194
|
-
appId?: string;
|
|
3195
|
-
}): Promise<boolean>;
|
|
3196
|
-
onSupport(fn: (event: SessionSupportEventDto) => void | Promise<void>, params?: {
|
|
3197
|
-
appId?: string;
|
|
3198
|
-
}): Promise<() => void>;
|
|
3199
3291
|
storageUpdated(event: SessionStorageEventDto, params?: {
|
|
3200
3292
|
appId?: string;
|
|
3201
3293
|
storageId?: string;
|
|
@@ -3374,4 +3466,4 @@ declare class SermasApiClient {
|
|
|
3374
3466
|
login(username: any, password: any, appId?: string): Promise<LoginResponseDto>;
|
|
3375
3467
|
}
|
|
3376
3468
|
|
|
3377
|
-
export { type AccessTokenRequestDto, type ActuationEventDto, type AgentChangedDto, type AgentDto, 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 BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTextToSpeechDto, 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 LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LoginRequestDto, type LoginResponseDto, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, 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 QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, 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 SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, TypeEnum, 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 ViewLogsRequestDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_101, type anonymous_schema_104, type anonymous_schema_174, type anonymous_schema_253, type
|
|
3469
|
+
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 BoundingBox, Broker, type Buffer$1 as Buffer, type ButtonDto, type ButtonsContentDto, type ButtonsUIContentDto, type ClearScreenDto, type ClearUIContentDto, type CreatePlatformAppDto, type DialogueActor, DialogueActorEnum, type DialogueDocumentDto, type DialogueDocumentMetadataDto, type DialogueDocumentOptionsDto, type DialogueMessageDto, type DialogueMessageUIContentDto, type DialogueTextToSpeechDto, 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 LinearVelocityDto, type LinkContentDto, type LinkUIContentDto, type LoginRequestDto, type LoginResponseDto, type ModelGender, ModelGenderEnum, type ModelType, ModelTypeEnum, type ModuleConfigEventDto, type ModuleResourceDto, type ModuleSettingsDto, type MovementDto, type MovementEventDto, type NoiseEventDto, type ObjectContentDto, type ObjectDetectionDto, type ObjectDetectionEventDto, type ObjectDetectionRequest, type ObjectDetectionType, ObjectDetectionTypeEnum, type ObjectUIContentDto, 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 QrCodePayloadDto, type QuizAnswerDto, type QuizContentDto, type QuizUIContentDto, 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 SessionStorageEventDto, type SessionStorageRecordDto, type SessionStorageSearchDto, type SessionSupportEventDto, type SessionSupportRequestDto, type SessionSupportResponseDto, type StatusDto, type StatusEventDto, type StringInferenceValue, type SupportedContentTypes, SupportedContentTypesEnum, type TextContentDto, type TextUIContentDto, type ToolsParameterSchema, type ToolsParameterSchemaTypes, ToolsParameterSchemaTypesEnum, type ToolsRequestSchema, type ToolsRequestSchemaAuthBasic, type ToolsRequestSchemaAuthBearer, TypeEnum, 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 ViewLogsRequestDto, type WebpageContentDto, type WebpageUIContentDto, type XRMarkerChangedDto, type XRMarkerDto, type XRMarkerListRequestDto, type XROcclusionDto, type XROcclusionResponseDto, type anonymous_schema_101, type anonymous_schema_104, type anonymous_schema_174, type anonymous_schema_253, type anonymous_schema_329, type anonymous_schema_332, type anonymous_schema_99, sleep };
|