Skip to content

Commit 6ac4649

Browse files
author
aws-amplify-bot
committed
chore(release): update API docs [ci skip]
1 parent d505105 commit 6ac4649

File tree

636 files changed

+244387
-167064
lines changed

Some content is hidden

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

636 files changed

+244387
-167064
lines changed

docs/api/assets/js/search.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/api/classes/abstractconvertpredictionsprovider.html

Lines changed: 0 additions & 1242 deletions
This file was deleted.

docs/api/classes/abstractidentifypredictionsprovider.html

Lines changed: 0 additions & 1242 deletions
This file was deleted.

docs/api/classes/abstractinteractionsprovider.html

Lines changed: 0 additions & 1276 deletions
This file was deleted.

docs/api/classes/abstractpredictionsprovider.html

Lines changed: 0 additions & 1134 deletions
This file was deleted.

docs/api/classes/amazonpersonalizeprovider.html renamed to docs/api/classes/abstractpubsub.html

Lines changed: 88 additions & 65 deletions
Large diffs are not rendered by default.

docs/api/classes/abstractpubsubprovider.html

Lines changed: 0 additions & 1272 deletions
This file was deleted.

docs/api/classes/amazonaiconvertpredictionsprovider.html

Lines changed: 29 additions & 142 deletions
Large diffs are not rendered by default.

docs/api/classes/amazonaiidentifypredictionsprovider.html

Lines changed: 26 additions & 139 deletions
Large diffs are not rendered by default.

docs/api/classes/amazonaiinterpretpredictionsprovider.html

Lines changed: 16 additions & 127 deletions
Original file line numberDiff line numberDiff line change
@@ -919,25 +919,13 @@
919919
<li class="current tsd-kind-class">
920920
<a href="amazonaiinterpretpredictionsprovider.html" class="tsd-kind-icon">AmazonAIInterpret<wbr>Predictions<wbr>Provider</a>
921921
<ul>
922-
<li class=" tsd-kind-constructor tsd-parent-kind-class">
923-
<a href="amazonaiinterpretpredictionsprovider.html#constructor" class="tsd-kind-icon">constructor</a>
924-
</li>
925-
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
926-
<a href="amazonaiinterpretpredictionsprovider.html#_config" class="tsd-kind-icon">_config</a>
927-
</li>
928-
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
929-
<a href="amazonaiinterpretpredictionsprovider.html#configure" class="tsd-kind-icon">configure</a>
930-
</li>
931-
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
932-
<a href="amazonaiinterpretpredictionsprovider.html#getcategory" class="tsd-kind-icon">get<wbr>Category</a>
933-
</li>
934-
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
922+
<li class=" tsd-kind-method tsd-parent-kind-class">
935923
<a href="amazonaiinterpretpredictionsprovider.html#getprovidername" class="tsd-kind-icon">get<wbr>Provider<wbr>Name</a>
936924
</li>
937-
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
925+
<li class=" tsd-kind-method tsd-parent-kind-class">
938926
<a href="amazonaiinterpretpredictionsprovider.html#interpret" class="tsd-kind-icon">interpret</a>
939927
</li>
940-
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
928+
<li class=" tsd-kind-method tsd-parent-kind-class">
941929
<a href="amazonaiinterpretpredictionsprovider.html#interprettext" class="tsd-kind-icon">interpret<wbr>Text</a>
942930
</li>
943931
</ul>
@@ -950,153 +938,55 @@
950938
<h3>Hierarchy</h3>
951939
<ul class="tsd-hierarchy">
952940
<li>
953-
<a href="abstractinterpretpredictionsprovider.html" class="tsd-signature-type">AbstractInterpretPredictionsProvider</a>
954-
<ul class="tsd-hierarchy">
955-
<li>
956-
<span class="target">AmazonAIInterpretPredictionsProvider</span>
957-
</li>
958-
</ul>
941+
<span class="target">AmazonAIInterpretPredictionsProvider</span>
959942
</li>
960943
</ul>
961944
</section>
962945
<section class="tsd-panel-group tsd-index-group">
963946
<h2>Index</h2>
964947
<section class="tsd-panel tsd-index-panel">
965948
<div class="tsd-index-content">
966-
<section class="tsd-index-section ">
967-
<h3>Constructors</h3>
968-
<ul class="tsd-index-list">
969-
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="amazonaiinterpretpredictionsprovider.html#constructor" class="tsd-kind-icon">constructor</a></li>
970-
</ul>
971-
</section>
972-
<section class="tsd-index-section tsd-is-inherited tsd-is-private-protected">
973-
<h3>Properties</h3>
974-
<ul class="tsd-index-list">
975-
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected"><a href="amazonaiinterpretpredictionsprovider.html#_config" class="tsd-kind-icon">_config</a></li>
976-
</ul>
977-
</section>
978949
<section class="tsd-index-section ">
979950
<h3>Methods</h3>
980951
<ul class="tsd-index-list">
981-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="amazonaiinterpretpredictionsprovider.html#configure" class="tsd-kind-icon">configure</a></li>
982-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited"><a href="amazonaiinterpretpredictionsprovider.html#getcategory" class="tsd-kind-icon">get<wbr>Category</a></li>
983-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="amazonaiinterpretpredictionsprovider.html#getprovidername" class="tsd-kind-icon">get<wbr>Provider<wbr>Name</a></li>
984-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="amazonaiinterpretpredictionsprovider.html#interpret" class="tsd-kind-icon">interpret</a></li>
985-
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-overwrite"><a href="amazonaiinterpretpredictionsprovider.html#interprettext" class="tsd-kind-icon">interpret<wbr>Text</a></li>
952+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="amazonaiinterpretpredictionsprovider.html#getprovidername" class="tsd-kind-icon">get<wbr>Provider<wbr>Name</a></li>
953+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="amazonaiinterpretpredictionsprovider.html#interpret" class="tsd-kind-icon">interpret</a></li>
954+
<li class="tsd-kind-method tsd-parent-kind-class"><a href="amazonaiinterpretpredictionsprovider.html#interprettext" class="tsd-kind-icon">interpret<wbr>Text</a></li>
986955
</ul>
987956
</section>
988957
</div>
989958
</section>
990959
</section>
991-
<section class="tsd-panel-group tsd-member-group ">
992-
<h2>Constructors</h2>
993-
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
994-
<a name="constructor" class="tsd-anchor"></a>
995-
<h3>constructor</h3>
996-
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
997-
<li class="tsd-signature tsd-kind-icon">new <wbr>AmazonAIInterpret<wbr>Predictions<wbr>Provider<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="amazonaiinterpretpredictionsprovider.html" class="tsd-signature-type">AmazonAIInterpretPredictionsProvider</a></li>
998-
</ul>
999-
<ul class="tsd-descriptions">
1000-
<li class="tsd-description">
1001-
<aside class="tsd-sources">
1002-
<ul>
1003-
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/f0df916a9/packages/predictions/src/Providers/AmazonAIInterpretPredictionsProvider.ts#L30">packages/predictions/src/Providers/AmazonAIInterpretPredictionsProvider.ts:30</a></li>
1004-
</ul>
1005-
</aside>
1006-
<h4 class="tsd-returns-title">Returns <a href="amazonaiinterpretpredictionsprovider.html" class="tsd-signature-type">AmazonAIInterpretPredictionsProvider</a></h4>
1007-
</li>
1008-
</ul>
1009-
</section>
1010-
</section>
1011-
<section class="tsd-panel-group tsd-member-group tsd-is-inherited tsd-is-private-protected">
1012-
<h2>Properties</h2>
1013-
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited tsd-is-protected">
1014-
<a name="_config" class="tsd-anchor"></a>
1015-
<h3><span class="tsd-flag ts-flagProtected">Protected</span> _config</h3>
1016-
<div class="tsd-signature tsd-kind-icon">_config<span class="tsd-signature-symbol">:</span> <a href="../interfaces/predictionsoptions.html" class="tsd-signature-type">PredictionsOptions</a></div>
1017-
<aside class="tsd-sources">
1018-
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#_config">_config</a></p>
1019-
<ul>
1020-
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/f0df916a9/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L9">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:9</a></li>
1021-
</ul>
1022-
</aside>
1023-
</section>
1024-
</section>
1025960
<section class="tsd-panel-group tsd-member-group ">
1026961
<h2>Methods</h2>
1027-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1028-
<a name="configure" class="tsd-anchor"></a>
1029-
<h3>configure</h3>
1030-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
1031-
<li class="tsd-signature tsd-kind-icon">configure<span class="tsd-signature-symbol">(</span>config<span class="tsd-signature-symbol">: </span><a href="../interfaces/predictionsoptions.html" class="tsd-signature-type">PredictionsOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="../interfaces/predictionsoptions.html" class="tsd-signature-type">PredictionsOptions</a></li>
1032-
</ul>
1033-
<ul class="tsd-descriptions">
1034-
<li class="tsd-description">
1035-
<aside class="tsd-sources">
1036-
<p>Inherited from <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#configure">configure</a></p>
1037-
<ul>
1038-
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/f0df916a9/packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts#L11">packages/predictions/src/types/Providers/AbstractPredictionsProvider.ts:11</a></li>
1039-
</ul>
1040-
</aside>
1041-
<h4 class="tsd-parameters-title">Parameters</h4>
1042-
<ul class="tsd-parameters">
1043-
<li>
1044-
<h5>config: <a href="../interfaces/predictionsoptions.html" class="tsd-signature-type">PredictionsOptions</a></h5>
1045-
</li>
1046-
</ul>
1047-
<h4 class="tsd-returns-title">Returns <a href="../interfaces/predictionsoptions.html" class="tsd-signature-type">PredictionsOptions</a></h4>
1048-
</li>
1049-
</ul>
1050-
</section>
1051-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
1052-
<a name="getcategory" class="tsd-anchor"></a>
1053-
<h3>get<wbr>Category</h3>
1054-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite tsd-is-inherited">
1055-
<li class="tsd-signature tsd-kind-icon">get<wbr>Category<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
1056-
</ul>
1057-
<ul class="tsd-descriptions">
1058-
<li class="tsd-description">
1059-
<aside class="tsd-sources">
1060-
<p>Inherited from <a href="abstractinterpretpredictionsprovider.html">AbstractInterpretPredictionsProvider</a>.<a href="abstractinterpretpredictionsprovider.html#getcategory">getCategory</a></p>
1061-
<p>Overrides <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getcategory">getCategory</a></p>
1062-
<ul>
1063-
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/f0df916a9/packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts#L11">packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts:11</a></li>
1064-
</ul>
1065-
</aside>
1066-
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
1067-
</li>
1068-
</ul>
1069-
</section>
1070-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
962+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
1071963
<a name="getprovidername" class="tsd-anchor"></a>
1072964
<h3>get<wbr>Provider<wbr>Name</h3>
1073-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
965+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
1074966
<li class="tsd-signature tsd-kind-icon">get<wbr>Provider<wbr>Name<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></li>
1075967
</ul>
1076968
<ul class="tsd-descriptions">
1077969
<li class="tsd-description">
1078970
<aside class="tsd-sources">
1079-
<p>Overrides <a href="abstractpredictionsprovider.html">AbstractPredictionsProvider</a>.<a href="abstractpredictionsprovider.html#getprovidername">getProviderName</a></p>
1080971
<ul>
1081-
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/f0df916a9/packages/predictions/src/Providers/AmazonAIInterpretPredictionsProvider.ts#L36">packages/predictions/src/Providers/AmazonAIInterpretPredictionsProvider.ts:36</a></li>
972+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/d505105/packages/predictions/src/providers/AmazonAIInterpretPredictionsProvider.ts#L38">packages/predictions/src/providers/AmazonAIInterpretPredictionsProvider.ts:38</a></li>
1082973
</ul>
1083974
</aside>
1084975
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4>
1085976
</li>
1086977
</ul>
1087978
</section>
1088-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
979+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
1089980
<a name="interpret" class="tsd-anchor"></a>
1090981
<h3>interpret</h3>
1091-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
982+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
1092983
<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>
1093984
</ul>
1094985
<ul class="tsd-descriptions">
1095986
<li class="tsd-description">
1096987
<aside class="tsd-sources">
1097-
<p>Inherited from <a href="abstractinterpretpredictionsprovider.html">AbstractInterpretPredictionsProvider</a>.<a href="abstractinterpretpredictionsprovider.html#interpret">interpret</a></p>
1098988
<ul>
1099-
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/f0df916a9/packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts#L15">packages/predictions/src/types/Providers/AbstractInterpretPredictionsProvider.ts:15</a></li>
989+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/d505105/packages/predictions/src/providers/AmazonAIInterpretPredictionsProvider.ts#L42">packages/predictions/src/providers/AmazonAIInterpretPredictionsProvider.ts:42</a></li>
1100990
</ul>
1101991
</aside>
1102992
<h4 class="tsd-parameters-title">Parameters</h4>
@@ -1109,18 +999,17 @@ <h4 class="tsd-returns-title">Returns <a href="asyncitem.html#promise" class="ts
1109999
</li>
11101000
</ul>
11111001
</section>
1112-
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
1002+
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
11131003
<a name="interprettext" class="tsd-anchor"></a>
11141004
<h3>interpret<wbr>Text</h3>
1115-
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-overwrite">
1005+
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
11161006
<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>
11171007
</ul>
11181008
<ul class="tsd-descriptions">
11191009
<li class="tsd-description">
11201010
<aside class="tsd-sources">
1121-
<p>Overrides <a href="abstractinterpretpredictionsprovider.html">AbstractInterpretPredictionsProvider</a>.<a href="abstractinterpretpredictionsprovider.html#interprettext">interpretText</a></p>
11221011
<ul>
1123-
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/f0df916a9/packages/predictions/src/Providers/AmazonAIInterpretPredictionsProvider.ts#L40">packages/predictions/src/Providers/AmazonAIInterpretPredictionsProvider.ts:40</a></li>
1012+
<li>Defined in <a href="https://github.com/aws-amplify/amplify-js/blob/d505105/packages/predictions/src/providers/AmazonAIInterpretPredictionsProvider.ts#L51">packages/predictions/src/providers/AmazonAIInterpretPredictionsProvider.ts:51</a></li>
11241013
</ul>
11251014
</aside>
11261015
<h4 class="tsd-parameters-title">Parameters</h4>

0 commit comments

Comments
 (0)