pinecall 0.0.1

data/lib/pinecall/wire/shapes_call_events.rb

@@ -0,0 +1,137 @@
+# frozen_string_literal: true
+
+# The shape of each event's data in a call's life and in the agent that holds it.
+
+module Pinecall
+  module Wire
+    module Shapes
+      CALL_EVENTS = {
+        "AgentConfigured" => {
+          changed: { kind: :list, items: { kind: :str }, required: true }
+        }.freeze,
+        "AgentDetached" => {
+          app: { kind: :str, required: true },
+          env: { kind: :ref, ref: "Env", required: true },
+          left: { kind: :bool, required: true }
+        }.freeze,
+        "AgentDraining" => {
+          app: { kind: :str, required: true },
+          env: { kind: :ref, ref: "Env", required: true },
+          handed: { kind: :int, required: true },
+          parked: { kind: :int, required: true }
+        }.freeze,
+        "AgentRegistered" => {
+          routes: { kind: :list, items: { kind: :ref, ref: "Route" }, required: true },
+          app: { kind: :str, required: true },
+          sdk: { kind: :str },
+          env: { kind: :ref, ref: "Env" }
+        }.freeze,
+        "AgentStateChanged" => {
+          state: { kind: :ref, ref: "AgentState", required: true }
+        }.freeze,
+        "AgentTranscript" => {
+          speech_id: { kind: :str, required: true },
+          text: { kind: :str, required: true },
+          final: { kind: :bool, required: true },
+          start: { kind: :float },
+          end: { kind: :float }
+        }.freeze,
+        "CallAttached" => {
+          app: { kind: :str, required: true },
+          started: { kind: :ref, ref: "CallStarted", required: true },
+          state: { kind: :json, required: true },
+          seq: { kind: :int, required: true },
+          claimed: { kind: :str, null: true }
+        }.freeze,
+        "CallClaimed" => {
+          code: { kind: :str, required: true },
+          via: { kind: :enum, values: %w[keypad agent], required: true }
+        }.freeze,
+        "CallDialing" => {
+          channel: { kind: :ref, ref: "Channel", required: true },
+          from: { kind: :str, required: true },
+          to: { kind: :str, required: true },
+          run: { kind: :str, null: true },
+          caller: { kind: :ref, null: true, ref: "Contact", required: true },
+          external_id: { kind: :str },
+          asked_by: { kind: :str }
+        }.freeze,
+        "CallEnded" => {
+          reason: { kind: :ref, ref: "EndReason", required: true },
+          ended_by: { kind: :ref, ref: "EndedBy", required: true },
+          ended_at: { kind: :float, required: true },
+          duration_s: { kind: :float, required: true }
+        }.freeze,
+        "CallLine" => {
+          held: { kind: :bool, required: true },
+          muted: { kind: :bool, required: true }
+        }.freeze,
+        "CallRinging" => {
+          channel: { kind: :ref, ref: "Channel", required: true },
+          from: { kind: :str, required: true },
+          to: { kind: :str, required: true },
+          route: { kind: :ref, ref: "Route", required: true },
+          run: { kind: :str, null: true },
+          caller: { kind: :ref, null: true, ref: "Contact", required: true },
+          external_id: { kind: :str }
+        }.freeze,
+        "CallScore" => {
+          passed: { kind: :bool },
+          not_judged: { kind: :str },
+          judges: { kind: :list, items: { kind: :ref, ref: "Judgment" }, required: true },
+          panel: { kind: :list, items: { kind: :str } },
+          judge_calls: { kind: :int, required: true },
+          judge_cost_usd: { kind: :float },
+          judged_by: { kind: :ref, ref: "JudgedBy" }
+        }.freeze,
+        "CallStarted" => {
+          channel: { kind: :ref, ref: "Channel", required: true },
+          direction: { kind: :ref, ref: "Direction", required: true },
+          from: { kind: :str, required: true },
+          to: { kind: :str, required: true },
+          run: { kind: :str, null: true },
+          persona: { kind: :str, null: true },
+          accepts_when: { kind: :str, null: true },
+          declines_when: { kind: :str, null: true },
+          caller: { kind: :ref, null: true, ref: "Contact", required: true },
+          started_at: { kind: :float, required: true },
+          env: { kind: :ref, ref: "Env" },
+          worker: { kind: :str, null: true },
+          medium: { kind: :ref, ref: "Medium", null: true },
+          state: { kind: :json }
+        }.freeze,
+        "CallSummary" => {
+          reason: { kind: :ref, ref: "EndReason", required: true },
+          outcome: { kind: :str, required: true },
+          duration_s: { kind: :float, required: true },
+          turns: { kind: :int, required: true },
+          usage: { kind: :list, items: { kind: :ref, ref: "ModelUsage" }, required: true },
+          cost: { kind: :ref, ref: "Cost", required: true },
+          recording: { kind: :str }
+        }.freeze,
+        "CallTransferred" => {
+          to: { kind: :str, required: true },
+          mode: { kind: :ref, null: true, ref: "TransferMode" },
+          ok: { kind: :bool, required: true },
+          error: { kind: :str }
+        }.freeze,
+        "CallbackRequested" => {
+          channel: { kind: :ref, ref: "Channel", required: true },
+          number: { kind: :str, required: true },
+          via: { kind: :enum, values: %w[overflow widget agent], required: true },
+          call: { kind: :str, null: true, required: true },
+          when: { kind: :str },
+          note: { kind: :str },
+          contact: { kind: :ref, null: true, ref: "Contact", required: true }
+        }.freeze,
+        "AgentTurnEnded" => {
+          speech_id: { kind: :str, required: true },
+          item_id: { kind: :str },
+          text: { kind: :str, required: true },
+          interrupted: { kind: :bool, required: true },
+          metrics: { kind: :ref, ref: "AgentTurnMetrics", required: true }
+        }.freeze,
+      }.freeze
+    end
+  end
+end

data/lib/pinecall/wire/shapes_commands.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+# The shape of each command's data, as an app sends it.
+
+module Pinecall
+  module Wire
+    module Shapes
+      COMMANDS = {
+        "AgentConfigure" => {
+          config: { kind: :ref, ref: "AgentConfig", required: true }
+        }.freeze,
+        "AgentDrain" => {}.freeze,
+        "AgentRegister" => {
+          routes: { kind: :list, items: { kind: :ref, ref: "Route" }, required: true },
+          sdk: { kind: :str },
+          host: { kind: :str },
+          takes_unclaimed: { kind: :bool, default: true },
+          answers_dev: { kind: :bool, default: false }
+        }.freeze,
+        "AgentReply" => {
+          instructions: { kind: :str, required: true },
+          allow_interruptions: { kind: :bool }
+        }.freeze,
+        "AgentSay" => {
+          text: { kind: :str, required: true },
+          allow_interruptions: { kind: :bool }
+        }.freeze,
+        "CallAttention" => {
+          reason: { kind: :str, required: true },
+          wait_s: { kind: :float, required: true }
+        }.freeze,
+        "CallCallback" => {
+          number: { kind: :str, required: true },
+          when: { kind: :str },
+          note: { kind: :str }
+        }.freeze,
+        "CallClaim" => {
+          code: { kind: :str, required: true, pattern: "^[0-9]{4}$" }
+        }.freeze,
+        "CallDial" => {
+          to: { kind: :str, required: true },
+          from: { kind: :str },
+          caller: { kind: :ref, ref: "Contact" },
+          metadata: { kind: :json }
+        }.freeze,
+        "CallDtmf" => {
+          digits: { kind: :str, required: true }
+        }.freeze,
+        "CallEvent" => {
+          name: { kind: :str, required: true },
+          data: { kind: :json, required: true }
+        }.freeze,
+        "CallHangup" => {
+          reason: { kind: :str }
+        }.freeze,
+        "CallHold" => {}.freeze,
+        "CallOptOut" => {
+          note: { kind: :str, null: true }
+        }.freeze,
+        "CallLog" => {
+          name: { kind: :str, required: true },
+          data: { kind: :json, required: true }
+        }.freeze,
+        "CallMute" => {}.freeze,
+        "CallTransfer" => {
+          to: { kind: :str, required: true },
+          mode: { kind: :ref, ref: "TransferMode" }
+        }.freeze,
+        "CallUnhold" => {}.freeze,
+        "CallUnmute" => {}.freeze,
+        "DevAnswer" => {
+          id: { kind: :str, required: true },
+          result: { kind: :json },
+          refused: { kind: :ref, ref: "DevRefusal" }
+        }.freeze,
+        "ParticipantMute" => {
+          identity: { kind: :str, required: true }
+        }.freeze,
+        "ParticipantRemove" => {
+          identity: { kind: :str, required: true }
+        }.freeze,
+        "Ping" => {}.freeze,
+        "PromptSet" => {
+          name: { kind: :str, required: true },
+          text: { kind: :str, required: true }
+        }.freeze,
+        "RoomInvite" => {
+          to: { kind: :str, required: true },
+          kind: { kind: :enum, values: %w[sip participant], required: true }
+        }.freeze,
+        "RoomSend" => {
+          topic: { kind: :str, required: true },
+          data: { kind: :json, required: true },
+          to: { kind: :str }
+        }.freeze,
+        "SessionConfigure" => {
+          state: { kind: :json },
+          config: { kind: :ref, ref: "AgentConfig" }
+        }.freeze,
+        "StateSet" => {
+          state: { kind: :json, required: true },
+          changed: { kind: :list, items: { kind: :str } }
+        }.freeze,
+        "SupervisorVerb" => {
+          by: { kind: :ref, ref: "Supervisor", required: true },
+          verb: { kind: :ref, ref: "Verb", required: true }
+        }.freeze,
+        "ToolsSet" => {
+          tools: { kind: :list, items: { kind: :ref, ref: "ToolSpec" }, required: true }
+        }.freeze,
+      }.freeze
+    end
+  end
+end

data/lib/pinecall/wire/shapes_config.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+# An agent as its app declares it: voice, models, turns, tools, views, docs, memory.
+
+module Pinecall
+  module Wire
+    module Shapes
+      CONFIG = {
+        "PromptBlockSpec" => {
+          name: { kind: :str, required: true, pattern: "^[a-z][a-z0-9_]*$" },
+          region: { kind: :ref, ref: "PromptRegion", required: true }
+        }.freeze,
+        "VoiceConfig" => {
+          name: { kind: :str },
+          provider: { kind: :str },
+          model: { kind: :str },
+          voice_id: { kind: :str }
+        }.freeze,
+        "ModelConfig" => {
+          provider: { kind: :str, required: true },
+          model: { kind: :str, required: true },
+          temperature: { kind: :float }
+        }.freeze,
+        "TurnConfig" => {
+          min_interruption_words: { kind: :int },
+          endpointing_ms: { kind: :int },
+          eot_threshold: { kind: :float },
+          eager_eot_threshold: { kind: :float }
+        }.freeze,
+        "Pronunciation" => {
+          word: { kind: :str, required: true },
+          spoken: { kind: :str, required: true }
+        }.freeze,
+        "StateFieldSpec" => {
+          name: { kind: :str, required: true },
+          visibility: { kind: :ref, ref: "Visibility", required: true }
+        }.freeze,
+        "ViewSpec" => {
+          name: { kind: :str, required: true }
+        }.freeze,
+        "EventSpec" => {
+          name: { kind: :str, required: true },
+          from: { kind: :list, items: { kind: :ref, ref: "EventSource" }, required: true }
+        }.freeze,
+        "KnowledgeFile" => {
+          path: { kind: :str, required: true },
+          text: { kind: :str, required: true }
+        }.freeze,
+        "DocsConfig" => {
+          base: { kind: :str, required: true },
+          mode: { kind: :ref, ref: "DocsMode", default: "retrieved" },
+          k: { kind: :int, default: 8 },
+          min_score: { kind: :float }
+        }.freeze,
+        "GreetingConfig" => {
+          say: { kind: :str },
+          reply: { kind: :str },
+          allow_interruptions: { kind: :bool }
+        }.freeze,
+        "HangupConfig" => {
+          when: { kind: :str, default: "" }
+        }.freeze,
+        "MemoryConfig" => {
+          remember: { kind: :list, items: { kind: :str }, default: [] },
+          forget: { kind: :list, items: { kind: :str }, default: [] }
+        }.freeze,
+      }.freeze
+    end
+  end
+end

data/lib/pinecall/wire/shapes_doors.rb

@@ -0,0 +1,96 @@
+# frozen_string_literal: true
+
+# The bodies and answers of the doors this gem calls: knowledge, memory, the agent's config.
+
+module Pinecall
+  module Wire
+    module Shapes
+      DOORS = {
+        "ToolSpec" => {
+          name: { kind: :str, required: true },
+          description: { kind: :str, required: true },
+          parameters: { kind: :json, required: true },
+          side_effect: { kind: :enum, values: %w[read write irreversible], default: "read" },
+          confirm: { kind: :str },
+          pii: { kind: :list, items: { kind: :str } },
+          timeout_s: { kind: :float }
+        }.freeze,
+        "AgentConfig" => {
+          prompt: { kind: :list, items: { kind: :ref, ref: "PromptBlockSpec" } },
+          greeting: { kind: :ref, ref: "GreetingConfig" },
+          voice: { kind: :ref, ref: "VoiceConfig" },
+          llm: { kind: :ref, ref: "ModelConfig" },
+          stt: { kind: :ref, ref: "ModelConfig" },
+          turn: { kind: :ref, ref: "TurnConfig" },
+          says: { kind: :list, items: { kind: :ref, ref: "Pronunciation" } },
+          hears: { kind: :list, items: { kind: :str } },
+          knowledge: { kind: :ref, ref: "KnowledgeFile" },
+          docs: { kind: :ref, ref: "DocsConfig" },
+          memory: { kind: :ref, ref: "MemoryConfig" },
+          hangup: { kind: :ref, ref: "HangupConfig" },
+          record: { kind: :bool, default: true },
+          tools: { kind: :list, items: { kind: :ref, ref: "ToolSpec" } },
+          uses_knowledge: { kind: :bool, default: false },
+          state_fields: { kind: :list, items: { kind: :ref, ref: "StateFieldSpec" } },
+          view: { kind: :ref, ref: "ViewSpec" },
+          events: { kind: :list, items: { kind: :ref, ref: "EventSpec" } }
+        }.freeze,
+        "KnowledgePush" => {
+          files: { kind: :list, items: { kind: :ref, ref: "KnowledgeFile" }, required: true }
+        }.freeze,
+        "KnowledgeGolden" => {
+          questions: { kind: :list, items: { kind: :ref, ref: "GoldenQuestion" }, required: true },
+          k: { kind: :int }
+        }.freeze,
+        "KnowledgeScore" => {
+          base: { kind: :str, required: true },
+          model: { kind: :str, required: true },
+          questions: { kind: :int, required: true },
+          k: { kind: :int, required: true },
+          recall_at_k: { kind: :float, required: true },
+          ndcg_at_10: { kind: :float, required: true },
+          took_ms: { kind: :float, required: true },
+          misses: { kind: :list, items: { kind: :ref, ref: "GoldenMiss" }, required: true }
+        }.freeze,
+        "KnowledgePushed" => {
+          base: { kind: :str, required: true },
+          chunks: { kind: :int, required: true },
+          took_ms: { kind: :float, required: true }
+        }.freeze,
+        "KnowledgeList" => {
+          bases: { kind: :list, items: { kind: :ref, ref: "KnowledgeBase" }, required: true }
+        }.freeze,
+        "ContactMemory" => {
+          facts: { kind: :list, items: { kind: :ref, ref: "ContactFact" }, required: true }
+        }.freeze,
+        "Forgotten" => {
+          forgotten: { kind: :int, required: true }
+        }.freeze,
+        "MemoryGolden" => {
+          questions: { kind: :list, items: { kind: :ref, ref: "MemoryQuestion" }, required: true },
+          k: { kind: :int }
+        }.freeze,
+        "MemoryScore" => {
+          model: { kind: :str, required: true },
+          questions: { kind: :int, required: true },
+          k: { kind: :int, required: true },
+          recall_at_k: { kind: :float, required: true },
+          ndcg_at_10: { kind: :float, required: true },
+          took_ms: { kind: :float, required: true },
+          misses: { kind: :list, items: { kind: :ref, ref: "MemoryMiss" }, required: true }
+        }.freeze,
+        "ExtractionCases" => {
+          cases: { kind: :list, items: { kind: :ref, ref: "ExtractionGolden" }, required: true }
+        }.freeze,
+        "ExtractionRun" => {
+          agent: { kind: :str, required: true },
+          model: { kind: :str, required: true },
+          cases: { kind: :int, required: true },
+          held: { kind: :int, required: true },
+          took_ms: { kind: :float, required: true },
+          results: { kind: :list, items: { kind: :ref, ref: "ExtractionJudged" }, required: true }
+        }.freeze,
+      }.freeze
+    end
+  end
+end