Skip to content

Commit 83f49da

Browse files
stainless-app[bot]stainless-app[bot]
committed
feat: Correct external LLM forwarded metadata docs
1 parent 8757bf7 commit 83f49da

6 files changed

Lines changed: 51 additions & 51 deletions

File tree

‎.stats.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
configured_endpoints: 1029
22
openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/telnyx%2Ftelnyx-19572c62b79a44fd7ffb5094bf3577a11dbc099378a10afeee9b2d03c727a00b.yml
3-
openapi_spec_hash: 79849742c5d3938bb3933089a12166f7
3+
openapi_spec_hash: 35995374c2e89fe8c6f448c30d9fd275
44
config_hash: e27d77ada721542f2cf22308ec03cc97

‎src/telnyx/types/ai/assistant_create_params.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -137,11 +137,11 @@ class ExternalLlm(TypedDict, total=False):
137137

138138
forward_metadata: bool
139139
"""
140-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
141-
external LLM endpoint. Defaults to false. The external endpoint receives the
142-
standard chat completions payload with top-level `metadata` and
143-
`dynamic_variables` objects when values are available. For example:
144-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
140+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
141+
LLM endpoint. Defaults to false. The chat completion request includes a
142+
top-level `extra_metadata` object when dynamic variables are available. For
143+
example:
144+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
145145
"""
146146

147147
llm_api_key_ref: str
@@ -171,11 +171,11 @@ class FallbackConfigExternalLlm(TypedDict, total=False):
171171

172172
forward_metadata: bool
173173
"""
174-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
175-
external LLM endpoint. Defaults to false. The external endpoint receives the
176-
standard chat completions payload with top-level `metadata` and
177-
`dynamic_variables` objects when values are available. For example:
178-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
174+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
175+
LLM endpoint. Defaults to false. The chat completion request includes a
176+
top-level `extra_metadata` object when dynamic variables are available. For
177+
example:
178+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
179179
"""
180180

181181
llm_api_key_ref: str

‎src/telnyx/types/ai/assistant_update_params.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -143,11 +143,11 @@ class ExternalLlm(TypedDict, total=False):
143143

144144
forward_metadata: bool
145145
"""
146-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
147-
external LLM endpoint. Defaults to false. The external endpoint receives the
148-
standard chat completions payload with top-level `metadata` and
149-
`dynamic_variables` objects when values are available. For example:
150-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
146+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
147+
LLM endpoint. Defaults to false. The chat completion request includes a
148+
top-level `extra_metadata` object when dynamic variables are available. For
149+
example:
150+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
151151
"""
152152

153153
llm_api_key_ref: str
@@ -177,11 +177,11 @@ class FallbackConfigExternalLlm(TypedDict, total=False):
177177

178178
forward_metadata: bool
179179
"""
180-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
181-
external LLM endpoint. Defaults to false. The external endpoint receives the
182-
standard chat completions payload with top-level `metadata` and
183-
`dynamic_variables` objects when values are available. For example:
184-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
180+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
181+
LLM endpoint. Defaults to false. The chat completion request includes a
182+
top-level `extra_metadata` object when dynamic variables are available. For
183+
example:
184+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
185185
"""
186186

187187
llm_api_key_ref: str

‎src/telnyx/types/ai/assistants/version_update_params.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -139,11 +139,11 @@ class ExternalLlm(TypedDict, total=False):
139139

140140
forward_metadata: bool
141141
"""
142-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
143-
external LLM endpoint. Defaults to false. The external endpoint receives the
144-
standard chat completions payload with top-level `metadata` and
145-
`dynamic_variables` objects when values are available. For example:
146-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
142+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
143+
LLM endpoint. Defaults to false. The chat completion request includes a
144+
top-level `extra_metadata` object when dynamic variables are available. For
145+
example:
146+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
147147
"""
148148

149149
llm_api_key_ref: str
@@ -173,11 +173,11 @@ class FallbackConfigExternalLlm(TypedDict, total=False):
173173

174174
forward_metadata: bool
175175
"""
176-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
177-
external LLM endpoint. Defaults to false. The external endpoint receives the
178-
standard chat completions payload with top-level `metadata` and
179-
`dynamic_variables` objects when values are available. For example:
180-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
176+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
177+
LLM endpoint. Defaults to false. The chat completion request includes a
178+
top-level `extra_metadata` object when dynamic variables are available. For
179+
example:
180+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
181181
"""
182182

183183
llm_api_key_ref: str

‎src/telnyx/types/ai/inference_embedding.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ class ExternalLlm(BaseModel):
4444

4545
forward_metadata: Optional[bool] = None
4646
"""
47-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
48-
external LLM endpoint. Defaults to false. The external endpoint receives the
49-
standard chat completions payload with top-level `metadata` and
50-
`dynamic_variables` objects when values are available. For example:
51-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
47+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
48+
LLM endpoint. Defaults to false. The chat completion request includes a
49+
top-level `extra_metadata` object when dynamic variables are available. For
50+
example:
51+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
5252
"""
5353

5454
llm_api_key_ref: Optional[str] = None
@@ -78,11 +78,11 @@ class FallbackConfigExternalLlm(BaseModel):
7878

7979
forward_metadata: Optional[bool] = None
8080
"""
81-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
82-
external LLM endpoint. Defaults to false. The external endpoint receives the
83-
standard chat completions payload with top-level `metadata` and
84-
`dynamic_variables` objects when values are available. For example:
85-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
81+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
82+
LLM endpoint. Defaults to false. The chat completion request includes a
83+
top-level `extra_metadata` object when dynamic variables are available. For
84+
example:
85+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
8686
"""
8787

8888
llm_api_key_ref: Optional[str] = None

‎src/telnyx/types/call_assistant_request_param.py‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,11 @@ class ExternalLlm(TypedDict, total=False, extra_items=object): # type: ignore[c
3232

3333
forward_metadata: bool
3434
"""
35-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
36-
external LLM endpoint. Defaults to false. The external endpoint receives the
37-
standard chat completions payload with top-level `metadata` and
38-
`dynamic_variables` objects when values are available. For example:
39-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
35+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
36+
LLM endpoint. Defaults to false. The chat completion request includes a
37+
top-level `extra_metadata` object when dynamic variables are available. For
38+
example:
39+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
4040
"""
4141

4242
llm_api_key_ref: str
@@ -68,11 +68,11 @@ class FallbackConfigExternalLlm(TypedDict, total=False):
6868

6969
forward_metadata: bool
7070
"""
71-
When enabled, Telnyx forwards conversation metadata and dynamic variables to the
72-
external LLM endpoint. Defaults to false. The external endpoint receives the
73-
standard chat completions payload with top-level `metadata` and
74-
`dynamic_variables` objects when values are available. For example:
75-
`{"metadata":{"conversation_id":"conv_123","assistant_id":"assistant_456","call_control_id":"v3:abc123","telnyx_conversation_channel":"phone_call"},"dynamic_variables":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
71+
When enabled, Telnyx forwards the assistant's dynamic variables to the external
72+
LLM endpoint. Defaults to false. The chat completion request includes a
73+
top-level `extra_metadata` object when dynamic variables are available. For
74+
example:
75+
`{"extra_metadata":{"customer_name":"Jane","account_id":"acct_789","telnyx_agent_target":"+13125550100","telnyx_end_user_target":"+13125550123"}}`.
7676
"""
7777

7878
llm_api_key_ref: str

0 commit comments

Comments
 (0)