Skip to content

Commit 5a22e40

Browse files
chore: Docs updates (#11111)
1 parent 42d5328 commit 5a22e40

File tree

359 files changed

+5127
-5211
lines changed

Some content is hidden

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

359 files changed

+5127
-5211
lines changed

docs/api/assets/js/search.js

+1-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

docs/api/classes/abstractconvertpredictionsprovider.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -1000,7 +1000,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _config</h3>
10001000
<aside class="tsd-sources">
10011001
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#_config">_config</a></p>
10021002
<ul>
1003-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
1003+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
10041004
</ul>
10051005
</aside>
10061006
</section>
@@ -1018,7 +1018,7 @@ <h3>configure</h3>
10181018
<aside class="tsd-sources">
10191019
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#configure">configure</a></p>
10201020
<ul>
1021-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
1021+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
10221022
</ul>
10231023
</aside>
10241024
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1041,7 +1041,7 @@ <h3>convert</h3>
10411041
<li class="tsd-description">
10421042
<aside class="tsd-sources">
10431043
<ul>
1044-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:21</a></li>
1044+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:21</a></li>
10451045
</ul>
10461046
</aside>
10471047
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1064,7 +1064,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> convert<wbr>Speech<
10641064
<li class="tsd-description">
10651065
<aside class="tsd-sources">
10661066
<ul>
1067-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L48">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:48</a></li>
1067+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L48">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:48</a></li>
10681068
</ul>
10691069
</aside>
10701070
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1087,7 +1087,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> convert<wbr>Text<wb
10871087
<li class="tsd-description">
10881088
<aside class="tsd-sources">
10891089
<ul>
1090-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L42">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:42</a></li>
1090+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L42">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:42</a></li>
10911091
</ul>
10921092
</aside>
10931093
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1111,7 +1111,7 @@ <h3>get<wbr>Category</h3>
11111111
<aside class="tsd-sources">
11121112
<p>Overrides <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getcategory">getCategory</a></p>
11131113
<ul>
1114-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:17</a></li>
1114+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:17</a></li>
11151115
</ul>
11161116
</aside>
11171117
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1129,7 +1129,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Provider<wbr>
11291129
<aside class="tsd-sources">
11301130
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getprovidername">getProviderName</a></p>
11311131
<ul>
1132-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
1132+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
11331133
</ul>
11341134
</aside>
11351135
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1146,7 +1146,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> translate<wbr>Text<
11461146
<li class="tsd-description">
11471147
<aside class="tsd-sources">
11481148
<ul>
1149-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L36">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:36</a></li>
1149+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts#L36">packages/predictions/src/types/Providers/AbstractConvertPredictionsProvider.ts:36</a></li>
11501150
</ul>
11511151
</aside>
11521152
<h4 class="tsd-parameters-title">Parameters</h4>

docs/api/classes/abstractidentifypredictionsprovider.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -1000,7 +1000,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _config</h3>
10001000
<aside class="tsd-sources">
10011001
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#_config">_config</a></p>
10021002
<ul>
1003-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
1003+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
10041004
</ul>
10051005
</aside>
10061006
</section>
@@ -1018,7 +1018,7 @@ <h3>configure</h3>
10181018
<aside class="tsd-sources">
10191019
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#configure">configure</a></p>
10201020
<ul>
1021-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
1021+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
10221022
</ul>
10231023
</aside>
10241024
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1042,7 +1042,7 @@ <h3>get<wbr>Category</h3>
10421042
<aside class="tsd-sources">
10431043
<p>Overrides <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getcategory">getCategory</a></p>
10441044
<ul>
1045-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:17</a></li>
1045+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L17">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:17</a></li>
10461046
</ul>
10471047
</aside>
10481048
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1060,7 +1060,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Provider<wbr>
10601060
<aside class="tsd-sources">
10611061
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getprovidername">getProviderName</a></p>
10621062
<ul>
1063-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
1063+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
10641064
</ul>
10651065
</aside>
10661066
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1077,7 +1077,7 @@ <h3>identify</h3>
10771077
<li class="tsd-description">
10781078
<aside class="tsd-sources">
10791079
<ul>
1080-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:21</a></li>
1080+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L21">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:21</a></li>
10811081
</ul>
10821082
</aside>
10831083
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1100,7 +1100,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> identify<wbr>Entiti
11001100
<li class="tsd-description">
11011101
<aside class="tsd-sources">
11021102
<ul>
1103-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L50">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:50</a></li>
1103+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L50">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:50</a></li>
11041104
</ul>
11051105
</aside>
11061106
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1123,7 +1123,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> identify<wbr>Labels
11231123
<li class="tsd-description">
11241124
<aside class="tsd-sources">
11251125
<ul>
1126-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L44">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:44</a></li>
1126+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L44">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:44</a></li>
11271127
</ul>
11281128
</aside>
11291129
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1146,7 +1146,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> identify<wbr>Text</
11461146
<li class="tsd-description">
11471147
<aside class="tsd-sources">
11481148
<ul>
1149-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L38">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:38</a></li>
1149+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts#L38">packages/predictions/src/types/Providers/AbstractIdentifyPredictionsProvider.ts:38</a></li>
11501150
</ul>
11511151
</aside>
11521152
<h4 class="tsd-parameters-title">Parameters</h4>

docs/api/classes/abstractinteractionsprovider.html

+8-8
Original file line numberDiff line numberDiff line change
@@ -1017,7 +1017,7 @@ <h3>constructor</h3>
10171017
<li class="tsd-description">
10181018
<aside class="tsd-sources">
10191019
<ul>
1020-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/interactions/src/Providers/InteractionsProvider.ts#L16">packages/interactions/src/Providers/InteractionsProvider.ts:16</a></li>
1020+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/interactions/src/Providers/InteractionsProvider.ts#L16">packages/interactions/src/Providers/InteractionsProvider.ts:16</a></li>
10211021
</ul>
10221022
</aside>
10231023
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1039,7 +1039,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _config</h3>
10391039
<div class="tsd-signature tsd-kind-icon">_config<span class="tsd-signature-symbol">:</span> <a href="../interfaces/interactionsoptions.html" class="tsd-signature-type">InteractionsOptions</a></div>
10401040
<aside class="tsd-sources">
10411041
<ul>
1042-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/interactions/src/Providers/InteractionsProvider.ts#L16">packages/interactions/src/Providers/InteractionsProvider.ts:16</a></li>
1042+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/interactions/src/Providers/InteractionsProvider.ts#L16">packages/interactions/src/Providers/InteractionsProvider.ts:16</a></li>
10431043
</ul>
10441044
</aside>
10451045
</section>
@@ -1052,7 +1052,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> options</h3>
10521052
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span></div>
10531053
<aside class="tsd-sources">
10541054
<ul>
1055-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/interactions/src/Providers/InteractionsProvider.ts#L36">packages/interactions/src/Providers/InteractionsProvider.ts:36</a></li>
1055+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/interactions/src/Providers/InteractionsProvider.ts#L36">packages/interactions/src/Providers/InteractionsProvider.ts:36</a></li>
10561056
</ul>
10571057
</aside>
10581058
</section>
@@ -1070,7 +1070,7 @@ <h3>configure</h3>
10701070
<aside class="tsd-sources">
10711071
<p>Implementation of <a href="../interfaces/interactionsprovider.html">InteractionsProvider</a>.<a href="../interfaces/interactionsprovider.html#configure">configure</a></p>
10721072
<ul>
1073-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/interactions/src/Providers/InteractionsProvider.ts#L22">packages/interactions/src/Providers/InteractionsProvider.ts:22</a></li>
1073+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/interactions/src/Providers/InteractionsProvider.ts#L22">packages/interactions/src/Providers/InteractionsProvider.ts:22</a></li>
10741074
</ul>
10751075
</aside>
10761076
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1094,7 +1094,7 @@ <h3>get<wbr>Category</h3>
10941094
<aside class="tsd-sources">
10951095
<p>Implementation of <a href="../interfaces/interactionsprovider.html">InteractionsProvider</a>.<a href="../interfaces/interactionsprovider.html#getcategory">getCategory</a></p>
10961096
<ul>
1097-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/interactions/src/Providers/InteractionsProvider.ts#L30">packages/interactions/src/Providers/InteractionsProvider.ts:30</a></li>
1097+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/interactions/src/Providers/InteractionsProvider.ts#L30">packages/interactions/src/Providers/InteractionsProvider.ts:30</a></li>
10981098
</ul>
10991099
</aside>
11001100
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1112,7 +1112,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Provider<wbr>
11121112
<aside class="tsd-sources">
11131113
<p>Implementation of <a href="../interfaces/interactionsprovider.html">InteractionsProvider</a>.<a href="../interfaces/interactionsprovider.html#getprovidername">getProviderName</a></p>
11141114
<ul>
1115-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/interactions/src/Providers/InteractionsProvider.ts#L34">packages/interactions/src/Providers/InteractionsProvider.ts:34</a></li>
1115+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/interactions/src/Providers/InteractionsProvider.ts#L34">packages/interactions/src/Providers/InteractionsProvider.ts:34</a></li>
11161116
</ul>
11171117
</aside>
11181118
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
@@ -1129,7 +1129,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> on<wbr>Complete</h3>
11291129
<li class="tsd-description">
11301130
<aside class="tsd-sources">
11311131
<ul>
1132-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/interactions/src/Providers/InteractionsProvider.ts#L45">packages/interactions/src/Providers/InteractionsProvider.ts:45</a></li>
1132+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/interactions/src/Providers/InteractionsProvider.ts#L45">packages/interactions/src/Providers/InteractionsProvider.ts:45</a></li>
11331133
</ul>
11341134
</aside>
11351135
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1177,7 +1177,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> send<wbr>Message</h3>
11771177
<aside class="tsd-sources">
11781178
<p>Implementation of <a href="../interfaces/interactionsprovider.html">InteractionsProvider</a>.<a href="../interfaces/interactionsprovider.html#sendmessage">sendMessage</a></p>
11791179
<ul>
1180-
<li>Defined in <a href="https://github.com/jimblanc/amplify-js/blob/485560d00/packages/interactions/src/Providers/InteractionsProvider.ts#L40">packages/interactions/src/Providers/InteractionsProvider.ts:40</a></li>
1180+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/42d5328f8/packages/interactions/src/Providers/InteractionsProvider.ts#L40">packages/interactions/src/Providers/InteractionsProvider.ts:40</a></li>
11811181
</ul>
11821182
</aside>
11831183
<h4 class="tsd-parameters-title">Parameters</h4>

0 commit comments

Comments
 (0)