phonic 0.32.20 → 0.32.21

package/dist/esm/api/resources/responses/client/requests/GenerateResponsesRequest.d.mts

@@ -0,0 +1,46 @@
+import type * as Phonic from "../../../../index.mjs";
+/**
+ * @example
+ *     {
+ *         system_prompt: "You help callers find a pizza shop. Be friendly and concise.",
+ *         voice_id: "sabrina",
+ *         default_language: "en",
+ *         additional_languages: ["es"],
+ *         input: [{
+ *                 role: "user",
+ *                 text: "Where should I get pizza near Union Square?"
+ *             }],
+ *         tool_definitions: [{
+ *                 name: "search_pizza_shop_recs",
+ *                 description: "Search for pizza shop recommendations.",
+ *                 parameters: {
+ *                     type: "object",
+ *                     properties: {
+ *                         "location": {
+ *                             "type": "string",
+ *                             "description": "The neighborhood to search in."
+ *                         }
+ *                     },
+ *                     required: ["location"],
+ *                     additionalProperties: false
+ *                 }
+ *             }],
+ *         num_responses: 2
+ *     }
+ */
+export interface GenerateResponsesRequest {
+    /** The system prompt the assistant should follow. */
+    system_prompt: string;
+    /** ID of the voice the assistant would speak with. It shapes how the responses are worded. */
+    voice_id?: string;
+    /** ISO 639-1 language code that sets the assistant's default language to recognize and speak. */
+    default_language?: Phonic.LanguageCode;
+    /** Array of additional ISO 639-1 language codes that the assistant should be able to recognize and speak. Should not include `default_language`. */
+    additional_languages?: Phonic.LanguageCode[];
+    /** The conversation so far, in order. Must contain at least one item. */
+    input: Phonic.ResponsesInputItem[];
+    /** The tools the assistant may call, defined inline. Names must be unique and cannot be one of the names Phonic reserves for its built-in tools. */
+    tool_definitions?: Phonic.ResponsesToolDefinition[];
+    /** Number of alternative responses to generate. */
+    num_responses?: number;
+}

package/dist/esm/api/resources/responses/client/requests/GenerateResponsesRequest.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/resources/responses/client/requests/index.d.mts

@@ -0,0 +1 @@
+export type { GenerateResponsesRequest } from "./GenerateResponsesRequest.mjs";

package/dist/esm/api/resources/responses/client/requests/index.mjs

@@ -0,0 +1 @@
+export {};

package/dist/esm/api/resources/responses/exports.d.mts

@@ -0,0 +1,2 @@
+export { ResponsesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/responses/exports.mjs

@@ -0,0 +1,3 @@
+// This file was auto-generated by Fern from our API Definition.
+export { ResponsesClient } from "./client/Client.mjs";
+export * from "./client/index.mjs";

package/dist/esm/api/resources/responses/index.d.mts

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/resources/responses/index.mjs

@@ -0,0 +1 @@
+export * from "./client/index.mjs";

package/dist/esm/api/types/ConflictErrorBody.d.mts

@@ -0,0 +1,2 @@
+import type * as Phonic from "../index.mjs";
+export type ConflictErrorBody = Phonic.SipCallError | Phonic.BasicError;

package/dist/esm/api/types/ConflictErrorBody.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GenerateResponsesResponse.d.mts

@@ -0,0 +1,5 @@
+import type * as Phonic from "../index.mjs";
+export interface GenerateResponsesResponse {
+    /** The generated responses - always `num_responses` of them. */
+    responses: Phonic.GeneratedResponse[];
+}

package/dist/esm/api/types/GenerateResponsesResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GeneratedResponse.d.mts

@@ -0,0 +1,7 @@
+import type * as Phonic from "../index.mjs";
+export interface GeneratedResponse {
+    /** The text the assistant would say. Empty when the response only makes tool calls. */
+    text: string;
+    /** Tool calls the assistant would make - note that the tools are not actually called. */
+    tool_calls: Phonic.GeneratedToolCall[];
+}

package/dist/esm/api/types/GeneratedResponse.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/GeneratedToolCall.d.mts

@@ -0,0 +1,10 @@
+export interface GeneratedToolCall {
+    /** Identifier for this tool call. Send it back as the `tool_call_id` of the matching `tool_call_output` input item. */
+    tool_call_id: string;
+    /** Name of the tool to call. Always one of the `tool_definitions` from the request. */
+    tool_name: string;
+    /** Arguments the assistant produced for the request body. */
+    request_body?: Record<string, unknown> | undefined;
+    /** Arguments the assistant produced as query parameters. */
+    query_params?: Record<string, string> | undefined;
+}

package/dist/esm/api/types/GeneratedToolCall.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ResponsesAssistantMessage.d.mts

@@ -0,0 +1,11 @@
+import type * as Phonic from "../index.mjs";
+/**
+ * An assistant turn. Must carry `text`, `tool_calls`, or both.
+ */
+export interface ResponsesAssistantMessage {
+    role: "assistant";
+    /** What the assistant said. Empty when the turn only made tool calls. */
+    text: string;
+    /** Tool calls the assistant made on this turn. Each one must be followed immediately by its matching `tool_call_output` item. */
+    tool_calls?: Phonic.ResponsesToolCall[] | undefined;
+}

package/dist/esm/api/types/ResponsesAssistantMessage.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ResponsesInputItem.d.mts

@@ -0,0 +1,5 @@
+import type * as Phonic from "../index.mjs";
+/**
+ * One item of conversation history - a user message, an assistant message, or the output of an assistant tool call.
+ */
+export type ResponsesInputItem = Phonic.ResponsesUserMessage | Phonic.ResponsesAssistantMessage | Phonic.ResponsesToolCallOutput;

package/dist/esm/api/types/ResponsesInputItem.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ResponsesToolCall.d.mts

@@ -0,0 +1,13 @@
+/**
+ * A tool call the assistant made earlier in the conversation.
+ */
+export interface ResponsesToolCall {
+    /** Identifier for this tool call, unique within `input`. */
+    tool_call_id: string;
+    /** Name of the called tool. */
+    tool_name: string;
+    /** Arguments the assistant passed in the request body. */
+    request_body?: (Record<string, unknown> | null) | undefined;
+    /** Arguments the assistant passed as query parameters. An argument cannot appear in both `request_body` and `query_params`. */
+    query_params?: (Record<string, string | null> | null) | undefined;
+}

package/dist/esm/api/types/ResponsesToolCall.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ResponsesToolCallOutput.d.mts

@@ -0,0 +1,24 @@
+/**
+ * The result of an assistant tool call. Must record an outcome through `response_body`, `response_status_code`, `error_message`, `timed_out`, or `interrupted`.
+ */
+export interface ResponsesToolCallOutput {
+    type: "tool_call_output";
+    /** The `tool_call_id` of the assistant tool call this output belongs to. */
+    tool_call_id: string;
+    /** The value the tool returned. Can be any JSON-serializable value. */
+    response_body?: (ResponsesToolCallOutput.ResponseBody | null) | undefined;
+    /** HTTP status code the tool returned, for tools called over HTTP. */
+    response_status_code?: (number | null) | undefined;
+    /** Whether the tool call timed out. */
+    timed_out?: boolean | undefined;
+    /** The error the tool call failed with. */
+    error_message?: (string | null) | undefined;
+    /** Whether the tool call was interrupted before it finished. */
+    interrupted?: boolean | undefined;
+}
+export declare namespace ResponsesToolCallOutput {
+    /**
+     * The value the tool returned. Can be any JSON-serializable value.
+     */
+    type ResponseBody = Record<string, unknown> | unknown[] | string | number | boolean;
+}

package/dist/esm/api/types/ResponsesToolCallOutput.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ResponsesToolDefinition.d.mts

@@ -0,0 +1,11 @@
+import type * as Phonic from "../index.mjs";
+/**
+ * A tool the assistant may call, defined inline for this request only.
+ */
+export interface ResponsesToolDefinition {
+    /** The tool name. */
+    name: string;
+    /** What the tool does. The model uses this to decide when to call it. */
+    description: string;
+    parameters: Phonic.ToolParametersJsonSchema;
+}

package/dist/esm/api/types/ResponsesToolDefinition.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/ResponsesUserMessage.d.mts

@@ -0,0 +1,8 @@
+/**
+ * Something the user said.
+ */
+export interface ResponsesUserMessage {
+    role: "user";
+    /** What the user said. */
+    text: string;
+}

package/dist/esm/api/types/ResponsesUserMessage.mjs

@@ -0,0 +1,2 @@
+// This file was auto-generated by Fern from our API Definition.
+export {};

package/dist/esm/api/types/index.d.mts

@@ -16,6 +16,7 @@ export * from "./BuiltInToolDefinition.mjs";
 export * from "./ChooseNotToRespondToolConfig.mjs";
 export * from "./ConfigOptions.mjs";
 export * from "./ConfigPayload.mjs";
+export * from "./ConflictErrorBody.mjs";
 export * from "./Conversation.mjs";
 export * from "./ConversationAnalysis.mjs";
 export * from "./ConversationCreatedPayload.mjs";
@@ -37,7 +38,10 @@ export * from "./ErrorPayload.mjs";
 export * from "./ExternalStoragePolicy.mjs";
 export * from "./ExtractionField.mjs";
 export * from "./ExtractionSchema.mjs";
+export * from "./GeneratedResponse.mjs";
+export * from "./GeneratedToolCall.mjs";
 export * from "./GenerateReplyPayload.mjs";
+export * from "./GenerateResponsesResponse.mjs";
 export * from "./InlineWebSocketTool.mjs";
 export * from "./InputCancelledPayload.mjs";
 export * from "./InputTextPayload.mjs";
@@ -55,6 +59,12 @@ export * from "./ReadyToStartConversationPayload.mjs";
 export * from "./ReplayConversationItemResponse.mjs";
 export * from "./ReplayToolCall.mjs";
 export * from "./ResetPayload.mjs";
+export * from "./ResponsesAssistantMessage.mjs";
+export * from "./ResponsesInputItem.mjs";
+export * from "./ResponsesToolCall.mjs";
+export * from "./ResponsesToolCallOutput.mjs";
+export * from "./ResponsesToolDefinition.mjs";
+export * from "./ResponsesUserMessage.mjs";
 export * from "./SayPayload.mjs";
 export * from "./SetExternalIdPayload.mjs";
 export * from "./SipCallError.mjs";

package/dist/esm/api/types/index.mjs

@@ -16,6 +16,7 @@ export * from "./BuiltInToolDefinition.mjs";
 export * from "./ChooseNotToRespondToolConfig.mjs";
 export * from "./ConfigOptions.mjs";
 export * from "./ConfigPayload.mjs";
+export * from "./ConflictErrorBody.mjs";
 export * from "./Conversation.mjs";
 export * from "./ConversationAnalysis.mjs";
 export * from "./ConversationCreatedPayload.mjs";
@@ -37,7 +38,10 @@ export * from "./ErrorPayload.mjs";
 export * from "./ExternalStoragePolicy.mjs";
 export * from "./ExtractionField.mjs";
 export * from "./ExtractionSchema.mjs";
+export * from "./GeneratedResponse.mjs";
+export * from "./GeneratedToolCall.mjs";
 export * from "./GenerateReplyPayload.mjs";
+export * from "./GenerateResponsesResponse.mjs";
 export * from "./InlineWebSocketTool.mjs";
 export * from "./InputCancelledPayload.mjs";
 export * from "./InputTextPayload.mjs";
@@ -55,6 +59,12 @@ export * from "./ReadyToStartConversationPayload.mjs";
 export * from "./ReplayConversationItemResponse.mjs";
 export * from "./ReplayToolCall.mjs";
 export * from "./ResetPayload.mjs";
+export * from "./ResponsesAssistantMessage.mjs";
+export * from "./ResponsesInputItem.mjs";
+export * from "./ResponsesToolCall.mjs";
+export * from "./ResponsesToolCallOutput.mjs";
+export * from "./ResponsesToolDefinition.mjs";
+export * from "./ResponsesUserMessage.mjs";
 export * from "./SayPayload.mjs";
 export * from "./SetExternalIdPayload.mjs";
 export * from "./SipCallError.mjs";

package/dist/esm/version.d.mts

@@ -1 +1 @@
-export declare const SDK_VERSION = "0.32.20";
+export declare const SDK_VERSION = "0.32.21";

package/dist/esm/version.mjs

@@ -1 +1 @@
-export const SDK_VERSION = "0.32.20";
+export const SDK_VERSION = "0.32.21";

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "phonic",
-    "version": "0.32.20",
+    "version": "0.32.21",
     "private": false,
     "repository": {
         "type": "git",
@@ -155,6 +155,17 @@
             },
             "default": "./dist/cjs/api/resources/projects/exports.js"
         },
+        "./responses": {
+            "import": {
+                "types": "./dist/esm/api/resources/responses/exports.d.mts",
+                "default": "./dist/esm/api/resources/responses/exports.mjs"
+            },
+            "require": {
+                "types": "./dist/cjs/api/resources/responses/exports.d.ts",
+                "default": "./dist/cjs/api/resources/responses/exports.js"
+            },
+            "default": "./dist/cjs/api/resources/responses/exports.js"
+        },
         "./package.json": "./package.json"
     },
     "files": [

package/reference.md

@@ -4020,3 +4020,107 @@ await client.projects.listEvals("id");
 </dl>
 </details>
 
+## Responses
+<details><summary><code>client.responses.<a href="/src/api/resources/responses/client/Client.ts">create</a>({ ...params }) -> Phonic.GenerateResponsesResponse</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+Generates one or more alternative assistant responses for a conversation
+you supply inline to simulate Phonic agent behavior.
+
+This endpoint is stateless, so it does not create a new conversation or
+store anything. The request carries the system prompt, a conversation so
+far as `input`, and the tools the assistant may call as
+`tool_definitions`.
+
+Each item in `input` is a user message, an assistant message (with
+optional `tool_calls`), or a `tool_call_output`. Every assistant tool
+call must be followed immediately by the `tool_call_output` item that
+carries its result.
+
+This is an experimental feature and must be enabled for your workspace;
+otherwise, it returns `404`. Please contact our team if you would like
+access.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```typescript
+await client.responses.create({
+    system_prompt: "You help callers find a pizza shop. Be friendly and concise.",
+    voice_id: "sabrina",
+    default_language: "en",
+    additional_languages: ["es"],
+    input: [{
+            role: "user",
+            text: "Where should I get pizza near Union Square?"
+        }],
+    tool_definitions: [{
+            name: "search_pizza_shop_recs",
+            description: "Search for pizza shop recommendations.",
+            parameters: {
+                type: "object",
+                properties: {
+                    "location": {
+                        "type": "string",
+                        "description": "The neighborhood to search in."
+                    }
+                },
+                required: ["location"],
+                additionalProperties: false
+            }
+        }],
+    num_responses: 2
+});
+
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**request:** `Phonic.GenerateResponsesRequest` 
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**requestOptions:** `ResponsesClient.RequestOptions` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
+
+</dd>
+</dl>
+</details>
+