telnyx 7.7.0 → 7.8.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/CHANGELOG.md +9 -0
- package/client.d.mts +7 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +7 -4
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/ai/ai.d.mts +3 -36
- package/resources/ai/ai.d.mts.map +1 -1
- package/resources/ai/ai.d.ts +3 -36
- package/resources/ai/ai.d.ts.map +1 -1
- package/resources/ai/ai.js +0 -30
- package/resources/ai/ai.js.map +1 -1
- package/resources/ai/ai.mjs +1 -31
- package/resources/ai/ai.mjs.map +1 -1
- package/resources/ai/assistants/assistants.d.mts +43 -1
- package/resources/ai/assistants/assistants.d.mts.map +1 -1
- package/resources/ai/assistants/assistants.d.ts +43 -1
- package/resources/ai/assistants/assistants.d.ts.map +1 -1
- package/resources/ai/assistants/assistants.js.map +1 -1
- package/resources/ai/assistants/assistants.mjs.map +1 -1
- package/resources/ai/chat.d.mts +1 -188
- package/resources/ai/chat.d.mts.map +1 -1
- package/resources/ai/chat.d.ts +1 -188
- package/resources/ai/chat.d.ts.map +1 -1
- package/resources/ai/chat.js +0 -14
- package/resources/ai/chat.js.map +1 -1
- package/resources/ai/chat.mjs +0 -14
- package/resources/ai/chat.mjs.map +1 -1
- package/resources/ai/index.d.mts +2 -2
- package/resources/ai/index.d.mts.map +1 -1
- package/resources/ai/index.d.ts +2 -2
- package/resources/ai/index.d.ts.map +1 -1
- package/resources/ai/index.js.map +1 -1
- package/resources/ai/index.mjs +1 -1
- package/resources/ai/index.mjs.map +1 -1
- package/resources/ai/tools.d.mts +6 -0
- package/resources/ai/tools.d.mts.map +1 -1
- package/resources/ai/tools.d.ts +6 -0
- package/resources/ai/tools.d.ts.map +1 -1
- package/resources/calls/actions.d.mts +23 -1
- package/resources/calls/actions.d.mts.map +1 -1
- package/resources/calls/actions.d.ts +23 -1
- package/resources/calls/actions.d.ts.map +1 -1
- package/resources/calls/calls.d.mts +3 -0
- package/resources/calls/calls.d.mts.map +1 -1
- package/resources/calls/calls.d.ts +3 -0
- package/resources/calls/calls.d.ts.map +1 -1
- package/resources/calls/calls.js.map +1 -1
- package/resources/calls/calls.mjs.map +1 -1
- package/resources/conferences/actions.d.mts +6 -0
- package/resources/conferences/actions.d.mts.map +1 -1
- package/resources/conferences/actions.d.ts +6 -0
- package/resources/conferences/actions.d.ts.map +1 -1
- package/resources/index.d.mts +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/messages/index.d.mts +1 -1
- package/resources/messages/index.d.mts.map +1 -1
- package/resources/messages/index.d.ts +1 -1
- package/resources/messages/index.d.ts.map +1 -1
- package/resources/messages/index.js.map +1 -1
- package/resources/messages/index.mjs.map +1 -1
- package/resources/messages/messages.d.mts +4 -82
- package/resources/messages/messages.d.mts.map +1 -1
- package/resources/messages/messages.d.ts +4 -82
- package/resources/messages/messages.d.ts.map +1 -1
- package/resources/messages/messages.js +3 -15
- package/resources/messages/messages.js.map +1 -1
- package/resources/messages/messages.mjs +3 -15
- package/resources/messages/messages.mjs.map +1 -1
- package/resources/phone-numbers/phone-numbers.d.mts +21 -0
- package/resources/phone-numbers/phone-numbers.d.mts.map +1 -1
- package/resources/phone-numbers/phone-numbers.d.ts +21 -0
- package/resources/phone-numbers/phone-numbers.d.ts.map +1 -1
- package/resources/phone-numbers/phone-numbers.js.map +1 -1
- package/resources/phone-numbers/phone-numbers.mjs.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.mts +16 -11
- package/resources/text-to-speech/text-to-speech.d.mts.map +1 -1
- package/resources/text-to-speech/text-to-speech.d.ts +16 -11
- package/resources/text-to-speech/text-to-speech.d.ts.map +1 -1
- package/src/client.ts +3 -8
- package/src/resources/ai/ai.ts +2 -57
- package/src/resources/ai/assistants/assistants.ts +49 -0
- package/src/resources/ai/chat.ts +2 -234
- package/src/resources/ai/index.ts +1 -9
- package/src/resources/ai/tools.ts +4 -0
- package/src/resources/calls/actions.ts +23 -1
- package/src/resources/calls/calls.ts +3 -0
- package/src/resources/conferences/actions.ts +6 -0
- package/src/resources/index.ts +0 -4
- package/src/resources/messages/index.ts +0 -2
- package/src/resources/messages/messages.ts +3 -112
- package/src/resources/phone-numbers/phone-numbers.ts +24 -0
- package/src/resources/text-to-speech/text-to-speech.ts +16 -11
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
package/src/client.ts
CHANGED
|
@@ -1182,8 +1182,6 @@ import {
|
|
|
1182
1182
|
} from './resources/addresses/addresses';
|
|
1183
1183
|
import {
|
|
1184
1184
|
AI,
|
|
1185
|
-
AICreateResponseDeprecatedParams,
|
|
1186
|
-
AICreateResponseDeprecatedResponse,
|
|
1187
1185
|
AIRetrieveConversationHistoriesParams,
|
|
1188
1186
|
AIRetrieveConversationHistoriesResponse,
|
|
1189
1187
|
AISummarizeParams,
|
|
@@ -1334,8 +1332,6 @@ import {
|
|
|
1334
1332
|
MessageSendResponse,
|
|
1335
1333
|
MessageSendShortCodeParams,
|
|
1336
1334
|
MessageSendShortCodeResponse,
|
|
1337
|
-
MessageSendWhatsappParams,
|
|
1338
|
-
MessageSendWhatsappResponse,
|
|
1339
1335
|
MessageSendWithAlphanumericSenderParams,
|
|
1340
1336
|
MessageSendWithAlphanumericSenderResponse,
|
|
1341
1337
|
Messages,
|
|
@@ -2703,6 +2699,9 @@ export class Telnyx {
|
|
|
2703
2699
|
* Media Storage operations
|
|
2704
2700
|
*/
|
|
2705
2701
|
media: API.Media = new API.Media(this);
|
|
2702
|
+
/**
|
|
2703
|
+
* Messages
|
|
2704
|
+
*/
|
|
2706
2705
|
messages: API.Messages = new API.Messages(this);
|
|
2707
2706
|
messaging: API.Messaging = new API.Messaging(this);
|
|
2708
2707
|
/**
|
|
@@ -3496,11 +3495,9 @@ export declare namespace Telnyx {
|
|
|
3496
3495
|
AI as AI,
|
|
3497
3496
|
type ModelMetadata as ModelMetadata,
|
|
3498
3497
|
type ModelsResponse as ModelsResponse,
|
|
3499
|
-
type AICreateResponseDeprecatedResponse as AICreateResponseDeprecatedResponse,
|
|
3500
3498
|
type AIRetrieveConversationHistoriesResponse as AIRetrieveConversationHistoriesResponse,
|
|
3501
3499
|
type AISummarizeResponse as AISummarizeResponse,
|
|
3502
3500
|
type AISummarizeParams as AISummarizeParams,
|
|
3503
|
-
type AICreateResponseDeprecatedParams as AICreateResponseDeprecatedParams,
|
|
3504
3501
|
type AIRetrieveConversationHistoriesParams as AIRetrieveConversationHistoriesParams,
|
|
3505
3502
|
};
|
|
3506
3503
|
|
|
@@ -4047,14 +4044,12 @@ export declare namespace Telnyx {
|
|
|
4047
4044
|
type MessageSendLongCodeResponse as MessageSendLongCodeResponse,
|
|
4048
4045
|
type MessageSendNumberPoolResponse as MessageSendNumberPoolResponse,
|
|
4049
4046
|
type MessageSendShortCodeResponse as MessageSendShortCodeResponse,
|
|
4050
|
-
type MessageSendWhatsappResponse as MessageSendWhatsappResponse,
|
|
4051
4047
|
type MessageSendWithAlphanumericSenderResponse as MessageSendWithAlphanumericSenderResponse,
|
|
4052
4048
|
type MessageSendParams as MessageSendParams,
|
|
4053
4049
|
type MessageSendLongCodeParams as MessageSendLongCodeParams,
|
|
4054
4050
|
type MessageSendNumberPoolParams as MessageSendNumberPoolParams,
|
|
4055
4051
|
type MessageSendShortCodeParams as MessageSendShortCodeParams,
|
|
4056
4052
|
type MessageSendGroupMmsParams as MessageSendGroupMmsParams,
|
|
4057
|
-
type MessageSendWhatsappParams as MessageSendWhatsappParams,
|
|
4058
4053
|
type MessageScheduleParams as MessageScheduleParams,
|
|
4059
4054
|
type MessageSendWithAlphanumericSenderParams as MessageSendWithAlphanumericSenderParams,
|
|
4060
4055
|
};
|
package/src/resources/ai/ai.ts
CHANGED
|
@@ -4,13 +4,7 @@ import { APIResource } from '../../core/resource';
|
|
|
4
4
|
import * as AudioAPI from './audio';
|
|
5
5
|
import { Audio, AudioTranscribeParams, AudioTranscribeResponse } from './audio';
|
|
6
6
|
import * as ChatAPI from './chat';
|
|
7
|
-
import {
|
|
8
|
-
BucketIDs,
|
|
9
|
-
Chat,
|
|
10
|
-
ChatCompletionRequest,
|
|
11
|
-
ChatCreateCompletionParams,
|
|
12
|
-
ChatCreateCompletionResponse,
|
|
13
|
-
} from './chat';
|
|
7
|
+
import { BucketIDs, Chat, ChatCompletionRequest } from './chat';
|
|
14
8
|
import * as ClustersAPI from './clusters';
|
|
15
9
|
import {
|
|
16
10
|
ClusterComputeParams,
|
|
@@ -164,23 +158,6 @@ export class AI extends APIResource {
|
|
|
164
158
|
openai: OpenAIAPI.OpenAI = new OpenAIAPI.OpenAI(this._client);
|
|
165
159
|
tools: ToolsAPI.Tools = new ToolsAPI.Tools(this._client);
|
|
166
160
|
|
|
167
|
-
/**
|
|
168
|
-
* **Deprecated**: Use `GET /v2/ai/openai/models` instead.
|
|
169
|
-
*
|
|
170
|
-
* Returns the same `ModelsResponse` payload as the OpenAI-compatible endpoint —
|
|
171
|
-
* open-source LLMs hosted on Telnyx (e.g. `moonshotai/Kimi-K2.6`,
|
|
172
|
-
* `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`), embedding models, and
|
|
173
|
-
* fine-tuned models — kept around for backwards compatibility. New integrations
|
|
174
|
-
* should use `/v2/ai/openai/models`.
|
|
175
|
-
*
|
|
176
|
-
* Model ids follow the `{organization}/{model_name}` convention from Hugging Face.
|
|
177
|
-
*
|
|
178
|
-
* @deprecated
|
|
179
|
-
*/
|
|
180
|
-
retrieveModels(options?: RequestOptions): APIPromise<ModelsResponse> {
|
|
181
|
-
return this._client.get('/ai/models', options);
|
|
182
|
-
}
|
|
183
|
-
|
|
184
161
|
/**
|
|
185
162
|
* Generate a summary of a file's contents.
|
|
186
163
|
*
|
|
@@ -206,24 +183,6 @@ export class AI extends APIResource {
|
|
|
206
183
|
return this._client.post('/ai/summarize', { body, ...options });
|
|
207
184
|
}
|
|
208
185
|
|
|
209
|
-
/**
|
|
210
|
-
* **Deprecated**: Use `POST /v2/ai/openai/responses` instead. This endpoint is
|
|
211
|
-
* compatible with the
|
|
212
|
-
* [OpenAI Responses API](https://developers.openai.com/api/reference/responses/overview)
|
|
213
|
-
* and may be used with the OpenAI JS or Python SDK. Response id parameter is not
|
|
214
|
-
* supported at the moment. Use the `conversation` parameter with a Telnyx
|
|
215
|
-
* Conversation ID to leverage persistent conversations.
|
|
216
|
-
*
|
|
217
|
-
* @deprecated
|
|
218
|
-
*/
|
|
219
|
-
createResponseDeprecated(
|
|
220
|
-
params: AICreateResponseDeprecatedParams,
|
|
221
|
-
options?: RequestOptions,
|
|
222
|
-
): APIPromise<AICreateResponseDeprecatedResponse> {
|
|
223
|
-
const { response_request } = params;
|
|
224
|
-
return this._client.post('/ai/responses', { body: response_request, ...options });
|
|
225
|
-
}
|
|
226
|
-
|
|
227
186
|
/**
|
|
228
187
|
* Performs semantic vector search across conversation history records.
|
|
229
188
|
*
|
|
@@ -427,8 +386,6 @@ export interface ModelsResponse {
|
|
|
427
386
|
object?: string;
|
|
428
387
|
}
|
|
429
388
|
|
|
430
|
-
export type AICreateResponseDeprecatedResponse = { [key: string]: unknown };
|
|
431
|
-
|
|
432
389
|
/**
|
|
433
390
|
* Search response following the standard Telnyx V2 API format.
|
|
434
391
|
*/
|
|
@@ -569,10 +526,6 @@ export interface AISummarizeParams {
|
|
|
569
526
|
system_prompt?: string;
|
|
570
527
|
}
|
|
571
528
|
|
|
572
|
-
export interface AICreateResponseDeprecatedParams {
|
|
573
|
-
response_request: { [key: string]: unknown };
|
|
574
|
-
}
|
|
575
|
-
|
|
576
529
|
export interface AIRetrieveConversationHistoriesParams {
|
|
577
530
|
/**
|
|
578
531
|
* Natural language search query. The text is embedded into a 1024-dimensional
|
|
@@ -667,11 +620,9 @@ export declare namespace AI {
|
|
|
667
620
|
export {
|
|
668
621
|
type ModelMetadata as ModelMetadata,
|
|
669
622
|
type ModelsResponse as ModelsResponse,
|
|
670
|
-
type AICreateResponseDeprecatedResponse as AICreateResponseDeprecatedResponse,
|
|
671
623
|
type AIRetrieveConversationHistoriesResponse as AIRetrieveConversationHistoriesResponse,
|
|
672
624
|
type AISummarizeResponse as AISummarizeResponse,
|
|
673
625
|
type AISummarizeParams as AISummarizeParams,
|
|
674
|
-
type AICreateResponseDeprecatedParams as AICreateResponseDeprecatedParams,
|
|
675
626
|
type AIRetrieveConversationHistoriesParams as AIRetrieveConversationHistoriesParams,
|
|
676
627
|
};
|
|
677
628
|
|
|
@@ -739,13 +690,7 @@ export declare namespace AI {
|
|
|
739
690
|
type AudioTranscribeParams as AudioTranscribeParams,
|
|
740
691
|
};
|
|
741
692
|
|
|
742
|
-
export {
|
|
743
|
-
Chat as Chat,
|
|
744
|
-
type BucketIDs as BucketIDs,
|
|
745
|
-
type ChatCompletionRequest as ChatCompletionRequest,
|
|
746
|
-
type ChatCreateCompletionResponse as ChatCreateCompletionResponse,
|
|
747
|
-
type ChatCreateCompletionParams as ChatCreateCompletionParams,
|
|
748
|
-
};
|
|
693
|
+
export { Chat as Chat, type BucketIDs as BucketIDs, type ChatCompletionRequest as ChatCompletionRequest };
|
|
749
694
|
|
|
750
695
|
export {
|
|
751
696
|
Clusters as Clusters,
|
|
@@ -375,6 +375,7 @@ export interface AssistantMcpServer {
|
|
|
375
375
|
*/
|
|
376
376
|
export type AssistantTool =
|
|
377
377
|
| InferenceEmbeddingWebhookToolParams
|
|
378
|
+
| AssistantTool.ClientSideTool
|
|
378
379
|
| RetrievalTool
|
|
379
380
|
| AssistantTool.Handoff
|
|
380
381
|
| HangupTool
|
|
@@ -386,6 +387,54 @@ export type AssistantTool =
|
|
|
386
387
|
| AssistantTool.SkipTurn;
|
|
387
388
|
|
|
388
389
|
export namespace AssistantTool {
|
|
390
|
+
export interface ClientSideTool {
|
|
391
|
+
client_side_tool: ClientSideTool.ClientSideTool;
|
|
392
|
+
|
|
393
|
+
type: 'client_side_tool';
|
|
394
|
+
}
|
|
395
|
+
|
|
396
|
+
export namespace ClientSideTool {
|
|
397
|
+
export interface ClientSideTool {
|
|
398
|
+
/**
|
|
399
|
+
* The description of the tool.
|
|
400
|
+
*/
|
|
401
|
+
description: string;
|
|
402
|
+
|
|
403
|
+
/**
|
|
404
|
+
* The name of the tool.
|
|
405
|
+
*/
|
|
406
|
+
name: string;
|
|
407
|
+
|
|
408
|
+
/**
|
|
409
|
+
* The parameters the tool accepts, described as a JSON Schema object. See the
|
|
410
|
+
* [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
|
|
411
|
+
* documentation about the format
|
|
412
|
+
*/
|
|
413
|
+
parameters: ClientSideTool.Parameters;
|
|
414
|
+
}
|
|
415
|
+
|
|
416
|
+
export namespace ClientSideTool {
|
|
417
|
+
/**
|
|
418
|
+
* The parameters the tool accepts, described as a JSON Schema object. See the
|
|
419
|
+
* [JSON Schema reference](https://json-schema.org/understanding-json-schema) for
|
|
420
|
+
* documentation about the format
|
|
421
|
+
*/
|
|
422
|
+
export interface Parameters {
|
|
423
|
+
/**
|
|
424
|
+
* The properties of the parameters.
|
|
425
|
+
*/
|
|
426
|
+
properties?: { [key: string]: unknown };
|
|
427
|
+
|
|
428
|
+
/**
|
|
429
|
+
* The required properties of the parameters.
|
|
430
|
+
*/
|
|
431
|
+
required?: Array<string>;
|
|
432
|
+
|
|
433
|
+
type?: 'object';
|
|
434
|
+
}
|
|
435
|
+
}
|
|
436
|
+
}
|
|
437
|
+
|
|
389
438
|
/**
|
|
390
439
|
* The handoff tool allows the assistant to hand off control of the conversation to
|
|
391
440
|
* another AI assistant. By default, this will happen transparently to the end
|
package/src/resources/ai/chat.ts
CHANGED
|
@@ -2,28 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
import { APIResource } from '../../core/resource';
|
|
4
4
|
import * as ChatAPI from './chat';
|
|
5
|
-
import { APIPromise } from '../../core/api-promise';
|
|
6
|
-
import { RequestOptions } from '../../internal/request-options';
|
|
7
5
|
|
|
8
|
-
|
|
9
|
-
* Generate text with LLMs
|
|
10
|
-
*/
|
|
11
|
-
export class Chat extends APIResource {
|
|
12
|
-
/**
|
|
13
|
-
* **Deprecated**: Use `POST /v2/ai/openai/chat/completions` instead. Chat with a
|
|
14
|
-
* language model. This endpoint is consistent with the
|
|
15
|
-
* [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat)
|
|
16
|
-
* and may be used with the OpenAI JS or Python SDK.
|
|
17
|
-
*
|
|
18
|
-
* @deprecated
|
|
19
|
-
*/
|
|
20
|
-
createCompletion(
|
|
21
|
-
body: ChatCreateCompletionParams,
|
|
22
|
-
options?: RequestOptions,
|
|
23
|
-
): APIPromise<ChatCreateCompletionResponse> {
|
|
24
|
-
return this._client.post('/ai/chat/completions', { body, ...options });
|
|
25
|
-
}
|
|
26
|
-
}
|
|
6
|
+
export class Chat extends APIResource {}
|
|
27
7
|
|
|
28
8
|
export interface BucketIDs {
|
|
29
9
|
/**
|
|
@@ -244,218 +224,6 @@ export namespace ChatCompletionRequest {
|
|
|
244
224
|
}
|
|
245
225
|
}
|
|
246
226
|
|
|
247
|
-
export type ChatCreateCompletionResponse = { [key: string]: unknown };
|
|
248
|
-
|
|
249
|
-
export interface ChatCreateCompletionParams {
|
|
250
|
-
/**
|
|
251
|
-
* A list of the previous chat messages for context.
|
|
252
|
-
*/
|
|
253
|
-
messages: Array<ChatCreateCompletionParams.Message>;
|
|
254
|
-
|
|
255
|
-
/**
|
|
256
|
-
* If you are using an external inference provider like xAI or OpenAI, this field
|
|
257
|
-
* allows you to pass along a reference to your API key. After creating an
|
|
258
|
-
* [integration secret](https://developers.telnyx.com/api-reference/integration-secrets/create-a-secret)
|
|
259
|
-
* for you API key, pass the secret's `identifier` in this field.
|
|
260
|
-
*/
|
|
261
|
-
api_key_ref?: string;
|
|
262
|
-
|
|
263
|
-
/**
|
|
264
|
-
* This is used with `use_beam_search` to determine how many candidate beams to
|
|
265
|
-
* explore.
|
|
266
|
-
*/
|
|
267
|
-
best_of?: number;
|
|
268
|
-
|
|
269
|
-
/**
|
|
270
|
-
* This is used with `use_beam_search`. If `true`, generation stops as soon as
|
|
271
|
-
* there are `best_of` complete candidates; if `false`, a heuristic is applied and
|
|
272
|
-
* the generation stops when is it very unlikely to find better candidates.
|
|
273
|
-
*/
|
|
274
|
-
early_stopping?: boolean;
|
|
275
|
-
|
|
276
|
-
/**
|
|
277
|
-
* Whether to enable the thinking/reasoning phase for models that support it (e.g.,
|
|
278
|
-
* QwQ, Qwen3). When set to false, the model will skip the internal reasoning step
|
|
279
|
-
* and respond directly, which can reduce latency. Defaults to true.
|
|
280
|
-
*/
|
|
281
|
-
enable_thinking?: boolean;
|
|
282
|
-
|
|
283
|
-
/**
|
|
284
|
-
* Higher values will penalize the model from repeating the same output tokens.
|
|
285
|
-
*/
|
|
286
|
-
frequency_penalty?: number;
|
|
287
|
-
|
|
288
|
-
/**
|
|
289
|
-
* If specified, the output will be exactly one of the choices.
|
|
290
|
-
*/
|
|
291
|
-
guided_choice?: Array<string>;
|
|
292
|
-
|
|
293
|
-
/**
|
|
294
|
-
* Must be a valid JSON schema. If specified, the output will follow the JSON
|
|
295
|
-
* schema.
|
|
296
|
-
*/
|
|
297
|
-
guided_json?: { [key: string]: unknown };
|
|
298
|
-
|
|
299
|
-
/**
|
|
300
|
-
* If specified, the output will follow the regex pattern.
|
|
301
|
-
*/
|
|
302
|
-
guided_regex?: string;
|
|
303
|
-
|
|
304
|
-
/**
|
|
305
|
-
* This is used with `use_beam_search` to prefer shorter or longer completions.
|
|
306
|
-
*/
|
|
307
|
-
length_penalty?: number;
|
|
308
|
-
|
|
309
|
-
/**
|
|
310
|
-
* Whether to return log probabilities of the output tokens or not. If true,
|
|
311
|
-
* returns the log probabilities of each output token returned in the `content` of
|
|
312
|
-
* `message`.
|
|
313
|
-
*/
|
|
314
|
-
logprobs?: boolean;
|
|
315
|
-
|
|
316
|
-
/**
|
|
317
|
-
* Maximum number of completion tokens the model should generate.
|
|
318
|
-
*/
|
|
319
|
-
max_tokens?: number;
|
|
320
|
-
|
|
321
|
-
/**
|
|
322
|
-
* This is an alternative to `top_p` that
|
|
323
|
-
* [many prefer](https://github.com/huggingface/transformers/issues/27670). Must be
|
|
324
|
-
* in [0, 1].
|
|
325
|
-
*/
|
|
326
|
-
min_p?: number;
|
|
327
|
-
|
|
328
|
-
/**
|
|
329
|
-
* The language model to chat with.
|
|
330
|
-
*/
|
|
331
|
-
model?: string;
|
|
332
|
-
|
|
333
|
-
/**
|
|
334
|
-
* This will return multiple choices for you instead of a single chat completion.
|
|
335
|
-
*/
|
|
336
|
-
n?: number;
|
|
337
|
-
|
|
338
|
-
/**
|
|
339
|
-
* Higher values will penalize the model from repeating the same output tokens.
|
|
340
|
-
*/
|
|
341
|
-
presence_penalty?: number;
|
|
342
|
-
|
|
343
|
-
/**
|
|
344
|
-
* Use this is you want to guarantee a JSON output without defining a schema. For
|
|
345
|
-
* control over the schema, use `guided_json`.
|
|
346
|
-
*/
|
|
347
|
-
response_format?: ChatCreateCompletionParams.ResponseFormat;
|
|
348
|
-
|
|
349
|
-
/**
|
|
350
|
-
* If specified, the system will make a best effort to sample deterministically,
|
|
351
|
-
* such that repeated requests with the same `seed` and parameters should return
|
|
352
|
-
* the same result.
|
|
353
|
-
*/
|
|
354
|
-
seed?: number;
|
|
355
|
-
|
|
356
|
-
/**
|
|
357
|
-
* Up to 4 sequences where the API will stop generating further tokens. The
|
|
358
|
-
* returned text will not contain the stop sequence.
|
|
359
|
-
*/
|
|
360
|
-
stop?: string | Array<string>;
|
|
361
|
-
|
|
362
|
-
/**
|
|
363
|
-
* Whether or not to stream data-only server-sent events as they become available.
|
|
364
|
-
*/
|
|
365
|
-
stream?: boolean;
|
|
366
|
-
|
|
367
|
-
/**
|
|
368
|
-
* Adjusts the "creativity" of the model. Lower values make the model more
|
|
369
|
-
* deterministic and repetitive, while higher values make the model more random and
|
|
370
|
-
* creative.
|
|
371
|
-
*/
|
|
372
|
-
temperature?: number;
|
|
373
|
-
|
|
374
|
-
tool_choice?: 'none' | 'auto' | 'required';
|
|
375
|
-
|
|
376
|
-
/**
|
|
377
|
-
* The `function` tool type follows the same schema as the
|
|
378
|
-
* [OpenAI Chat Completions API](https://platform.openai.com/docs/api-reference/chat).
|
|
379
|
-
* The `retrieval` tool type is unique to Telnyx. You may pass a list of
|
|
380
|
-
* [embedded storage buckets](https://developers.telnyx.com/api-reference/embeddings/embed-documents)
|
|
381
|
-
* for retrieval-augmented generation.
|
|
382
|
-
*/
|
|
383
|
-
tools?: Array<ChatCreateCompletionParams.Function | ChatCreateCompletionParams.Retrieval>;
|
|
384
|
-
|
|
385
|
-
/**
|
|
386
|
-
* This is used with `logprobs`. An integer between 0 and 20 specifying the number
|
|
387
|
-
* of most likely tokens to return at each token position, each with an associated
|
|
388
|
-
* log probability.
|
|
389
|
-
*/
|
|
390
|
-
top_logprobs?: number;
|
|
391
|
-
|
|
392
|
-
/**
|
|
393
|
-
* An alternative or complement to `temperature`. This adjusts how many of the top
|
|
394
|
-
* possibilities to consider.
|
|
395
|
-
*/
|
|
396
|
-
top_p?: number;
|
|
397
|
-
|
|
398
|
-
/**
|
|
399
|
-
* Setting this to `true` will allow the model to
|
|
400
|
-
* [explore more completion options](https://huggingface.co/blog/how-to-generate#beam-search).
|
|
401
|
-
* This is not supported by OpenAI.
|
|
402
|
-
*/
|
|
403
|
-
use_beam_search?: boolean;
|
|
404
|
-
}
|
|
405
|
-
|
|
406
|
-
export namespace ChatCreateCompletionParams {
|
|
407
|
-
export interface Message {
|
|
408
|
-
content: string | Array<Message.TextAndImageArray>;
|
|
409
|
-
|
|
410
|
-
role: 'system' | 'user' | 'assistant' | 'tool';
|
|
411
|
-
}
|
|
412
|
-
|
|
413
|
-
export namespace Message {
|
|
414
|
-
export interface TextAndImageArray {
|
|
415
|
-
type: 'text' | 'image_url';
|
|
416
|
-
|
|
417
|
-
image_url?: string;
|
|
418
|
-
|
|
419
|
-
text?: string;
|
|
420
|
-
}
|
|
421
|
-
}
|
|
422
|
-
|
|
423
|
-
/**
|
|
424
|
-
* Use this is you want to guarantee a JSON output without defining a schema. For
|
|
425
|
-
* control over the schema, use `guided_json`.
|
|
426
|
-
*/
|
|
427
|
-
export interface ResponseFormat {
|
|
428
|
-
type: 'text' | 'json_object';
|
|
429
|
-
}
|
|
430
|
-
|
|
431
|
-
export interface Function {
|
|
432
|
-
function: Function.Function;
|
|
433
|
-
|
|
434
|
-
type: 'function';
|
|
435
|
-
}
|
|
436
|
-
|
|
437
|
-
export namespace Function {
|
|
438
|
-
export interface Function {
|
|
439
|
-
name: string;
|
|
440
|
-
|
|
441
|
-
description?: string;
|
|
442
|
-
|
|
443
|
-
parameters?: { [key: string]: unknown };
|
|
444
|
-
}
|
|
445
|
-
}
|
|
446
|
-
|
|
447
|
-
export interface Retrieval {
|
|
448
|
-
retrieval: ChatAPI.BucketIDs;
|
|
449
|
-
|
|
450
|
-
type: 'retrieval';
|
|
451
|
-
}
|
|
452
|
-
}
|
|
453
|
-
|
|
454
227
|
export declare namespace Chat {
|
|
455
|
-
export {
|
|
456
|
-
type BucketIDs as BucketIDs,
|
|
457
|
-
type ChatCompletionRequest as ChatCompletionRequest,
|
|
458
|
-
type ChatCreateCompletionResponse as ChatCreateCompletionResponse,
|
|
459
|
-
type ChatCreateCompletionParams as ChatCreateCompletionParams,
|
|
460
|
-
};
|
|
228
|
+
export { type BucketIDs as BucketIDs, type ChatCompletionRequest as ChatCompletionRequest };
|
|
461
229
|
}
|
|
@@ -4,11 +4,9 @@ export {
|
|
|
4
4
|
AI,
|
|
5
5
|
type ModelMetadata,
|
|
6
6
|
type ModelsResponse,
|
|
7
|
-
type AICreateResponseDeprecatedResponse,
|
|
8
7
|
type AIRetrieveConversationHistoriesResponse,
|
|
9
8
|
type AISummarizeResponse,
|
|
10
9
|
type AISummarizeParams,
|
|
11
|
-
type AICreateResponseDeprecatedParams,
|
|
12
10
|
type AIRetrieveConversationHistoriesParams,
|
|
13
11
|
} from './ai';
|
|
14
12
|
export {
|
|
@@ -69,13 +67,7 @@ export {
|
|
|
69
67
|
type AssistantSendSMSParams,
|
|
70
68
|
} from './assistants/index';
|
|
71
69
|
export { Audio, type AudioTranscribeResponse, type AudioTranscribeParams } from './audio';
|
|
72
|
-
export {
|
|
73
|
-
Chat,
|
|
74
|
-
type BucketIDs,
|
|
75
|
-
type ChatCompletionRequest,
|
|
76
|
-
type ChatCreateCompletionResponse,
|
|
77
|
-
type ChatCreateCompletionParams,
|
|
78
|
-
} from './chat';
|
|
70
|
+
export { Chat, type BucketIDs, type ChatCompletionRequest } from './chat';
|
|
79
71
|
export {
|
|
80
72
|
Clusters,
|
|
81
73
|
type RecursiveCluster,
|
|
@@ -122,6 +122,8 @@ export interface ToolCreateParams {
|
|
|
122
122
|
|
|
123
123
|
type: string;
|
|
124
124
|
|
|
125
|
+
client_side_tool?: { [key: string]: unknown };
|
|
126
|
+
|
|
125
127
|
function?: { [key: string]: unknown };
|
|
126
128
|
|
|
127
129
|
handoff?: { [key: string]: unknown };
|
|
@@ -138,6 +140,8 @@ export interface ToolCreateParams {
|
|
|
138
140
|
}
|
|
139
141
|
|
|
140
142
|
export interface ToolUpdateParams {
|
|
143
|
+
client_side_tool?: { [key: string]: unknown };
|
|
144
|
+
|
|
141
145
|
display_name?: string;
|
|
142
146
|
|
|
143
147
|
function?: { [key: string]: unknown };
|
|
@@ -1546,7 +1546,8 @@ export interface TelnyxVoiceSettings {
|
|
|
1546
1546
|
|
|
1547
1547
|
/**
|
|
1548
1548
|
* The voice speed to be used for the voice. The voice speed must be between 0.1
|
|
1549
|
-
* and 2.0. Default value is 1.0.
|
|
1549
|
+
* and 2.0. Default value is 1.0. Not supported for `Telnyx.Bayan.*` or
|
|
1550
|
+
* `Telnyx.Sukhan.*` voices.
|
|
1550
1551
|
*/
|
|
1551
1552
|
voice_speed?: number;
|
|
1552
1553
|
}
|
|
@@ -2420,6 +2421,9 @@ export interface ActionStartAIAssistantParams {
|
|
|
2420
2421
|
* - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
2421
2422
|
* `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
2422
2423
|
* `Max`, `TTS2`.
|
|
2424
|
+
* - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
2425
|
+
* `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
2426
|
+
* `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
2423
2427
|
* - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
2424
2428
|
* `ara`, `rex`, `sal`, `leo`.
|
|
2425
2429
|
*/
|
|
@@ -3129,6 +3133,9 @@ export interface ActionGatherUsingAIParams {
|
|
|
3129
3133
|
* - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
3130
3134
|
* `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
3131
3135
|
* `Max`, `TTS2`.
|
|
3136
|
+
* - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
3137
|
+
* `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
3138
|
+
* `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
3132
3139
|
* - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
3133
3140
|
* `ara`, `rex`, `sal`, `leo`.
|
|
3134
3141
|
*/
|
|
@@ -3279,6 +3286,9 @@ export interface ActionGatherUsingSpeakParams {
|
|
|
3279
3286
|
* [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
|
|
3280
3287
|
* - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
|
|
3281
3288
|
* Use `voice_settings` to configure voice_speed and other synthesis parameters.
|
|
3289
|
+
* `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
|
|
3290
|
+
* `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
|
|
3291
|
+
* (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
|
|
3282
3292
|
* - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
|
|
3283
3293
|
* `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
|
|
3284
3294
|
* `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
|
|
@@ -3293,6 +3303,9 @@ export interface ActionGatherUsingSpeakParams {
|
|
|
3293
3303
|
* `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
3294
3304
|
* `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
|
|
3295
3305
|
* `BALANCED`, `CREATIVE`), supported by `TTS2` only.
|
|
3306
|
+
* - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
3307
|
+
* `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
3308
|
+
* `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
3296
3309
|
* - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
3297
3310
|
* `ara`, `rex`, `sal`, `leo`.
|
|
3298
3311
|
*
|
|
@@ -4162,6 +4175,9 @@ export interface ActionSpeakParams {
|
|
|
4162
4175
|
* [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
|
|
4163
4176
|
* - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
|
|
4164
4177
|
* Use `voice_settings` to configure voice_speed and other synthesis parameters.
|
|
4178
|
+
* `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
|
|
4179
|
+
* `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
|
|
4180
|
+
* (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
|
|
4165
4181
|
* - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
|
|
4166
4182
|
* `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
|
|
4167
4183
|
* `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
|
|
@@ -4176,6 +4192,9 @@ export interface ActionSpeakParams {
|
|
|
4176
4192
|
* `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
4177
4193
|
* `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
|
|
4178
4194
|
* `BALANCED`, `CREATIVE`), supported by `TTS2` only.
|
|
4195
|
+
* - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
4196
|
+
* `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
4197
|
+
* `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
4179
4198
|
* - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
4180
4199
|
* `ara`, `rex`, `sal`, `leo`.
|
|
4181
4200
|
*
|
|
@@ -5122,6 +5141,9 @@ export interface ActionStartConversationRelayParams {
|
|
|
5122
5141
|
* - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
5123
5142
|
* `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
5124
5143
|
* `Max`, `TTS2`.
|
|
5144
|
+
* - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
5145
|
+
* `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
5146
|
+
* `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
5125
5147
|
* - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
5126
5148
|
* `ara`, `rex`, `sal`, `leo`.
|
|
5127
5149
|
*/
|
|
@@ -525,6 +525,9 @@ export interface ConversationRelayEmbeddedConfig {
|
|
|
525
525
|
* - **Inworld:** Use `Inworld.<ModelId>.<VoiceId>` (e.g., `Inworld.Mini.Loretta`,
|
|
526
526
|
* `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
527
527
|
* `Max`, `TTS2`.
|
|
528
|
+
* - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
529
|
+
* `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
530
|
+
* `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
528
531
|
* - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
529
532
|
* `ara`, `rex`, `sal`, `leo`.
|
|
530
533
|
*/
|
|
@@ -778,6 +778,9 @@ export interface ActionSpeakParams {
|
|
|
778
778
|
* [available voices](https://elevenlabs.io/docs/api-reference/get-voices).
|
|
779
779
|
* - **Telnyx:** Use `Telnyx.<model_id>.<voice_id>` (e.g., `Telnyx.KokoroTTS.af`).
|
|
780
780
|
* Use `voice_settings` to configure voice_speed and other synthesis parameters.
|
|
781
|
+
* `Bayan` provides Arabic (multiple dialects) and English voices (e.g.,
|
|
782
|
+
* `Telnyx.Bayan.Ahmed`, `Telnyx.Bayan.Amanda`). `Sukhan` provides Urdu voices
|
|
783
|
+
* (e.g., `Telnyx.Sukhan.urdu-professor`); `voice_speed` is not supported.
|
|
781
784
|
* - **Minimax:** Use `Minimax.<ModelId>.<VoiceId>` (e.g.,
|
|
782
785
|
* `Minimax.speech-02-hd.Wise_Woman`). Supported models: `speech-02-turbo`,
|
|
783
786
|
* `speech-02-hd`, `speech-2.6-turbo`, `speech-2.8-turbo`. Use `voice_settings`
|
|
@@ -792,6 +795,9 @@ export interface ActionSpeakParams {
|
|
|
792
795
|
* `Inworld.Max.Oliver`, `Inworld.TTS2.Loretta`). Supported models: `Mini`,
|
|
793
796
|
* `Max`, `TTS2`. Use `voice_settings` to configure `delivery_mode` (`STABLE`,
|
|
794
797
|
* `BALANCED`, `CREATIVE`), supported by `TTS2` only.
|
|
798
|
+
* - **Fish Audio:** Use `FishAudio.<ModelId>.<VoiceId>` (e.g.,
|
|
799
|
+
* `FishAudio.s2.1-pro.<reference_id>`). Supported models: `s2.1-pro`, `s2-pro`,
|
|
800
|
+
* `s1`. `VoiceId` is a Fish Voice-Library reference ID.
|
|
795
801
|
* - **xAI:** Use `xAI.<VoiceId>` (e.g., `xAI.eve`). Available voices: `eve`,
|
|
796
802
|
* `ara`, `rex`, `sal`, `leo`.
|
|
797
803
|
*
|
package/src/resources/index.ts
CHANGED
|
@@ -5,11 +5,9 @@ export {
|
|
|
5
5
|
AI,
|
|
6
6
|
type ModelMetadata,
|
|
7
7
|
type ModelsResponse,
|
|
8
|
-
type AICreateResponseDeprecatedResponse,
|
|
9
8
|
type AIRetrieveConversationHistoriesResponse,
|
|
10
9
|
type AISummarizeResponse,
|
|
11
10
|
type AISummarizeParams,
|
|
12
|
-
type AICreateResponseDeprecatedParams,
|
|
13
11
|
type AIRetrieveConversationHistoriesParams,
|
|
14
12
|
} from './ai/ai';
|
|
15
13
|
export {
|
|
@@ -593,14 +591,12 @@ export {
|
|
|
593
591
|
type MessageSendLongCodeResponse,
|
|
594
592
|
type MessageSendNumberPoolResponse,
|
|
595
593
|
type MessageSendShortCodeResponse,
|
|
596
|
-
type MessageSendWhatsappResponse,
|
|
597
594
|
type MessageSendWithAlphanumericSenderResponse,
|
|
598
595
|
type MessageSendParams,
|
|
599
596
|
type MessageSendLongCodeParams,
|
|
600
597
|
type MessageSendNumberPoolParams,
|
|
601
598
|
type MessageSendShortCodeParams,
|
|
602
599
|
type MessageSendGroupMmsParams,
|
|
603
|
-
type MessageSendWhatsappParams,
|
|
604
600
|
type MessageScheduleParams,
|
|
605
601
|
type MessageSendWithAlphanumericSenderParams,
|
|
606
602
|
} from './messages/messages';
|
|
@@ -23,14 +23,12 @@ export {
|
|
|
23
23
|
type MessageSendLongCodeResponse,
|
|
24
24
|
type MessageSendNumberPoolResponse,
|
|
25
25
|
type MessageSendShortCodeResponse,
|
|
26
|
-
type MessageSendWhatsappResponse,
|
|
27
26
|
type MessageSendWithAlphanumericSenderResponse,
|
|
28
27
|
type MessageSendParams,
|
|
29
28
|
type MessageSendLongCodeParams,
|
|
30
29
|
type MessageSendNumberPoolParams,
|
|
31
30
|
type MessageSendShortCodeParams,
|
|
32
31
|
type MessageSendGroupMmsParams,
|
|
33
|
-
type MessageSendWhatsappParams,
|
|
34
32
|
type MessageScheduleParams,
|
|
35
33
|
type MessageSendWithAlphanumericSenderParams,
|
|
36
34
|
} from './messages';
|