Skip to content

Commit 8a4327a

Browse files
committed
Re-added all referenced links that were previously removed from name field
1 parent 75db98e commit 8a4327a

File tree

5 files changed

+30
-10
lines changed

5 files changed

+30
-10
lines changed

website/docs/main/swml/methods/_sharedtables/actions.mdx

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ new dialplan actions via the `action` key.
5757
>
5858
Whether to toggle the functions on or off.
5959

60-
See [`toggle_functions`](/swml/guides/ai/toggle_functions) for additional details.
60+
See [`toggle_functions`][toggle_functions] for additional details.
6161
</APIField>
6262

6363
<APIField
@@ -88,7 +88,7 @@ new dialplan actions via the `action` key.
8888
>
8989
A JSON object containing any metadata, as a key-value map. This action sets the data in the [`meta_data`][parameters] to be referenced locally in the function.
9090

91-
See [`set_meta_data`](/swml/guides/ai/set_meta_data) for additional details.
91+
See [`set_meta_data`][set_meta_data] for additional details.
9292
</APIField>
9393

9494
<APIField
@@ -145,9 +145,9 @@ new dialplan actions via the `action` key.
145145
name="context_switch"
146146
type="object"
147147
>
148-
A JSON object containing the context to switch to.
149-
150-
See [`context_switch`](/swml/guides/ai/context_switch) for additional details.
148+
A JSON object containing the context to switch to.
149+
150+
See [`context_switch`][context_switch] for additional details.
151151
</APIField>
152152

153153
<APIField

website/docs/main/swml/methods/ai/ai_params/index.mdx

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ These parameters control the fundamental behavior and capabilities of the AI age
5252
default='"Remember to stay in character. You must not do anything outside the scope of your provided role."'
5353
>
5454
Sets the prompt which binds the agent to its purpose.
55+
56+
See [conscience] for more details.
5557
</APIField>
5658

5759
<APIField
@@ -349,6 +351,8 @@ Manage how the AI agent handles interruptions when users speak over it, includin
349351
type="string"
350352
>
351353
Provide a prompt for the agent to handle crosstalk.
354+
355+
See [interrupt-prompt] for more details.
352356
</APIField>
353357

354358
<APIField
@@ -482,6 +486,8 @@ Control background audio, hold music, and greeting messages to enhance the calle
482486
type="string"
483487
>
484488
A URL for the hold music to play, accepting WAV, mp3, and [FreeSWITCH tone_stream][tone-stream].
489+
490+
See [hold-music] for more details.
485491
</APIField>
486492

487493
<APIField

website/docs/main/swml/methods/ai/ai_swaig/defaults/index.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,5 +24,5 @@ Default settings for all SWAIG functions. If `defaults` is not set, settings may
2424
>
2525
Default URL to send status callbacks and reports to. Authentication can also be set in the url in the format of `username:password@url`.
2626

27-
See [Callback Parameters](./defaults.web_hook_url.mdx) for details on the request body. See [`web_hook_url`](/swml/methods/ai/swaig/defaults/web_hook_url) for additional details.
27+
See [`web_hook_url`](/swml/methods/ai/swaig/defaults/web_hook_url) for additional details.
2828
</APIField>

website/docs/main/swml/methods/ai/index.mdx

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -49,15 +49,13 @@ it is recommended to read the [Prompting Best Practices][Prompting Best Practice
4949
type="object"
5050
required={true}
5151
>
52-
Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations.
52+
Defines the AI agent's personality, goals, behaviors, and instructions for handling conversations.
5353
The prompt establishes how the agent should interact with callers, what information it should gather,
5454
and how it should respond to various scenarios.
5555

56-
It is recommended to write prompts using markdown formatting as LLMs better understand structured content.
56+
It is recommended to write [prompts][prompt] using [markdown formatting][markdown-guide] as LLMs better understand structured content.
5757
Additionally it is recommended to read the [Prompting Best Practices][Prompting Best Practices] guide.
5858

59-
Learn more about the [prompt] parameter.
60-
6159
</APIField>
6260

6361
<APIField
@@ -77,48 +75,62 @@ it is recommended to read the [Prompting Best Practices][Prompting Best Practice
7775
type="string"
7876
>
7977
Hints help the AI agent understand certain words or phrases better. Words that can commonly be misinterpreted can be added to the hints to help the AI speak more accurately.
78+
79+
See [hints] for more details.
8080
</APIField>
8181

8282
<APIField
8383
name="languages"
8484
type="object"
8585
>
8686
An array of JSON objects defining supported languages in the conversation.
87+
88+
See [languages] for more details.
8789
</APIField>
8890

8991
<APIField
9092
name="params"
9193
type="object"
9294
>
9395
A JSON object containing parameters as key-value pairs.
96+
97+
See [params] for more details.
9498
</APIField>
9599

96100
<APIField
97101
name="post_prompt"
98102
type="object"
99103
>
100104
The final set of instructions and configuration settings to send to the agent.
105+
106+
See [post_prompt] for more details.
101107
</APIField>
102108

103109
<APIField
104110
name="post_prompt_url"
105111
type="string"
106112
>
107113
The URL to which to send status callbacks and reports. Authentication can also be set in the url in the format of `username:password@url`.
114+
115+
See [post_prompt_url] for more details.
108116
</APIField>
109117

110118
<APIField
111119
name="pronounce"
112120
type="object"
113121
>
114122
An array of JSON objects to clarify the AI's pronunciation of words or expressions.
123+
124+
See [pronounce] for more details.
115125
</APIField>
116126

117127
<APIField
118128
name="SWAIG"
119129
type="object"
120130
>
121131
An array of JSON objects to create user-defined functions/endpoints that can be executed during the dialogue.
132+
133+
See [SWAIG] for more details.
122134
</APIField>
123135

124136
## Example

website/docs/main/swml/methods/pay/payment_connector_url.mdx

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ The `payment_connector_url` is a required URL that processes payment requests du
1919
type="string"
2020
>
2121
The URL to which payment requests are sent after all required payment details have been provided.
22+
23+
See [pay method][pay-method] for more details.
2224
</APIField>
2325

2426

0 commit comments

Comments
 (0)