telnyx 5.150.0 → 5.151.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.
Files changed (76) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +7 -0
  3. data/README.md +10 -1
  4. data/lib/telnyx/models/ai_retrieve_conversation_histories_params.rb +22 -48
  5. data/lib/telnyx/models/ai_retrieve_conversation_histories_response.rb +10 -50
  6. data/lib/telnyx/models/calls/deepgram_nova2_config.rb +23 -1
  7. data/lib/telnyx/models/calls/deepgram_nova3_config.rb +22 -1
  8. data/lib/telnyx/models/calls/transcription_start_request.rb +5 -3
  9. data/lib/telnyx/models/public_internet_gateway.rb +24 -1
  10. data/lib/telnyx/models/texml/accounts/call_calls_params.rb +9 -69
  11. data/lib/telnyx/models/virtual_cross_connect_create.rb +176 -2
  12. data/lib/telnyx/models/wireguard_interface.rb +24 -1
  13. data/lib/telnyx/resources/ai.rb +20 -21
  14. data/lib/telnyx/resources/calls/actions.rb +1 -1
  15. data/lib/telnyx/version.rb +1 -1
  16. data/lib/telnyx.rb +1 -0
  17. data/rbi/telnyx/models/ai_retrieve_conversation_histories_params.rbi +30 -97
  18. data/rbi/telnyx/models/ai_retrieve_conversation_histories_response.rbi +10 -85
  19. data/rbi/telnyx/models/calls/deepgram_nova2_config.rbi +34 -0
  20. data/rbi/telnyx/models/calls/deepgram_nova3_config.rbi +32 -0
  21. data/rbi/telnyx/models/calls/transcription_start_request.rbi +5 -0
  22. data/rbi/telnyx/models/public_internet_gateway.rbi +45 -3
  23. data/rbi/telnyx/models/texml/accounts/call_calls_params.rbi +12 -189
  24. data/rbi/telnyx/models/virtual_cross_connect_create.rbi +265 -7
  25. data/rbi/telnyx/models/wireguard_interface.rbi +48 -3
  26. data/rbi/telnyx/models.rbi +0 -7
  27. data/rbi/telnyx/resources/ai.rbi +21 -28
  28. data/rbi/telnyx/resources/calls/actions.rbi +1 -0
  29. data/sig/telnyx/models/ai_retrieve_conversation_histories_params.rbs +15 -34
  30. data/sig/telnyx/models/ai_retrieve_conversation_histories_response.rbs +0 -24
  31. data/sig/telnyx/models/calls/deepgram_nova2_config.rbs +14 -0
  32. data/sig/telnyx/models/calls/deepgram_nova3_config.rbs +14 -0
  33. data/sig/telnyx/models/calls/transcription_start_request.rbs +1 -0
  34. data/sig/telnyx/models/public_internet_gateway.rbs +32 -3
  35. data/sig/telnyx/models/texml/accounts/call_calls_params.rbs +15 -63
  36. data/sig/telnyx/models/virtual_cross_connect_create.rbs +138 -7
  37. data/sig/telnyx/models/wireguard_interface.rbs +34 -3
  38. data/sig/telnyx/models.rbs +0 -1
  39. data/sig/telnyx/resources/ai.rbs +2 -3
  40. metadata +2 -38
  41. data/lib/telnyx/models/dir/phone_number_create_params.rb +0 -47
  42. data/lib/telnyx/models/dir/phone_number_create_response.rb +0 -32
  43. data/lib/telnyx/models/dir/phone_number_delete_all_params.rb +0 -28
  44. data/lib/telnyx/models/dir/phone_number_delete_all_response.rb +0 -103
  45. data/lib/telnyx/models/dir_loa_params.rb +0 -79
  46. data/lib/telnyx/models/dir_retrieve_document_types_params.rb +0 -14
  47. data/lib/telnyx/models/dir_retrieve_document_types_response.rb +0 -51
  48. data/lib/telnyx/models/dir_retrieve_infringement_claims_params.rb +0 -40
  49. data/lib/telnyx/models/dir_retrieve_infringement_claims_response.rb +0 -30
  50. data/lib/telnyx/models/dir_update_infringement_update_params.rb +0 -134
  51. data/lib/telnyx/models/enterprises/reputation/loa_create_params.rb +0 -146
  52. data/lib/telnyx/models/enterprises/reputation/loa_patch_all_params.rb +0 -38
  53. data/rbi/telnyx/models/dir/phone_number_create_params.rbi +0 -72
  54. data/rbi/telnyx/models/dir/phone_number_create_response.rbi +0 -48
  55. data/rbi/telnyx/models/dir/phone_number_delete_all_params.rbi +0 -48
  56. data/rbi/telnyx/models/dir/phone_number_delete_all_response.rbi +0 -206
  57. data/rbi/telnyx/models/dir_loa_params.rbi +0 -120
  58. data/rbi/telnyx/models/dir_retrieve_document_types_params.rbi +0 -30
  59. data/rbi/telnyx/models/dir_retrieve_document_types_response.rbi +0 -103
  60. data/rbi/telnyx/models/dir_retrieve_infringement_claims_params.rbi +0 -66
  61. data/rbi/telnyx/models/dir_retrieve_infringement_claims_response.rbi +0 -55
  62. data/rbi/telnyx/models/dir_update_infringement_update_params.rbi +0 -256
  63. data/rbi/telnyx/models/enterprises/reputation/loa_create_params.rbi +0 -238
  64. data/rbi/telnyx/models/enterprises/reputation/loa_patch_all_params.rbi +0 -60
  65. data/sig/telnyx/models/dir/phone_number_create_params.rbs +0 -38
  66. data/sig/telnyx/models/dir/phone_number_create_response.rbs +0 -16
  67. data/sig/telnyx/models/dir/phone_number_delete_all_params.rbs +0 -30
  68. data/sig/telnyx/models/dir/phone_number_delete_all_response.rbs +0 -86
  69. data/sig/telnyx/models/dir_loa_params.rbs +0 -61
  70. data/sig/telnyx/models/dir_retrieve_document_types_params.rbs +0 -15
  71. data/sig/telnyx/models/dir_retrieve_document_types_response.rbs +0 -41
  72. data/sig/telnyx/models/dir_retrieve_infringement_claims_params.rbs +0 -36
  73. data/sig/telnyx/models/dir_retrieve_infringement_claims_response.rbs +0 -25
  74. data/sig/telnyx/models/dir_update_infringement_update_params.rbs +0 -111
  75. data/sig/telnyx/models/enterprises/reputation/loa_create_params.rbs +0 -135
  76. data/sig/telnyx/models/enterprises/reputation/loa_patch_all_params.rbs +0 -32
@@ -3,18 +3,192 @@
3
3
  module Telnyx
4
4
  module Models
5
5
  class VirtualCrossConnectCreate < Telnyx::Models::Record
6
- # @!method initialize
6
+ # @!attribute name
7
+ # A user specified name for the interface.
8
+ #
9
+ # @return [String, nil]
10
+ optional :name, String
11
+
12
+ # @!attribute network_id
13
+ # The id of the network associated with the interface.
14
+ #
15
+ # @return [String, nil]
16
+ optional :network_id, String
17
+
18
+ # @!attribute region_code
19
+ # The region the interface should be deployed to.
20
+ #
21
+ # @return [String]
22
+ required :region_code, String
23
+
24
+ # @!attribute bandwidth_mbps
25
+ # The desired throughput in Megabits per Second (Mbps) for your Virtual Cross
26
+ # Connect.<br /><br />The available bandwidths can be found using the
27
+ # /virtual_cross_connect_regions endpoint.
28
+ #
29
+ # @return [Float, nil]
30
+ optional :bandwidth_mbps, Float
31
+
32
+ # @!attribute bgp_asn
33
+ # The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
34
+ # will be assigned by Telnyx.
35
+ #
36
+ # @return [Float, nil]
37
+ optional :bgp_asn, Float
38
+
39
+ # @!attribute cloud_provider
40
+ # The Virtual Private Cloud with which you would like to establish a cross
41
+ # connect.
42
+ #
43
+ # @return [Symbol, Telnyx::Models::VirtualCrossConnectCreate::CloudProvider, nil]
44
+ optional :cloud_provider, enum: -> { Telnyx::VirtualCrossConnectCreate::CloudProvider }
45
+
46
+ # @!attribute cloud_provider_region
47
+ # The region where your Virtual Private Cloud hosts are located.<br /><br />The
48
+ # available regions can be found using the /virtual_cross_connect_regions
49
+ # endpoint.
50
+ #
51
+ # @return [String, nil]
52
+ optional :cloud_provider_region, String
53
+
54
+ # @!attribute primary_bgp_key
55
+ # The authentication key for BGP peer configuration.
56
+ #
57
+ # @return [String, nil]
58
+ optional :primary_bgp_key, String
59
+
60
+ # @!attribute primary_cloud_account_id
61
+ # The identifier for your Virtual Private Cloud. The number will be different
62
+ # based upon your Cloud provider.
63
+ #
64
+ # @return [String, nil]
65
+ optional :primary_cloud_account_id, String
66
+
67
+ # @!attribute primary_cloud_ip
68
+ # The IP address assigned for your side of the Virtual Cross
69
+ # Connect.<br /><br />If none is provided, one will be generated for
70
+ # you.<br /><br />This value should be null for GCE as Google will only inform you
71
+ # of your assigned IP once the connection has been accepted.
72
+ #
73
+ # @return [String, nil]
74
+ optional :primary_cloud_ip, String
75
+
76
+ # @!attribute primary_telnyx_ip
77
+ # The IP address assigned to the Telnyx side of the Virtual Cross
78
+ # Connect.<br /><br />If none is provided, one will be generated for
79
+ # you.<br /><br />This value should be null for GCE as Google will only inform you
80
+ # of your assigned IP once the connection has been accepted.
81
+ #
82
+ # @return [String, nil]
83
+ optional :primary_telnyx_ip, String
84
+
85
+ # @!attribute secondary_bgp_key
86
+ # The authentication key for BGP peer configuration.
87
+ #
88
+ # @return [String, nil]
89
+ optional :secondary_bgp_key, String
90
+
91
+ # @!attribute secondary_cloud_account_id
92
+ # The identifier for your Virtual Private Cloud. The number will be different
93
+ # based upon your Cloud provider.<br /><br />This attribute is only necessary for
94
+ # GCE.
95
+ #
96
+ # @return [String, nil]
97
+ optional :secondary_cloud_account_id, String
98
+
99
+ # @!attribute secondary_cloud_ip
100
+ # The IP address assigned for your side of the Virtual Cross
101
+ # Connect.<br /><br />If none is provided, one will be generated for
102
+ # you.<br /><br />This value should be null for GCE as Google will only inform you
103
+ # of your assigned IP once the connection has been accepted.
104
+ #
105
+ # @return [String, nil]
106
+ optional :secondary_cloud_ip, String
107
+
108
+ # @!attribute secondary_telnyx_ip
109
+ # The IP address assigned to the Telnyx side of the Virtual Cross
110
+ # Connect.<br /><br />If none is provided, one will be generated for
111
+ # you.<br /><br />This value should be null for GCE as Google will only inform you
112
+ # of your assigned IP once the connection has been accepted.
113
+ #
114
+ # @return [String, nil]
115
+ optional :secondary_telnyx_ip, String
116
+
117
+ response_only do
118
+ # @!attribute status
119
+ # The current status of the interface deployment.
120
+ #
121
+ # @return [Symbol, Telnyx::Models::InterfaceStatus, nil]
122
+ optional :status, enum: -> { Telnyx::InterfaceStatus }
123
+
124
+ # @!attribute primary_enabled
125
+ # Indicates whether the primary circuit is enabled. Setting this to `false` will
126
+ # disable the circuit.
127
+ #
128
+ # @return [Boolean, nil]
129
+ optional :primary_enabled, Telnyx::Internal::Type::Boolean
130
+
131
+ # @!attribute secondary_enabled
132
+ # Indicates whether the secondary circuit is enabled. Setting this to `false` will
133
+ # disable the circuit.
134
+ #
135
+ # @return [Boolean, nil]
136
+ optional :secondary_enabled, Telnyx::Internal::Type::Boolean
137
+ end
138
+
139
+ # @!method initialize(region_code:, name: nil, network_id: nil, status: nil, bandwidth_mbps: nil, bgp_asn: nil, cloud_provider: nil, cloud_provider_region: nil, primary_bgp_key: nil, primary_cloud_account_id: nil, primary_cloud_ip: nil, primary_enabled: nil, primary_telnyx_ip: nil, secondary_bgp_key: nil, secondary_cloud_account_id: nil, secondary_cloud_ip: nil, secondary_enabled: nil, secondary_telnyx_ip: nil)
140
+ # Some parameter documentations has been truncated, see
141
+ # {Telnyx::Models::VirtualCrossConnectCreate} for more details.
142
+ #
143
+ # @param region_code [String] The region the interface should be deployed to.
144
+ #
145
+ # @param name [String] A user specified name for the interface.
146
+ #
147
+ # @param network_id [String] The id of the network associated with the interface.
148
+ #
149
+ # @param status [Symbol, Telnyx::Models::InterfaceStatus] The current status of the interface deployment.
150
+ #
151
+ # @param bandwidth_mbps [Float] The desired throughput in Megabits per Second (Mbps) for your Virtual Cross Conn
152
+ #
153
+ # @param bgp_asn [Float] The Border Gateway Protocol (BGP) Autonomous System Number (ASN). If null, value
154
+ #
155
+ # @param cloud_provider [Symbol, Telnyx::Models::VirtualCrossConnectCreate::CloudProvider] The Virtual Private Cloud with which you would like to establish a cross connect
156
+ #
157
+ # @param cloud_provider_region [String] The region where your Virtual Private Cloud hosts are located.<br /><br />The av
158
+ #
159
+ # @param primary_bgp_key [String] The authentication key for BGP peer configuration.
160
+ #
161
+ # @param primary_cloud_account_id [String] The identifier for your Virtual Private Cloud. The number will be different base
162
+ #
163
+ # @param primary_cloud_ip [String] The IP address assigned for your side of the Virtual Cross Connect.<br /><br />I
164
+ #
165
+ # @param primary_enabled [Boolean] Indicates whether the primary circuit is enabled. Setting this to `false` will d
166
+ #
167
+ # @param primary_telnyx_ip [String] The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><b
168
+ #
169
+ # @param secondary_bgp_key [String] The authentication key for BGP peer configuration.
170
+ #
171
+ # @param secondary_cloud_account_id [String] The identifier for your Virtual Private Cloud. The number will be different base
172
+ #
173
+ # @param secondary_cloud_ip [String] The IP address assigned for your side of the Virtual Cross Connect.<br /><br />I
174
+ #
175
+ # @param secondary_enabled [Boolean] Indicates whether the secondary circuit is enabled. Setting this to `false` will
176
+ #
177
+ # @param secondary_telnyx_ip [String] The IP address assigned to the Telnyx side of the Virtual Cross Connect.<br /><b
7
178
 
8
179
  # The Virtual Private Cloud with which you would like to establish a cross
9
180
  # connect.
10
181
  #
11
- # @see Telnyx::Models::VirtualCrossConnectCreate::CloudProvider
182
+ # @see Telnyx::Models::VirtualCrossConnectCreate#cloud_provider
12
183
  module CloudProvider
13
184
  extend Telnyx::Internal::Type::Enum
14
185
 
15
186
  AWS = :aws
16
187
  AZURE = :azure
17
188
  GCE = :gce
189
+
190
+ # @!method self.values
191
+ # @return [Array<Symbol>]
18
192
  end
19
193
  end
20
194
  end
@@ -3,7 +3,30 @@
3
3
  module Telnyx
4
4
  module Models
5
5
  class WireguardInterface < Telnyx::Models::Record
6
- # @!method initialize
6
+ # @!attribute name
7
+ # A user specified name for the interface.
8
+ #
9
+ # @return [String, nil]
10
+ optional :name, String
11
+
12
+ # @!attribute network_id
13
+ # The id of the network associated with the interface.
14
+ #
15
+ # @return [String, nil]
16
+ optional :network_id, String
17
+
18
+ # @!attribute enable_sip_trunking
19
+ # Enable SIP traffic forwarding over VPN interface.
20
+ #
21
+ # @return [Boolean, nil]
22
+ optional :enable_sip_trunking, Telnyx::Internal::Type::Boolean
23
+
24
+ # @!method initialize(name: nil, network_id: nil, enable_sip_trunking: nil)
25
+ # @param name [String] A user specified name for the interface.
26
+ #
27
+ # @param network_id [String] The id of the network associated with the interface.
28
+ #
29
+ # @param enable_sip_trunking [Boolean] Enable SIP traffic forwarding over VPN interface.
7
30
  end
8
31
  end
9
32
  end
@@ -82,12 +82,12 @@ module Telnyx
82
82
  #
83
83
  # 1. The query text is embedded into a 1024-dimensional vector using the
84
84
  # multilingual-e5-large model.
85
- # 2. The vector is sent to regional OpenSearch clusters for kNN search using HNSW
86
- # cosine similarity.
85
+ # 2. The vector is compared against indexed record chunks using semantic
86
+ # similarity search.
87
87
  # 3. When no region is specified, all regions are queried in parallel (fan-out)
88
88
  # and results are merged by score.
89
- # 4. Results are ranked by cosine similarity score (descending) and truncated to
90
- # `top_k`.
89
+ # 4. Results are ranked by similarity score (descending) and paginated via
90
+ # `page[number]` / `page[size]`.
91
91
  #
92
92
  # **Authentication:** Requires a Telnyx API key via `Authorization: Bearer <key>`.
93
93
  # Results are automatically scoped to the caller's organization —
@@ -101,14 +101,14 @@ module Telnyx
101
101
  # **Filtering:** Use `filter[field][operator]=value` query parameters to narrow
102
102
  # results before vector search.
103
103
  #
104
- # Top-level filterable fields: `user_id`, `record_type`, `region`, `document_id`,
105
- # `record_id`, `record_created_at`, `ingested_at`, `retention`
104
+ # Top-level filterable fields: `user_id`, `region`, `record_id`,
105
+ # `record_created_at`, `ingested_at`, `retention`
106
106
  #
107
107
  # Note: `retention` is filter-only — it can be used to narrow results but is not
108
108
  # returned in the response body.
109
109
  #
110
110
  # Metadata fields: any field not in the list above is resolved to
111
- # `data.metadata.<field>` in OpenSearch (e.g., `filter[language]=en` →
111
+ # `data.metadata.<field>` (e.g., `filter[language]=en` →
112
112
  # `data.metadata.language`).
113
113
  #
114
114
  # Supported filter operators:
@@ -121,21 +121,17 @@ module Telnyx
121
121
  # **Examples:**
122
122
  #
123
123
  # ```
124
- # GET /v2/ai/conversation_histories?q=billing+issue&record_type=voice&top_k=10
125
- # GET /v2/ai/conversation_histories?q=setup+guide&record_type=knowledge_base&region=USA&min_score=0.5
126
- # GET /v2/ai/conversation_histories?q=refund&record_type=voice&filter[record_created_at][gte]=2026-01-01T00:00:00Z
127
- # GET /v2/ai/conversation_histories?q=outage&record_type=voice&filter[region][in]=USA,DEU
128
- # GET /v2/ai/conversation_histories?q=hold+time&record_type=voice&filter[language]=en
124
+ # GET /v2/ai/conversation_histories?q=billing+issue&page[size]=10
125
+ # GET /v2/ai/conversation_histories?q=setup+guide&region=USA&min_score=0.5
126
+ # GET /v2/ai/conversation_histories?q=refund&filter[record_created_at][gte]=2026-01-01T00:00:00Z
127
+ # GET /v2/ai/conversation_histories?q=outage&filter[region][in]=USA,DEU
128
+ # GET /v2/ai/conversation_histories?q=hold+time&filter[language]=en
129
129
  # ```
130
130
  #
131
- # @overload retrieve_conversation_histories(q:, record_type:, filter_document_id: nil, filter_ingested_at_gte: nil, filter_ingested_at_lte: nil, filter_record_created_at_gte: nil, filter_record_created_at_lte: nil, filter_record_id: nil, filter_region_in: nil, filter_retention: nil, filter_user_id: nil, min_score: nil, region: nil, top_k: nil, request_options: {})
131
+ # @overload retrieve_conversation_histories(q:, filter_ingested_at_gte: nil, filter_ingested_at_lte: nil, filter_record_created_at_gte: nil, filter_record_created_at_lte: nil, filter_record_id: nil, filter_region_in: nil, filter_retention: nil, filter_user_id: nil, min_score: nil, page_number: nil, page_size: nil, region: nil, request_options: {})
132
132
  #
133
133
  # @param q [String] Natural language search query. The text is embedded into a 1024-dimensional vect
134
134
  #
135
- # @param record_type [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::RecordType] The type of records to search. Each record type is stored in a separate vector i
136
- #
137
- # @param filter_document_id [String] Filter by document identifier (exact match). Populated for knowledge_base record
138
- #
139
135
  # @param filter_ingested_at_gte [Time] Only include records ingested (chunked, embedded, and indexed) on or after this
140
136
  #
141
137
  # @param filter_ingested_at_lte [Time] Only include records ingested (chunked, embedded, and indexed) on or before this
@@ -154,9 +150,11 @@ module Telnyx
154
150
  #
155
151
  # @param min_score [Float] Minimum cosine similarity score threshold (0.0 to 1.0). Results below this thres
156
152
  #
157
- # @param region [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::Region] Restrict search to a specific region's OpenSearch cluster. When omitted, all reg
153
+ # @param page_number [Integer] Page number to return (1-based). Defaults to 1.
154
+ #
155
+ # @param page_size [Integer] Number of results per page. Defaults to 20, maximum 100.
158
156
  #
159
- # @param top_k [Integer] Maximum number of results to return. Defaults to 20, maximum 100.
157
+ # @param region [Symbol, Telnyx::Models::AIRetrieveConversationHistoriesParams::Region] Restrict search to a specific region. When omitted, all regions are queried in p
160
158
  #
161
159
  # @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}, nil]
162
160
  #
@@ -170,7 +168,6 @@ module Telnyx
170
168
  method: :get,
171
169
  path: "ai/conversation_histories",
172
170
  query: query.transform_keys(
173
- filter_document_id: "filter[document_id]",
174
171
  filter_ingested_at_gte: "filter[ingested_at][gte]",
175
172
  filter_ingested_at_lte: "filter[ingested_at][lte]",
176
173
  filter_record_created_at_gte: "filter[record_created_at][gte]",
@@ -178,7 +175,9 @@ module Telnyx
178
175
  filter_record_id: "filter[record_id]",
179
176
  filter_region_in: "filter[region][in]",
180
177
  filter_retention: "filter[retention]",
181
- filter_user_id: "filter[user_id]"
178
+ filter_user_id: "filter[user_id]",
179
+ page_number: "page[number]",
180
+ page_size: "page[size]"
182
181
  ),
183
182
  model: Telnyx::Models::AIRetrieveConversationHistoriesResponse,
184
183
  options: options
@@ -1339,7 +1339,7 @@ module Telnyx
1339
1339
  #
1340
1340
  # @param transcription_engine [Symbol, Telnyx::Models::Calls::TranscriptionStartRequest::TranscriptionEngine] Engine to use for speech recognition. Legacy values `A` - `Google`, `B` - `Telny
1341
1341
  #
1342
- # @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
1342
+ # @param transcription_engine_config [Telnyx::Models::Calls::TranscriptionEngineGoogleConfig, Telnyx::Models::Calls::TranscriptionEngineTelnyxConfig, Telnyx::Models::Calls::TranscriptionEngineAzureConfig, Telnyx::Models::Calls::TranscriptionEngineXaiConfig, Telnyx::Models::Calls::TranscriptionEngineAssemblyaiConfig, Telnyx::Models::Calls::TranscriptionEngineSpeechmaticsConfig, Telnyx::Models::Calls::TranscriptionEngineSonioxConfig, Telnyx::Models::Calls::TranscriptionEngineParakeetConfig, Telnyx::Models::Calls::TranscriptionEngineAConfig, Telnyx::Models::Calls::TranscriptionEngineBConfig, Telnyx::Models::Calls::DeepgramNova2Config, Telnyx::Models::Calls::DeepgramNova3Config]
1343
1343
  #
1344
1344
  # @param transcription_tracks [String] Indicates which leg of the call will be transcribed. Use `inbound` for the leg t
1345
1345
  #
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module Telnyx
4
- VERSION = "5.150.0"
4
+ VERSION = "5.151.0"
5
5
  end
data/lib/telnyx.rb CHANGED
@@ -688,6 +688,7 @@ require_relative "telnyx/models/calls/transcription_engine_azure_config"
688
688
  require_relative "telnyx/models/calls/transcription_engine_b_config"
689
689
  require_relative "telnyx/models/calls/transcription_engine_deepgram_config"
690
690
  require_relative "telnyx/models/calls/transcription_engine_google_config"
691
+ require_relative "telnyx/models/calls/transcription_engine_parakeet_config"
691
692
  require_relative "telnyx/models/calls/transcription_engine_soniox_config"
692
693
  require_relative "telnyx/models/calls/transcription_engine_speechmatics_config"
693
694
  require_relative "telnyx/models/calls/transcription_engine_telnyx_config"
@@ -15,27 +15,10 @@ module Telnyx
15
15
  end
16
16
 
17
17
  # Natural language search query. The text is embedded into a 1024-dimensional
18
- # vector and compared against indexed record chunks using kNN cosine similarity.
18
+ # vector and compared against indexed record chunks using semantic similarity.
19
19
  sig { returns(String) }
20
20
  attr_accessor :q
21
21
 
22
- # The type of records to search. Each record type is stored in a separate vector
23
- # index.
24
- sig do
25
- returns(
26
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType::OrSymbol
27
- )
28
- end
29
- attr_accessor :record_type
30
-
31
- # Filter by document identifier (exact match). Populated for knowledge_base
32
- # records.
33
- sig { returns(T.nilable(String)) }
34
- attr_reader :filter_document_id
35
-
36
- sig { params(filter_document_id: String).void }
37
- attr_writer :filter_document_id
38
-
39
22
  # Only include records ingested (chunked, embedded, and indexed) on or after this
40
23
  # ISO 8601 timestamp.
41
24
  sig { returns(T.nilable(Time)) }
@@ -107,9 +90,22 @@ module Telnyx
107
90
  sig { params(min_score: Float).void }
108
91
  attr_writer :min_score
109
92
 
110
- # Restrict search to a specific region's OpenSearch cluster. When omitted, all
111
- # regions are queried in parallel (fan-out) and results are merged by cosine
112
- # similarity score.
93
+ # Page number to return (1-based). Defaults to 1.
94
+ sig { returns(T.nilable(Integer)) }
95
+ attr_reader :page_number
96
+
97
+ sig { params(page_number: Integer).void }
98
+ attr_writer :page_number
99
+
100
+ # Number of results per page. Defaults to 20, maximum 100.
101
+ sig { returns(T.nilable(Integer)) }
102
+ attr_reader :page_size
103
+
104
+ sig { params(page_size: Integer).void }
105
+ attr_writer :page_size
106
+
107
+ # Restrict search to a specific region. When omitted, all regions are queried in
108
+ # parallel (fan-out) and results are merged by similarity score.
113
109
  sig do
114
110
  returns(
115
111
  T.nilable(
@@ -127,19 +123,9 @@ module Telnyx
127
123
  end
128
124
  attr_writer :region
129
125
 
130
- # Maximum number of results to return. Defaults to 20, maximum 100.
131
- sig { returns(T.nilable(Integer)) }
132
- attr_reader :top_k
133
-
134
- sig { params(top_k: Integer).void }
135
- attr_writer :top_k
136
-
137
126
  sig do
138
127
  params(
139
128
  q: String,
140
- record_type:
141
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType::OrSymbol,
142
- filter_document_id: String,
143
129
  filter_ingested_at_gte: Time,
144
130
  filter_ingested_at_lte: Time,
145
131
  filter_record_created_at_gte: Time,
@@ -149,22 +135,17 @@ module Telnyx
149
135
  filter_retention: String,
150
136
  filter_user_id: String,
151
137
  min_score: Float,
138
+ page_number: Integer,
139
+ page_size: Integer,
152
140
  region:
153
141
  Telnyx::AIRetrieveConversationHistoriesParams::Region::OrSymbol,
154
- top_k: Integer,
155
142
  request_options: Telnyx::RequestOptions::OrHash
156
143
  ).returns(T.attached_class)
157
144
  end
158
145
  def self.new(
159
146
  # Natural language search query. The text is embedded into a 1024-dimensional
160
- # vector and compared against indexed record chunks using kNN cosine similarity.
147
+ # vector and compared against indexed record chunks using semantic similarity.
161
148
  q:,
162
- # The type of records to search. Each record type is stored in a separate vector
163
- # index.
164
- record_type:,
165
- # Filter by document identifier (exact match). Populated for knowledge_base
166
- # records.
167
- filter_document_id: nil,
168
149
  # Only include records ingested (chunked, embedded, and indexed) on or after this
169
150
  # ISO 8601 timestamp.
170
151
  filter_ingested_at_gte: nil,
@@ -191,12 +172,13 @@ module Telnyx
191
172
  # Minimum cosine similarity score threshold (0.0 to 1.0). Results below this
192
173
  # threshold are excluded.
193
174
  min_score: nil,
194
- # Restrict search to a specific region's OpenSearch cluster. When omitted, all
195
- # regions are queried in parallel (fan-out) and results are merged by cosine
196
- # similarity score.
175
+ # Page number to return (1-based). Defaults to 1.
176
+ page_number: nil,
177
+ # Number of results per page. Defaults to 20, maximum 100.
178
+ page_size: nil,
179
+ # Restrict search to a specific region. When omitted, all regions are queried in
180
+ # parallel (fan-out) and results are merged by similarity score.
197
181
  region: nil,
198
- # Maximum number of results to return. Defaults to 20, maximum 100.
199
- top_k: nil,
200
182
  request_options: {}
201
183
  )
202
184
  end
@@ -205,9 +187,6 @@ module Telnyx
205
187
  override.returns(
206
188
  {
207
189
  q: String,
208
- record_type:
209
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType::OrSymbol,
210
- filter_document_id: String,
211
190
  filter_ingested_at_gte: Time,
212
191
  filter_ingested_at_lte: Time,
213
192
  filter_record_created_at_gte: Time,
@@ -217,9 +196,10 @@ module Telnyx
217
196
  filter_retention: String,
218
197
  filter_user_id: String,
219
198
  min_score: Float,
199
+ page_number: Integer,
200
+ page_size: Integer,
220
201
  region:
221
202
  Telnyx::AIRetrieveConversationHistoriesParams::Region::OrSymbol,
222
- top_k: Integer,
223
203
  request_options: Telnyx::RequestOptions
224
204
  }
225
205
  )
@@ -227,55 +207,8 @@ module Telnyx
227
207
  def to_hash
228
208
  end
229
209
 
230
- # The type of records to search. Each record type is stored in a separate vector
231
- # index.
232
- module RecordType
233
- extend Telnyx::Internal::Type::Enum
234
-
235
- TaggedSymbol =
236
- T.type_alias do
237
- T.all(
238
- Symbol,
239
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType
240
- )
241
- end
242
- OrSymbol = T.type_alias { T.any(Symbol, String) }
243
-
244
- VOICE =
245
- T.let(
246
- :voice,
247
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType::TaggedSymbol
248
- )
249
- MESSAGE =
250
- T.let(
251
- :message,
252
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType::TaggedSymbol
253
- )
254
- AI_PIPELINE_STORAGE =
255
- T.let(
256
- :ai_pipeline_storage,
257
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType::TaggedSymbol
258
- )
259
- KNOWLEDGE_BASE =
260
- T.let(
261
- :knowledge_base,
262
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType::TaggedSymbol
263
- )
264
-
265
- sig do
266
- override.returns(
267
- T::Array[
268
- Telnyx::AIRetrieveConversationHistoriesParams::RecordType::TaggedSymbol
269
- ]
270
- )
271
- end
272
- def self.values
273
- end
274
- end
275
-
276
- # Restrict search to a specific region's OpenSearch cluster. When omitted, all
277
- # regions are queried in parallel (fan-out) and results are merged by cosine
278
- # similarity score.
210
+ # Restrict search to a specific region. When omitted, all regions are queried in
211
+ # parallel (fan-out) and results are merged by similarity score.
279
212
  module Region
280
213
  extend Telnyx::Internal::Type::Enum
281
214