Skip to content

Commit

Permalink
chore: API Docs updates (#10707)
Browse files Browse the repository at this point in the history
  • Loading branch information
@elorzafe
elorzafe committed Nov 29, 2022
2 parents fa7d6c6 + 275b737 commit b1562e7
Show file tree
Hide file tree
Showing 508 changed files with 33,937 additions and 241,559 deletions.
2 changes: 1 addition & 1 deletion docs/api/assets/js/search.js
View file

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions docs/api/classes/abstractconvertpredictionsprovider.html
View file

Large diffs are not rendered by default.

32 changes: 16 additions & 16 deletions docs/api/classes/abstractidentifypredictionsprovider.html
View file

Large diffs are not rendered by default.

24 changes: 14 additions & 10 deletions docs/api/classes/abstractinteractionsprovider.html
View file
Expand Up @@ -957,6 +957,9 @@ <h3>Hierarchy</h3>
<li>
<a href="awslexprovider.html" class="tsd-signature-type">AWSLexProvider</a>
</li>
<li>
<a href="awslexv2provider.html" class="tsd-signature-type">AWSLexV2Provider</a>
</li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -1014,7 +1017,7 @@ <h3>constructor</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/interactions/src/Providers/InteractionsProvider.ts#L26">packages/interactions/src/Providers/InteractionsProvider.ts:26</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/interactions/src/Providers/InteractionsProvider.ts#L16">packages/interactions/src/Providers/InteractionsProvider.ts:16</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1036,7 +1039,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _config</h3>
<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>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/interactions/src/Providers/InteractionsProvider.ts#L26">packages/interactions/src/Providers/InteractionsProvider.ts:26</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/interactions/src/Providers/InteractionsProvider.ts#L16">packages/interactions/src/Providers/InteractionsProvider.ts:16</a></li>
</ul>
</aside>
</section>
Expand All @@ -1049,7 +1052,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> options</h3>
<div class="tsd-signature tsd-kind-icon">options<span class="tsd-signature-symbol">:</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/interactions/src/Providers/InteractionsProvider.ts#L46">packages/interactions/src/Providers/InteractionsProvider.ts:46</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/interactions/src/Providers/InteractionsProvider.ts#L36">packages/interactions/src/Providers/InteractionsProvider.ts:36</a></li>
</ul>
</aside>
</section>
Expand All @@ -1065,8 +1068,9 @@ <h3>configure</h3>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interactionsprovider.html">InteractionsProvider</a>.<a href="../interfaces/interactionsprovider.html#configure">configure</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/interactions/src/Providers/InteractionsProvider.ts#L32">packages/interactions/src/Providers/InteractionsProvider.ts:32</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/interactions/src/Providers/InteractionsProvider.ts#L22">packages/interactions/src/Providers/InteractionsProvider.ts:22</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1090,7 +1094,7 @@ <h3>get<wbr>Category</h3>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interactionsprovider.html">InteractionsProvider</a>.<a href="../interfaces/interactionsprovider.html#getcategory">getCategory</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/interactions/src/Providers/InteractionsProvider.ts#L40">packages/interactions/src/Providers/InteractionsProvider.ts:40</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/interactions/src/Providers/InteractionsProvider.ts#L30">packages/interactions/src/Providers/InteractionsProvider.ts:30</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -1108,7 +1112,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Provider<wbr>
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interactionsprovider.html">InteractionsProvider</a>.<a href="../interfaces/interactionsprovider.html#getprovidername">getProviderName</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/interactions/src/Providers/InteractionsProvider.ts#L44">packages/interactions/src/Providers/InteractionsProvider.ts:44</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/interactions/src/Providers/InteractionsProvider.ts#L34">packages/interactions/src/Providers/InteractionsProvider.ts:34</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -1125,7 +1129,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> on<wbr>Complete</h3>
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/interactions/src/Providers/InteractionsProvider.ts#L55">packages/interactions/src/Providers/InteractionsProvider.ts:55</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/interactions/src/Providers/InteractionsProvider.ts#L45">packages/interactions/src/Providers/InteractionsProvider.ts:45</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand Down Expand Up @@ -1166,14 +1170,14 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span
<a name="sendmessage" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagAbstract">Abstract</span> send<wbr>Message</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">send<wbr>Message<span class="tsd-signature-symbol">(</span>botname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">send<wbr>Message<span class="tsd-signature-symbol">(</span>botname<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, message<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="asyncitem.html#promise" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<p>Implementation of <a href="../interfaces/interactionsprovider.html">InteractionsProvider</a>.<a href="../interfaces/interactionsprovider.html#sendmessage">sendMessage</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/interactions/src/Providers/InteractionsProvider.ts#L50">packages/interactions/src/Providers/InteractionsProvider.ts:50</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/interactions/src/Providers/InteractionsProvider.ts#L40">packages/interactions/src/Providers/InteractionsProvider.ts:40</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1185,7 +1189,7 @@ <h5>botname: <span class="tsd-signature-type">string</span></h5>
<h5>message: <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">Object</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <a href="asyncitem.html#promise" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">object</span><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
Expand Down
20 changes: 10 additions & 10 deletions docs/api/classes/abstractinterpretpredictionsprovider.html
View file
Expand Up @@ -992,7 +992,7 @@ <h3><span class="tsd-flag ts-flagProtected">Protected</span> _config</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#_config">_config</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L7">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:7</a></li>
</ul>
</aside>
</section>
Expand All @@ -1010,7 +1010,7 @@ <h3>configure</h3>
<aside class="tsd-sources">
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#configure">configure</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1034,7 +1034,7 @@ <h3>get<wbr>Category</h3>
<aside class="tsd-sources">
<p>Overrides <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getcategory">getCategory</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts:9</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts:9</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -1052,7 +1052,7 @@ <h3><span class="tsd-flag ts-flagAbstract">Abstract</span> get<wbr>Provider<wbr>
<aside class="tsd-sources">
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getprovidername">getProviderName</a></p>
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:15</a></li>
</ul>
</aside>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
Expand All @@ -1063,13 +1063,13 @@ <h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</s
<a name="interpret" class="tsd-anchor"></a>
<h3>interpret</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">interpret<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/interprettextinput.html" class="tsd-signature-type">InterpretTextInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interprettextoutput.html" class="tsd-signature-type">InterpretTextOutput</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">interpret<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/interprettextinput.html" class="tsd-signature-type">InterpretTextInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="asyncitem.html#promise" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interprettextoutput.html" class="tsd-signature-type">InterpretTextOutput</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts#L13">packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts:13</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts#L13">packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts:13</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1078,21 +1078,21 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>input: <a href="../interfaces/interprettextinput.html" class="tsd-signature-type">InterpretTextInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interprettextoutput.html" class="tsd-signature-type">InterpretTextOutput</a><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <a href="asyncitem.html#promise" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interprettextoutput.html" class="tsd-signature-type">InterpretTextOutput</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<a name="interprettext" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagProtected">Protected</span> interpret<wbr>Text</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-protected">
<li class="tsd-signature tsd-kind-icon">interpret<wbr>Text<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/interprettextinput.html" class="tsd-signature-type">InterpretTextInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interprettextoutput.html" class="tsd-signature-type">InterpretTextOutput</a><span class="tsd-signature-symbol">&gt;</span></li>
<li class="tsd-signature tsd-kind-icon">interpret<wbr>Text<span class="tsd-signature-symbol">(</span>input<span class="tsd-signature-symbol">: </span><a href="../interfaces/interprettextinput.html" class="tsd-signature-type">InterpretTextInput</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="asyncitem.html#promise" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interprettextoutput.html" class="tsd-signature-type">InterpretTextOutput</a><span class="tsd-signature-symbol">&gt;</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/88fc68a01/packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts#L19">packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts:19</a></li>
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/6caccc7b4/packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts#L19">packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts:19</a></li>
</ul>
</aside>
<h4 class="tsd-parameters-title">Parameters</h4>
Expand All @@ -1101,7 +1101,7 @@ <h4 class="tsd-parameters-title">Parameters</h4>
<h5>input: <a href="../interfaces/interprettextinput.html" class="tsd-signature-type">InterpretTextInput</a></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interprettextoutput.html" class="tsd-signature-type">InterpretTextOutput</a><span class="tsd-signature-symbol">&gt;</span></h4>
<h4 class="tsd-returns-title">Returns <a href="asyncitem.html#promise" class="tsd-signature-type">Promise</a><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/interprettextoutput.html" class="tsd-signature-type">InterpretTextOutput</a><span class="tsd-signature-symbol">&gt;</span></h4>
</li>
</ul>
</section>
Expand Down

0 comments on commit b1562e7

Please sign in to comment.