Skip to content

Commit

Permalink
chore(release): update API docs [skip release]
Browse files Browse the repository at this point in the history
  • Loading branch information
aws-amplify-bot committed Mar 25, 2024
1 parent 6c46368 commit 6dd4fd2
Show file tree
Hide file tree
Showing 284 changed files with 647 additions and 629 deletions.
2 changes: 1 addition & 1 deletion docs/api/assets/navigation.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/assets/search.js

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
<a href="_aws_amplify_predictions._Reference_Types_.AmazonAIIdentifyPredictionsProvider.html#identifyText" class="tsd-index-link tsd-is-protected"><svg class="tsd-kind-icon" viewBox="0 0 24 24"><use href="#icon-2048"></use></svg><span>identify<wbr/>Text</span></a>
</div></section></div></details></section></section><section class="tsd-panel-group tsd-member-group"><h2>Constructors</h2><section class="tsd-panel tsd-member"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>constructor</span><a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="constructor.new_AmazonAIIdentifyPredictionsProvider" class="tsd-anchor"></a><span class="tsd-kind-constructor-signature">new <wbr/>AmazonAIIdentify<wbr/>Predictions<wbr/>Provider</span><span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_aws_amplify_predictions._Reference_Types_.AmazonAIIdentifyPredictionsProvider.html" class="tsd-signature-type tsd-kind-class">AmazonAIIdentifyPredictionsProvider</a><a href="#constructor.new_AmazonAIIdentifyPredictionsProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <a href="_aws_amplify_predictions._Reference_Types_.AmazonAIIdentifyPredictionsProvider.html" class="tsd-signature-type tsd-kind-class">AmazonAIIdentifyPredictionsProvider</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group"><h2>Methods</h2><section class="tsd-panel tsd-member"><a id="getProviderName" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>get<wbr/>Provider<wbr/>Name</span><a href="#getProviderName" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="getProviderName.getProviderName-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">get<wbr/>Provider<wbr/>Name</span><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><a href="#getProviderName.getProviderName-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">string</span></h4></li></ul></section><section class="tsd-panel tsd-member"><a id="identify" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span>identify</span><a href="#identify" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="identify.identify-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">identify</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</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><a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyEntitiesOutput</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_predictions.IdentifyLabelsOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyLabelsOutput</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_predictions.IdentifyTextOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyTextOutput</a><span class="tsd-signature-symbol">&gt;</span><a href="#identify.identify-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesInput.html" class="tsd-signature-type tsd-kind-interface">IdentifyEntitiesInput</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_predictions.IdentifyLabelsInput.html" class="tsd-signature-type tsd-kind-interface">IdentifyLabelsInput</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_predictions.IdentifyTextInput.html" class="tsd-signature-type tsd-kind-interface">IdentifyTextInput</a></h5></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyEntitiesOutput</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_predictions.IdentifyLabelsOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyLabelsOutput</a><span class="tsd-signature-symbol"> | </span><a href="../interfaces/_aws_amplify_predictions.IdentifyTextOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyTextOutput</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="identifyEntities" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>identify<wbr/>Entities</span><a href="#identifyEntities" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class="tsd-signature tsd-anchor-link"><a id="identifyEntities.identifyEntities-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">identify<wbr/>Entities</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</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><a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyEntitiesOutput</a><span class="tsd-signature-symbol">&gt;</span><a href="#identifyEntities.identifyEntities-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Identify faces within an image that is provided as input, and match faces from a collection
or identify celebrities.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesInput.html" class="tsd-signature-type tsd-kind-interface">IdentifyEntitiesInput</a></h5><div class="tsd-comment tsd-typography"><p>object containing the source image and face match options.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyEntitiesOutput</a><span class="tsd-signature-symbol">&gt;</span></h4><p>Promise resolving to identify results.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesInput.html" class="tsd-signature-type tsd-kind-interface">IdentifyEntitiesInput</a></h5><div class="tsd-comment tsd-typography"><p>object of <a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesInput.html" class="tsd-kind-interface">IdentifyEntitiesInput</a> containing the source image and face match options.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyEntitiesOutput</a><span class="tsd-signature-symbol">&gt;</span></h4><p>a promise resolving to identify results as <a href="../interfaces/_aws_amplify_predictions.IdentifyEntitiesOutput.html" class="tsd-kind-interface">IdentifyEntitiesOutput</a>.</p>
<div class="tsd-comment tsd-typography"></div></li></ul></section><section class="tsd-panel tsd-member tsd-is-protected"><a id="identifyLabels" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><code class="tsd-tag ts-flagProtected">Protected</code> <span>identify<wbr/>Labels</span><a href="#identifyLabels" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></h3><ul class="tsd-signatures tsd-is-protected"><li class="tsd-signature tsd-anchor-link"><a id="identifyLabels.identifyLabels-1" class="tsd-anchor"></a><span class="tsd-kind-call-signature">identify<wbr/>Labels</span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">input</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><a href="../interfaces/_aws_amplify_predictions.IdentifyLabelsOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyLabelsOutput</a><span class="tsd-signature-symbol">&gt;</span><a href="#identifyLabels.identifyLabels-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Identify instances of real world entities from an image and if it contains unsafe content.</p>
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><h5><span class="tsd-kind-parameter">input</span>: <a href="../interfaces/_aws_amplify_predictions.IdentifyLabelsInput.html" class="tsd-signature-type tsd-kind-interface">IdentifyLabelsInput</a></h5><div class="tsd-comment tsd-typography"><p>Object containing the source image and entity type to identify.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/_aws_amplify_predictions.IdentifyLabelsOutput.html" class="tsd-signature-type tsd-kind-interface">IdentifyLabelsOutput</a><span class="tsd-signature-symbol">&gt;</span></h4><ul>
Expand Down
Loading

0 comments on commit 6dd4fd2

Please sign in to comment.