telnyx 7.2.0 → 7.5.0

package/src/resources/ai/ai.ts

@@ -164,6 +164,48 @@ export class AI extends APIResource {
   openai: OpenAIAPI.OpenAI = new OpenAIAPI.OpenAI(this._client);
   tools: ToolsAPI.Tools = new ToolsAPI.Tools(this._client);
 
+  /**
+   * **Deprecated**: Use `GET /v2/ai/openai/models` instead.
+   *
+   * Returns the same `ModelsResponse` payload as the OpenAI-compatible endpoint —
+   * open-source LLMs hosted on Telnyx (e.g. `moonshotai/Kimi-K2.6`,
+   * `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`), embedding models, and
+   * fine-tuned models — kept around for backwards compatibility. New integrations
+   * should use `/v2/ai/openai/models`.
+   *
+   * Model ids follow the `{organization}/{model_name}` convention from Hugging Face.
+   *
+   * @deprecated
+   */
+  retrieveModels(options?: RequestOptions): APIPromise<ModelsResponse> {
+    return this._client.get('/ai/models', options);
+  }
+
+  /**
+   * Generate a summary of a file's contents.
+   *
+   * Supports the following text formats:
+   *
+   * - PDF, HTML, txt, json, csv
+   *
+   * Supports the following media formats (billed for both the transcription and
+   * summary):
+   *
+   * - flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm
+   * - Up to 100 MB
+   *
+   * @example
+   * ```ts
+   * const response = await client.ai.summarize({
+   *   bucket: 'bucket',
+   *   filename: 'filename',
+   * });
+   * ```
+   */
+  summarize(body: AISummarizeParams, options?: RequestOptions): APIPromise<AISummarizeResponse> {
+    return this._client.post('/ai/summarize', { body, ...options });
+  }
+
   /**
    * **Deprecated**: Use `POST /v2/ai/openai/responses` instead. This endpoint is
    * compatible with the
@@ -189,12 +231,12 @@ export class AI extends APIResource {
    *
    * 1. The query text is embedded into a 1024-dimensional vector using the
    *    multilingual-e5-large model.
-   * 2. The vector is sent to regional OpenSearch clusters for kNN search using HNSW
-   *    cosine similarity.
+   * 2. The vector is compared against indexed record chunks using semantic
+   *    similarity search.
    * 3. When no region is specified, all regions are queried in parallel (fan-out)
    *    and results are merged by score.
-   * 4. Results are ranked by cosine similarity score (descending) and truncated to
-   *    `top_k`.
+   * 4. Results are ranked by similarity score (descending) and paginated via
+   *    `page[number]` / `page[size]`.
    *
    * **Authentication:** Requires a Telnyx API key via `Authorization: Bearer <key>`.
    * Results are automatically scoped to the caller's organization —
@@ -208,14 +250,14 @@ export class AI extends APIResource {
    * **Filtering:** Use `filter[field][operator]=value` query parameters to narrow
    * results before vector search.
    *
-   * Top-level filterable fields: `user_id`, `record_type`, `region`, `document_id`,
-   * `record_id`, `record_created_at`, `ingested_at`, `retention`
+   * Top-level filterable fields: `user_id`, `region`, `record_id`,
+   * `record_created_at`, `ingested_at`, `retention`
    *
    * Note: `retention` is filter-only — it can be used to narrow results but is not
    * returned in the response body.
    *
    * Metadata fields: any field not in the list above is resolved to
-   * `data.metadata.<field>` in OpenSearch (e.g., `filter[language]=en` →
+   * `data.metadata.<field>` (e.g., `filter[language]=en` →
    * `data.metadata.language`).
    *
    * Supported filter operators:
@@ -228,11 +270,11 @@ export class AI extends APIResource {
    * **Examples:**
    *
    * ```
-   * GET /v2/ai/conversation_histories?q=billing+issue&record_type=voice&top_k=10
-   * GET /v2/ai/conversation_histories?q=setup+guide&record_type=knowledge_base&region=USA&min_score=0.5
-   * GET /v2/ai/conversation_histories?q=refund&record_type=voice&filter[record_created_at][gte]=2026-01-01T00:00:00Z
-   * GET /v2/ai/conversation_histories?q=outage&record_type=voice&filter[region][in]=USA,DEU
-   * GET /v2/ai/conversation_histories?q=hold+time&record_type=voice&filter[language]=en
+   * GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10
+   * GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5
+   * GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z
+   * GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU
+   * GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en
    * ```
    *
    * @example
@@ -240,7 +282,6 @@ export class AI extends APIResource {
    * const response =
    *   await client.ai.retrieveConversationHistories({
    *     q: 'customer called about billing issue',
-   *     record_type: 'voice',
    *   });
    * ```
    */
@@ -250,48 +291,6 @@ export class AI extends APIResource {
   ): APIPromise<AIRetrieveConversationHistoriesResponse> {
     return this._client.get('/ai/conversation_histories', { query, ...options });
   }
-
-  /**
-   * **Deprecated**: Use `GET /v2/ai/openai/models` instead.
-   *
-   * Returns the same `ModelsResponse` payload as the OpenAI-compatible endpoint —
-   * open-source LLMs hosted on Telnyx (e.g. `moonshotai/Kimi-K2.6`,
-   * `zai-org/GLM-5.1-FP8`, `MiniMaxAI/MiniMax-M2.7`), embedding models, and
-   * fine-tuned models — kept around for backwards compatibility. New integrations
-   * should use `/v2/ai/openai/models`.
-   *
-   * Model ids follow the `{organization}/{model_name}` convention from Hugging Face.
-   *
-   * @deprecated
-   */
-  retrieveModels(options?: RequestOptions): APIPromise<ModelsResponse> {
-    return this._client.get('/ai/models', options);
-  }
-
-  /**
-   * Generate a summary of a file's contents.
-   *
-   * Supports the following text formats:
-   *
-   * - PDF, HTML, txt, json, csv
-   *
-   * Supports the following media formats (billed for both the transcription and
-   * summary):
-   *
-   * - flac, mp3, mp4, mpeg, mpga, m4a, ogg, wav, or webm
-   * - Up to 100 MB
-   *
-   * @example
-   * ```ts
-   * const response = await client.ai.summarize({
-   *   bucket: 'bucket',
-   *   filename: 'filename',
-   * });
-   * ```
-   */
-  summarize(body: AISummarizeParams, options?: RequestOptions): APIPromise<AISummarizeResponse> {
-    return this._client.post('/ai/summarize', { body, ...options });
-  }
 }
 
 /**
@@ -468,12 +467,6 @@ export namespace AIRetrieveConversationHistoriesResponse {
      */
     chunk_total: number;
 
-    /**
-     * Document identifier. Present only for knowledge_base records; null for all other
-     * record types.
-     */
-    document_id: string | null;
-
     /**
      * When the record was chunked, embedded, and indexed (ISO 8601).
      */
@@ -495,11 +488,6 @@ export namespace AIRetrieveConversationHistoriesResponse {
      */
     record_id: string;
 
-    /**
-     * Type of the record.
-     */
-    record_type: 'voice' | 'message' | 'ai_pipeline_storage' | 'knowledge_base';
-
     /**
      * The region where this record is stored.
      */
@@ -522,9 +510,8 @@ export namespace AIRetrieveConversationHistoriesResponse {
     user_id: string;
 
     /**
-     * Arbitrary metadata attached to the record at ingestion time. Stored as a
-     * flat_object in OpenSearch and filterable via filter[field]=value query
-     * parameters.
+     * Arbitrary metadata attached to the record at ingestion time. Filterable via
+     * filter[field]=value query parameters.
      */
     metadata?: { [key: string]: unknown };
   }
@@ -534,13 +521,12 @@ export namespace AIRetrieveConversationHistoriesResponse {
    */
   export interface Meta {
     /**
-     * Current page number (always 1 — this API does not support pagination, use top_k
-     * instead).
+     * Current page number (1-based), matching the requested page[number].
      */
     page_number: number;
 
     /**
-     * Number of results per page (equals the effective top_k value).
+     * Number of results per page, matching the requested page[size].
      */
     page_size: number;
 
@@ -550,8 +536,7 @@ export namespace AIRetrieveConversationHistoriesResponse {
     total_pages: number;
 
     /**
-     * Total number of matching results across all queried regions (before top_k
-     * truncation).
+     * Total number of matching results across all queried regions.
      */
     total_results: number;
   }
@@ -567,28 +552,33 @@ export namespace AISummarizeResponse {
   }
 }
 
-export interface AICreateResponseDeprecatedParams {
-  response_request: { [key: string]: unknown };
-}
+export interface AISummarizeParams {
+  /**
+   * The name of the bucket that contains the file to be summarized.
+   */
+  bucket: string;
 
-export interface AIRetrieveConversationHistoriesParams {
   /**
-   * Natural language search query. The text is embedded into a 1024-dimensional
-   * vector and compared against indexed record chunks using kNN cosine similarity.
+   * The name of the file to be summarized.
    */
-  q: string;
+  filename: string;
 
   /**
-   * The type of records to search. Each record type is stored in a separate vector
-   * index.
+   * A system prompt to guide the summary generation.
    */
-  record_type: 'voice' | 'message' | 'ai_pipeline_storage' | 'knowledge_base';
+  system_prompt?: string;
+}
+
+export interface AICreateResponseDeprecatedParams {
+  response_request: { [key: string]: unknown };
+}
 
+export interface AIRetrieveConversationHistoriesParams {
   /**
-   * Filter by document identifier (exact match). Populated for knowledge_base
-   * records.
+   * Natural language search query. The text is embedded into a 1024-dimensional
+   * vector and compared against indexed record chunks using semantic similarity.
    */
-  'filter[document_id]'?: string;
+  q: string;
 
   /**
    * Only include records ingested (chunked, embedded, and indexed) on or after this
@@ -644,33 +634,20 @@ export interface AIRetrieveConversationHistoriesParams {
   min_score?: number;
 
   /**
-   * Restrict search to a specific region's OpenSearch cluster. When omitted, all
-   * regions are queried in parallel (fan-out) and results are merged by cosine
-   * similarity score.
-   */
-  region?: 'USA' | 'DEU' | 'AUS' | 'UAE';
-
-  /**
-   * Maximum number of results to return. Defaults to 20, maximum 100.
-   */
-  top_k?: number;
-}
-
-export interface AISummarizeParams {
-  /**
-   * The name of the bucket that contains the file to be summarized.
+   * Page number to return (1-based). Defaults to 1.
    */
-  bucket: string;
+  'page[number]'?: number;
 
   /**
-   * The name of the file to be summarized.
+   * Number of results per page. Defaults to 20, maximum 100.
    */
-  filename: string;
+  'page[size]'?: number;
 
   /**
-   * A system prompt to guide the summary generation.
+   * Restrict search to a specific region. When omitted, all regions are queried in
+   * parallel (fan-out) and results are merged by similarity score.
    */
-  system_prompt?: string;
+  region?: 'USA' | 'DEU' | 'AUS' | 'UAE';
 }
 
 AI.Assistants = Assistants;
@@ -693,9 +670,9 @@ export declare namespace AI {
     type AICreateResponseDeprecatedResponse as AICreateResponseDeprecatedResponse,
     type AIRetrieveConversationHistoriesResponse as AIRetrieveConversationHistoriesResponse,
     type AISummarizeResponse as AISummarizeResponse,
+    type AISummarizeParams as AISummarizeParams,
     type AICreateResponseDeprecatedParams as AICreateResponseDeprecatedParams,
     type AIRetrieveConversationHistoriesParams as AIRetrieveConversationHistoriesParams,
-    type AISummarizeParams as AISummarizeParams,
   };
 
   export {
@@ -749,10 +726,10 @@ export declare namespace AI {
     type AssistantGetTexmlResponse as AssistantGetTexmlResponse,
     type AssistantSendSMSResponse as AssistantSendSMSResponse,
     type AssistantCreateParams as AssistantCreateParams,
+    type AssistantImportsParams as AssistantImportsParams,
     type AssistantRetrieveParams as AssistantRetrieveParams,
     type AssistantUpdateParams as AssistantUpdateParams,
     type AssistantChatParams as AssistantChatParams,
-    type AssistantImportsParams as AssistantImportsParams,
     type AssistantSendSMSParams as AssistantSendSMSParams,
   };
 
@@ -777,9 +754,9 @@ export declare namespace AI {
     type ClusterListResponse as ClusterListResponse,
     type ClusterComputeResponse as ClusterComputeResponse,
     type ClusterListResponsesDefaultFlatPagination as ClusterListResponsesDefaultFlatPagination,
-    type ClusterRetrieveParams as ClusterRetrieveParams,
     type ClusterListParams as ClusterListParams,
     type ClusterComputeParams as ClusterComputeParams,
+    type ClusterRetrieveParams as ClusterRetrieveParams,
     type ClusterFetchGraphParams as ClusterFetchGraphParams,
   };
 
@@ -790,9 +767,9 @@ export declare namespace AI {
     type ConversationUpdateResponse as ConversationUpdateResponse,
     type ConversationListResponse as ConversationListResponse,
     type ConversationRetrieveConversationsInsightsResponse as ConversationRetrieveConversationsInsightsResponse,
+    type ConversationListParams as ConversationListParams,
     type ConversationCreateParams as ConversationCreateParams,
     type ConversationUpdateParams as ConversationUpdateParams,
-    type ConversationListParams as ConversationListParams,
     type ConversationAddMessageParams as ConversationAddMessageParams,
   };
 
@@ -803,8 +780,8 @@ export declare namespace AI {
     type EmbeddingRetrieveResponse as EmbeddingRetrieveResponse,
     type EmbeddingListResponse as EmbeddingListResponse,
     type EmbeddingSimilaritySearchResponse as EmbeddingSimilaritySearchResponse,
-    type EmbeddingCreateParams as EmbeddingCreateParams,
     type EmbeddingListParams as EmbeddingListParams,
+    type EmbeddingCreateParams as EmbeddingCreateParams,
     type EmbeddingSimilaritySearchParams as EmbeddingSimilaritySearchParams,
     type EmbeddingURLParams as EmbeddingURLParams,
   };
@@ -821,9 +798,9 @@ export declare namespace AI {
     McpServers as McpServers,
     type McpServer as McpServer,
     type McpServersDefaultFlatPaginationTopLevelArray as McpServersDefaultFlatPaginationTopLevelArray,
+    type McpServerListParams as McpServerListParams,
     type McpServerCreateParams as McpServerCreateParams,
     type McpServerUpdateParams as McpServerUpdateParams,
-    type McpServerListParams as McpServerListParams,
   };
 
   export {
@@ -834,8 +811,8 @@ export declare namespace AI {
     type MissionResponse as MissionResponse,
     type MissionCloneMissionResponse as MissionCloneMissionResponse,
     type MissionDataDefaultFlatPagination as MissionDataDefaultFlatPagination,
-    type MissionCreateParams as MissionCreateParams,
     type MissionListParams as MissionListParams,
+    type MissionCreateParams as MissionCreateParams,
     type MissionListEventsParams as MissionListEventsParams,
     type MissionUpdateMissionParams as MissionUpdateMissionParams,
   };
@@ -851,8 +828,8 @@ export declare namespace AI {
     type SharedToolResponse as SharedToolResponse,
     type ToolDeleteResponse as ToolDeleteResponse,
     type SharedToolResponsesDefaultFlatPagination as SharedToolResponsesDefaultFlatPagination,
+    type ToolListParams as ToolListParams,
     type ToolCreateParams as ToolCreateParams,
     type ToolUpdateParams as ToolUpdateParams,
-    type ToolListParams as ToolListParams,
   };
 }

package/src/resources/ai/assistants/assistants.ts

@@ -82,6 +82,18 @@ export class Assistants extends APIResource {
   tags: TagsAPI.Tags = new TagsAPI.Tags(this._client);
   instructions: InstructionsAPI.Instructions = new InstructionsAPI.Instructions(this._client);
 
+  /**
+   * Retrieve a list of all AI Assistants configured by the user.
+   *
+   * @example
+   * ```ts
+   * const assistantsList = await client.ai.assistants.list();
+   * ```
+   */
+  list(options?: RequestOptions): APIPromise<AssistantsList> {
+    return this._client.get('/ai/assistants', options);
+  }
+
   /**
    * Create a new AI Assistant.
    *
@@ -98,6 +110,37 @@ export class Assistants extends APIResource {
     return this._client.post('/ai/assistants', { body, ...options });
   }
 
+  /**
+   * Import assistants from external providers. Any assistant that has already been
+   * imported will be overwritten with its latest version from the importing
+   * provider.
+   *
+   * @example
+   * ```ts
+   * const assistantsList = await client.ai.assistants.imports({
+   *   api_key_ref: 'api_key_ref',
+   *   provider: 'elevenlabs',
+   * });
+   * ```
+   */
+  imports(body: AssistantImportsParams, options?: RequestOptions): APIPromise<AssistantsList> {
+    return this._client.post('/ai/assistants/import', { body, ...options });
+  }
+
+  /**
+   * Delete an AI Assistant by `assistant_id`.
+   *
+   * @example
+   * ```ts
+   * const assistant = await client.ai.assistants.delete(
+   *   'assistant_id',
+   * );
+   * ```
+   */
+  delete(assistantID: string, options?: RequestOptions): APIPromise<AssistantDeleteResponse> {
+    return this._client.delete(path`/ai/assistants/${assistantID}`, options);
+  }
+
   /**
    * Retrieve an AI Assistant configuration by `assistant_id`.
    *
@@ -132,32 +175,6 @@ export class Assistants extends APIResource {
     return this._client.post(path`/ai/assistants/${assistantID}`, { body, ...options });
   }
 
-  /**
-   * Retrieve a list of all AI Assistants configured by the user.
-   *
-   * @example
-   * ```ts
-   * const assistantsList = await client.ai.assistants.list();
-   * ```
-   */
-  list(options?: RequestOptions): APIPromise<AssistantsList> {
-    return this._client.get('/ai/assistants', options);
-  }
-
-  /**
-   * Delete an AI Assistant by `assistant_id`.
-   *
-   * @example
-   * ```ts
-   * const assistant = await client.ai.assistants.delete(
-   *   'assistant_id',
-   * );
-   * ```
-   */
-  delete(assistantID: string, options?: RequestOptions): APIPromise<AssistantDeleteResponse> {
-    return this._client.delete(path`/ai/assistants/${assistantID}`, options);
-  }
-
   /**
    * This endpoint allows a client to send a chat message to a specific AI Assistant.
    * The assistant processes the message and returns a relevant reply based on the
@@ -215,23 +232,6 @@ export class Assistants extends APIResource {
     return this._client.get(path`/ai/assistants/${assistantID}/texml`, options);
   }
 
-  /**
-   * Import assistants from external providers. Any assistant that has already been
-   * imported will be overwritten with its latest version from the importing
-   * provider.
-   *
-   * @example
-   * ```ts
-   * const assistantsList = await client.ai.assistants.imports({
-   *   api_key_ref: 'api_key_ref',
-   *   provider: 'elevenlabs',
-   * });
-   * ```
-   */
-  imports(body: AssistantImportsParams, options?: RequestOptions): APIPromise<AssistantsList> {
-    return this._client.post('/ai/assistants/import', { body, ...options });
-  }
-
   /**
    * Send an SMS message for an assistant. This endpoint:
    *
@@ -3146,6 +3146,26 @@ export interface AssistantCreateParams {
   widget_settings?: WidgetSettings;
 }
 
+export interface AssistantImportsParams {
+  /**
+   * Integration secret pointer that refers to the API key for the external provider.
+   * This should be an identifier for an integration secret created via
+   * /v2/integration_secrets.
+   */
+  api_key_ref: string;
+
+  /**
+   * The external provider to import assistants from.
+   */
+  provider: 'elevenlabs' | 'vapi' | 'retell';
+
+  /**
+   * Optional list of assistant IDs to import from the external provider. If not
+   * provided, all assistants will be imported.
+   */
+  import_ids?: Array<string>;
+}
+
 export interface AssistantRetrieveParams {
   /**
    * Filter results by call control id.
@@ -3349,26 +3369,6 @@ export interface AssistantChatParams {
   name?: string;
 }
 
-export interface AssistantImportsParams {
-  /**
-   * Integration secret pointer that refers to the API key for the external provider.
-   * This should be an identifier for an integration secret created via
-   * /v2/integration_secrets.
-   */
-  api_key_ref: string;
-
-  /**
-   * The external provider to import assistants from.
-   */
-  provider: 'elevenlabs' | 'vapi' | 'retell';
-
-  /**
-   * Optional list of assistant IDs to import from the external provider. If not
-   * provided, all assistants will be imported.
-   */
-  import_ids?: Array<string>;
-}
-
 export interface AssistantSendSMSParams {
   from: string;
 
@@ -3440,10 +3440,10 @@ export declare namespace Assistants {
     type AssistantGetTexmlResponse as AssistantGetTexmlResponse,
     type AssistantSendSMSResponse as AssistantSendSMSResponse,
     type AssistantCreateParams as AssistantCreateParams,
+    type AssistantImportsParams as AssistantImportsParams,
     type AssistantRetrieveParams as AssistantRetrieveParams,
     type AssistantUpdateParams as AssistantUpdateParams,
     type AssistantChatParams as AssistantChatParams,
-    type AssistantImportsParams as AssistantImportsParams,
     type AssistantSendSMSParams as AssistantSendSMSParams,
   };
 
@@ -3452,9 +3452,9 @@ export declare namespace Assistants {
     type AssistantTest as AssistantTest,
     type TelnyxConversationChannel as TelnyxConversationChannel,
     type AssistantTestsDefaultFlatPagination as AssistantTestsDefaultFlatPagination,
+    type TestListParams as TestListParams,
     type TestCreateParams as TestCreateParams,
     type TestUpdateParams as TestUpdateParams,
-    type TestListParams as TestListParams,
   };
 
   export {
@@ -3480,10 +3480,10 @@ export declare namespace Assistants {
     type ScheduledSMSEventResponse as ScheduledSMSEventResponse,
     type ScheduledEventListResponse as ScheduledEventListResponse,
     type ScheduledEventListResponsesDefaultFlatPagination as ScheduledEventListResponsesDefaultFlatPagination,
-    type ScheduledEventCreateParams as ScheduledEventCreateParams,
-    type ScheduledEventRetrieveParams as ScheduledEventRetrieveParams,
     type ScheduledEventListParams as ScheduledEventListParams,
+    type ScheduledEventCreateParams as ScheduledEventCreateParams,
     type ScheduledEventDeleteParams as ScheduledEventDeleteParams,
+    type ScheduledEventRetrieveParams as ScheduledEventRetrieveParams,
   };
 
   export {
@@ -3491,17 +3491,17 @@ export declare namespace Assistants {
     type ToolAddResponse as ToolAddResponse,
     type ToolRemoveResponse as ToolRemoveResponse,
     type ToolTestResponse as ToolTestResponse,
-    type ToolAddParams as ToolAddParams,
-    type ToolRemoveParams as ToolRemoveParams,
     type ToolTestParams as ToolTestParams,
+    type ToolRemoveParams as ToolRemoveParams,
+    type ToolAddParams as ToolAddParams,
   };
 
   export {
     Versions as Versions,
     type UpdateAssistant as UpdateAssistant,
+    type VersionDeleteParams as VersionDeleteParams,
     type VersionRetrieveParams as VersionRetrieveParams,
     type VersionUpdateParams as VersionUpdateParams,
-    type VersionDeleteParams as VersionDeleteParams,
     type VersionPromoteParams as VersionPromoteParams,
   };