@pinecall/protocol 0.3.0 → 0.4.0

package/dist/generated/commands.d.ts

@@ -8,8 +8,8 @@ export declare const AgentConfigureSchema: z.ZodObject<{
         prompt: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             region: z.ZodEnum<{
-                static: "static";
                 dynamic: "dynamic";
+                static: "static";
             }>;
         }, z.core.$strict>>>>;
         language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -46,6 +46,10 @@ export declare const AgentConfigureSchema: z.ZodObject<{
         knowledge: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             path: z.ZodString;
             text: z.ZodString;
+            mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                retrieved: "retrieved";
+                whole: "whole";
+            }>>>;
         }, z.core.$strict>>>;
         docs: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             base: z.ZodString;
@@ -68,20 +72,21 @@ export declare const AgentConfigureSchema: z.ZodObject<{
             description: z.ZodString;
             parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
             side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                irreversible: "irreversible";
                 read: "read";
                 write: "write";
-                irreversible: "irreversible";
             }>>>;
             confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
             timeout_s: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         }, z.core.$strict>>>>;
+        uses_knowledge: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
         state_fields: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             visibility: z.ZodEnum<{
+                pii: "pii";
                 public: "public";
                 tenant: "tenant";
-                pii: "pii";
             }>;
         }, z.core.$strict>>>>;
         events: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
@@ -254,8 +259,8 @@ export type PromptSet = z.infer<typeof PromptSetSchema>;
 export declare const RoomInviteSchema: z.ZodObject<{
     to: z.ZodString;
     kind: z.ZodEnum<{
-        sip: "sip";
         participant: "participant";
+        sip: "sip";
     }>;
 }, z.core.$strict>;
 export type RoomInvite = z.infer<typeof RoomInviteSchema>;
@@ -280,8 +285,8 @@ export declare const SessionConfigureSchema: z.ZodObject<{
         prompt: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             region: z.ZodEnum<{
-                static: "static";
                 dynamic: "dynamic";
+                static: "static";
             }>;
         }, z.core.$strict>>>>;
         language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -318,6 +323,10 @@ export declare const SessionConfigureSchema: z.ZodObject<{
         knowledge: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             path: z.ZodString;
             text: z.ZodString;
+            mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                retrieved: "retrieved";
+                whole: "whole";
+            }>>>;
         }, z.core.$strict>>>;
         docs: z.ZodOptional<z.ZodNullable<z.ZodObject<{
             base: z.ZodString;
@@ -340,20 +349,21 @@ export declare const SessionConfigureSchema: z.ZodObject<{
             description: z.ZodString;
             parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
             side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+                irreversible: "irreversible";
                 read: "read";
                 write: "write";
-                irreversible: "irreversible";
             }>>>;
             confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
             pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
             timeout_s: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
         }, z.core.$strict>>>>;
+        uses_knowledge: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
         state_fields: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
             name: z.ZodString;
             visibility: z.ZodEnum<{
+                pii: "pii";
                 public: "public";
                 tenant: "tenant";
-                pii: "pii";
             }>;
         }, z.core.$strict>>>>;
         events: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
@@ -411,9 +421,9 @@ export declare const ToolsSetSchema: z.ZodObject<{
         description: z.ZodString;
         parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            irreversible: "irreversible";
             read: "read";
             write: "write";
-            irreversible: "irreversible";
         }>>>;
         confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;

package/dist/generated/defs.d.ts

@@ -37,25 +37,25 @@ export type Env = z.infer<typeof EnvSchema>;
  * gateway.
  */
 export declare const DevVerbSchema: z.ZodEnum<{
+    "chat.end": "chat.end";
     "chat.roster": "chat.roster";
-    "chat.start": "chat.start";
     "chat.say": "chat.say";
-    "chat.end": "chat.end";
-    "simulate.roster": "simulate.roster";
-    "simulate.start": "simulate.start";
+    "chat.start": "chat.start";
+    "drift.read": "drift.read";
     "goldens.roster": "goldens.roster";
     "goldens.run": "goldens.run";
-    "knowledge.roster": "knowledge.roster";
-    "knowledge.push": "knowledge.push";
     "knowledge.eval": "knowledge.eval";
-    "memory.roster": "memory.roster";
+    "knowledge.push": "knowledge.push";
+    "knowledge.roster": "knowledge.roster";
     "memory.eval": "memory.eval";
     "memory.extraction": "memory.extraction";
+    "memory.roster": "memory.roster";
     "promote.roster": "promote.roster";
     "promote.write": "promote.write";
-    "drift.read": "drift.read";
-    "reproductions.roster": "reproductions.roster";
     "reproductions.read": "reproductions.read";
+    "reproductions.roster": "reproductions.roster";
+    "simulate.roster": "simulate.roster";
+    "simulate.start": "simulate.start";
 }>;
 export type DevVerb = z.infer<typeof DevVerbSchema>;
 /**
@@ -65,25 +65,25 @@ export type DevVerb = z.infer<typeof DevVerbSchema>;
  * both are nobody's fault and neither is an error.
  */
 export declare const EndReasonSchema: z.ZodEnum<{
-    caller_hung_up: "caller_hung_up";
     agent_hung_up: "agent_hung_up";
-    supervisor_ended: "supervisor_ended";
-    transferred: "transferred";
-    no_answer: "no_answer";
+    app_detached: "app_detached";
     busy: "busy";
+    caller_hung_up: "caller_hung_up";
     dial_failed: "dial_failed";
-    timeout: "timeout";
     drained: "drained";
-    app_detached: "app_detached";
     error: "error";
+    no_answer: "no_answer";
+    supervisor_ended: "supervisor_ended";
+    timeout: "timeout";
+    transferred: "transferred";
 }>;
 export type EndReason = z.infer<typeof EndReasonSchema>;
 /** Whose action ended the call. platform covers timeouts, errors and a drained worker. */
 export declare const EndedBySchema: z.ZodEnum<{
     agent: "agent";
     caller: "caller";
-    supervisor: "supervisor";
     platform: "platform";
+    supervisor: "supervisor";
 }>;
 export type EndedBy = z.infer<typeof EndedBySchema>;
 /**
@@ -92,9 +92,9 @@ export type EndedBy = z.infer<typeof EndedBySchema>;
  * nobody asked it — no model was reachable inside the call's judging budget.
  */
 export declare const ScoreVerdictSchema: z.ZodEnum<{
-    held: "held";
     broken: "broken";
     deferred: "deferred";
+    held: "held";
     skipped: "skipped";
 }>;
 export type ScoreVerdict = z.infer<typeof ScoreVerdictSchema>;
@@ -113,8 +113,8 @@ export type TransferMode = z.infer<typeof TransferModeSchema>;
  * written by the app.
  */
 export declare const PromptRegionSchema: z.ZodEnum<{
-    static: "static";
     dynamic: "dynamic";
+    static: "static";
 }>;
 export type PromptRegion = z.infer<typeof PromptRegionSchema>;
 /**
@@ -146,8 +146,8 @@ export type PlatformTool = z.infer<typeof PlatformToolSchema>;
 export declare const PromptBlockSpecSchema: z.ZodObject<{
     name: z.ZodString;
     region: z.ZodEnum<{
-        static: "static";
         dynamic: "dynamic";
+        static: "static";
     }>;
 }, z.core.$strict>;
 export type PromptBlockSpec = z.infer<typeof PromptBlockSpecSchema>;
@@ -156,9 +156,9 @@ export type PromptBlockSpec = z.infer<typeof PromptBlockSpecSchema>;
  * session's own.
  */
 export declare const UserStateSchema: z.ZodEnum<{
+    away: "away";
     listening: "listening";
     speaking: "speaking";
-    away: "away";
 }>;
 export type UserState = z.infer<typeof UserStateSchema>;
 /**
@@ -166,10 +166,10 @@ export type UserState = z.infer<typeof UserStateSchema>;
  * caller, generating, or playing audio.
  */
 export declare const AgentStateSchema: z.ZodEnum<{
+    idle: "idle";
+    initializing: "initializing";
     listening: "listening";
     speaking: "speaking";
-    initializing: "initializing";
-    idle: "idle";
     thinking: "thinking";
 }>;
 export type AgentState = z.infer<typeof AgentStateSchema>;
@@ -181,25 +181,25 @@ export type AgentState = z.infer<typeof AgentStateSchema>;
 export declare const ParticipantKindSchema: z.ZodEnum<{
     agent: "agent";
     caller: "caller";
-    supervisor: "supervisor";
     listener: "listener";
     sip: "sip";
+    supervisor: "supervisor";
 }>;
 export type ParticipantKind = z.infer<typeof ParticipantKindSchema>;
 /** What a track carries: a microphone's audio, a camera's video, or a screen share. */
 export declare const TrackKindSchema: z.ZodEnum<{
     audio: "audio";
-    video: "video";
     screen: "screen";
+    video: "video";
 }>;
 export type TrackKind = z.infer<typeof TrackKindSchema>;
 /** Where a track comes from, as livekit's TrackSource names it, in lower case. */
 export declare const TrackSourceSchema: z.ZodEnum<{
-    unknown: "unknown";
-    microphone: "microphone";
     camera: "camera";
+    microphone: "microphone";
     screen_share: "screen_share";
     screen_share_audio: "screen_share_audio";
+    unknown: "unknown";
 }>;
 export type TrackSource = z.infer<typeof TrackSourceSchema>;
 /**
@@ -216,9 +216,9 @@ export type EventSource = z.infer<typeof EventSourceSchema>;
  * (tenant, the default for a field never declared), or nobody without masking (pii).
  */
 export declare const VisibilitySchema: z.ZodEnum<{
+    pii: "pii";
     public: "public";
     tenant: "tenant";
-    pii: "pii";
 }>;
 export type Visibility = z.infer<typeof VisibilitySchema>;
 /**
@@ -272,9 +272,9 @@ export declare const ToolSpecSchema: z.ZodObject<{
     description: z.ZodString;
     parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
     side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        irreversible: "irreversible";
         read: "read";
         write: "write";
-        irreversible: "irreversible";
     }>>>;
     confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
@@ -312,9 +312,9 @@ export type MemoryFact = z.infer<typeof MemoryFactSchema>;
  */
 export declare const MemoryOpSchema: z.ZodObject<{
     op: z.ZodEnum<{
+        forget: "forget";
         recall: "recall";
         remember: "remember";
-        forget: "forget";
     }>;
     contact: z.ZodOptional<z.ZodNullable<z.ZodString>>;
     query: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -349,12 +349,12 @@ export declare const CostRowSchema: z.ZodObject<{
     provider: z.ZodString;
     model: z.ZodString;
     unit: z.ZodEnum<{
-        input_tokens: "input_tokens";
-        cached_input_tokens: "cached_input_tokens";
+        audio_seconds: "audio_seconds";
         cache_creation_tokens: "cache_creation_tokens";
-        output_tokens: "output_tokens";
+        cached_input_tokens: "cached_input_tokens";
         characters: "characters";
-        audio_seconds: "audio_seconds";
+        input_tokens: "input_tokens";
+        output_tokens: "output_tokens";
         requests: "requests";
         session_seconds: "session_seconds";
     }>;
@@ -384,12 +384,12 @@ export declare const CostSchema: z.ZodObject<{
         provider: z.ZodString;
         model: z.ZodString;
         unit: z.ZodEnum<{
-            input_tokens: "input_tokens";
-            cached_input_tokens: "cached_input_tokens";
+            audio_seconds: "audio_seconds";
             cache_creation_tokens: "cache_creation_tokens";
-            output_tokens: "output_tokens";
+            cached_input_tokens: "cached_input_tokens";
             characters: "characters";
-            audio_seconds: "audio_seconds";
+            input_tokens: "input_tokens";
+            output_tokens: "output_tokens";
             requests: "requests";
             session_seconds: "session_seconds";
         }>;
@@ -437,9 +437,9 @@ export type Pronunciation = z.infer<typeof PronunciationSchema>;
 export declare const StateFieldSpecSchema: z.ZodObject<{
     name: z.ZodString;
     visibility: z.ZodEnum<{
+        pii: "pii";
         public: "public";
         tenant: "tenant";
-        pii: "pii";
     }>;
 }, z.core.$strict>;
 export type StateFieldSpec = z.infer<typeof StateFieldSpecSchema>;
@@ -459,6 +459,10 @@ export type EventSpec = z.infer<typeof EventSpecSchema>;
 export declare const KnowledgeFileSchema: z.ZodObject<{
     path: z.ZodString;
     text: z.ZodString;
+    mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+        retrieved: "retrieved";
+        whole: "whole";
+    }>>>;
 }, z.core.$strict>;
 export type KnowledgeFile = z.infer<typeof KnowledgeFileSchema>;
 /**
@@ -517,8 +521,8 @@ export declare const AgentConfigSchema: z.ZodObject<{
     prompt: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         region: z.ZodEnum<{
-            static: "static";
             dynamic: "dynamic";
+            static: "static";
         }>;
     }, z.core.$strict>>>>;
     language: z.ZodOptional<z.ZodNullable<z.ZodString>>;
@@ -555,6 +559,10 @@ export declare const AgentConfigSchema: z.ZodObject<{
     knowledge: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         path: z.ZodString;
         text: z.ZodString;
+        mode: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            retrieved: "retrieved";
+            whole: "whole";
+        }>>>;
     }, z.core.$strict>>>;
     docs: z.ZodOptional<z.ZodNullable<z.ZodObject<{
         base: z.ZodString;
@@ -577,20 +585,21 @@ export declare const AgentConfigSchema: z.ZodObject<{
         description: z.ZodString;
         parameters: z.ZodRecord<z.ZodString, z.ZodUnknown>;
         side_effect: z.ZodOptional<z.ZodNullable<z.ZodEnum<{
+            irreversible: "irreversible";
             read: "read";
             write: "write";
-            irreversible: "irreversible";
         }>>>;
         confirm: z.ZodOptional<z.ZodNullable<z.ZodString>>;
         pii: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodString>>>;
         timeout_s: z.ZodOptional<z.ZodNullable<z.ZodNumber>>;
     }, z.core.$strict>>>>;
+    uses_knowledge: z.ZodOptional<z.ZodNullable<z.ZodBoolean>>;
     state_fields: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{
         name: z.ZodString;
         visibility: z.ZodEnum<{
+            pii: "pii";
             public: "public";
             tenant: "tenant";
-            pii: "pii";
         }>;
     }, z.core.$strict>>>>;
     events: z.ZodOptional<z.ZodNullable<z.ZodArray<z.ZodObject<{

package/dist/generated/defs.js

@@ -262,6 +262,7 @@ export const EventSpecSchema = z.strictObject({
 export const KnowledgeFileSchema = z.strictObject({
     path: z.string(),
     text: z.string(),
+    mode: z.enum(["retrieved", "whole"]).nullish(),
 });
 /**
  * The knowledge base the agent answers from, and how its chunks reach the model. It is named by
@@ -323,6 +324,7 @@ export const AgentConfigSchema = z.strictObject({
     memory: MemoryConfigSchema.nullish(),
     hangup: HangupConfigSchema.nullish(),
     tools: z.array(ToolSpecSchema).nullish(),
+    uses_knowledge: z.boolean().nullish(),
     state_fields: z.array(StateFieldSpecSchema).nullish(),
     events: z.array(EventSpecSchema).nullish(),
 });