@amigo-ai/platform-sdk 0.33.0 → 0.34.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/types/generated/api.d.ts +259 -0
- package/dist/types/generated/api.d.ts.map +1 -1
- package/dist/types/resources/functions.d.ts.map +1 -1
- package/dist/types/resources/intake.d.ts.map +1 -1
- package/dist/types/resources/metrics.d.ts.map +1 -1
- package/dist/types/resources/operators.d.ts.map +1 -1
- package/dist/types/resources/settings.d.ts.map +1 -1
- package/dist/types/resources/surfaces.d.ts.map +1 -1
- package/package.json +1 -1
|
@@ -5680,6 +5680,26 @@ export interface paths {
|
|
|
5680
5680
|
patch?: never;
|
|
5681
5681
|
trace?: never;
|
|
5682
5682
|
};
|
|
5683
|
+
"/v1/{workspace_id}/services/{service_id}/text-turn": {
|
|
5684
|
+
parameters: {
|
|
5685
|
+
query?: never;
|
|
5686
|
+
header?: never;
|
|
5687
|
+
path?: never;
|
|
5688
|
+
cookie?: never;
|
|
5689
|
+
};
|
|
5690
|
+
get?: never;
|
|
5691
|
+
put?: never;
|
|
5692
|
+
/**
|
|
5693
|
+
* Text Turn
|
|
5694
|
+
* @description Run one WhatsApp-style text turn against the service's agent.
|
|
5695
|
+
*/
|
|
5696
|
+
post: operations["text-turn"];
|
|
5697
|
+
delete?: never;
|
|
5698
|
+
options?: never;
|
|
5699
|
+
head?: never;
|
|
5700
|
+
patch?: never;
|
|
5701
|
+
trace?: never;
|
|
5702
|
+
};
|
|
5683
5703
|
"/v1/{workspace_id}/services/{service_id}/tools/resolve": {
|
|
5684
5704
|
parameters: {
|
|
5685
5705
|
query?: never;
|
|
@@ -24876,6 +24896,195 @@ export interface components {
|
|
|
24876
24896
|
/** Session Id */
|
|
24877
24897
|
session_id: string;
|
|
24878
24898
|
};
|
|
24899
|
+
/**
|
|
24900
|
+
* TextStreamErrorFrame
|
|
24901
|
+
* @description Recoverable error mid-session. The connection MAY remain open;
|
|
24902
|
+
* for terminal errors the WebSocket is closed with a 4xxx code instead
|
|
24903
|
+
* of (or in addition to) this frame.
|
|
24904
|
+
*/
|
|
24905
|
+
TextStreamErrorFrame: {
|
|
24906
|
+
/** Message */
|
|
24907
|
+
message: string;
|
|
24908
|
+
/**
|
|
24909
|
+
* @description discriminator enum property added by openapi-typescript
|
|
24910
|
+
* @enum {string}
|
|
24911
|
+
*/
|
|
24912
|
+
type: "error";
|
|
24913
|
+
};
|
|
24914
|
+
TextStreamFrame: components["schemas"]["TextStreamSessionStartedFrame"] | components["schemas"]["TextStreamSessionEndedFrame"] | components["schemas"]["TextStreamErrorFrame"] | components["schemas"]["TextStreamPingFrame"] | components["schemas"]["TextStreamTypingFrame"] | components["schemas"]["TextStreamResponseCompleteFrame"] | components["schemas"]["TextStreamMessageFrame"] | components["schemas"]["TextStreamToolCallStartedFrame"] | components["schemas"]["TextStreamToolCallCompletedFrame"];
|
|
24915
|
+
/**
|
|
24916
|
+
* TextStreamMessageFrame
|
|
24917
|
+
* @description Final consolidated agent message for a turn. ``role`` defaults
|
|
24918
|
+
* to ``"agent"`` because that is the only role that originates server
|
|
24919
|
+
* frames; the field is on the wire so a future bidirectional
|
|
24920
|
+
* extension (e.g. mid-turn system messages) can be added without a
|
|
24921
|
+
* schema break.
|
|
24922
|
+
*/
|
|
24923
|
+
TextStreamMessageFrame: {
|
|
24924
|
+
/**
|
|
24925
|
+
* Role
|
|
24926
|
+
* @default agent
|
|
24927
|
+
*/
|
|
24928
|
+
role?: string;
|
|
24929
|
+
/** Text */
|
|
24930
|
+
text: string;
|
|
24931
|
+
/**
|
|
24932
|
+
* @description discriminator enum property added by openapi-typescript
|
|
24933
|
+
* @enum {string}
|
|
24934
|
+
*/
|
|
24935
|
+
type: "message";
|
|
24936
|
+
};
|
|
24937
|
+
/**
|
|
24938
|
+
* TextStreamPingFrame
|
|
24939
|
+
* @description Keepalive frame emitted at the heartbeat interval. Consumers
|
|
24940
|
+
* SHOULD reset the dead-socket watchdog and otherwise ignore it.
|
|
24941
|
+
*/
|
|
24942
|
+
TextStreamPingFrame: {
|
|
24943
|
+
/**
|
|
24944
|
+
* @description discriminator enum property added by openapi-typescript
|
|
24945
|
+
* @enum {string}
|
|
24946
|
+
*/
|
|
24947
|
+
type: "ping";
|
|
24948
|
+
};
|
|
24949
|
+
/**
|
|
24950
|
+
* TextStreamResponseCompleteFrame
|
|
24951
|
+
* @description Marks the end of an agent turn. The next user message can be
|
|
24952
|
+
* sent. ``duplicate=true`` indicates the server suppressed a repeat
|
|
24953
|
+
* response (idempotent ``message`` send-with-same-client_message_id).
|
|
24954
|
+
*/
|
|
24955
|
+
TextStreamResponseCompleteFrame: {
|
|
24956
|
+
/**
|
|
24957
|
+
* Duplicate
|
|
24958
|
+
* @default false
|
|
24959
|
+
*/
|
|
24960
|
+
duplicate?: boolean;
|
|
24961
|
+
/**
|
|
24962
|
+
* @description discriminator enum property added by openapi-typescript
|
|
24963
|
+
* @enum {string}
|
|
24964
|
+
*/
|
|
24965
|
+
type: "response_complete";
|
|
24966
|
+
};
|
|
24967
|
+
/**
|
|
24968
|
+
* TextStreamSessionEndedFrame
|
|
24969
|
+
* @description Graceful end-of-conversation. ``reason`` echoes the actor's
|
|
24970
|
+
* completion reason (``stopped``, ``completed``, ``escalated``,
|
|
24971
|
+
* ``disconnected``, ``other``).
|
|
24972
|
+
*/
|
|
24973
|
+
TextStreamSessionEndedFrame: {
|
|
24974
|
+
/**
|
|
24975
|
+
* Reason
|
|
24976
|
+
* @default other
|
|
24977
|
+
*/
|
|
24978
|
+
reason?: string;
|
|
24979
|
+
/**
|
|
24980
|
+
* @description discriminator enum property added by openapi-typescript
|
|
24981
|
+
* @enum {string}
|
|
24982
|
+
*/
|
|
24983
|
+
type: "session_ended";
|
|
24984
|
+
};
|
|
24985
|
+
/**
|
|
24986
|
+
* TextStreamSessionStartedFrame
|
|
24987
|
+
* @description First frame after the WebSocket handshake completes. Carries the
|
|
24988
|
+
* session_id (server-minted) and the conversation_id the actor bound
|
|
24989
|
+
* to (newly minted, or the one supplied via the ``conversation_id``
|
|
24990
|
+
* query param).
|
|
24991
|
+
*/
|
|
24992
|
+
TextStreamSessionStartedFrame: {
|
|
24993
|
+
/** Conversation Id */
|
|
24994
|
+
conversation_id: string;
|
|
24995
|
+
/** Session Id */
|
|
24996
|
+
session_id: string;
|
|
24997
|
+
/**
|
|
24998
|
+
* @description discriminator enum property added by openapi-typescript
|
|
24999
|
+
* @enum {string}
|
|
25000
|
+
*/
|
|
25001
|
+
type: "session_started";
|
|
25002
|
+
};
|
|
25003
|
+
/**
|
|
25004
|
+
* TextStreamToolCallCompletedFrame
|
|
25005
|
+
* @description Companion to ``TextStreamToolCallStartedFrame``. ``result`` is
|
|
25006
|
+
* the tool's stringified output; binary or large results are sent
|
|
25007
|
+
* out-of-band and not surfaced here.
|
|
25008
|
+
*/
|
|
25009
|
+
TextStreamToolCallCompletedFrame: {
|
|
25010
|
+
/** Call Id */
|
|
25011
|
+
call_id: string;
|
|
25012
|
+
/**
|
|
25013
|
+
* Result
|
|
25014
|
+
* @default
|
|
25015
|
+
*/
|
|
25016
|
+
result?: string;
|
|
25017
|
+
/**
|
|
25018
|
+
* Succeeded
|
|
25019
|
+
* @default true
|
|
25020
|
+
*/
|
|
25021
|
+
succeeded?: boolean;
|
|
25022
|
+
/** Tool Name */
|
|
25023
|
+
tool_name: string;
|
|
25024
|
+
/**
|
|
25025
|
+
* @description discriminator enum property added by openapi-typescript
|
|
25026
|
+
* @enum {string}
|
|
25027
|
+
*/
|
|
25028
|
+
type: "tool_call_completed";
|
|
25029
|
+
};
|
|
25030
|
+
/**
|
|
25031
|
+
* TextStreamToolCallStartedFrame
|
|
25032
|
+
* @description A tool-call effect from the most-recent agent turn. Both
|
|
25033
|
+
* ``tool_call_started`` and the matching ``tool_call_completed``
|
|
25034
|
+
* arrive after the tool already ran — they are post-hoc summaries,
|
|
25035
|
+
* not real-time progress events. Frontends typically animate them as
|
|
25036
|
+
* a sequence.
|
|
25037
|
+
*/
|
|
25038
|
+
TextStreamToolCallStartedFrame: {
|
|
25039
|
+
/** Call Id */
|
|
25040
|
+
call_id: string;
|
|
25041
|
+
/**
|
|
25042
|
+
* Input
|
|
25043
|
+
* @default null
|
|
25044
|
+
*/
|
|
25045
|
+
input?: {
|
|
25046
|
+
[key: string]: unknown;
|
|
25047
|
+
} | string | null;
|
|
25048
|
+
/** Tool Name */
|
|
25049
|
+
tool_name: string;
|
|
25050
|
+
/**
|
|
25051
|
+
* @description discriminator enum property added by openapi-typescript
|
|
25052
|
+
* @enum {string}
|
|
25053
|
+
*/
|
|
25054
|
+
type: "tool_call_started";
|
|
25055
|
+
};
|
|
25056
|
+
/**
|
|
25057
|
+
* TextStreamTypingFrame
|
|
25058
|
+
* @description Indicates the agent is preparing a response. Pure UX hint;
|
|
25059
|
+
* no payload.
|
|
25060
|
+
*/
|
|
25061
|
+
TextStreamTypingFrame: {
|
|
25062
|
+
/**
|
|
25063
|
+
* @description discriminator enum property added by openapi-typescript
|
|
25064
|
+
* @enum {string}
|
|
25065
|
+
*/
|
|
25066
|
+
type: "typing";
|
|
25067
|
+
};
|
|
25068
|
+
/**
|
|
25069
|
+
* TextTurnRequest
|
|
25070
|
+
* @description Request body for ``POST /v1/{ws}/services/{service_id}/text-turn``.
|
|
25071
|
+
*/
|
|
25072
|
+
TextTurnRequest: {
|
|
25073
|
+
/** Phone Number */
|
|
25074
|
+
phone_number: string;
|
|
25075
|
+
/** Text */
|
|
25076
|
+
text: string;
|
|
25077
|
+
};
|
|
25078
|
+
/**
|
|
25079
|
+
* TextTurnResponse
|
|
25080
|
+
* @description Response body — the agent's text reply.
|
|
25081
|
+
*
|
|
25082
|
+
* Returned only on 200; 204 indicates the engine elected silence.
|
|
25083
|
+
*/
|
|
25084
|
+
TextTurnResponse: {
|
|
25085
|
+
/** Text */
|
|
25086
|
+
text: string;
|
|
25087
|
+
};
|
|
24879
25088
|
/** ThroughputBucket */
|
|
24880
25089
|
ThroughputBucket: {
|
|
24881
25090
|
/** Bucket */
|
|
@@ -41494,6 +41703,56 @@ export interface operations {
|
|
|
41494
41703
|
};
|
|
41495
41704
|
};
|
|
41496
41705
|
};
|
|
41706
|
+
"text-turn": {
|
|
41707
|
+
parameters: {
|
|
41708
|
+
query?: never;
|
|
41709
|
+
header?: never;
|
|
41710
|
+
path: {
|
|
41711
|
+
workspace_id: string;
|
|
41712
|
+
service_id: string;
|
|
41713
|
+
};
|
|
41714
|
+
cookie?: never;
|
|
41715
|
+
};
|
|
41716
|
+
requestBody: {
|
|
41717
|
+
content: {
|
|
41718
|
+
"application/json": components["schemas"]["TextTurnRequest"];
|
|
41719
|
+
};
|
|
41720
|
+
};
|
|
41721
|
+
responses: {
|
|
41722
|
+
/** @description Agent text reply */
|
|
41723
|
+
200: {
|
|
41724
|
+
headers: {
|
|
41725
|
+
[name: string]: unknown;
|
|
41726
|
+
};
|
|
41727
|
+
content: {
|
|
41728
|
+
"application/json": components["schemas"]["TextTurnResponse"];
|
|
41729
|
+
};
|
|
41730
|
+
};
|
|
41731
|
+
/** @description Agent elected silence */
|
|
41732
|
+
204: {
|
|
41733
|
+
headers: {
|
|
41734
|
+
[name: string]: unknown;
|
|
41735
|
+
};
|
|
41736
|
+
content?: never;
|
|
41737
|
+
};
|
|
41738
|
+
/** @description Concurrent text turn in progress for this speaker */
|
|
41739
|
+
409: {
|
|
41740
|
+
headers: {
|
|
41741
|
+
[name: string]: unknown;
|
|
41742
|
+
};
|
|
41743
|
+
content?: never;
|
|
41744
|
+
};
|
|
41745
|
+
/** @description Validation Error */
|
|
41746
|
+
422: {
|
|
41747
|
+
headers: {
|
|
41748
|
+
[name: string]: unknown;
|
|
41749
|
+
};
|
|
41750
|
+
content: {
|
|
41751
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
41752
|
+
};
|
|
41753
|
+
};
|
|
41754
|
+
};
|
|
41755
|
+
};
|
|
41497
41756
|
"resolve-service-tools": {
|
|
41498
41757
|
parameters: {
|
|
41499
41758
|
query?: never;
|