@livekit/protocol 1.44.0 → 1.45.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@livekit/protocol",
-  "version": "1.44.0",
+  "version": "1.45.0",
   "description": "",
   "type": "module",
   "require": "dist/index.cjs",

package/src/gen/agent/livekit_agent_text_pb.d.ts

@@ -0,0 +1,281 @@
+// Copyright 2023 LiveKit, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// @generated by protoc-gen-es v1.10.1 with parameter "target=dts+js"
+// @generated from file agent/livekit_agent_text.proto (package livekit.agent, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import type { BinaryReadOptions, FieldList, JsonReadOptions, JsonValue, PartialMessage, PlainMessage } from "@bufbuild/protobuf";
+import { Message, proto3 } from "@bufbuild/protobuf";
+import type { AgentHandoff, ChatMessage, FunctionCall, FunctionCallOutput } from "./livekit_agent_session_pb.js";
+
+/**
+ * @generated from enum livekit.agent.TextMessageErrorCode
+ */
+export declare enum TextMessageErrorCode {
+  /**
+   * Unexpected internal error
+   *
+   * @generated from enum value: INTERNAL_ERROR = 0;
+   */
+  INTERNAL_ERROR = 0,
+
+  /**
+   * Session state not found in cache or version mismatch
+   *
+   * @generated from enum value: SESSION_STATE_NOT_FOUND = 1;
+   */
+  SESSION_STATE_NOT_FOUND = 1,
+
+  /**
+   * An exception was raised inside the user's text handler
+   *
+   * @generated from enum value: TEXT_HANDLER_ERROR = 2;
+   */
+  TEXT_HANDLER_ERROR = 2,
+
+  /**
+   * The worker process exited before the text session completed
+   *
+   * @generated from enum value: PROCESS_CLOSED = 3;
+   */
+  PROCESS_CLOSED = 3,
+}
+
+/**
+ * Request to send a text message to an agent.
+ *
+ * @generated from message livekit.agent.TextMessageRequest
+ */
+export declare class TextMessageRequest extends Message<TextMessageRequest> {
+  /**
+   * @generated from field: string text = 1;
+   */
+  text: string;
+
+  /**
+   * @generated from field: string message_id = 2;
+   */
+  messageId: string;
+
+  /**
+   * @generated from field: string session_id = 3;
+   */
+  sessionId: string;
+
+  /**
+   * @generated from field: string agent_name = 4;
+   */
+  agentName: string;
+
+  /**
+   * @generated from field: string metadata = 5;
+   */
+  metadata: string;
+
+  /**
+   * @generated from field: optional livekit.agent.AgentSessionState session_state = 6;
+   */
+  sessionState?: AgentSessionState;
+
+  constructor(data?: PartialMessage<TextMessageRequest>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.TextMessageRequest";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageRequest;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageRequest;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageRequest;
+
+  static equals(a: TextMessageRequest | PlainMessage<TextMessageRequest> | undefined, b: TextMessageRequest | PlainMessage<TextMessageRequest> | undefined): boolean;
+}
+
+/**
+ * Response to a text message request, multiple responses may be sent for a single request until it is complete.
+ *
+ * @generated from message livekit.agent.TextMessageResponse
+ */
+export declare class TextMessageResponse extends Message<TextMessageResponse> {
+  /**
+   * @generated from field: string message_id = 1;
+   */
+  messageId: string;
+
+  /**
+   * @generated from field: string session_id = 2;
+   */
+  sessionId: string;
+
+  /**
+   * @generated from oneof livekit.agent.TextMessageResponse.event
+   */
+  event: {
+    /**
+     * @generated from field: livekit.agent.ChatMessage message = 3;
+     */
+    value: ChatMessage;
+    case: "message";
+  } | {
+    /**
+     * @generated from field: livekit.agent.FunctionCall function_call = 4;
+     */
+    value: FunctionCall;
+    case: "functionCall";
+  } | {
+    /**
+     * @generated from field: livekit.agent.FunctionCallOutput function_call_output = 5;
+     */
+    value: FunctionCallOutput;
+    case: "functionCallOutput";
+  } | {
+    /**
+     * @generated from field: livekit.agent.AgentHandoff agent_handoff = 6;
+     */
+    value: AgentHandoff;
+    case: "agentHandoff";
+  } | {
+    /**
+     * @generated from field: livekit.agent.TextMessageComplete complete = 7;
+     */
+    value: TextMessageComplete;
+    case: "complete";
+  } | { case: undefined; value?: undefined };
+
+  constructor(data?: PartialMessage<TextMessageResponse>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.TextMessageResponse";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageResponse;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageResponse;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageResponse;
+
+  static equals(a: TextMessageResponse | PlainMessage<TextMessageResponse> | undefined, b: TextMessageResponse | PlainMessage<TextMessageResponse> | undefined): boolean;
+}
+
+/**
+ * Indicates the text message session is complete.
+ *
+ * @generated from message livekit.agent.TextMessageComplete
+ */
+export declare class TextMessageComplete extends Message<TextMessageComplete> {
+  /**
+   * @generated from oneof livekit.agent.TextMessageComplete.result
+   */
+  result: {
+    /**
+     * @generated from field: livekit.agent.AgentSessionState session_state = 1;
+     */
+    value: AgentSessionState;
+    case: "sessionState";
+  } | {
+    /**
+     * @generated from field: livekit.agent.TextMessageError error = 2;
+     */
+    value: TextMessageError;
+    case: "error";
+  } | { case: undefined; value?: undefined };
+
+  constructor(data?: PartialMessage<TextMessageComplete>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.TextMessageComplete";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageComplete;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageComplete;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageComplete;
+
+  static equals(a: TextMessageComplete | PlainMessage<TextMessageComplete> | undefined, b: TextMessageComplete | PlainMessage<TextMessageComplete> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.agent.AgentSessionState
+ */
+export declare class AgentSessionState extends Message<AgentSessionState> {
+  /**
+   * @generated from field: uint64 version = 1;
+   */
+  version: bigint;
+
+  /**
+   * @generated from oneof livekit.agent.AgentSessionState.data
+   */
+  data: {
+    /**
+     * @generated from field: bytes snapshot = 2;
+     */
+    value: Uint8Array;
+    case: "snapshot";
+  } | {
+    /**
+     * @generated from field: bytes delta = 3;
+     */
+    value: Uint8Array;
+    case: "delta";
+  } | { case: undefined; value?: undefined };
+
+  constructor(data?: PartialMessage<AgentSessionState>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.AgentSessionState";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): AgentSessionState;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): AgentSessionState;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): AgentSessionState;
+
+  static equals(a: AgentSessionState | PlainMessage<AgentSessionState> | undefined, b: AgentSessionState | PlainMessage<AgentSessionState> | undefined): boolean;
+}
+
+/**
+ * @generated from message livekit.agent.TextMessageError
+ */
+export declare class TextMessageError extends Message<TextMessageError> {
+  /**
+   * @generated from field: string message = 1;
+   */
+  message: string;
+
+  /**
+   * @generated from field: livekit.agent.TextMessageErrorCode code = 2;
+   */
+  code: TextMessageErrorCode;
+
+  constructor(data?: PartialMessage<TextMessageError>);
+
+  static readonly runtime: typeof proto3;
+  static readonly typeName = "livekit.agent.TextMessageError";
+  static readonly fields: FieldList;
+
+  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageError;
+
+  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageError;
+
+  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageError;
+
+  static equals(a: TextMessageError | PlainMessage<TextMessageError> | undefined, b: TextMessageError | PlainMessage<TextMessageError> | undefined): boolean;
+}
+

package/src/gen/agent/livekit_agent_text_pb.js

@@ -0,0 +1,106 @@
+// Copyright 2023 LiveKit, Inc.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// @generated by protoc-gen-es v1.10.1 with parameter "target=dts+js"
+// @generated from file agent/livekit_agent_text.proto (package livekit.agent, syntax proto3)
+/* eslint-disable */
+// @ts-nocheck
+
+import { proto3 } from "@bufbuild/protobuf";
+import { AgentHandoff, ChatMessage, FunctionCall, FunctionCallOutput } from "./livekit_agent_session_pb.js";
+
+/**
+ * @generated from enum livekit.agent.TextMessageErrorCode
+ */
+export const TextMessageErrorCode = /*@__PURE__*/ proto3.makeEnum(
+  "livekit.agent.TextMessageErrorCode",
+  [
+    {no: 0, name: "INTERNAL_ERROR"},
+    {no: 1, name: "SESSION_STATE_NOT_FOUND"},
+    {no: 2, name: "TEXT_HANDLER_ERROR"},
+    {no: 3, name: "PROCESS_CLOSED"},
+  ],
+);
+
+/**
+ * Request to send a text message to an agent.
+ *
+ * @generated from message livekit.agent.TextMessageRequest
+ */
+export const TextMessageRequest = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.TextMessageRequest",
+  () => [
+    { no: 1, name: "text", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "message_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "session_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 4, name: "agent_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 5, name: "metadata", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 6, name: "session_state", kind: "message", T: AgentSessionState, opt: true },
+  ],
+);
+
+/**
+ * Response to a text message request, multiple responses may be sent for a single request until it is complete.
+ *
+ * @generated from message livekit.agent.TextMessageResponse
+ */
+export const TextMessageResponse = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.TextMessageResponse",
+  () => [
+    { no: 1, name: "message_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "session_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 3, name: "message", kind: "message", T: ChatMessage, oneof: "event" },
+    { no: 4, name: "function_call", kind: "message", T: FunctionCall, oneof: "event" },
+    { no: 5, name: "function_call_output", kind: "message", T: FunctionCallOutput, oneof: "event" },
+    { no: 6, name: "agent_handoff", kind: "message", T: AgentHandoff, oneof: "event" },
+    { no: 7, name: "complete", kind: "message", T: TextMessageComplete, oneof: "event" },
+  ],
+);
+
+/**
+ * Indicates the text message session is complete.
+ *
+ * @generated from message livekit.agent.TextMessageComplete
+ */
+export const TextMessageComplete = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.TextMessageComplete",
+  () => [
+    { no: 1, name: "session_state", kind: "message", T: AgentSessionState, oneof: "result" },
+    { no: 2, name: "error", kind: "message", T: TextMessageError, oneof: "result" },
+  ],
+);
+
+/**
+ * @generated from message livekit.agent.AgentSessionState
+ */
+export const AgentSessionState = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.AgentSessionState",
+  () => [
+    { no: 1, name: "version", kind: "scalar", T: 4 /* ScalarType.UINT64 */ },
+    { no: 2, name: "snapshot", kind: "scalar", T: 12 /* ScalarType.BYTES */, oneof: "data" },
+    { no: 3, name: "delta", kind: "scalar", T: 12 /* ScalarType.BYTES */, oneof: "data" },
+  ],
+);
+
+/**
+ * @generated from message livekit.agent.TextMessageError
+ */
+export const TextMessageError = /*@__PURE__*/ proto3.makeMessageType(
+  "livekit.agent.TextMessageError",
+  () => [
+    { no: 1, name: "message", kind: "scalar", T: 9 /* ScalarType.STRING */ },
+    { no: 2, name: "code", kind: "enum", T: proto3.getEnumType(TextMessageErrorCode) },
+  ],
+);
+

package/src/gen/livekit_agent_pb.d.ts

@@ -269,18 +269,6 @@ export declare class WorkerMessage extends Message<WorkerMessage> {
      */
     value: MigrateJobRequest;
     case: "migrateJob";
-  } | {
-    /**
-     * @generated from field: livekit.TextMessageResponse text_response = 8;
-     */
-    value: TextMessageResponse;
-    case: "textResponse";
-  } | {
-    /**
-     * @generated from field: livekit.PushTextRequest push_text = 9;
-     */
-    value: PushTextRequest;
-    case: "pushText";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<WorkerMessage>);
@@ -341,12 +329,6 @@ export declare class ServerMessage extends Message<ServerMessage> {
      */
     value: WorkerPong;
     case: "pong";
-  } | {
-    /**
-     * @generated from field: livekit.TextMessageRequest text_request = 6;
-     */
-    value: TextMessageRequest;
-    case: "textRequest";
   } | { case: undefined; value?: undefined };
 
   constructor(data?: PartialMessage<ServerMessage>);
@@ -784,119 +766,3 @@ export declare class JobTermination extends Message<JobTermination> {
   static equals(a: JobTermination | PlainMessage<JobTermination> | undefined, b: JobTermination | PlainMessage<JobTermination> | undefined): boolean;
 }
 
-/**
- * @generated from message livekit.TextMessageRequest
- */
-export declare class TextMessageRequest extends Message<TextMessageRequest> {
-  /**
-   * @generated from field: string message_id = 1;
-   */
-  messageId: string;
-
-  /**
-   * @generated from field: string session_id = 2;
-   */
-  sessionId: string;
-
-  /**
-   * @generated from field: string agent_name = 3;
-   */
-  agentName: string;
-
-  /**
-   * @generated from field: string metadata = 4;
-   */
-  metadata: string;
-
-  /**
-   * @generated from field: bytes session_data = 5;
-   */
-  sessionData: Uint8Array;
-
-  /**
-   * @generated from field: string text = 6;
-   */
-  text: string;
-
-  constructor(data?: PartialMessage<TextMessageRequest>);
-
-  static readonly runtime: typeof proto3;
-  static readonly typeName = "livekit.TextMessageRequest";
-  static readonly fields: FieldList;
-
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageRequest;
-
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageRequest;
-
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageRequest;
-
-  static equals(a: TextMessageRequest | PlainMessage<TextMessageRequest> | undefined, b: TextMessageRequest | PlainMessage<TextMessageRequest> | undefined): boolean;
-}
-
-/**
- * @generated from message livekit.PushTextRequest
- */
-export declare class PushTextRequest extends Message<PushTextRequest> {
-  /**
-   * The message_id of the TextMessageRequest that this push is for
-   *
-   * @generated from field: string message_id = 1;
-   */
-  messageId: string;
-
-  /**
-   * @generated from field: string content = 2;
-   */
-  content: string;
-
-  constructor(data?: PartialMessage<PushTextRequest>);
-
-  static readonly runtime: typeof proto3;
-  static readonly typeName = "livekit.PushTextRequest";
-  static readonly fields: FieldList;
-
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PushTextRequest;
-
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): PushTextRequest;
-
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): PushTextRequest;
-
-  static equals(a: PushTextRequest | PlainMessage<PushTextRequest> | undefined, b: PushTextRequest | PlainMessage<PushTextRequest> | undefined): boolean;
-}
-
-/**
- * @generated from message livekit.TextMessageResponse
- */
-export declare class TextMessageResponse extends Message<TextMessageResponse> {
-  /**
-   * Indicate the request is completed
-   *
-   * @generated from field: string message_id = 1;
-   */
-  messageId: string;
-
-  /**
-   * @generated from field: bytes session_data = 2;
-   */
-  sessionData: Uint8Array;
-
-  /**
-   * @generated from field: string error = 3;
-   */
-  error: string;
-
-  constructor(data?: PartialMessage<TextMessageResponse>);
-
-  static readonly runtime: typeof proto3;
-  static readonly typeName = "livekit.TextMessageResponse";
-  static readonly fields: FieldList;
-
-  static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): TextMessageResponse;
-
-  static fromJson(jsonValue: JsonValue, options?: Partial<JsonReadOptions>): TextMessageResponse;
-
-  static fromJsonString(jsonString: string, options?: Partial<JsonReadOptions>): TextMessageResponse;
-
-  static equals(a: TextMessageResponse | PlainMessage<TextMessageResponse> | undefined, b: TextMessageResponse | PlainMessage<TextMessageResponse> | undefined): boolean;
-}
-

package/src/gen/livekit_agent_pb.js

@@ -107,8 +107,6 @@ export const WorkerMessage = /*@__PURE__*/ proto3.makeMessageType(
     { no: 5, name: "ping", kind: "message", T: WorkerPing, oneof: "message" },
     { no: 6, name: "simulate_job", kind: "message", T: SimulateJobRequest, oneof: "message" },
     { no: 7, name: "migrate_job", kind: "message", T: MigrateJobRequest, oneof: "message" },
-    { no: 8, name: "text_response", kind: "message", T: TextMessageResponse, oneof: "message" },
-    { no: 9, name: "push_text", kind: "message", T: PushTextRequest, oneof: "message" },
   ],
 );
 
@@ -125,7 +123,6 @@ export const ServerMessage = /*@__PURE__*/ proto3.makeMessageType(
     { no: 3, name: "assignment", kind: "message", T: JobAssignment, oneof: "message" },
     { no: 5, name: "termination", kind: "message", T: JobTermination, oneof: "message" },
     { no: 4, name: "pong", kind: "message", T: WorkerPong, oneof: "message" },
-    { no: 6, name: "text_request", kind: "message", T: TextMessageRequest, oneof: "message" },
   ],
 );
 
@@ -272,41 +269,3 @@ export const JobTermination = /*@__PURE__*/ proto3.makeMessageType(
   ],
 );
 
-/**
- * @generated from message livekit.TextMessageRequest
- */
-export const TextMessageRequest = /*@__PURE__*/ proto3.makeMessageType(
-  "livekit.TextMessageRequest",
-  () => [
-    { no: 1, name: "message_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 2, name: "session_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 3, name: "agent_name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 4, name: "metadata", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 5, name: "session_data", kind: "scalar", T: 12 /* ScalarType.BYTES */ },
-    { no: 6, name: "text", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-  ],
-);
-
-/**
- * @generated from message livekit.PushTextRequest
- */
-export const PushTextRequest = /*@__PURE__*/ proto3.makeMessageType(
-  "livekit.PushTextRequest",
-  () => [
-    { no: 1, name: "message_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 2, name: "content", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-  ],
-);
-
-/**
- * @generated from message livekit.TextMessageResponse
- */
-export const TextMessageResponse = /*@__PURE__*/ proto3.makeMessageType(
-  "livekit.TextMessageResponse",
-  () => [
-    { no: 1, name: "message_id", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-    { no: 2, name: "session_data", kind: "scalar", T: 12 /* ScalarType.BYTES */ },
-    { no: 3, name: "error", kind: "scalar", T: 9 /* ScalarType.STRING */ },
-  ],
-);
-