Skip to content

Commit b281c78

Browse files
authored
add tags to SWML docs (#182)
1 parent 0f1976e commit b281c78

File tree

99 files changed

+215
-21
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

99 files changed

+215
-21
lines changed

config/presets.ts

+2
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,8 @@ const presets: PresetConfig[] = [
3434
[require("../plugins/remark-plugin-a11y-checker"), { stopOnError: false }],
3535
[require("../plugins/remark-plugin-image-to-figure"), {}],
3636
],
37+
tags: 'tags.yml',
38+
onInlineTags: 'throw'
3739
},
3840
blog: {
3941
blogSidebarCount: "ALL",

docs/home/calling/fax/getting-started/common-fax-errors.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@
22
slug: /fax/getting-started/common-fax-errors
33
title: Common Fax Errors
44
description: Our guide to understanding and troubleshooting the most common fax error messages.
5-
tags:
6-
- product:fax
75
x-custom:
86
ported_from_readme: true
7+
tags:
8+
- product:fax
99
---
1010

1111
# Common Fax Errors

docs/sdks/reference/browser-sdk/video/video-roomsession.mdx

-3
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,6 @@
11
---
22
title: "RoomSession"
33
sidebar_position: 0
4-
tags:
5-
- Browser SDK
6-
- Video
74
---
85

96
import MethodOff from "../../_common/_method_off.mdx";

docs/swml/get-started/index.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ description: Get started with SWML (SignalWire Markup Language), a markup and sc
44
sidebar_position: 0
55
sidebar_label: Introduction
66
slug: /swml
7+
tags: ['swml']
8+
keywords: ['swml', 'signalwire markup language']
79
---
810

911
import UiAccordion from '/docs/_common/dashboard/_ui-accordion.mdx'

docs/swml/guides/AI/ai_agent_with_background_audio.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
slug: /swml/guides/ai/background_audio
33
sidebar_label: AI Agent with Background Audio
4+
tags: ['swml']
5+
description: Learn how to create an AI agent with background audio.
46
---
57

68

docs/swml/guides/AI/back_to_back_functions.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
slug: /swml/guides/ai/back_to_back_functions
33
draft: true
4+
tags: ['swml']
5+
description: Learn how to use the `back_to_back_functions` property in SWAIG functions.
46
x-custom:
57
tags:
68
- favorite

docs/swml/guides/AI/context_switch.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
slug: /swml/guides/ai/context_switch
3+
tags: ['swml']
4+
description: Learn how to use `context_switch` to shift the focus of the conversation.
35
x-custom:
46
tags:
57
- favorite

docs/swml/guides/AI/executing_swml.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
sidebar_label: Executing SWML from a SWAIG function
33
slug: /swml/guides/ai/executing_swml
4+
tags: ['swml']
5+
description: Learn how to execute SWML from a SWAIG function.
46
x-custom:
57
tags:
68
- favorite

docs/swml/guides/AI/holiday-special-santa-ai/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
---
22
slug: /swml/guides/ai/holiday_special_santa_ai
33
title: Holiday Special - Creating a Santa AI with SWML
4+
tags: ['swml']
45
x-custom:
56
tags:
67
- sdk:swml

docs/swml/guides/AI/index.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: SWML AI guides
33
slug: /swml/guides/ai
4+
tags: ['swml']
5+
description: Guides for using AI with SWML.
46
sidebar_custom_props:
57
hideFromIndex: true
68
---

docs/swml/guides/AI/set_meta_data.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
slug: /swml/guides/ai/set_meta_data
33
title: Use `set_meta_data`
4+
description: Learn how to use `set_meta_data` to store metadata to reference later.
5+
tags: ['swml']
46
x-custom:
57
tags:
68
- favorite

docs/swml/guides/AI/swaig/functions/data_map/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ slug: /swml/guides/ai/swaig/functions/data_map
33
title: Understanding `data_map` in SWML SWAIG Functions
44
sidebar_label: Data Map
55
description: Learn how to use `data_map` in SWML SWAIG functions to process, transform, and utilize incoming data effectively.
6+
tags: ['swml']
67
x-custom:
78
tags:
89
- sdk:swml
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
---
22
title: SWAIG.Function Guides
33
slug: /swml/guides/ai/swaig/functions
4+
description: Guides for using SWAIG.functions with SignalWire.
5+
tags: ['swml']
46
---
57

6-
This section contains guides for using SWAIG.Function with SignalWire.
8+
[swaig-function]: /swml/methods/ai/swaig/functions
9+
10+
This section contains guides for using [SWAIG.Function][swaig-function] with SignalWire.
711

812
<DocCardList />

docs/swml/guides/AI/swaig/index.mdx

+5-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,12 @@
11
---
22
title: AI.SWAIG Guides
3+
description: Guides for using ai.SWAIG with SignalWire.
34
slug: /swml/guides/ai/swaig
5+
tags: ['swml']
46
---
57

6-
This section contains guides for using SWAIG.AI with SignalWire.
8+
[ai-swaig]: /swml/methods/ai/swaig
9+
10+
This section contains guides for using [ai.SWAIG][ai-swaig] with SignalWire.
711

812
<DocCardList />

docs/swml/guides/AI/toggle_functions.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
slug: /swml/guides/ai/toggle_functions
3+
tags: ['swml']
4+
description: Learn how to use `toggle_functions` to toggle functions on and off.
35
x-custom:
46
tags:
57
- sdk:swml

docs/swml/guides/AI/voicemail_bot_example.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,16 @@
11
---
22
slug: /swml/guides/ai/voicemail_bot_example
3+
title: Creating a Voicemail Bot
4+
description: Learn how to create a voicemail bot using SWML.
35
sidebar_label: Creating a Voicemail Bot
6+
tags: ['swml']
47
x-custom:
58
tags:
69
- sdk:swml
710
- product:ai
811
- product:voice
912
---
1013

11-
# Creating a Voicemail Bot
12-
1314
```yaml andJson
1415
version: 1.0.0
1516
sections:

docs/swml/guides/call-whisper/index.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
title: Call whisper
33
slug: /swml/guides/call-whisper
44
description: A guide that shows you how to perform a Call Whisper using SWML.
5+
tags: ['swml']
56
x-custom:
67
tags:
78
- favorite

docs/swml/guides/creating-ivr-with-swml/index.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
slug: /swml/guides/creating_ivr
33
title: Create an IVR with SWML
4+
description: Learn how to create an IVR with SWML.
5+
tags: ['swml']
46
x-custom:
57
tags:
68
- favorite

docs/swml/guides/index.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
---
22
title: Overview
3+
description: Guides for using SWML.
34
slug: /swml/guides
45
sidebar_position: 0
6+
tags: ['swml']
57
sidebar_custom_props:
68
hideFromIndex: true
79
---

docs/swml/guides/methods/goto-execute-transfer-disambiguation/index.mdx

+1-2
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22
title: How are the methods goto, execute and transfer different?
33
slug: /swml/guides/methods/goto_execute_transfer_disambiguation
44
description: Learn how to use the goto, execute, and transfer methods in SWML.
5+
tags: ['swml']
56
---
67

7-
# How are the methods goto, execute and transfer different?
8-
98
SWML offers a lot of flexibility in how you control program flow with it's control methods.
109
Of these, [`goto`], [`execute`], and [`transfer`] allow you to unconditionally control program flow.
1110

docs/swml/guides/methods/index.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
title: Methods
33
slug: /swml/guides/methods
4+
tags: ['swml']
5+
description: Guides for using methods with SWML.
46
---
57

68
This section contains guides for using methods with SWML.

docs/swml/guides/methods/request/index.mdx

+3-2
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
---
22
slug: /swml/guides/methods/request
3+
title: Request
4+
description: Learn how to use the request method in SWML to send HTTP requests to a web server.
5+
tags: ['swml']
36
---
47

58

6-
# Request
7-
89
Let us take a deep dive into the [`request`] method. Using this method, you can send HTTP requests to
910
a web server open to internet. It is a simple but powerful way to add all kinds of external functionality to
1011
SWML scripts.

docs/swml/guides/swml_remote_server.mdx

+2-1
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,13 @@
11
---
22
slug: /swml/guides/remote_server
33
title: Handle incoming calls from code
4+
tags: ['swml']
45
x-custom:
56
tags:
67
- sdk:swml
78
- language:nodejs
89
- product:voice
9-
description: Use Node.js and Express.js to dynamically create SWML scripts to handle calls based on incoming call information.
10+
description: Learn how to handle incomming calls from a remote server using SWML.
1011
sidebar_custom_props:
1112
platform: javascript
1213

docs/swml/methods/ai/ai_languages.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ hide_title: false
55
sidebar_position: 1
66
slug: /swml/methods/ai/languages
77
title: ai.languages
8+
description: Configure the spoken language of your AI Agent, as well as the TTS engine, voice, and fillers.
9+
tags: ['swml']
810
---
911

1012
# ai.languages

docs/swml/methods/ai/ai_params/conscience.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ hide_title: false
55
sidebar_position: 1
66
slug: /swml/methods/ai/params/conscience
77
title: params.conscience
8+
description: A prompt for AI that reinforces the AI agent's behavior and guardrails throughout the conversation.
9+
tags: ['swml']
810
---
911

1012

1113
A prompt for AI that can be passed in `ai.conscience` at the top level of the [`ai` Method](./index.mdx).
1214

13-
Used to reinforce the AI agent's behavior after SWAIG calls.
15+
Used to reinforce the AI agent's behavior and guardrails throughout the conversation.
1416

1517
| Name | Type | Default | Description |
1618
|:-----------------------------------------------------------|:---------|:-----------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------|

docs/swml/methods/ai/ai_params/hold_music.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ hide_title: false
55
sidebar_position: 1
66
slug: /swml/methods/ai/params/hold_music
77
title: params.hold_music
8+
description: A URL for the hold music to play, accepting WAV, Mp3, and FreeSWITCH tone_stream.
9+
tags: ['swml']
810
---
911

1012

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

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ hide_title: false
55
sidebar_position: 0
66
title: ai.params
77
slug: /swml/methods/ai/params
8+
description: Parameters for AI that can customize the AI agent's behavior.
9+
tags: ['swml']
810
---
911

1012
[functions-fillers]: /swml/methods/ai/swaig/functions/fillers

docs/swml/methods/ai/ai_params/interrupt_prompt.mdx

+3-1
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,12 @@ hide_title: false
55
sidebar_position: 1
66
slug: /swml/methods/ai/params/interrupt_prompt
77
title: params.interrupt_prompt
8+
description: A prompt for AI that can be passed for when the AI agent is interrupted by the user.
9+
tags: ['swml']
810
---
911

1012

11-
A prompt for AI that can be passed in `ai.interrupt_prompt` at the top level of the [`ai` Method](./index.mdx).
13+
A prompt for AI that can be passed for when the AI agent is interrupted by the user.
1214

1315
| Name | Type | Default | Description |
1416
|:-----------------------------------------------------------------|:---------|:------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------|

docs/swml/methods/ai/ai_post_prompt.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ hide_title: false
44
sidebar_position: 1
55
slug: /swml/methods/ai/post_prompt
66
title: ai.post_prompt
7+
description: The final set of instructions and configuration settings to send to the agent.
8+
tags: ['swml']
79
---
810

911
The final set of instructions and configuration settings to send to the agent.

docs/swml/methods/ai/ai_post_prompt_url.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ hide_title: false
55
sidebar_position: 1
66
slug: /swml/methods/ai/post_prompt_url
77
title: ai.post_prompt_url
8+
description: The URL that the user defines to which to send status callbacks and reports.
9+
tags: ['swml']
810
---
911

1012

docs/swml/methods/ai/ai_pronounce.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ hide_title: false
44
sidebar_position: 1
55
slug: /swml/methods/ai/pronounce
66
title: ai.pronounce
7+
description: Use this object to clarify AI's pronunciation of certain words or expressions.
8+
tags: ['swml']
79
---
810

911

docs/swml/methods/ai/ai_swaig/defaults/defaults.web_hook_url.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ slug: /swml/methods/ai/swaig/defaults/web_hook_url
33
title: defaults.web_hook_url
44
sidebar_label: defaults.web_hook_url
55
description: The default URL that the user defines to which to send status callbacks and reports.
6+
tags: ['swml']
67
---
78
import WebHookUrl from '../../../_sharedtables/web_hook_url_.mdx';
89

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

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
slug: /swml/methods/ai/swaig/defaults
33
title: SWAIG.defaults
44
description: The default settings for all SWAIG functions.
5+
tags: ['swml']
56
---
67

78

docs/swml/methods/ai/ai_swaig/functions/ai_swaig.data_map/data_map.expressions.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ sidebar_position: 1
33
sidebar_label: data_map.expressions
44
slug: /swml/methods/ai/swaig/functions/data_map/expressions
55
title: data_map.expressions
6+
description: An array of objects that define plain string or regex patterns to match against the user's input.
7+
tags: ['swml']
68
---
79

810

docs/swml/methods/ai/ai_swaig/functions/ai_swaig.data_map/data_map.output.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ sidebar_position: 1
33
sidebar_label: data_map.output
44
slug: /swml/methods/ai/swaig/functions/data_map/output
55
title: data_map.output
6+
description: The output object for the SWAIG function.
7+
tags: ['swml']
68
---
79

810

docs/swml/methods/ai/ai_swaig/functions/ai_swaig.data_map/data_map.webhooks/foreach.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22
sidebar_label: webhooks.foreach
33
slug: /swml/methods/ai/swaig/functions/data_map/webhooks/foreach
44
title: webhooks.foreach
5+
description: Iterates over an array of objects and processes an output based on each element in the array.
6+
tags: ['swml']
57
---
68

79
Iterates over an array of objects and processes an output based on each element in the array.

docs/swml/methods/ai/ai_swaig/functions/ai_swaig.data_map/data_map.webhooks/index.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@ sidebar_position: 1
33
sidebar_label: data_map.webhooks
44
slug: /swml/methods/ai/swaig/functions/data_map/webhooks
55
title: data_map.webhooks
6+
description: An array of objects that define external API calls.
7+
tags: ['swml']
68
---
79

810

docs/swml/methods/ai/ai_swaig/functions/ai_swaig.data_map/index.mdx

+2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
---
22
slug: /swml/methods/ai/swaig/functions/data_map
33
title: functions.data_map
4+
description: Defines how a SWAIG function should process and respond to the user's input data.
5+
tags: ['swml']
46
---
57

68

docs/swml/methods/ai/ai_swaig/functions/fillers.mdx

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ slug: /swml/methods/ai/swaig/functions/fillers
33
title: functions.fillers
44
sidebar_label: functions.fillers
55
description: The fillers object for the SWAIG function.
6+
tags: ['swml']
67
---
78

89
import SupportedLanguageCodes from '../../../_sharedtables/supported_langauge_codes.mdx';

0 commit comments

Comments
 (0)