diff --git a/clients/aws-sdk-bedrock-runtime/docs/Makefile b/clients/aws-sdk-bedrock-runtime/docs/Makefile deleted file mode 100644 index 59458fa..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/Makefile +++ /dev/null @@ -1,15 +0,0 @@ -# Code generated by smithy-python-codegen DO NOT EDIT. - -SPHINXBUILD = sphinx-build -BUILDDIR = build -SERVICESDIR = source/reference/services -SPHINXOPTS = -j auto -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/clients/aws-sdk-bedrock-runtime/docs/README.md b/clients/aws-sdk-bedrock-runtime/docs/README.md deleted file mode 100644 index 141b2c7..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/README.md +++ /dev/null @@ -1,10 +0,0 @@ -## Generating Documentation - -Sphinx is used for documentation. You can generate HTML locally with the -following: - -``` -$ uv pip install --group docs . -$ cd docs -$ make html -``` diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/apply_guardrail.rst b/clients/aws-sdk-bedrock-runtime/docs/client/apply_guardrail.rst deleted file mode 100644 index b1d59c8..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/apply_guardrail.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -apply_guardrail -=============== - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.apply_guardrail - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ApplyGuardrailInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ApplyGuardrailOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/converse.rst b/clients/aws-sdk-bedrock-runtime/docs/client/converse.rst deleted file mode 100644 index 22c01eb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/converse.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -converse -======== - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.converse - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseOperationOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/converse_stream.rst b/clients/aws-sdk-bedrock-runtime/docs/client/converse_stream.rst deleted file mode 100644 index 56edb60..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/converse_stream.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -converse_stream -=============== - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.converse_stream - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOperationOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/count_tokens.rst b/clients/aws-sdk-bedrock-runtime/docs/client/count_tokens.rst deleted file mode 100644 index 3891ee9..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/count_tokens.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -count_tokens -============ - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.count_tokens - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.CountTokensOperationInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.CountTokensOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/get_async_invoke.rst b/clients/aws-sdk-bedrock-runtime/docs/client/get_async_invoke.rst deleted file mode 100644 index 709637f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/get_async_invoke.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -get_async_invoke -================ - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.get_async_invoke - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GetAsyncInvokeInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GetAsyncInvokeOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/index.rst b/clients/aws-sdk-bedrock-runtime/docs/client/index.rst deleted file mode 100644 index 371f32a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Client -======= -.. toctree:: - :maxdepth: 1 - :titlesonly: - :glob: - - * diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model.rst b/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model.rst deleted file mode 100644 index d32c743..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -invoke_model -============ - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.invoke_model - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model_with_bidirectional_stream.rst b/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model_with_bidirectional_stream.rst deleted file mode 100644 index e688299..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model_with_bidirectional_stream.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -invoke_model_with_bidirectional_stream -====================================== - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.invoke_model_with_bidirectional_stream - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOperationInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOperationOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model_with_response_stream.rst b/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model_with_response_stream.rst deleted file mode 100644 index d971a2a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/invoke_model_with_response_stream.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -invoke_model_with_response_stream -================================= - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.invoke_model_with_response_stream - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithResponseStreamInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithResponseStreamOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/list_async_invokes.rst b/clients/aws-sdk-bedrock-runtime/docs/client/list_async_invokes.rst deleted file mode 100644 index 65f65dd..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/list_async_invokes.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -list_async_invokes -================== - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.list_async_invokes - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ListAsyncInvokesInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ListAsyncInvokesOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/client/start_async_invoke.rst b/clients/aws-sdk-bedrock-runtime/docs/client/start_async_invoke.rst deleted file mode 100644 index b782631..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/client/start_async_invoke.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -start_async_invoke -================== - -.. automethod:: aws_sdk_bedrock_runtime.client.BedrockRuntimeClient.start_async_invoke - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.StartAsyncInvokeInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.StartAsyncInvokeOutput - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/conf.py b/clients/aws-sdk-bedrock-runtime/docs/conf.py deleted file mode 100644 index 8a68fa8..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/conf.py +++ /dev/null @@ -1,24 +0,0 @@ -# Code generated by smithy-python-codegen DO NOT EDIT. - -import os -import sys - -sys.path.insert(0, os.path.abspath("..")) - -project = "Amazon Bedrock Runtime" -author = "Amazon Web Services" -release = "0.2.0" - -extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] - -templates_path = ["_templates"] -exclude_patterns = [] - -autodoc_default_options = { - "exclude-members": "deserialize,deserialize_kwargs,serialize,serialize_members" -} - -html_theme = "pydata_sphinx_theme" -html_theme_options = {"logo": {"text": "Amazon Bedrock Runtime"}} - -autodoc_typehints = "description" diff --git a/clients/aws-sdk-bedrock-runtime/docs/index.rst b/clients/aws-sdk-bedrock-runtime/docs/index.rst deleted file mode 100644 index 8d8fb3f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Amazon Bedrock Runtime -====================== - -.. toctree:: - :maxdepth: 2 - :titlesonly: - :glob: - - */index diff --git a/clients/aws-sdk-bedrock-runtime/docs/make.bat b/clients/aws-sdk-bedrock-runtime/docs/make.bat deleted file mode 100644 index 3245132..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -REM Code generated by smithy-python-codegen DO NOT EDIT. - -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=build -set SERVICESDIR=source/reference/services -set SPHINXOPTS=-j auto -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . - -if "%1" == "" goto help - -if "%1" == "clean" ( - rmdir /S /Q %BUILDDIR% - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - echo. - echo "Build finished. The HTML pages are in %BUILDDIR%/html." - goto end -) - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AccessDeniedException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AccessDeniedException.rst deleted file mode 100644 index 2a56317..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AccessDeniedException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -AccessDeniedException -===================== - -.. autoexception:: aws_sdk_bedrock_runtime.models.AccessDeniedException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AnyToolChoice.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AnyToolChoice.rst deleted file mode 100644 index 4929d37..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AnyToolChoice.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -AnyToolChoice -============= - -.. autoclass:: aws_sdk_bedrock_runtime.models.AnyToolChoice - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AppliedGuardrailDetails.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AppliedGuardrailDetails.rst deleted file mode 100644 index 9385c50..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AppliedGuardrailDetails.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -AppliedGuardrailDetails -======================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.AppliedGuardrailDetails - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfig.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfig.rst deleted file mode 100644 index a4b2945..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfig.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _AsyncInvokeOutputDataConfig: - -AsyncInvokeOutputDataConfig -=========================== - -.. autodata:: aws_sdk_bedrock_runtime.models.AsyncInvokeOutputDataConfig diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfigS3OutputDataConfig.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfigS3OutputDataConfig.rst deleted file mode 100644 index 2dc4a64..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfigS3OutputDataConfig.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _AsyncInvokeOutputDataConfigS3OutputDataConfig: - -AsyncInvokeOutputDataConfigS3OutputDataConfig -============================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.AsyncInvokeOutputDataConfigS3OutputDataConfig diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfigUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfigUnknown.rst deleted file mode 100644 index 44ba487..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeOutputDataConfigUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _AsyncInvokeOutputDataConfigUnknown: - -AsyncInvokeOutputDataConfigUnknown -================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.AsyncInvokeOutputDataConfigUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeS3OutputDataConfig.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeS3OutputDataConfig.rst deleted file mode 100644 index 20c05e8..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeS3OutputDataConfig.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -AsyncInvokeS3OutputDataConfig -============================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.AsyncInvokeS3OutputDataConfig - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeSummary.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeSummary.rst deleted file mode 100644 index b521ecb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AsyncInvokeSummary.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -AsyncInvokeSummary -================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.AsyncInvokeSummary - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/AutoToolChoice.rst b/clients/aws-sdk-bedrock-runtime/docs/models/AutoToolChoice.rst deleted file mode 100644 index 2daf886..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/AutoToolChoice.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -AutoToolChoice -============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.AutoToolChoice - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/BidirectionalInputPayloadPart.rst b/clients/aws-sdk-bedrock-runtime/docs/models/BidirectionalInputPayloadPart.rst deleted file mode 100644 index 76a1eef..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/BidirectionalInputPayloadPart.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -BidirectionalInputPayloadPart -============================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.BidirectionalInputPayloadPart - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/BidirectionalOutputPayloadPart.rst b/clients/aws-sdk-bedrock-runtime/docs/models/BidirectionalOutputPayloadPart.rst deleted file mode 100644 index 6c20a50..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/BidirectionalOutputPayloadPart.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -BidirectionalOutputPayloadPart -============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.BidirectionalOutputPayloadPart - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CachePointBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CachePointBlock.rst deleted file mode 100644 index 555af58..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CachePointBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CachePointBlock -=============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CachePointBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/Citation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/Citation.rst deleted file mode 100644 index 8402260..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/Citation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Citation -======== - -.. autoclass:: aws_sdk_bedrock_runtime.models.Citation - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContent.rst deleted file mode 100644 index e6550d8..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationGeneratedContent: - -CitationGeneratedContent -======================== - -.. autodata:: aws_sdk_bedrock_runtime.models.CitationGeneratedContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContentText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContentText.rst deleted file mode 100644 index a9057fa..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContentText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationGeneratedContentText: - -CitationGeneratedContentText -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationGeneratedContentText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContentUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContentUnknown.rst deleted file mode 100644 index 377bed0..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationGeneratedContentUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationGeneratedContentUnknown: - -CitationGeneratedContentUnknown -=============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationGeneratedContentUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocation.rst deleted file mode 100644 index 05c8ea0..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocation.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationLocation: - -CitationLocation -================ - -.. autodata:: aws_sdk_bedrock_runtime.models.CitationLocation diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentChar.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentChar.rst deleted file mode 100644 index 652066f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentChar.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationLocationDocumentChar: - -CitationLocationDocumentChar -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationLocationDocumentChar diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentChunk.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentChunk.rst deleted file mode 100644 index 1a05b2c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentChunk.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationLocationDocumentChunk: - -CitationLocationDocumentChunk -============================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationLocationDocumentChunk diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentPage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentPage.rst deleted file mode 100644 index deaec36..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationDocumentPage.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationLocationDocumentPage: - -CitationLocationDocumentPage -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationLocationDocumentPage diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationSearchResultLocation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationSearchResultLocation.rst deleted file mode 100644 index 5ad6c4a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationSearchResultLocation.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationLocationSearchResultLocation: - -CitationLocationSearchResultLocation -==================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationLocationSearchResultLocation diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationUnknown.rst deleted file mode 100644 index 7102545..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationLocationUnknown: - -CitationLocationUnknown -======================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationLocationUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationWeb.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationWeb.rst deleted file mode 100644 index 1b07822..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationLocationWeb.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationLocationWeb: - -CitationLocationWeb -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationLocationWeb diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContent.rst deleted file mode 100644 index 3e3f814..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationSourceContent: - -CitationSourceContent -===================== - -.. autodata:: aws_sdk_bedrock_runtime.models.CitationSourceContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentDelta.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentDelta.rst deleted file mode 100644 index e2376df..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentDelta.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CitationSourceContentDelta -========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationSourceContentDelta - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentText.rst deleted file mode 100644 index c0f39cf..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationSourceContentText: - -CitationSourceContentText -========================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationSourceContentText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentUnknown.rst deleted file mode 100644 index fe7928c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationSourceContentUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CitationSourceContentUnknown: - -CitationSourceContentUnknown -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationSourceContentUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationsConfig.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationsConfig.rst deleted file mode 100644 index f53ee31..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationsConfig.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CitationsConfig -=============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationsConfig - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationsContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationsContentBlock.rst deleted file mode 100644 index 7e6ff3d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationsContentBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CitationsContentBlock -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationsContentBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CitationsDelta.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CitationsDelta.rst deleted file mode 100644 index c498f6d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CitationsDelta.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CitationsDelta -============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CitationsDelta - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConflictException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConflictException.rst deleted file mode 100644 index c967482..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConflictException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConflictException -================= - -.. autoexception:: aws_sdk_bedrock_runtime.models.ConflictException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlock.rst deleted file mode 100644 index 7884ab4..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlock.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlock: - -ContentBlock -============ - -.. autodata:: aws_sdk_bedrock_runtime.models.ContentBlock diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockCachePoint.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockCachePoint.rst deleted file mode 100644 index 57fa676..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockCachePoint.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockCachePoint: - -ContentBlockCachePoint -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockCachePoint diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockCitationsContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockCitationsContent.rst deleted file mode 100644 index b2406a2..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockCitationsContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockCitationsContent: - -ContentBlockCitationsContent -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockCitationsContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDelta.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDelta.rst deleted file mode 100644 index 5e87458..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDelta.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockDelta: - -ContentBlockDelta -================= - -.. autodata:: aws_sdk_bedrock_runtime.models.ContentBlockDelta diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaCitation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaCitation.rst deleted file mode 100644 index 9d4349a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaCitation.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockDeltaCitation: - -ContentBlockDeltaCitation -========================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockDeltaCitation diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaEvent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaEvent.rst deleted file mode 100644 index d67f1b2..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ContentBlockDeltaEvent -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockDeltaEvent - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaReasoningContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaReasoningContent.rst deleted file mode 100644 index 202a6a0..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaReasoningContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockDeltaReasoningContent: - -ContentBlockDeltaReasoningContent -================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockDeltaReasoningContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaText.rst deleted file mode 100644 index df0dce1..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockDeltaText: - -ContentBlockDeltaText -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockDeltaText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaToolResult.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaToolResult.rst deleted file mode 100644 index 83efbbb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaToolResult.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockDeltaToolResult: - -ContentBlockDeltaToolResult -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockDeltaToolResult diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaToolUse.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaToolUse.rst deleted file mode 100644 index 5c1964f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaToolUse.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockDeltaToolUse: - -ContentBlockDeltaToolUse -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockDeltaToolUse diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaUnknown.rst deleted file mode 100644 index dcf99d5..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDeltaUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockDeltaUnknown: - -ContentBlockDeltaUnknown -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockDeltaUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDocument.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDocument.rst deleted file mode 100644 index 10eef28..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockDocument.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockDocument: - -ContentBlockDocument -==================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockDocument diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockGuardContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockGuardContent.rst deleted file mode 100644 index 05d191f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockGuardContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockGuardContent: - -ContentBlockGuardContent -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockGuardContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockImage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockImage.rst deleted file mode 100644 index 19696c5..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockImage.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockImage: - -ContentBlockImage -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockImage diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockReasoningContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockReasoningContent.rst deleted file mode 100644 index 1798eb4..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockReasoningContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockReasoningContent: - -ContentBlockReasoningContent -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockReasoningContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockSearchResult.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockSearchResult.rst deleted file mode 100644 index 5334d7b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockSearchResult.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockSearchResult: - -ContentBlockSearchResult -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockSearchResult diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStart.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStart.rst deleted file mode 100644 index a1169f0..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStart.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockStart: - -ContentBlockStart -================= - -.. autodata:: aws_sdk_bedrock_runtime.models.ContentBlockStart diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartEvent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartEvent.rst deleted file mode 100644 index 4e2af6a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ContentBlockStartEvent -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockStartEvent - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartToolResult.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartToolResult.rst deleted file mode 100644 index e326ab0..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartToolResult.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockStartToolResult: - -ContentBlockStartToolResult -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockStartToolResult diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartToolUse.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartToolUse.rst deleted file mode 100644 index 5619a0d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartToolUse.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockStartToolUse: - -ContentBlockStartToolUse -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockStartToolUse diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartUnknown.rst deleted file mode 100644 index 74615c2..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStartUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockStartUnknown: - -ContentBlockStartUnknown -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockStartUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStopEvent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStopEvent.rst deleted file mode 100644 index c7cec1d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockStopEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ContentBlockStopEvent -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockStopEvent - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockText.rst deleted file mode 100644 index 571892c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockText: - -ContentBlockText -================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockToolResult.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockToolResult.rst deleted file mode 100644 index f21157c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockToolResult.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockToolResult: - -ContentBlockToolResult -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockToolResult diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockToolUse.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockToolUse.rst deleted file mode 100644 index 4120c0b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockToolUse.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockToolUse: - -ContentBlockToolUse -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockToolUse diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockUnknown.rst deleted file mode 100644 index 365c274..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockUnknown: - -ContentBlockUnknown -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockVideo.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockVideo.rst deleted file mode 100644 index c352a88..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ContentBlockVideo.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ContentBlockVideo: - -ContentBlockVideo -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ContentBlockVideo diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseMetrics.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseMetrics.rst deleted file mode 100644 index c592a0b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseMetrics.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConverseMetrics -=============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseMetrics - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutput.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutput.rst deleted file mode 100644 index 9e3e84f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutput.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseOutput: - -ConverseOutput -============== - -.. autodata:: aws_sdk_bedrock_runtime.models.ConverseOutput diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutputMessage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutputMessage.rst deleted file mode 100644 index 67ee967..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutputMessage.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseOutputMessage: - -ConverseOutputMessage -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseOutputMessage diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutputUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutputUnknown.rst deleted file mode 100644 index 980accf..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseOutputUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseOutputUnknown: - -ConverseOutputUnknown -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseOutputUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamMetadataEvent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamMetadataEvent.rst deleted file mode 100644 index 6c18461..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamMetadataEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConverseStreamMetadataEvent -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamMetadataEvent - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamMetrics.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamMetrics.rst deleted file mode 100644 index 9f4cfad..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamMetrics.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConverseStreamMetrics -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamMetrics - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutput.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutput.rst deleted file mode 100644 index 564202f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutput.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutput: - -ConverseStreamOutput -==================== - -.. autodata:: aws_sdk_bedrock_runtime.models.ConverseStreamOutput diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockDelta.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockDelta.rst deleted file mode 100644 index 3eb660e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockDelta.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputContentBlockDelta: - -ConverseStreamOutputContentBlockDelta -===================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputContentBlockDelta diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockStart.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockStart.rst deleted file mode 100644 index 393dee9..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockStart.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputContentBlockStart: - -ConverseStreamOutputContentBlockStart -===================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputContentBlockStart diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockStop.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockStop.rst deleted file mode 100644 index 23cf1af..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputContentBlockStop.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputContentBlockStop: - -ConverseStreamOutputContentBlockStop -==================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputContentBlockStop diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputInternalServerException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputInternalServerException.rst deleted file mode 100644 index b078958..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputInternalServerException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputInternalServerException: - -ConverseStreamOutputInternalServerException -=========================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputInternalServerException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMessageStart.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMessageStart.rst deleted file mode 100644 index 1926594..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMessageStart.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputMessageStart: - -ConverseStreamOutputMessageStart -================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputMessageStart diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMessageStop.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMessageStop.rst deleted file mode 100644 index 7af89a5..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMessageStop.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputMessageStop: - -ConverseStreamOutputMessageStop -=============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputMessageStop diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMetadata.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMetadata.rst deleted file mode 100644 index 921c50e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputMetadata.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputMetadata: - -ConverseStreamOutputMetadata -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputMetadata diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputModelStreamErrorException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputModelStreamErrorException.rst deleted file mode 100644 index 5e8a6a9..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputModelStreamErrorException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputModelStreamErrorException: - -ConverseStreamOutputModelStreamErrorException -============================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputModelStreamErrorException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputServiceUnavailableException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputServiceUnavailableException.rst deleted file mode 100644 index 6b3c44d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputServiceUnavailableException: - -ConverseStreamOutputServiceUnavailableException -=============================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputServiceUnavailableException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputThrottlingException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputThrottlingException.rst deleted file mode 100644 index ec8c5f7..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputThrottlingException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputThrottlingException: - -ConverseStreamOutputThrottlingException -======================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputThrottlingException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputUnknown.rst deleted file mode 100644 index 72da278..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputUnknown: - -ConverseStreamOutputUnknown -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputValidationException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputValidationException.rst deleted file mode 100644 index d172ad4..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamOutputValidationException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ConverseStreamOutputValidationException: - -ConverseStreamOutputValidationException -======================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamOutputValidationException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamTrace.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamTrace.rst deleted file mode 100644 index 848eeab..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseStreamTrace.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConverseStreamTrace -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseStreamTrace - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseTokensRequest.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseTokensRequest.rst deleted file mode 100644 index 00d4c64..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseTokensRequest.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConverseTokensRequest -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseTokensRequest - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseTrace.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ConverseTrace.rst deleted file mode 100644 index a8da8d5..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ConverseTrace.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConverseTrace -============= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ConverseTrace - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInput.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInput.rst deleted file mode 100644 index 0fee59f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInput.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CountTokensInput: - -CountTokensInput -================ - -.. autodata:: aws_sdk_bedrock_runtime.models.CountTokensInput diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputConverse.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputConverse.rst deleted file mode 100644 index b96d33a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputConverse.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CountTokensInputConverse: - -CountTokensInputConverse -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CountTokensInputConverse diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputInvokeModel.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputInvokeModel.rst deleted file mode 100644 index 23e80b8..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputInvokeModel.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CountTokensInputInvokeModel: - -CountTokensInputInvokeModel -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.CountTokensInputInvokeModel diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputUnknown.rst deleted file mode 100644 index ccb9692..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/CountTokensInputUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CountTokensInputUnknown: - -CountTokensInputUnknown -======================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.CountTokensInputUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentBlock.rst deleted file mode 100644 index 98287d7..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -DocumentBlock -============= - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentCharLocation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentCharLocation.rst deleted file mode 100644 index 84a596e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentCharLocation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -DocumentCharLocation -==================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentCharLocation - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentChunkLocation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentChunkLocation.rst deleted file mode 100644 index fe442fd..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentChunkLocation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -DocumentChunkLocation -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentChunkLocation - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlock.rst deleted file mode 100644 index dd5d13f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlock.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentContentBlock: - -DocumentContentBlock -==================== - -.. autodata:: aws_sdk_bedrock_runtime.models.DocumentContentBlock diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlockText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlockText.rst deleted file mode 100644 index 776e7ee..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlockText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentContentBlockText: - -DocumentContentBlockText -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentContentBlockText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlockUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlockUnknown.rst deleted file mode 100644 index 22ce953..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentContentBlockUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentContentBlockUnknown: - -DocumentContentBlockUnknown -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentContentBlockUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentPageLocation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentPageLocation.rst deleted file mode 100644 index 4bcef38..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentPageLocation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -DocumentPageLocation -==================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentPageLocation - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSource.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSource.rst deleted file mode 100644 index 547b919..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSource.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentSource: - -DocumentSource -============== - -.. autodata:: aws_sdk_bedrock_runtime.models.DocumentSource diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceBytes.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceBytes.rst deleted file mode 100644 index be564d6..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceBytes.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentSourceBytes: - -DocumentSourceBytes -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentSourceBytes diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceContent.rst deleted file mode 100644 index b8a5939..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentSourceContent: - -DocumentSourceContent -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentSourceContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceS3Location.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceS3Location.rst deleted file mode 100644 index 1956d70..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceS3Location.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentSourceS3Location: - -DocumentSourceS3Location -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentSourceS3Location diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceText.rst deleted file mode 100644 index 50ce90f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentSourceText: - -DocumentSourceText -================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentSourceText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceUnknown.rst deleted file mode 100644 index 0cdcba0..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/DocumentSourceUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _DocumentSourceUnknown: - -DocumentSourceUnknown -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.DocumentSourceUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAssessment.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAssessment.rst deleted file mode 100644 index ee239a3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAssessment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAssessment -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAssessment - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFinding.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFinding.rst deleted file mode 100644 index b9b3a54..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFinding.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFinding: - -GuardrailAutomatedReasoningFinding -================================== - -.. autodata:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFinding diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingImpossible.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingImpossible.rst deleted file mode 100644 index 0d75006..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingImpossible.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFindingImpossible: - -GuardrailAutomatedReasoningFindingImpossible -============================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFindingImpossible diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingInvalid.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingInvalid.rst deleted file mode 100644 index 2c689a7..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingInvalid.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFindingInvalid: - -GuardrailAutomatedReasoningFindingInvalid -========================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFindingInvalid diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingNoTranslations.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingNoTranslations.rst deleted file mode 100644 index 14c206b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingNoTranslations.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFindingNoTranslations: - -GuardrailAutomatedReasoningFindingNoTranslations -================================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFindingNoTranslations diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingSatisfiable.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingSatisfiable.rst deleted file mode 100644 index c231dc3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingSatisfiable.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFindingSatisfiable: - -GuardrailAutomatedReasoningFindingSatisfiable -============================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFindingSatisfiable diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingTooComplex.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingTooComplex.rst deleted file mode 100644 index 0be78ea..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingTooComplex.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFindingTooComplex: - -GuardrailAutomatedReasoningFindingTooComplex -============================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFindingTooComplex diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingTranslationAmbiguous.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingTranslationAmbiguous.rst deleted file mode 100644 index 5ad5208..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingTranslationAmbiguous.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFindingTranslationAmbiguous: - -GuardrailAutomatedReasoningFindingTranslationAmbiguous -====================================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFindingTranslationAmbiguous diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingUnknown.rst deleted file mode 100644 index bf2f198..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFindingUnknown: - -GuardrailAutomatedReasoningFindingUnknown -========================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFindingUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingValid.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingValid.rst deleted file mode 100644 index 76da39e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningFindingValid.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailAutomatedReasoningFindingValid: - -GuardrailAutomatedReasoningFindingValid -======================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningFindingValid diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningImpossibleFinding.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningImpossibleFinding.rst deleted file mode 100644 index 08bcc44..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningImpossibleFinding.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningImpossibleFinding -============================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningImpossibleFinding - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningInputTextReference.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningInputTextReference.rst deleted file mode 100644 index c82096c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningInputTextReference.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningInputTextReference -============================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningInputTextReference - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningInvalidFinding.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningInvalidFinding.rst deleted file mode 100644 index 566dfde..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningInvalidFinding.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningInvalidFinding -========================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningInvalidFinding - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningLogicWarning.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningLogicWarning.rst deleted file mode 100644 index 023c6cd..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningLogicWarning.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningLogicWarning -======================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningLogicWarning - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningNoTranslationsFinding.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningNoTranslationsFinding.rst deleted file mode 100644 index 73027b5..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningNoTranslationsFinding.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningNoTranslationsFinding -================================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningNoTranslationsFinding - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningPolicyAssessment.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningPolicyAssessment.rst deleted file mode 100644 index dae19df..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningPolicyAssessment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningPolicyAssessment -=========================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningPolicyAssessment - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningRule.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningRule.rst deleted file mode 100644 index 6e84eea..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningRule.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningRule -=============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningRule - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningSatisfiableFinding.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningSatisfiableFinding.rst deleted file mode 100644 index 8d75da6..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningSatisfiableFinding.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningSatisfiableFinding -============================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningSatisfiableFinding - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningScenario.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningScenario.rst deleted file mode 100644 index 448c6d8..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningScenario.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningScenario -=================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningScenario - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningStatement.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningStatement.rst deleted file mode 100644 index 40720de..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningStatement.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningStatement -==================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningStatement - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTooComplexFinding.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTooComplexFinding.rst deleted file mode 100644 index 3efede1..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTooComplexFinding.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningTooComplexFinding -============================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningTooComplexFinding - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslation.rst deleted file mode 100644 index ef8d59c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningTranslation -====================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningTranslation - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslationAmbiguousFinding.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslationAmbiguousFinding.rst deleted file mode 100644 index d166b10..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslationAmbiguousFinding.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningTranslationAmbiguousFinding -====================================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningTranslationAmbiguousFinding - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslationOption.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslationOption.rst deleted file mode 100644 index 83a59ec..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningTranslationOption.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningTranslationOption -============================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningTranslationOption - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningValidFinding.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningValidFinding.rst deleted file mode 100644 index c3880df..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailAutomatedReasoningValidFinding.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailAutomatedReasoningValidFinding -======================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailAutomatedReasoningValidFinding - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConfiguration.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConfiguration.rst deleted file mode 100644 index 427c653..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConfiguration.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailConfiguration -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailConfiguration - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlock.rst deleted file mode 100644 index 7044071..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlock.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailContentBlock: - -GuardrailContentBlock -===================== - -.. autodata:: aws_sdk_bedrock_runtime.models.GuardrailContentBlock diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockImage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockImage.rst deleted file mode 100644 index bf9718f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockImage.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailContentBlockImage: - -GuardrailContentBlockImage -========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailContentBlockImage diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockText.rst deleted file mode 100644 index 39d601b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailContentBlockText: - -GuardrailContentBlockText -========================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailContentBlockText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockUnknown.rst deleted file mode 100644 index a73bf75..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentBlockUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailContentBlockUnknown: - -GuardrailContentBlockUnknown -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailContentBlockUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentFilter.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentFilter.rst deleted file mode 100644 index 5290cda..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentFilter.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailContentFilter -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailContentFilter - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentPolicyAssessment.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentPolicyAssessment.rst deleted file mode 100644 index e6f53eb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContentPolicyAssessment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailContentPolicyAssessment -================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailContentPolicyAssessment - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContextualGroundingFilter.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContextualGroundingFilter.rst deleted file mode 100644 index f5adb91..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContextualGroundingFilter.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailContextualGroundingFilter -================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailContextualGroundingFilter - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContextualGroundingPolicyAssessment.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContextualGroundingPolicyAssessment.rst deleted file mode 100644 index 3e57695..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailContextualGroundingPolicyAssessment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailContextualGroundingPolicyAssessment -============================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailContextualGroundingPolicyAssessment - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlock.rst deleted file mode 100644 index d6d1525..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlock.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailConverseContentBlock: - -GuardrailConverseContentBlock -============================= - -.. autodata:: aws_sdk_bedrock_runtime.models.GuardrailConverseContentBlock diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockImage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockImage.rst deleted file mode 100644 index c253256..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockImage.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailConverseContentBlockImage: - -GuardrailConverseContentBlockImage -================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailConverseContentBlockImage diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockText.rst deleted file mode 100644 index 5d91aa3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailConverseContentBlockText: - -GuardrailConverseContentBlockText -================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailConverseContentBlockText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockUnknown.rst deleted file mode 100644 index af405d6..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseContentBlockUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailConverseContentBlockUnknown: - -GuardrailConverseContentBlockUnknown -==================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailConverseContentBlockUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageBlock.rst deleted file mode 100644 index c20a5c5..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailConverseImageBlock -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailConverseImageBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSource.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSource.rst deleted file mode 100644 index e3cf4d5..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSource.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailConverseImageSource: - -GuardrailConverseImageSource -============================ - -.. autodata:: aws_sdk_bedrock_runtime.models.GuardrailConverseImageSource diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSourceBytes.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSourceBytes.rst deleted file mode 100644 index 694cb25..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSourceBytes.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailConverseImageSourceBytes: - -GuardrailConverseImageSourceBytes -================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailConverseImageSourceBytes diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSourceUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSourceUnknown.rst deleted file mode 100644 index 0ca1af7..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseImageSourceUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailConverseImageSourceUnknown: - -GuardrailConverseImageSourceUnknown -=================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailConverseImageSourceUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseTextBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseTextBlock.rst deleted file mode 100644 index 865e8d3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailConverseTextBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailConverseTextBlock -========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailConverseTextBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailCoverage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailCoverage.rst deleted file mode 100644 index 1932629..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailCoverage.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailCoverage -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailCoverage - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailCustomWord.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailCustomWord.rst deleted file mode 100644 index 775fe4d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailCustomWord.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailCustomWord -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailCustomWord - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageBlock.rst deleted file mode 100644 index c3c9c31..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailImageBlock -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailImageBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageCoverage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageCoverage.rst deleted file mode 100644 index 1f62948..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageCoverage.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailImageCoverage -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailImageCoverage - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSource.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSource.rst deleted file mode 100644 index e9d4080..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSource.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailImageSource: - -GuardrailImageSource -==================== - -.. autodata:: aws_sdk_bedrock_runtime.models.GuardrailImageSource diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSourceBytes.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSourceBytes.rst deleted file mode 100644 index 5455c76..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSourceBytes.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailImageSourceBytes: - -GuardrailImageSourceBytes -========================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailImageSourceBytes diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSourceUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSourceUnknown.rst deleted file mode 100644 index 9311747..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailImageSourceUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _GuardrailImageSourceUnknown: - -GuardrailImageSourceUnknown -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailImageSourceUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailInvocationMetrics.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailInvocationMetrics.rst deleted file mode 100644 index 590d7af..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailInvocationMetrics.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailInvocationMetrics -========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailInvocationMetrics - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailManagedWord.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailManagedWord.rst deleted file mode 100644 index 2ba02cd..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailManagedWord.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailManagedWord -==================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailManagedWord - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailOutputContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailOutputContent.rst deleted file mode 100644 index 5899fcc..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailOutputContent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailOutputContent -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailOutputContent - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailPiiEntityFilter.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailPiiEntityFilter.rst deleted file mode 100644 index c51ee94..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailPiiEntityFilter.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailPiiEntityFilter -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailPiiEntityFilter - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailRegexFilter.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailRegexFilter.rst deleted file mode 100644 index c9350fc..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailRegexFilter.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailRegexFilter -==================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailRegexFilter - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailSensitiveInformationPolicyAssessment.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailSensitiveInformationPolicyAssessment.rst deleted file mode 100644 index 21f78da..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailSensitiveInformationPolicyAssessment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailSensitiveInformationPolicyAssessment -============================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailSensitiveInformationPolicyAssessment - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailStreamConfiguration.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailStreamConfiguration.rst deleted file mode 100644 index d5bdc6e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailStreamConfiguration.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailStreamConfiguration -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailStreamConfiguration - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTextBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTextBlock.rst deleted file mode 100644 index 2f2a01d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTextBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailTextBlock -================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailTextBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTextCharactersCoverage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTextCharactersCoverage.rst deleted file mode 100644 index ad3305e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTextCharactersCoverage.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailTextCharactersCoverage -=============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailTextCharactersCoverage - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTopic.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTopic.rst deleted file mode 100644 index 6183629..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTopic.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailTopic -============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailTopic - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTopicPolicyAssessment.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTopicPolicyAssessment.rst deleted file mode 100644 index d7eaa0d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTopicPolicyAssessment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailTopicPolicyAssessment -============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailTopicPolicyAssessment - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTraceAssessment.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTraceAssessment.rst deleted file mode 100644 index 6bb680b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailTraceAssessment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailTraceAssessment -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailTraceAssessment - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailUsage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailUsage.rst deleted file mode 100644 index 3a7bb8a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailUsage.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailUsage -============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailUsage - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailWordPolicyAssessment.rst b/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailWordPolicyAssessment.rst deleted file mode 100644 index ec41897..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/GuardrailWordPolicyAssessment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -GuardrailWordPolicyAssessment -============================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.GuardrailWordPolicyAssessment - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ImageBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ImageBlock.rst deleted file mode 100644 index 932a8f2..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ImageBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ImageBlock -========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ImageBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ImageSource.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ImageSource.rst deleted file mode 100644 index 73fb43f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ImageSource.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ImageSource: - -ImageSource -=========== - -.. autodata:: aws_sdk_bedrock_runtime.models.ImageSource diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceBytes.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceBytes.rst deleted file mode 100644 index c508cc5..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceBytes.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ImageSourceBytes: - -ImageSourceBytes -================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ImageSourceBytes diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceS3Location.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceS3Location.rst deleted file mode 100644 index 40671cb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceS3Location.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ImageSourceS3Location: - -ImageSourceS3Location -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ImageSourceS3Location diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceUnknown.rst deleted file mode 100644 index 4db8e9b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ImageSourceUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ImageSourceUnknown: - -ImageSourceUnknown -================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ImageSourceUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InferenceConfiguration.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InferenceConfiguration.rst deleted file mode 100644 index bb8d4b3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InferenceConfiguration.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -InferenceConfiguration -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.InferenceConfiguration - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InternalServerException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InternalServerException.rst deleted file mode 100644 index 6d51ab6..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InternalServerException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -InternalServerException -======================= - -.. autoexception:: aws_sdk_bedrock_runtime.models.InternalServerException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelTokensRequest.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelTokensRequest.rst deleted file mode 100644 index 02d1cdb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelTokensRequest.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -InvokeModelTokensRequest -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelTokensRequest - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInput.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInput.rst deleted file mode 100644 index ef73a25..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInput.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamInput: - -InvokeModelWithBidirectionalStreamInput -======================================= - -.. autodata:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamInput diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInputChunk.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInputChunk.rst deleted file mode 100644 index 0f8c3eb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInputChunk.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamInputChunk: - -InvokeModelWithBidirectionalStreamInputChunk -============================================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamInputChunk diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInputUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInputUnknown.rst deleted file mode 100644 index b588a0b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamInputUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamInputUnknown: - -InvokeModelWithBidirectionalStreamInputUnknown -============================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamInputUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutput.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutput.rst deleted file mode 100644 index 49e1312..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutput.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutput: - -InvokeModelWithBidirectionalStreamOutput -======================================== - -.. autodata:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutput diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputChunk.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputChunk.rst deleted file mode 100644 index 8e1af1e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputChunk.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutputChunk: - -InvokeModelWithBidirectionalStreamOutputChunk -============================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutputChunk diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputInternalServerException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputInternalServerException.rst deleted file mode 100644 index 6addd58..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputInternalServerException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutputInternalServerException: - -InvokeModelWithBidirectionalStreamOutputInternalServerException -=============================================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutputInternalServerException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputModelStreamErrorException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputModelStreamErrorException.rst deleted file mode 100644 index 8addc9e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputModelStreamErrorException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutputModelStreamErrorException: - -InvokeModelWithBidirectionalStreamOutputModelStreamErrorException -================================================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutputModelStreamErrorException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputModelTimeoutException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputModelTimeoutException.rst deleted file mode 100644 index 0c46b1b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputModelTimeoutException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutputModelTimeoutException: - -InvokeModelWithBidirectionalStreamOutputModelTimeoutException -============================================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutputModelTimeoutException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputServiceUnavailableException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputServiceUnavailableException.rst deleted file mode 100644 index aadcac1..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutputServiceUnavailableException: - -InvokeModelWithBidirectionalStreamOutputServiceUnavailableException -=================================================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutputServiceUnavailableException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputThrottlingException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputThrottlingException.rst deleted file mode 100644 index d590204..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputThrottlingException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutputThrottlingException: - -InvokeModelWithBidirectionalStreamOutputThrottlingException -=========================================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutputThrottlingException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputUnknown.rst deleted file mode 100644 index 2e19a67..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutputUnknown: - -InvokeModelWithBidirectionalStreamOutputUnknown -=============================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutputUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputValidationException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputValidationException.rst deleted file mode 100644 index 0350b5b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/InvokeModelWithBidirectionalStreamOutputValidationException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _InvokeModelWithBidirectionalStreamOutputValidationException: - -InvokeModelWithBidirectionalStreamOutputValidationException -=========================================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.InvokeModelWithBidirectionalStreamOutputValidationException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/Message.rst b/clients/aws-sdk-bedrock-runtime/docs/models/Message.rst deleted file mode 100644 index 63123be..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/Message.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Message -======= - -.. autoclass:: aws_sdk_bedrock_runtime.models.Message - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/MessageStartEvent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/MessageStartEvent.rst deleted file mode 100644 index 87a90d7..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/MessageStartEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MessageStartEvent -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.MessageStartEvent - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/MessageStopEvent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/MessageStopEvent.rst deleted file mode 100644 index 29292c3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/MessageStopEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MessageStopEvent -================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.MessageStopEvent - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ModelErrorException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ModelErrorException.rst deleted file mode 100644 index f2b340f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ModelErrorException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ModelErrorException -=================== - -.. autoexception:: aws_sdk_bedrock_runtime.models.ModelErrorException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ModelNotReadyException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ModelNotReadyException.rst deleted file mode 100644 index e5a2dbc..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ModelNotReadyException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ModelNotReadyException -====================== - -.. autoexception:: aws_sdk_bedrock_runtime.models.ModelNotReadyException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ModelStreamErrorException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ModelStreamErrorException.rst deleted file mode 100644 index c743d6a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ModelStreamErrorException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ModelStreamErrorException -========================= - -.. autoexception:: aws_sdk_bedrock_runtime.models.ModelStreamErrorException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ModelTimeoutException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ModelTimeoutException.rst deleted file mode 100644 index edd1705..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ModelTimeoutException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ModelTimeoutException -===================== - -.. autoexception:: aws_sdk_bedrock_runtime.models.ModelTimeoutException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/PayloadPart.rst b/clients/aws-sdk-bedrock-runtime/docs/models/PayloadPart.rst deleted file mode 100644 index 1b3bd85..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/PayloadPart.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -PayloadPart -=========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.PayloadPart - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/PerformanceConfiguration.rst b/clients/aws-sdk-bedrock-runtime/docs/models/PerformanceConfiguration.rst deleted file mode 100644 index c0a3a3a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/PerformanceConfiguration.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -PerformanceConfiguration -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.PerformanceConfiguration - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/PromptRouterTrace.rst b/clients/aws-sdk-bedrock-runtime/docs/models/PromptRouterTrace.rst deleted file mode 100644 index 92fa674..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/PromptRouterTrace.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -PromptRouterTrace -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.PromptRouterTrace - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValues.rst b/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValues.rst deleted file mode 100644 index 3625953..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValues.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _PromptVariableValues: - -PromptVariableValues -==================== - -.. autodata:: aws_sdk_bedrock_runtime.models.PromptVariableValues diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValuesText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValuesText.rst deleted file mode 100644 index e6fb06c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValuesText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _PromptVariableValuesText: - -PromptVariableValuesText -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.PromptVariableValuesText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValuesUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValuesUnknown.rst deleted file mode 100644 index 7e6a5f3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/PromptVariableValuesUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _PromptVariableValuesUnknown: - -PromptVariableValuesUnknown -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.PromptVariableValuesUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlock.rst deleted file mode 100644 index e9e4edd..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlock.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlock: - -ReasoningContentBlock -===================== - -.. autodata:: aws_sdk_bedrock_runtime.models.ReasoningContentBlock diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDelta.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDelta.rst deleted file mode 100644 index 57b690a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDelta.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlockDelta: - -ReasoningContentBlockDelta -========================== - -.. autodata:: aws_sdk_bedrock_runtime.models.ReasoningContentBlockDelta diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaRedactedContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaRedactedContent.rst deleted file mode 100644 index e8a4951..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaRedactedContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlockDeltaRedactedContent: - -ReasoningContentBlockDeltaRedactedContent -========================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ReasoningContentBlockDeltaRedactedContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaSignature.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaSignature.rst deleted file mode 100644 index d6f6174..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaSignature.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlockDeltaSignature: - -ReasoningContentBlockDeltaSignature -=================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ReasoningContentBlockDeltaSignature diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaText.rst deleted file mode 100644 index daf4023..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlockDeltaText: - -ReasoningContentBlockDeltaText -============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ReasoningContentBlockDeltaText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaUnknown.rst deleted file mode 100644 index bc34156..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockDeltaUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlockDeltaUnknown: - -ReasoningContentBlockDeltaUnknown -================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ReasoningContentBlockDeltaUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockReasoningText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockReasoningText.rst deleted file mode 100644 index 94ebc72..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockReasoningText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlockReasoningText: - -ReasoningContentBlockReasoningText -================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ReasoningContentBlockReasoningText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockRedactedContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockRedactedContent.rst deleted file mode 100644 index 987e902..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockRedactedContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlockRedactedContent: - -ReasoningContentBlockRedactedContent -==================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ReasoningContentBlockRedactedContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockUnknown.rst deleted file mode 100644 index 983447b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningContentBlockUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ReasoningContentBlockUnknown: - -ReasoningContentBlockUnknown -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ReasoningContentBlockUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningTextBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningTextBlock.rst deleted file mode 100644 index 444ad3d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ReasoningTextBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ReasoningTextBlock -================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ReasoningTextBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResourceNotFoundException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResourceNotFoundException.rst deleted file mode 100644 index 4444865..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResourceNotFoundException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ResourceNotFoundException -========================= - -.. autoexception:: aws_sdk_bedrock_runtime.models.ResourceNotFoundException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStream.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStream.rst deleted file mode 100644 index 12413b3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStream.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStream: - -ResponseStream -============== - -.. autodata:: aws_sdk_bedrock_runtime.models.ResponseStream diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamChunk.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamChunk.rst deleted file mode 100644 index 41cf601..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamChunk.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamChunk: - -ResponseStreamChunk -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ResponseStreamChunk diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamInternalServerException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamInternalServerException.rst deleted file mode 100644 index e257015..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamInternalServerException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamInternalServerException: - -ResponseStreamInternalServerException -===================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ResponseStreamInternalServerException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamModelStreamErrorException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamModelStreamErrorException.rst deleted file mode 100644 index 4639669..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamModelStreamErrorException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamModelStreamErrorException: - -ResponseStreamModelStreamErrorException -======================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ResponseStreamModelStreamErrorException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamModelTimeoutException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamModelTimeoutException.rst deleted file mode 100644 index a930a15..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamModelTimeoutException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamModelTimeoutException: - -ResponseStreamModelTimeoutException -=================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ResponseStreamModelTimeoutException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamServiceUnavailableException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamServiceUnavailableException.rst deleted file mode 100644 index 0deeeeb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamServiceUnavailableException: - -ResponseStreamServiceUnavailableException -========================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ResponseStreamServiceUnavailableException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamThrottlingException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamThrottlingException.rst deleted file mode 100644 index f75a57c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamThrottlingException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamThrottlingException: - -ResponseStreamThrottlingException -================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ResponseStreamThrottlingException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamUnknown.rst deleted file mode 100644 index 2d24960..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamUnknown: - -ResponseStreamUnknown -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ResponseStreamUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamValidationException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamValidationException.rst deleted file mode 100644 index 9030929..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ResponseStreamValidationException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamValidationException: - -ResponseStreamValidationException -================================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ResponseStreamValidationException diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/S3Location.rst b/clients/aws-sdk-bedrock-runtime/docs/models/S3Location.rst deleted file mode 100644 index 30ee62e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/S3Location.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -S3Location -========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.S3Location - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultBlock.rst deleted file mode 100644 index 1f5fe97..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -SearchResultBlock -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.SearchResultBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultContentBlock.rst deleted file mode 100644 index 475c25a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultContentBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -SearchResultContentBlock -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.SearchResultContentBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultLocation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultLocation.rst deleted file mode 100644 index ac45633..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SearchResultLocation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -SearchResultLocation -==================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.SearchResultLocation - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ServiceQuotaExceededException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ServiceQuotaExceededException.rst deleted file mode 100644 index f89199a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ServiceQuotaExceededException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ServiceQuotaExceededException -============================= - -.. autoexception:: aws_sdk_bedrock_runtime.models.ServiceQuotaExceededException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ServiceTier.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ServiceTier.rst deleted file mode 100644 index 1a11ec4..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ServiceTier.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ServiceTier -=========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ServiceTier - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ServiceUnavailableException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ServiceUnavailableException.rst deleted file mode 100644 index 0cce1af..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ServiceUnavailableException -=========================== - -.. autoexception:: aws_sdk_bedrock_runtime.models.ServiceUnavailableException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SpecificToolChoice.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SpecificToolChoice.rst deleted file mode 100644 index 1d1e095..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SpecificToolChoice.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -SpecificToolChoice -================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.SpecificToolChoice - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlock.rst deleted file mode 100644 index bc0affa..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlock.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _SystemContentBlock: - -SystemContentBlock -================== - -.. autodata:: aws_sdk_bedrock_runtime.models.SystemContentBlock diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockCachePoint.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockCachePoint.rst deleted file mode 100644 index 815bab2..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockCachePoint.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _SystemContentBlockCachePoint: - -SystemContentBlockCachePoint -============================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.SystemContentBlockCachePoint diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockGuardContent.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockGuardContent.rst deleted file mode 100644 index b13f4f1..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockGuardContent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _SystemContentBlockGuardContent: - -SystemContentBlockGuardContent -============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.SystemContentBlockGuardContent diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockText.rst deleted file mode 100644 index d683f3d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _SystemContentBlockText: - -SystemContentBlockText -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.SystemContentBlockText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockUnknown.rst deleted file mode 100644 index 875b849..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SystemContentBlockUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _SystemContentBlockUnknown: - -SystemContentBlockUnknown -========================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.SystemContentBlockUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/SystemTool.rst b/clients/aws-sdk-bedrock-runtime/docs/models/SystemTool.rst deleted file mode 100644 index a703f41..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/SystemTool.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -SystemTool -========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.SystemTool - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/Tag.rst b/clients/aws-sdk-bedrock-runtime/docs/models/Tag.rst deleted file mode 100644 index 1bd811a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/Tag.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Tag -=== - -.. autoclass:: aws_sdk_bedrock_runtime.models.Tag - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ThrottlingException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ThrottlingException.rst deleted file mode 100644 index e9d6e99..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ThrottlingException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ThrottlingException -=================== - -.. autoexception:: aws_sdk_bedrock_runtime.models.ThrottlingException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/TokenUsage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/TokenUsage.rst deleted file mode 100644 index 90f47a0..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/TokenUsage.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -TokenUsage -========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.TokenUsage - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/Tool.rst b/clients/aws-sdk-bedrock-runtime/docs/models/Tool.rst deleted file mode 100644 index 5c10016..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/Tool.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _Tool: - -Tool -==== - -.. autodata:: aws_sdk_bedrock_runtime.models.Tool diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolCachePoint.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolCachePoint.rst deleted file mode 100644 index 5e77fa4..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolCachePoint.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolCachePoint: - -ToolCachePoint -============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolCachePoint diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoice.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoice.rst deleted file mode 100644 index 7070d2a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoice.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolChoice: - -ToolChoice -========== - -.. autodata:: aws_sdk_bedrock_runtime.models.ToolChoice diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceAny.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceAny.rst deleted file mode 100644 index a85d53d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceAny.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolChoiceAny: - -ToolChoiceAny -============= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolChoiceAny diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceAuto.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceAuto.rst deleted file mode 100644 index 393479b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceAuto.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolChoiceAuto: - -ToolChoiceAuto -============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolChoiceAuto diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceTool.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceTool.rst deleted file mode 100644 index 0fd05e8..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceTool.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolChoiceTool: - -ToolChoiceTool -============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolChoiceTool diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceUnknown.rst deleted file mode 100644 index 71716bb..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolChoiceUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolChoiceUnknown: - -ToolChoiceUnknown -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolChoiceUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolConfiguration.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolConfiguration.rst deleted file mode 100644 index aed2dab..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolConfiguration.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ToolConfiguration -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolConfiguration - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchema.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchema.rst deleted file mode 100644 index d55d131..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchema.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolInputSchema: - -ToolInputSchema -=============== - -.. autodata:: aws_sdk_bedrock_runtime.models.ToolInputSchema diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchemaJson.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchemaJson.rst deleted file mode 100644 index 4a61440..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchemaJson.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolInputSchemaJson: - -ToolInputSchemaJson -=================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolInputSchemaJson diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchemaUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchemaUnknown.rst deleted file mode 100644 index 8a5c249..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolInputSchemaUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolInputSchemaUnknown: - -ToolInputSchemaUnknown -====================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolInputSchemaUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlock.rst deleted file mode 100644 index 178ae5c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ToolResultBlock -=============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDelta.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDelta.rst deleted file mode 100644 index 8c9fe53..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDelta.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultBlockDelta: - -ToolResultBlockDelta -==================== - -.. autodata:: aws_sdk_bedrock_runtime.models.ToolResultBlockDelta diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDeltaText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDeltaText.rst deleted file mode 100644 index 668e34c..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDeltaText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultBlockDeltaText: - -ToolResultBlockDeltaText -======================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultBlockDeltaText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDeltaUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDeltaUnknown.rst deleted file mode 100644 index a456726..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockDeltaUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultBlockDeltaUnknown: - -ToolResultBlockDeltaUnknown -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultBlockDeltaUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockStart.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockStart.rst deleted file mode 100644 index 0762e80..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultBlockStart.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ToolResultBlockStart -==================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultBlockStart - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlock.rst deleted file mode 100644 index 5e63d0d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlock.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultContentBlock: - -ToolResultContentBlock -====================== - -.. autodata:: aws_sdk_bedrock_runtime.models.ToolResultContentBlock diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockDocument.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockDocument.rst deleted file mode 100644 index 69f675b..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockDocument.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultContentBlockDocument: - -ToolResultContentBlockDocument -============================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultContentBlockDocument diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockImage.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockImage.rst deleted file mode 100644 index a900728..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockImage.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultContentBlockImage: - -ToolResultContentBlockImage -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultContentBlockImage diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockJson.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockJson.rst deleted file mode 100644 index 9c40307..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockJson.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultContentBlockJson: - -ToolResultContentBlockJson -========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultContentBlockJson diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockSearchResult.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockSearchResult.rst deleted file mode 100644 index 0dc1bc8..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockSearchResult.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultContentBlockSearchResult: - -ToolResultContentBlockSearchResult -================================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultContentBlockSearchResult diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockText.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockText.rst deleted file mode 100644 index a28a68a..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockText.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultContentBlockText: - -ToolResultContentBlockText -========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultContentBlockText diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockUnknown.rst deleted file mode 100644 index d44cc05..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultContentBlockUnknown: - -ToolResultContentBlockUnknown -============================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultContentBlockUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockVideo.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockVideo.rst deleted file mode 100644 index 35eef9e..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolResultContentBlockVideo.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolResultContentBlockVideo: - -ToolResultContentBlockVideo -=========================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolResultContentBlockVideo diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolSpecification.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolSpecification.rst deleted file mode 100644 index d8606c3..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolSpecification.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ToolSpecification -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolSpecification - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolSystemTool.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolSystemTool.rst deleted file mode 100644 index 6c08af7..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolSystemTool.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolSystemTool: - -ToolSystemTool -============== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolSystemTool diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolToolSpec.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolToolSpec.rst deleted file mode 100644 index 3e40d45..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolToolSpec.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolToolSpec: - -ToolToolSpec -============ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolToolSpec diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolUnknown.rst deleted file mode 100644 index e930183..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ToolUnknown: - -ToolUnknown -=========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlock.rst deleted file mode 100644 index 25e6957..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ToolUseBlock -============ - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolUseBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlockDelta.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlockDelta.rst deleted file mode 100644 index 98c1fbd..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlockDelta.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ToolUseBlockDelta -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolUseBlockDelta - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlockStart.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlockStart.rst deleted file mode 100644 index 44872cf..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ToolUseBlockStart.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ToolUseBlockStart -================= - -.. autoclass:: aws_sdk_bedrock_runtime.models.ToolUseBlockStart - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/ValidationException.rst b/clients/aws-sdk-bedrock-runtime/docs/models/ValidationException.rst deleted file mode 100644 index f0648a9..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/ValidationException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ValidationException -=================== - -.. autoexception:: aws_sdk_bedrock_runtime.models.ValidationException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/VideoBlock.rst b/clients/aws-sdk-bedrock-runtime/docs/models/VideoBlock.rst deleted file mode 100644 index 03f536d..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/VideoBlock.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -VideoBlock -========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.VideoBlock - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/VideoSource.rst b/clients/aws-sdk-bedrock-runtime/docs/models/VideoSource.rst deleted file mode 100644 index 43551dc..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/VideoSource.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _VideoSource: - -VideoSource -=========== - -.. autodata:: aws_sdk_bedrock_runtime.models.VideoSource diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceBytes.rst b/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceBytes.rst deleted file mode 100644 index 61aa347..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceBytes.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _VideoSourceBytes: - -VideoSourceBytes -================ - -.. autoclass:: aws_sdk_bedrock_runtime.models.VideoSourceBytes diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceS3Location.rst b/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceS3Location.rst deleted file mode 100644 index 759b551..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceS3Location.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _VideoSourceS3Location: - -VideoSourceS3Location -===================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.VideoSourceS3Location diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceUnknown.rst b/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceUnknown.rst deleted file mode 100644 index 9748ead..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/VideoSourceUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _VideoSourceUnknown: - -VideoSourceUnknown -================== - -.. autoclass:: aws_sdk_bedrock_runtime.models.VideoSourceUnknown diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/WebLocation.rst b/clients/aws-sdk-bedrock-runtime/docs/models/WebLocation.rst deleted file mode 100644 index beb095f..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/WebLocation.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -WebLocation -=========== - -.. autoclass:: aws_sdk_bedrock_runtime.models.WebLocation - :members: diff --git a/clients/aws-sdk-bedrock-runtime/docs/models/index.rst b/clients/aws-sdk-bedrock-runtime/docs/models/index.rst deleted file mode 100644 index c403929..0000000 --- a/clients/aws-sdk-bedrock-runtime/docs/models/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Models -======= -.. toctree:: - :maxdepth: 1 - :titlesonly: - :glob: - - * diff --git a/clients/aws-sdk-bedrock-runtime/pyproject.toml b/clients/aws-sdk-bedrock-runtime/pyproject.toml index 67f1c3d..df2fcb4 100644 --- a/clients/aws-sdk-bedrock-runtime/pyproject.toml +++ b/clients/aws-sdk-bedrock-runtime/pyproject.toml @@ -1,6 +1,5 @@ # Code generated by smithy-python-codegen DO NOT EDIT. - [project] name = "aws_sdk_bedrock_runtime" version = "0.2.0" @@ -35,21 +34,10 @@ test = [ "pytest-asyncio>=0.20.3,<0.21.0" ] -docs = [ - "pydata-sphinx-theme>=0.16.1", - "sphinx>=8.2.3" -] - [build-system] requires = ["hatchling"] build-backend = "hatchling.build" -[tool.hatch.build.targets.bdist] -exclude = [ - "tests", - "docs", -] - [tool.pyright] typeCheckingMode = "strict" reportPrivateUsage = false diff --git a/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/client.py b/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/client.py index 763178c..3ecd53a 100644 --- a/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/client.py +++ b/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/client.py @@ -60,18 +60,24 @@ class BedrockRuntimeClient: """ - Describes the API operations for running inference using Amazon Bedrock models. - - :param config: Optional configuration for the client. Here you can set things like the - endpoint for HTTP services or auth credentials. - - :param plugins: A list of callables that modify the configuration dynamically. These - can be used to set defaults, for example. + Describes the API operations for running inference using Amazon Bedrock + models. """ def __init__( self, config: Config | None = None, plugins: list[Plugin] | None = None ): + """ + Constructor for `BedrockRuntimeClient`. + + Args: + config: + Optional configuration for the client. Here you can set things like + the endpoint for HTTP services or auth credentials. + plugins: + A list of callables that modify the configuration dynamically. These + can be used to set defaults, for example. + """ self._config = config or Config() client_plugins: list[Plugin] = [aws_user_agent_plugin, user_agent_plugin] @@ -89,15 +95,23 @@ async def apply_guardrail( """ The action to apply a guardrail. - For troubleshooting some of the common errors you might encounter when using the - ``ApplyGuardrail`` API, see `Troubleshooting Amazon Bedrock API Error Codes `_ + For troubleshooting some of the common errors you might encounter when + using the `ApplyGuardrail` API, see [Troubleshooting Amazon Bedrock API + Error + Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Args: + input: + An instance of `ApplyGuardrailInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An instance of `ApplyGuardrailOutput`. """ operation_plugins: list[Plugin] = [] if plugins: @@ -145,50 +159,68 @@ async def converse( self, input: ConverseInput, plugins: list[Plugin] | None = None ) -> ConverseOperationOutput: """ - Sends messages to the specified Amazon Bedrock model. ``Converse`` provides a - consistent interface that works with all models that support messages. This - allows you to write code once and use it with different models. If a model has - unique inference parameters, you can also pass those unique parameters to the - model. - - Amazon Bedrock doesn't store any text, images, or documents that you provide as - content. The data is only used to generate the response. - - You can submit a prompt by including it in the ``messages`` field, specifying - the ``modelId`` of a foundation model or inference profile to run inference on - it, and including any other fields that are relevant to your use case. - - You can also submit a prompt from Prompt management by specifying the ARN of the - prompt version and including a map of variables to values in the - ``promptVariables`` field. You can append more messages to the prompt by using the ``messages`` field. If you use a prompt from Prompt management, you can't include the following fields in the request: ``additionalModelRequestFields``, ``inferenceConfig``, ``system``, or ``toolConfig``. Instead, these fields must be defined through Prompt management. For more information, see `Use a prompt from Prompt management `_ - . - - For information about the Converse API, see *Use the Converse API* in the - *Amazon Bedrock User Guide*. To use a guardrail, see *Use a guardrail with the - Converse API* in the *Amazon Bedrock User Guide*. To use a tool with a model, - see *Tool use (Function calling)* in the *Amazon Bedrock User Guide* - - For example code, see *Converse API examples* in the *Amazon Bedrock User - Guide*. - - This operation requires permission for the ``bedrock:InvokeModel`` action. - - .. important:: - To deny all inference access to resources that you specify in the modelId field, - you need to deny access to the ``bedrock:InvokeModel`` and ``bedrock:InvokeModelWithResponseStream`` actions. Doing this also denies access to the resource through the base inference actions (`InvokeModel `_ - and `InvokeModelWithResponseStream `_). - For more information see `Deny access for inference on specific models `_ - . - - For troubleshooting some of the common errors you might encounter when using the - ``Converse`` API, see `Troubleshooting Amazon Bedrock API Error Codes `_ - in the Amazon Bedrock User Guide + Sends messages to the specified Amazon Bedrock model. `Converse` + provides a consistent interface that works with all models that support + messages. This allows you to write code once and use it with different + models. If a model has unique inference parameters, you can also pass + those unique parameters to the model. + + Amazon Bedrock doesn't store any text, images, or documents that you + provide as content. The data is only used to generate the response. + + You can submit a prompt by including it in the `messages` field, + specifying the `modelId` of a foundation model or inference profile to + run inference on it, and including any other fields that are relevant to + your use case. + + You can also submit a prompt from Prompt management by specifying the + ARN of the prompt version and including a map of variables to values in + the `promptVariables` field. You can append more messages to the prompt + by using the `messages` field. If you use a prompt from Prompt + management, you can't include the following fields in the request: + `additionalModelRequestFields`, `inferenceConfig`, `system`, or + `toolConfig`. Instead, these fields must be defined through Prompt + management. For more information, see [Use a prompt from Prompt + management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html). + + For information about the Converse API, see *Use the Converse API* in + the *Amazon Bedrock User Guide*. To use a guardrail, see *Use a + guardrail with the Converse API* in the *Amazon Bedrock User Guide*. To + use a tool with a model, see *Tool use (Function calling)* in the + *Amazon Bedrock User Guide* + + For example code, see *Converse API examples* in the *Amazon Bedrock + User Guide*. - :param input: The operation's input. + This operation requires permission for the `bedrock:InvokeModel` action. + + Warning: + To deny all inference access to resources that you specify in the + modelId field, you need to deny access to the `bedrock:InvokeModel` and + `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies + access to the resource through the base inference actions + ([InvokeModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html) + and + [InvokeModelWithResponseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html)). + For more information see [Deny access for inference on specific + models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference). + + For troubleshooting some of the common errors you might encounter when + using the `Converse` API, see [Troubleshooting Amazon Bedrock API Error + Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) + in the Amazon Bedrock User Guide - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Args: + input: + An instance of `ConverseInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An instance of `ConverseOperationOutput`. """ operation_plugins: list[Plugin] = [] if plugins: @@ -236,58 +268,79 @@ async def converse_stream( self, input: ConverseStreamInput, plugins: list[Plugin] | None = None ) -> OutputEventStream[ConverseStreamOutput, ConverseStreamOperationOutput]: """ - Sends messages to the specified Amazon Bedrock model and returns the response in - a stream. ``ConverseStream`` provides a consistent API that works with all - Amazon Bedrock models that support messages. This allows you to write code once - and use it with different models. Should a model have unique inference - parameters, you can also pass those unique parameters to the model. - - To find out if a model supports streaming, call `GetFoundationModel `_ - and check the ``responseStreamingSupported`` field in the response. - - .. note:: - The CLI doesn't support streaming operations in Amazon Bedrock, including - ``ConverseStream``. - - Amazon Bedrock doesn't store any text, images, or documents that you provide as - content. The data is only used to generate the response. - - You can submit a prompt by including it in the ``messages`` field, specifying - the ``modelId`` of a foundation model or inference profile to run inference on - it, and including any other fields that are relevant to your use case. - - You can also submit a prompt from Prompt management by specifying the ARN of the - prompt version and including a map of variables to values in the - ``promptVariables`` field. You can append more messages to the prompt by using the ``messages`` field. If you use a prompt from Prompt management, you can't include the following fields in the request: ``additionalModelRequestFields``, ``inferenceConfig``, ``system``, or ``toolConfig``. Instead, these fields must be defined through Prompt management. For more information, see `Use a prompt from Prompt management `_ - . - - For information about the Converse API, see *Use the Converse API* in the - *Amazon Bedrock User Guide*. To use a guardrail, see *Use a guardrail with the - Converse API* in the *Amazon Bedrock User Guide*. To use a tool with a model, - see *Tool use (Function calling)* in the *Amazon Bedrock User Guide* - - For example code, see *Conversation streaming example* in the *Amazon Bedrock - User Guide*. + Sends messages to the specified Amazon Bedrock model and returns the + response in a stream. `ConverseStream` provides a consistent API that + works with all Amazon Bedrock models that support messages. This allows + you to write code once and use it with different models. Should a model + have unique inference parameters, you can also pass those unique + parameters to the model. + + To find out if a model supports streaming, call + [GetFoundationModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html) + and check the `responseStreamingSupported` field in the response. + + Note: + The CLI doesn't support streaming operations in Amazon Bedrock, + including `ConverseStream`. + + Amazon Bedrock doesn't store any text, images, or documents that you + provide as content. The data is only used to generate the response. + + You can submit a prompt by including it in the `messages` field, + specifying the `modelId` of a foundation model or inference profile to + run inference on it, and including any other fields that are relevant to + your use case. + + You can also submit a prompt from Prompt management by specifying the + ARN of the prompt version and including a map of variables to values in + the `promptVariables` field. You can append more messages to the prompt + by using the `messages` field. If you use a prompt from Prompt + management, you can't include the following fields in the request: + `additionalModelRequestFields`, `inferenceConfig`, `system`, or + `toolConfig`. Instead, these fields must be defined through Prompt + management. For more information, see [Use a prompt from Prompt + management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-use.html). + + For information about the Converse API, see *Use the Converse API* in + the *Amazon Bedrock User Guide*. To use a guardrail, see *Use a + guardrail with the Converse API* in the *Amazon Bedrock User Guide*. To + use a tool with a model, see *Tool use (Function calling)* in the + *Amazon Bedrock User Guide* + + For example code, see *Conversation streaming example* in the *Amazon + Bedrock User Guide*. This operation requires permission for the - ``bedrock:InvokeModelWithResponseStream`` action. - - .. important:: - To deny all inference access to resources that you specify in the modelId field, - you need to deny access to the ``bedrock:InvokeModel`` and ``bedrock:InvokeModelWithResponseStream`` actions. Doing this also denies access to the resource through the base inference actions (`InvokeModel `_ - and `InvokeModelWithResponseStream `_). - For more information see `Deny access for inference on specific models `_ - . - - For troubleshooting some of the common errors you might encounter when using the - ``ConverseStream`` API, see `Troubleshooting Amazon Bedrock API Error Codes `_ + `bedrock:InvokeModelWithResponseStream` action. + + Warning: + To deny all inference access to resources that you specify in the + modelId field, you need to deny access to the `bedrock:InvokeModel` and + `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies + access to the resource through the base inference actions + ([InvokeModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModel.html) + and + [InvokeModelWithResponseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_InvokeModelWithResponseStream.html)). + For more information see [Deny access for inference on specific + models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference). + + For troubleshooting some of the common errors you might encounter when + using the `ConverseStream` API, see [Troubleshooting Amazon Bedrock API + Error + Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Args: + input: + An instance of `ConverseStreamInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An `OutputEventStream` for server-to-client streaming. """ operation_plugins: list[Plugin] = [] if plugins: @@ -337,41 +390,47 @@ async def count_tokens( self, input: CountTokensOperationInput, plugins: list[Plugin] | None = None ) -> CountTokensOutput: """ - Returns the token count for a given inference request. This operation helps you - estimate token usage before sending requests to foundation models by returning - the token count that would be used if the same input were sent to the model in - an inference request. + Returns the token count for a given inference request. This operation + helps you estimate token usage before sending requests to foundation + models by returning the token count that would be used if the same input + were sent to the model in an inference request. Token counting is model-specific because different models use different - tokenization strategies. The token count returned by this operation will match - the token count that would be charged if the same input were sent to the model - in an ``InvokeModel`` or ``Converse`` request. + tokenization strategies. The token count returned by this operation will + match the token count that would be charged if the same input were sent + to the model in an `InvokeModel` or `Converse` request. You can use this operation to: - * Estimate costs before sending inference requests. + - Estimate costs before sending inference requests. - * Optimize prompts to fit within token limits. + - Optimize prompts to fit within token limits. - * Plan for token usage in your applications. + - Plan for token usage in your applications. - This operation accepts the same input formats as ``InvokeModel`` and - ``Converse``, allowing you to count tokens for both raw text inputs and + This operation accepts the same input formats as `InvokeModel` and + `Converse`, allowing you to count tokens for both raw text inputs and structured conversation formats. - The following operations are related to ``CountTokens``: + The following operations are related to `CountTokens`: - * `InvokeModel `_ - - Sends inference requests to foundation models + - [InvokeModel](https://docs.aws.amazon.com/bedrock/latest/API/API_runtime_InvokeModel.html) - + Sends inference requests to foundation models - * `Converse `_ - - Sends conversation-based inference requests to foundation models + - [Converse](https://docs.aws.amazon.com/bedrock/latest/API/API_runtime_Converse.html) - + Sends conversation-based inference requests to foundation models - :param input: The operation's input. + Args: + input: + An instance of `CountTokensOperationInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Returns: + An instance of `CountTokensOutput`. """ operation_plugins: list[Plugin] = [] if plugins: @@ -421,11 +480,17 @@ async def get_async_invoke( """ Retrieve information about an asynchronous invocation. - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Args: + input: + An instance of `GetAsyncInvokeInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An instance of `GetAsyncInvokeOutput`. """ operation_plugins: list[Plugin] = [] if plugins: @@ -473,31 +538,43 @@ async def invoke_model( self, input: InvokeModelInput, plugins: list[Plugin] | None = None ) -> InvokeModelOutput: """ - Invokes the specified Amazon Bedrock model to run inference using the prompt and - inference parameters provided in the request body. You use model inference to - generate text, images, and embeddings. - - For example code, see *Invoke model code examples* in the *Amazon Bedrock User - Guide*. + Invokes the specified Amazon Bedrock model to run inference using the + prompt and inference parameters provided in the request body. You use + model inference to generate text, images, and embeddings. - This operation requires permission for the ``bedrock:InvokeModel`` action. - - .. important:: - To deny all inference access to resources that you specify in the modelId field, - you need to deny access to the ``bedrock:InvokeModel`` and ``bedrock:InvokeModelWithResponseStream`` actions. Doing this also denies access to the resource through the Converse API actions (`Converse `_ - and `ConverseStream `_). - For more information see `Deny access for inference on specific models `_ - . + For example code, see *Invoke model code examples* in the *Amazon + Bedrock User Guide*. - For troubleshooting some of the common errors you might encounter when using the - ``InvokeModel`` API, see `Troubleshooting Amazon Bedrock API Error Codes `_ + This operation requires permission for the `bedrock:InvokeModel` action. + + Warning: + To deny all inference access to resources that you specify in the + modelId field, you need to deny access to the `bedrock:InvokeModel` and + `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies + access to the resource through the Converse API actions + ([Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) + and + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)). + For more information see [Deny access for inference on specific + models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference). + + For troubleshooting some of the common errors you might encounter when + using the `InvokeModel` API, see [Troubleshooting Amazon Bedrock API + Error + Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Args: + input: + An instance of `InvokeModelInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An instance of `InvokeModelOutput`. """ operation_plugins: list[Plugin] = [] if plugins: @@ -552,20 +629,28 @@ async def invoke_model_with_bidirectional_stream( ]: """ Invoke the specified Amazon Bedrock model to run inference using the - bidirectional stream. The response is returned in a stream that remains open for - 8 minutes. A single session can contain multiple prompts and responses from the - model. The prompts to the model are provided as audio files and the model's - responses are spoken back to the user and transcribed. - - It is possible for users to interrupt the model's response with a new prompt, - which will halt the response speech. The model will retain contextual awareness - of the conversation while pivoting to respond to the new prompt. - - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + bidirectional stream. The response is returned in a stream that remains + open for 8 minutes. A single session can contain multiple prompts and + responses from the model. The prompts to the model are provided as audio + files and the model's responses are spoken back to the user and + transcribed. + + It is possible for users to interrupt the model's response with a new + prompt, which will halt the response speech. The model will retain + contextual awareness of the conversation while pivoting to respond to + the new prompt. + + Args: + input: + An instance of `InvokeModelWithBidirectionalStreamOperationInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + A `DuplexEventStream` for bidirectional streaming. """ operation_plugins: list[Plugin] = [] if plugins: @@ -620,39 +705,52 @@ async def invoke_model_with_response_stream( plugins: list[Plugin] | None = None, ) -> OutputEventStream[ResponseStream, InvokeModelWithResponseStreamOutput]: """ - Invoke the specified Amazon Bedrock model to run inference using the prompt and - inference parameters provided in the request body. The response is returned in a - stream. + Invoke the specified Amazon Bedrock model to run inference using the + prompt and inference parameters provided in the request body. The + response is returned in a stream. - To see if a model supports streaming, call `GetFoundationModel `_ - and check the ``responseStreamingSupported`` field in the response. + To see if a model supports streaming, call + [GetFoundationModel](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_GetFoundationModel.html) + and check the `responseStreamingSupported` field in the response. - .. note:: - The CLI doesn't support streaming operations in Amazon Bedrock, including - ``InvokeModelWithResponseStream``. + Note: + The CLI doesn't support streaming operations in Amazon Bedrock, + including `InvokeModelWithResponseStream`. - For example code, see *Invoke model with streaming code example* in the *Amazon - Bedrock User Guide*. + For example code, see *Invoke model with streaming code example* in the + *Amazon Bedrock User Guide*. This operation requires permissions to perform the - ``bedrock:InvokeModelWithResponseStream`` action. - - .. important:: - To deny all inference access to resources that you specify in the modelId field, - you need to deny access to the ``bedrock:InvokeModel`` and ``bedrock:InvokeModelWithResponseStream`` actions. Doing this also denies access to the resource through the Converse API actions (`Converse `_ - and `ConverseStream `_). - For more information see `Deny access for inference on specific models `_ - . - - For troubleshooting some of the common errors you might encounter when using the - ``InvokeModelWithResponseStream`` API, see `Troubleshooting Amazon Bedrock API Error Codes `_ + `bedrock:InvokeModelWithResponseStream` action. + + Warning: + To deny all inference access to resources that you specify in the + modelId field, you need to deny access to the `bedrock:InvokeModel` and + `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies + access to the resource through the Converse API actions + ([Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) + and + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)). + For more information see [Deny access for inference on specific + models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference). + + For troubleshooting some of the common errors you might encounter when + using the `InvokeModelWithResponseStream` API, see [Troubleshooting + Amazon Bedrock API Error + Codes](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html) in the Amazon Bedrock User Guide - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Args: + input: + An instance of `InvokeModelWithResponseStreamInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An `OutputEventStream` for server-to-client streaming. """ operation_plugins: list[Plugin] = [] if plugins: @@ -704,11 +802,17 @@ async def list_async_invokes( """ Lists asynchronous invocations. - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Args: + input: + An instance of `ListAsyncInvokesInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An instance of `ListAsyncInvokesOutput`. """ operation_plugins: list[Plugin] = [] if plugins: @@ -758,20 +862,30 @@ async def start_async_invoke( """ Starts an asynchronous invocation. - This operation requires permission for the ``bedrock:InvokeModel`` action. - - .. important:: - To deny all inference access to resources that you specify in the modelId field, - you need to deny access to the ``bedrock:InvokeModel`` and ``bedrock:InvokeModelWithResponseStream`` actions. Doing this also denies access to the resource through the Converse API actions (`Converse `_ - and `ConverseStream `_). - For more information see `Deny access for inference on specific models `_ - . - - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + This operation requires permission for the `bedrock:InvokeModel` action. + + Warning: + To deny all inference access to resources that you specify in the + modelId field, you need to deny access to the `bedrock:InvokeModel` and + `bedrock:InvokeModelWithResponseStream` actions. Doing this also denies + access to the resource through the Converse API actions + ([Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) + and + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html)). + For more information see [Deny access for inference on specific + models](https://docs.aws.amazon.com/bedrock/latest/userguide/security_iam_id-based-policy-examples.html#security_iam_id-based-policy-examples-deny-inference). + + Args: + input: + An instance of `StartAsyncInvokeInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An instance of `StartAsyncInvokeOutput`. """ operation_plugins: list[Plugin] = [] if plugins: diff --git a/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/config.py b/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/config.py index ba72641..029196a 100644 --- a/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/config.py +++ b/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/config.py @@ -81,23 +81,72 @@ class Config: """Configuration for Bedrock Runtime.""" auth_scheme_resolver: HTTPAuthSchemeResolver + """ + An auth scheme resolver that determines the auth scheme for each + operation. + """ + auth_schemes: dict[ShapeID, AuthScheme[Any, Any, Any, Any]] + """A map of auth scheme ids to auth schemes.""" + aws_access_key_id: str | None + """The identifier for a secret access key.""" + aws_credentials_identity_resolver: ( IdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None ) + """Resolves AWS Credentials. Required for operations that use Sigv4 Auth.""" + aws_secret_access_key: str | None + """A secret access key that can be used to sign requests.""" + aws_session_token: str | None + """An access key ID that identifies temporary security credentials.""" + endpoint_resolver: _EndpointResolver + """ + The endpoint resolver used to resolve the final endpoint per-operation + based on the configuration. + """ + endpoint_uri: str | URI | None + """A static URI to route requests to.""" + http_request_config: HTTPRequestConfiguration | None + """Configuration for individual HTTP requests.""" + interceptors: list[_ServiceInterceptor] + """ + The list of interceptors, which are hooks that are called during the + execution of a request. + """ + protocol: ClientProtocol[Any, Any] | None + """The protocol to serialize and deserialize requests with.""" + region: str | None + """ + The AWS region to connect to. The configured region is used to determine + the service endpoint. + """ + retry_strategy: RetryStrategy | RetryStrategyOptions | None + """ + The retry strategy or options for configuring retry behavior. Can be + either a configured RetryStrategy or RetryStrategyOptions to create one. + """ + sdk_ua_app_id: str | None + """ + A unique and opaque application ID that is appended to the User-Agent + header. + """ + transport: ClientTransport[Any, Any] | None + """The transport to use to send requests (e.g. an HTTP client).""" + user_agent_extra: str | None + """Additional suffix to be added to the User-Agent header.""" def __init__( self, @@ -122,61 +171,6 @@ def __init__( transport: ClientTransport[Any, Any] | None = None, user_agent_extra: str | None = None, ): - """ - Constructor. - - :param auth_scheme_resolver: - An auth scheme resolver that determines the auth scheme for each operation. - - :param auth_schemes: - A map of auth scheme ids to auth schemes. - - :param aws_access_key_id: - The identifier for a secret access key. - - :param aws_credentials_identity_resolver: - Resolves AWS Credentials. Required for operations that use Sigv4 Auth. - - :param aws_secret_access_key: - A secret access key that can be used to sign requests. - - :param aws_session_token: - An access key ID that identifies temporary security credentials. - - :param endpoint_resolver: - The endpoint resolver used to resolve the final endpoint per-operation based on - the configuration. - - :param endpoint_uri: - A static URI to route requests to. - - :param http_request_config: - Configuration for individual HTTP requests. - - :param interceptors: - The list of interceptors, which are hooks that are called during the execution - of a request. - - :param protocol: - The protocol to serialize and deserialize requests with. - - :param region: - The AWS region to connect to. The configured region is used to determine the - service endpoint. - - :param retry_strategy: - The retry strategy or options for configuring retry behavior. Can be either a - configured RetryStrategy or RetryStrategyOptions to create one. - - :param sdk_ua_app_id: - A unique and opaque application ID that is appended to the User-Agent header. - - :param transport: - The transport to use to send requests (e.g. an HTTP client). - - :param user_agent_extra: - Additional suffix to be added to the User-Agent header. - """ self.auth_scheme_resolver = auth_scheme_resolver or HTTPAuthSchemeResolver() self.auth_schemes = auth_schemes or { ShapeID("aws.auth#sigv4"): SigV4AuthScheme(service="bedrock") @@ -201,16 +195,17 @@ def __init__( self.user_agent_extra = user_agent_extra def set_auth_scheme(self, scheme: AuthScheme[Any, Any, Any, Any]) -> None: - """Sets the implementation of an auth scheme. + """ + Sets the implementation of an auth scheme. Using this method ensures the correct key is used. - :param scheme: The auth scheme to add. + Args: + scheme: + The auth scheme to add. """ self.auth_schemes[scheme.scheme_id] = scheme -# -# A callable that allows customizing the config object on each request. -# Plugin: TypeAlias = Callable[[Config], None] +"""A callable that allows customizing the config object on each request.""" diff --git a/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/models.py b/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/models.py index 653e020..1e30b82 100644 --- a/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/models.py +++ b/clients/aws-sdk-bedrock-runtime/src/aws_sdk_bedrock_runtime/models.py @@ -189,7 +189,8 @@ class ServiceError(ModeledError): - """Base error for all errors in the service. + """ + Base error for all errors in the service. Some exceptions do not extend from this class, including synthetic, implicit, and shared exception types. @@ -199,9 +200,9 @@ class ServiceError(ModeledError): @dataclass(kw_only=True) class AccessDeniedException(ServiceError): """ - The request is denied because you do not have sufficient permissions to perform - the requested action. For troubleshooting this error, see - ``AccessDeniedException ``_ + The request is denied because you do not have sufficient permissions to + perform the requested action. For troubleshooting this error, see + [AccessDeniedException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-access-denied) in the Amazon Bedrock User Guide """ @@ -266,10 +267,10 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GetAsyncInvokeInput: + """Dataclass for GetAsyncInvokeInput structure.""" + invocation_arn: str | None = None - """ - The invocation's ARN. - """ + """The invocation's ARN.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GET_ASYNC_INVOKE_INPUT, self) @@ -305,23 +306,18 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class AsyncInvokeS3OutputDataConfig: - """ - Asynchronous invocation output data settings. - """ + """Asynchronous invocation output data settings.""" s3_uri: str - """ - An object URI starting with ``s3://``. - """ + """An object URI starting with `s3://`.""" kms_key_id: str | None = None - """ - A KMS encryption key ID. - """ + """A KMS encryption key ID.""" bucket_owner: str | None = None """ - If the bucket belongs to another AWS account, specify that account's ID. + If the bucket belongs to another AWS account, specify that account's + ID. """ def serialize(self, serializer: ShapeSerializer): @@ -381,9 +377,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class AsyncInvokeOutputDataConfigS3OutputDataConfig: - """ - A storage location for the output data in an S3 bucket - """ + """A storage location for the output data in an S3 bucket""" value: AsyncInvokeS3OutputDataConfig @@ -403,7 +397,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class AsyncInvokeOutputDataConfigUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -427,10 +422,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: AsyncInvokeOutputDataConfig = Union[ AsyncInvokeOutputDataConfigS3OutputDataConfig | AsyncInvokeOutputDataConfigUnknown ] - -""" -Asynchronous invocation output data settings. -""" +"""Asynchronous invocation output data settings.""" class _AsyncInvokeOutputDataConfigDeserializer: @@ -477,50 +469,34 @@ class AsyncInvokeStatus(StrEnum): @dataclass(kw_only=True) class GetAsyncInvokeOutput: + """Dataclass for GetAsyncInvokeOutput structure.""" + invocation_arn: str - """ - The invocation's ARN. - """ + """The invocation's ARN.""" model_arn: str - """ - The invocation's model ARN. - """ + """The invocation's model ARN.""" status: str - """ - The invocation's status. - """ + """The invocation's status.""" submit_time: datetime - """ - When the invocation request was submitted. - """ + """When the invocation request was submitted.""" output_data_config: AsyncInvokeOutputDataConfig - """ - Output data settings. - """ + """Output data settings.""" client_request_token: str | None = None - """ - The invocation's idempotency token. - """ + """The invocation's idempotency token.""" failure_message: str | None = field(repr=False, default=None) - """ - An error message. - """ + """An error message.""" last_modified_time: datetime | None = None - """ - The invocation's last modified time. - """ + """The invocation's last modified time.""" end_time: datetime | None = None - """ - When the invocation ended. - """ + """When the invocation ended.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GET_ASYNC_INVOKE_OUTPUT, self) @@ -633,7 +609,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: class InternalServerException(ServiceError): """ An internal server error occurred. For troubleshooting this error, see - ``InternalFailure ``_ + [InternalFailure](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-internal-failure) in the Amazon Bedrock User Guide """ @@ -674,7 +650,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: class ThrottlingException(ServiceError): """ Your request was denied due to exceeding the account quotas for *Amazon - Bedrock*. For troubleshooting this error, see ``ThrottlingException ``_ + Bedrock*. For troubleshooting this error, see + [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide """ @@ -714,8 +691,9 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ValidationException(ServiceError): """ - The input fails to satisfy the constraints specified by *Amazon Bedrock*. For - troubleshooting this error, see ``ValidationError ``_ + The input fails to satisfy the constraints specified by *Amazon + Bedrock*. For troubleshooting this error, see + [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide """ @@ -792,41 +770,31 @@ class SortOrder(StrEnum): @dataclass(kw_only=True) class ListAsyncInvokesInput: + """Dataclass for ListAsyncInvokesInput structure.""" + submit_time_after: datetime | None = None - """ - Include invocations submitted after this time. - """ + """Include invocations submitted after this time.""" submit_time_before: datetime | None = None - """ - Include invocations submitted before this time. - """ + """Include invocations submitted before this time.""" status_equals: str | None = None - """ - Filter invocations by status. - """ + """Filter invocations by status.""" max_results: int | None = None - """ - The maximum number of invocations to return in one page of results. - """ + """The maximum number of invocations to return in one page of results.""" next_token: str | None = None """ - Specify the pagination token from a previous request to retrieve the next page - of results. + Specify the pagination token from a previous request to retrieve the + next page of results. """ sort_by: str = "SubmissionTime" - """ - How to sort the response. - """ + """How to sort the response.""" sort_order: str = "Descending" - """ - The sorting order for the response. - """ + """The sorting order for the response.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_LIST_ASYNC_INVOKES_INPUT, self) @@ -924,54 +892,34 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class AsyncInvokeSummary: - """ - A summary of an asynchronous invocation. - """ + """A summary of an asynchronous invocation.""" invocation_arn: str - """ - The invocation's ARN. - """ + """The invocation's ARN.""" model_arn: str - """ - The invoked model's ARN. - """ + """The invoked model's ARN.""" submit_time: datetime - """ - When the invocation was submitted. - """ + """When the invocation was submitted.""" output_data_config: AsyncInvokeOutputDataConfig - """ - The invocation's output data settings. - """ + """The invocation's output data settings.""" client_request_token: str | None = None - """ - The invocation's idempotency token. - """ + """The invocation's idempotency token.""" status: str | None = None - """ - The invocation's status. - """ + """The invocation's status.""" failure_message: str | None = field(repr=False, default=None) - """ - An error message. - """ + """An error message.""" last_modified_time: datetime | None = None - """ - When the invocation was last modified. - """ + """When the invocation was last modified.""" end_time: datetime | None = None - """ - When the invocation ended. - """ + """When the invocation ended.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_ASYNC_INVOKE_SUMMARY, self) @@ -1108,16 +1056,16 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class ListAsyncInvokesOutput: + """Dataclass for ListAsyncInvokesOutput structure.""" + next_token: str | None = None """ - Specify the pagination token from a previous request to retrieve the next page - of results. + Specify the pagination token from a previous request to retrieve the + next page of results. """ async_invoke_summaries: list[AsyncInvokeSummary] | None = None - """ - A list of invocation summaries. - """ + """A list of invocation summaries.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_LIST_ASYNC_INVOKES_OUTPUT, self) @@ -1198,9 +1146,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConflictException(ServiceError): - """ - Error occurred because of a conflict while performing an operation. - """ + """Error occurred because of a conflict while performing an operation.""" fault: Literal["client", "server"] | None = "client" @@ -1238,8 +1184,9 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ResourceNotFoundException(ServiceError): """ - The specified resource ARN was not found. For troubleshooting this error, see - ``ResourceNotFound ``_ + The specified resource ARN was not found. For troubleshooting this + error, see + [ResourceNotFound](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-resource-not-found) in the Amazon Bedrock User Guide """ @@ -1281,8 +1228,9 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ServiceQuotaExceededException(ServiceError): """ - Your request exceeds the service quota for your account. You can view your - quotas at ``Viewing service quotas ``_. + Your request exceeds the service quota for your account. You can view + your quotas at [Viewing service + quotas](https://docs.aws.amazon.com/servicequotas/latest/userguide/gs-request-quota.html). You can resubmit your request later. """ @@ -1325,8 +1273,9 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ServiceUnavailableException(ServiceError): """ - The service isn't currently available. For troubleshooting this error, see - ``ServiceUnavailable ``_ + The service isn't currently available. For troubleshooting this error, + see + [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide """ @@ -1367,19 +1316,13 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class Tag: - """ - A tag. - """ + """A tag.""" key: str - """ - The tag's key. - """ + """The tag's key.""" value: str - """ - The tag's value. - """ + """The tag's value.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TAG, self) @@ -1436,30 +1379,22 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class StartAsyncInvokeInput: + """Dataclass for StartAsyncInvokeInput structure.""" + client_request_token: str | None = None - """ - Specify idempotency token to ensure that requests are not duplicated. - """ + """Specify idempotency token to ensure that requests are not duplicated.""" model_id: str | None = None - """ - The model to invoke. - """ + """The model to invoke.""" model_input: Document | None = field(repr=False, default=None) - """ - Input to send to the model. - """ + """Input to send to the model.""" output_data_config: AsyncInvokeOutputDataConfig | None = None - """ - Where to store the output. - """ + """Where to store the output.""" tags: list[Tag] | None = None - """ - Tags to apply to the invocation. - """ + """Tags to apply to the invocation.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_START_ASYNC_INVOKE_INPUT, self) @@ -1536,10 +1471,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class StartAsyncInvokeOutput: + """Dataclass for StartAsyncInvokeOutput structure.""" + invocation_arn: str - """ - The ARN of the invocation. - """ + """The ARN of the invocation.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_START_ASYNC_INVOKE_OUTPUT, self) @@ -1621,7 +1556,8 @@ class GuardrailImageFormat(StrEnum): @dataclass class GuardrailImageSourceBytes: """ - The bytes details of the guardrail image source. Object used in independent api. + The bytes details of the guardrail image source. Object used in + independent api. """ value: bytes @@ -1645,7 +1581,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailImageSourceUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -1667,10 +1604,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: GuardrailImageSource = Union[GuardrailImageSourceBytes | GuardrailImageSourceUnknown] - """ -The image source (image bytes) of the guardrail image source. Object used in -independent api. +The image source (image bytes) of the guardrail image source. Object +used in independent api. """ @@ -1713,12 +1649,14 @@ class GuardrailImageBlock: format: str """ - The format details for the file type of the image blocked by the guardrail. + The format details for the file type of the image blocked by the + guardrail. """ source: GuardrailImageSource = field(repr=False) """ - The image source (image bytes) details of the image blocked by the guardrail. + The image source (image bytes) details of the image blocked by the + guardrail. """ def serialize(self, serializer: ShapeSerializer): @@ -1793,19 +1731,13 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailTextBlock: - """ - The text block to be evaluated by the guardrail. - """ + """The text block to be evaluated by the guardrail.""" text: str - """ - The input text details to be evaluated by the guardrail. - """ + """The input text details to be evaluated by the guardrail.""" qualifiers: list[str] | None = None - """ - The qualifiers describing the text block. - """ + """The qualifiers describing the text block.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_TEXT_BLOCK, self) @@ -1850,9 +1782,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class GuardrailContentBlockText: - """ - Text within content block to be evaluated by the guardrail. - """ + """Text within content block to be evaluated by the guardrail.""" value: GuardrailTextBlock @@ -1871,9 +1801,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailContentBlockImage: - """ - Image within guardrail content block to be evaluated by the guardrail. - """ + """Image within guardrail content block to be evaluated by the guardrail.""" value: GuardrailImageBlock @@ -1892,7 +1820,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailContentBlockUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -1918,10 +1847,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | GuardrailContentBlockImage | GuardrailContentBlockUnknown ] - -""" -The content block to be evaluated by the guardrail. -""" +"""The content block to be evaluated by the guardrail.""" class _GuardrailContentBlockDeserializer: @@ -1994,36 +1920,30 @@ class GuardrailContentSource(StrEnum): @dataclass(kw_only=True) class ApplyGuardrailInput: + """Dataclass for ApplyGuardrailInput structure.""" + guardrail_identifier: str | None = None - """ - The guardrail identifier used in the request to apply the guardrail. - """ + """The guardrail identifier used in the request to apply the guardrail.""" guardrail_version: str | None = None - """ - The guardrail version used in the request to apply the guardrail. - """ + """The guardrail version used in the request to apply the guardrail.""" source: str | None = None - """ - The source of data used in the request to apply the guardrail. - """ + """The source of data used in the request to apply the guardrail.""" content: list[GuardrailContentBlock] | None = None - """ - The content details used in the request to apply the guardrail. - """ + """The content details used in the request to apply the guardrail.""" output_scope: str | None = None """ - Specifies the scope of the output that you get in the response. Set to ``FULL`` - to return the entire output, including any detected and non-detected entries in - the response for enhanced debugging. + Specifies the scope of the output that you get in the response. Set to + `FULL` to return the entire output, including any detected and + non-detected entries in the response for enhanced debugging. - Note that the full output scope doesn't apply to word filters or regex in - sensitive information filters. It does apply to all other filtering policies, - including sensitive information with filters that can detect personally - identifiable information (PII). + Note that the full output scope doesn't apply to word filters or regex + in sensitive information filters. It does apply to all other filtering + policies, including sensitive information with filters that can detect + personally identifiable information (PII). """ def serialize(self, serializer: ShapeSerializer): @@ -2146,37 +2066,32 @@ class GuardrailOwnership(StrEnum): @dataclass(kw_only=True) class AppliedGuardrailDetails: """ - Details about the specific guardrail that was applied during this assessment, - including its identifier, version, ARN, origin, and ownership information. + Details about the specific guardrail that was applied during this + assessment, including its identifier, version, ARN, origin, and + ownership information. """ guardrail_id: str | None = None - """ - The unique ID of the guardrail that was applied. - """ + """The unique ID of the guardrail that was applied.""" guardrail_version: str | None = None - """ - The version of the guardrail that was applied. - """ + """The version of the guardrail that was applied.""" guardrail_arn: str | None = None - """ - The ARN of the guardrail that was applied. - """ + """The ARN of the guardrail that was applied.""" guardrail_origin: list[str] | None = None """ - The origin of how the guardrail was applied. This can be either requested at the - API level or enforced at the account or organization level as a default - guardrail. + The origin of how the guardrail was applied. This can be either + requested at the API level or enforced at the account or organization + level as a default guardrail. """ guardrail_ownership: str | None = None """ - The ownership type of the guardrail, indicating whether it is owned by the - requesting account or is a cross-account guardrail shared from another AWS - account. + The ownership type of the guardrail, indicating whether it is owned by + the requesting account or is a cross-account guardrail shared from + another AWS account. """ def serialize(self, serializer: ShapeSerializer): @@ -2259,18 +2174,17 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAutomatedReasoningRule: """ - References a specific automated reasoning policy rule that was applied during - evaluation. + References a specific automated reasoning policy rule that was applied + during evaluation. """ identifier: str | None = None - """ - The unique identifier of the automated reasoning rule. - """ + """The unique identifier of the automated reasoning rule.""" policy_version_arn: str | None = None """ - The ARN of the automated reasoning policy version that contains this rule. + The ARN of the automated reasoning policy version that contains this + rule. """ def serialize(self, serializer: ShapeSerializer): @@ -2350,19 +2264,15 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailAutomatedReasoningStatement: """ - A logical statement that includes both formal logic representation and natural - language explanation. + A logical statement that includes both formal logic representation and + natural language explanation. """ logic: str | None = field(repr=False, default=None) - """ - The formal logical representation of the statement. - """ + """The formal logical representation of the statement.""" natural_language: str | None = field(repr=False, default=None) - """ - The natural language explanation of the logical statement. - """ + """The natural language explanation of the logical statement.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_AUTOMATED_REASONING_STATEMENT, self) @@ -2448,14 +2358,15 @@ class GuardrailAutomatedReasoningLogicWarningType(StrEnum): @dataclass(kw_only=True) class GuardrailAutomatedReasoningLogicWarning: """ - Identifies logical issues in the translated statements that exist independent of - any policy rules, such as statements that are always true or always false. + Identifies logical issues in the translated statements that exist + independent of any policy rules, such as statements that are always true + or always false. """ type: str | None = None """ - The category of the detected logical issue, such as statements that are always - true or always false. + The category of the detected logical issue, such as statements that are + always true or always false. """ premises: list[GuardrailAutomatedReasoningStatement] | None = None @@ -2545,14 +2456,12 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAutomatedReasoningInputTextReference: """ - References a portion of the original input text that corresponds to logical - elements. + References a portion of the original input text that corresponds to + logical elements. """ text: str | None = field(repr=False, default=None) - """ - The specific text from the original input that this reference points to. - """ + """The specific text from the original input that this reference points to.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct( @@ -2625,20 +2534,20 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailAutomatedReasoningTranslation: """ - Contains the logical translation of natural language input into formal logical - statements, including premises, claims, and confidence scores. + Contains the logical translation of natural language input into formal + logical statements, including premises, claims, and confidence scores. """ premises: list[GuardrailAutomatedReasoningStatement] | None = None """ - The logical statements that serve as the foundation or assumptions for the - claims. + The logical statements that serve as the foundation or assumptions for + the claims. """ claims: list[GuardrailAutomatedReasoningStatement] | None = None """ - The logical statements that are being validated against the premises and policy - rules. + The logical statements that are being validated against the premises and + policy rules. """ untranslated_premises: ( @@ -2653,14 +2562,14 @@ class GuardrailAutomatedReasoningTranslation: None ) """ - References to portions of the original input text that correspond to the claims - but could not be fully translated. + References to portions of the original input text that correspond to the + claims but could not be fully translated. """ confidence: float | None = None """ - A confidence score between 0 and 1 indicating how certain the system is about - the logical translation. + A confidence score between 0 and 1 indicating how certain the system is + about the logical translation. """ def serialize(self, serializer: ShapeSerializer): @@ -2774,25 +2683,23 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAutomatedReasoningImpossibleFinding: """ - Indicates that no valid claims can be made due to logical contradictions in the - premises or rules. + Indicates that no valid claims can be made due to logical contradictions + in the premises or rules. """ translation: GuardrailAutomatedReasoningTranslation | None = None - """ - The logical translation of the input that this finding evaluates. - """ + """The logical translation of the input that this finding evaluates.""" contradicting_rules: list[GuardrailAutomatedReasoningRule] | None = None """ - The automated reasoning policy rules that contradict the claims and/or premises - in the input. + The automated reasoning policy rules that contradict the claims and/or + premises in the input. """ logic_warning: GuardrailAutomatedReasoningLogicWarning | None = None """ - Indication of a logic issue with the translation without needing to consider the - automated reasoning policy rules. + Indication of a logic issue with the translation without needing to + consider the automated reasoning policy rules. """ def serialize(self, serializer: ShapeSerializer): @@ -2873,19 +2780,18 @@ class GuardrailAutomatedReasoningInvalidFinding: """ translation: GuardrailAutomatedReasoningTranslation | None = None - """ - The logical translation of the input that this finding invalidates. - """ + """The logical translation of the input that this finding invalidates.""" contradicting_rules: list[GuardrailAutomatedReasoningRule] | None = None """ - The automated reasoning policy rules that contradict the claims in the input. + The automated reasoning policy rules that contradict the claims in the + input. """ logic_warning: GuardrailAutomatedReasoningLogicWarning | None = None """ - Indication of a logic issue with the translation without needing to consider the - automated reasoning policy rules. + Indication of a logic issue with the translation without needing to + consider the automated reasoning policy rules. """ def serialize(self, serializer: ShapeSerializer): @@ -2961,8 +2867,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAutomatedReasoningNoTranslationsFinding: """ - Indicates that no relevant logical information could be extracted from the input - for validation. + Indicates that no relevant logical information could be extracted from + the input for validation. """ def serialize(self, serializer: ShapeSerializer): @@ -2996,14 +2902,12 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAutomatedReasoningScenario: """ - Represents a logical scenario where claims can be evaluated as true or false, - containing specific logical assignments. + Represents a logical scenario where claims can be evaluated as true or + false, containing specific logical assignments. """ statements: list[GuardrailAutomatedReasoningStatement] | None = None - """ - List of logical assignments and statements that define this scenario. - """ + """List of logical assignments and statements that define this scenario.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_AUTOMATED_REASONING_SCENARIO, self) @@ -3048,29 +2952,29 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAutomatedReasoningSatisfiableFinding: """ - Indicates that the claims could be either true or false depending on additional - assumptions not provided in the input. + Indicates that the claims could be either true or false depending on + additional assumptions not provided in the input. """ translation: GuardrailAutomatedReasoningTranslation | None = None - """ - The logical translation of the input that this finding evaluates. - """ + """The logical translation of the input that this finding evaluates.""" claims_true_scenario: GuardrailAutomatedReasoningScenario | None = None """ - An example scenario demonstrating how the claims could be logically true. + An example scenario demonstrating how the claims could be logically + true. """ claims_false_scenario: GuardrailAutomatedReasoningScenario | None = None """ - An example scenario demonstrating how the claims could be logically false. + An example scenario demonstrating how the claims could be logically + false. """ logic_warning: GuardrailAutomatedReasoningLogicWarning | None = None """ - Indication of a logic issue with the translation without needing to consider the - automated reasoning policy rules. + Indication of a logic issue with the translation without needing to + consider the automated reasoning policy rules. """ def serialize(self, serializer: ShapeSerializer): @@ -3154,8 +3058,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAutomatedReasoningTooComplexFinding: """ - Indicates that the input exceeds the processing capacity due to the volume or - complexity of the logical information. + Indicates that the input exceeds the processing capacity due to the + volume or complexity of the logical information. """ def serialize(self, serializer: ShapeSerializer): @@ -3243,12 +3147,14 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailAutomatedReasoningTranslationOption: """ - Represents one possible logical interpretation of ambiguous input content. + Represents one possible logical interpretation of ambiguous input + content. """ translations: list[GuardrailAutomatedReasoningTranslation] | None = None """ - Example translations that provide this possible interpretation of the input. + Example translations that provide this possible interpretation of the + input. """ def serialize(self, serializer: ShapeSerializer): @@ -3325,19 +3231,20 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailAutomatedReasoningTranslationAmbiguousFinding: """ - Indicates that the input has multiple valid logical interpretations, requiring - additional context or clarification. + Indicates that the input has multiple valid logical interpretations, + requiring additional context or clarification. """ options: list[GuardrailAutomatedReasoningTranslationOption] | None = None """ - Different logical interpretations that were detected during translation of the - input. + Different logical interpretations that were detected during translation + of the input. """ difference_scenarios: list[GuardrailAutomatedReasoningScenario] | None = None """ - Scenarios showing how the different translation options differ in meaning. + Scenarios showing how the different translation options differ in + meaning. """ def serialize(self, serializer: ShapeSerializer): @@ -3407,30 +3314,26 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAutomatedReasoningValidFinding: """ - Indicates that the claims are definitively true and logically implied by the - premises, with no possible alternative interpretations. + Indicates that the claims are definitively true and logically implied by + the premises, with no possible alternative interpretations. """ translation: GuardrailAutomatedReasoningTranslation | None = None - """ - The logical translation of the input that this finding validates. - """ + """The logical translation of the input that this finding validates.""" claims_true_scenario: GuardrailAutomatedReasoningScenario | None = None - """ - An example scenario demonstrating how the claims are logically true. - """ + """An example scenario demonstrating how the claims are logically true.""" supporting_rules: list[GuardrailAutomatedReasoningRule] | None = None """ - The automated reasoning policy rules that support why this result is considered - valid. + The automated reasoning policy rules that support why this result is + considered valid. """ logic_warning: GuardrailAutomatedReasoningLogicWarning | None = None """ - Indication of a logic issue with the translation without needing to consider the - automated reasoning policy rules. + Indication of a logic issue with the translation without needing to + consider the automated reasoning policy rules. """ def serialize(self, serializer: ShapeSerializer): @@ -3519,9 +3422,9 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class GuardrailAutomatedReasoningFindingValid: """ - Contains the result when the automated reasoning evaluation determines that the - claims in the input are logically valid and definitively true based on the - provided premises and policy rules. + Contains the result when the automated reasoning evaluation determines + that the claims in the input are logically valid and definitively true + based on the provided premises and policy rules. """ value: GuardrailAutomatedReasoningValidFinding @@ -3544,9 +3447,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailAutomatedReasoningFindingInvalid: """ - Contains the result when the automated reasoning evaluation determines that the - claims in the input are logically invalid and contradict the established - premises or policy rules. + Contains the result when the automated reasoning evaluation determines + that the claims in the input are logically invalid and contradict the + established premises or policy rules. """ value: GuardrailAutomatedReasoningInvalidFinding @@ -3569,9 +3472,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailAutomatedReasoningFindingSatisfiable: """ - Contains the result when the automated reasoning evaluation determines that the - claims in the input could be either true or false depending on additional - assumptions not provided in the input context. + Contains the result when the automated reasoning evaluation determines + that the claims in the input could be either true or false depending on + additional assumptions not provided in the input context. """ value: GuardrailAutomatedReasoningSatisfiableFinding @@ -3597,9 +3500,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailAutomatedReasoningFindingImpossible: """ - Contains the result when the automated reasoning evaluation determines that no - valid logical conclusions can be drawn due to contradictions in the premises or - policy rules themselves. + Contains the result when the automated reasoning evaluation determines + that no valid logical conclusions can be drawn due to contradictions in + the premises or policy rules themselves. """ value: GuardrailAutomatedReasoningImpossibleFinding @@ -3623,9 +3526,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailAutomatedReasoningFindingTranslationAmbiguous: """ - Contains the result when the automated reasoning evaluation detects that the - input has multiple valid logical interpretations, requiring additional context - or clarification to proceed with validation. + Contains the result when the automated reasoning evaluation detects that + the input has multiple valid logical interpretations, requiring + additional context or clarification to proceed with validation. """ value: GuardrailAutomatedReasoningTranslationAmbiguousFinding @@ -3653,9 +3556,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailAutomatedReasoningFindingTooComplex: """ - Contains the result when the automated reasoning evaluation cannot process the - input due to its complexity or volume exceeding the system's processing capacity - for logical analysis. + Contains the result when the automated reasoning evaluation cannot + process the input due to its complexity or volume exceeding the + system's processing capacity for logical analysis. """ value: GuardrailAutomatedReasoningTooComplexFinding @@ -3679,9 +3582,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailAutomatedReasoningFindingNoTranslations: """ - Contains the result when the automated reasoning evaluation cannot extract any - relevant logical information from the input that can be validated against the - policy rules. + Contains the result when the automated reasoning evaluation cannot + extract any relevant logical information from the input that can be + validated against the policy rules. """ value: GuardrailAutomatedReasoningNoTranslationsFinding @@ -3706,7 +3609,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailAutomatedReasoningFindingUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -3737,11 +3641,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | GuardrailAutomatedReasoningFindingNoTranslations | GuardrailAutomatedReasoningFindingUnknown ] - """ Represents a logical validation result from automated reasoning policy -evaluation. The finding indicates whether claims in the input are logically -valid, invalid, satisfiable, impossible, or have other logical issues. +evaluation. The finding indicates whether claims in the input are +logically valid, invalid, satisfiable, impossible, or have other logical +issues. """ @@ -3845,14 +3749,14 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailAutomatedReasoningPolicyAssessment: """ - Contains the results of automated reasoning policy evaluation, including logical - findings about the validity of claims made in the input content. + Contains the results of automated reasoning policy evaluation, including + logical findings about the validity of claims made in the input content. """ findings: list[GuardrailAutomatedReasoningFinding] | None = None """ - List of logical validation results produced by evaluating the input content - against automated reasoning policies. + List of logical validation results produced by evaluating the input + content against automated reasoning policies. """ def serialize(self, serializer: ShapeSerializer): @@ -3929,33 +3833,24 @@ class GuardrailContentFilterType(StrEnum): @dataclass(kw_only=True) class GuardrailContentFilter: - """ - The content filter for a guardrail. - """ + """The content filter for a guardrail.""" type: str - """ - The guardrail type. - """ + """The guardrail type.""" confidence: str - """ - The guardrail confidence. - """ + """The guardrail confidence.""" action: str - """ - The guardrail action. - """ + """The guardrail action.""" filter_strength: str | None = None - """ - The filter strength setting for the guardrail content filter. - """ + """The filter strength setting for the guardrail content filter.""" detected: bool | None = None """ - Indicates whether content that breaches the guardrail configuration is detected. + Indicates whether content that breaches the guardrail configuration is + detected. """ def serialize(self, serializer: ShapeSerializer): @@ -4051,14 +3946,10 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailContentPolicyAssessment: - """ - An assessment of a content policy for a guardrail. - """ + """An assessment of a content policy for a guardrail.""" filters: list[GuardrailContentFilter] - """ - The content policy filters. - """ + """The content policy filters.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_CONTENT_POLICY_ASSESSMENT, self) @@ -4107,30 +3998,22 @@ class GuardrailContextualGroundingFilterType(StrEnum): @dataclass(kw_only=True) class GuardrailContextualGroundingFilter: - """ - The details for the guardrails contextual grounding filter. - """ + """The details for the guardrails contextual grounding filter.""" type: str - """ - The contextual grounding filter type. - """ + """The contextual grounding filter type.""" threshold: float """ - The threshold used by contextual grounding filter to determine whether the - content is grounded or not. + The threshold used by contextual grounding filter to determine whether + the content is grounded or not. """ score: float - """ - The score generated by contextual grounding filter. - """ + """The score generated by contextual grounding filter.""" action: str - """ - The action performed by the guardrails contextual grounding filter. - """ + """The action performed by the guardrails contextual grounding filter.""" detected: bool | None = None """ @@ -4240,13 +4123,12 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailContextualGroundingPolicyAssessment: """ - The policy assessment details for the guardrails contextual grounding filter. + The policy assessment details for the guardrails contextual grounding + filter. """ filters: list[GuardrailContextualGroundingFilter] | None = None - """ - The filter details for the guardrails contextual grounding filter. - """ + """The filter details for the guardrails contextual grounding filter.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct( @@ -4294,14 +4176,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailImageCoverage: - """ - The details of the guardrail image coverage. - """ + """The details of the guardrail image coverage.""" guarded: int | None = None - """ - The count (integer) of images guardrails guarded. - """ + """The count (integer) of images guardrails guarded.""" total: int | None = None """ @@ -4352,19 +4230,13 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailTextCharactersCoverage: - """ - The guardrail coverage for the text characters. - """ + """The guardrail coverage for the text characters.""" guarded: int | None = None - """ - The text characters that were guarded by the guardrail coverage. - """ + """The text characters that were guarded by the guardrail coverage.""" total: int | None = None - """ - The total text characters by the guardrail coverage. - """ + """The total text characters by the guardrail coverage.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_TEXT_CHARACTERS_COVERAGE, self) @@ -4412,14 +4284,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailCoverage: - """ - The action of the guardrail coverage details. - """ + """The action of the guardrail coverage details.""" text_characters: GuardrailTextCharactersCoverage | None = None - """ - The text characters of the guardrail coverage details. - """ + """The text characters of the guardrail coverage details.""" images: GuardrailImageCoverage | None = None """ @@ -4469,54 +4337,36 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailUsage: - """ - The details on the use of the guardrail. - """ + """The details on the use of the guardrail.""" topic_policy_units: int - """ - The topic policy units processed by the guardrail. - """ + """The topic policy units processed by the guardrail.""" content_policy_units: int - """ - The content policy units processed by the guardrail. - """ + """The content policy units processed by the guardrail.""" word_policy_units: int - """ - The word policy units processed by the guardrail. - """ + """The word policy units processed by the guardrail.""" sensitive_information_policy_units: int - """ - The sensitive information policy units processed by the guardrail. - """ + """The sensitive information policy units processed by the guardrail.""" sensitive_information_policy_free_units: int - """ - The sensitive information policy free units processed by the guardrail. - """ + """The sensitive information policy free units processed by the guardrail.""" contextual_grounding_policy_units: int - """ - The contextual grounding policy units processed by the guardrail. - """ + """The contextual grounding policy units processed by the guardrail.""" content_policy_image_units: int | None = None - """ - The content policy image units processed by the guardrail. - """ + """The content policy image units processed by the guardrail.""" automated_reasoning_policy_units: int | None = None - """ - The number of text units processed by the automated reasoning policy. - """ + """The number of text units processed by the automated reasoning policy.""" automated_reasoning_policies: int | None = None """ - The number of automated reasoning policies that were processed during the - guardrail evaluation. + The number of automated reasoning policies that were processed during + the guardrail evaluation. """ def serialize(self, serializer: ShapeSerializer): @@ -4633,24 +4483,16 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailInvocationMetrics: - """ - The invocation metrics for the guardrail. - """ + """The invocation metrics for the guardrail.""" guardrail_processing_latency: int | None = None - """ - The processing latency details for the guardrail invocation metrics. - """ + """The processing latency details for the guardrail invocation metrics.""" usage: GuardrailUsage | None = None - """ - The usage details for the guardrail invocation metrics. - """ + """The usage details for the guardrail invocation metrics.""" guardrail_coverage: GuardrailCoverage | None = None - """ - The coverage details for the guardrail invocation metrics. - """ + """The coverage details for the guardrail invocation metrics.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_INVOCATION_METRICS, self) @@ -4750,28 +4592,23 @@ class GuardrailPiiEntityType(StrEnum): @dataclass(kw_only=True) class GuardrailPiiEntityFilter: """ - A Personally Identifiable Information (PII) entity configured in a guardrail. + A Personally Identifiable Information (PII) entity configured in a + guardrail. """ match: str - """ - The PII entity filter match. - """ + """The PII entity filter match.""" type: str - """ - The PII entity filter type. - """ + """The PII entity filter type.""" action: str - """ - The PII entity filter action. - """ + """The PII entity filter action.""" detected: bool | None = None """ - Indicates whether personally identifiable information (PII) that breaches the - guardrail configuration is detected. + Indicates whether personally identifiable information (PII) that + breaches the guardrail configuration is detected. """ def serialize(self, serializer: ShapeSerializer): @@ -4858,34 +4695,24 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailRegexFilter: - """ - A Regex filter configured in a guardrail. - """ + """A Regex filter configured in a guardrail.""" action: str - """ - The region filter action. - """ + """The region filter action.""" name: str | None = None - """ - The regex filter name. - """ + """The regex filter name.""" match: str | None = None - """ - The regesx filter match. - """ + """The regesx filter match.""" regex: str | None = None - """ - The regex query. - """ + """The regex query.""" detected: bool | None = None """ - Indicates whether custom regex entities that breach the guardrail configuration - are detected. + Indicates whether custom regex entities that breach the guardrail + configuration are detected. """ def serialize(self, serializer: ShapeSerializer): @@ -4984,19 +4811,13 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailSensitiveInformationPolicyAssessment: - """ - The assessment for a Personally Identifiable Information (PII) policy. - """ + """The assessment for a Personally Identifiable Information (PII) policy.""" pii_entities: list[GuardrailPiiEntityFilter] - """ - The PII entities in the assessment. - """ + """The PII entities in the assessment.""" regexes: list[GuardrailRegexFilter] - """ - The regex queries in the assessment. - """ + """The regex queries in the assessment.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct( @@ -5068,30 +4889,24 @@ class GuardrailTopicType(StrEnum): @dataclass(kw_only=True) class GuardrailTopic: - """ - Information about a topic guardrail. - """ + """Information about a topic guardrail.""" name: str - """ - The name for the guardrail. - """ + """The name for the guardrail.""" type: str """ - The type behavior that the guardrail should perform when the model detects the - topic. + The type behavior that the guardrail should perform when the model + detects the topic. """ action: str - """ - The action the guardrail should take when it intervenes on a topic. - """ + """The action the guardrail should take when it intervenes on a topic.""" detected: bool | None = None """ - Indicates whether topic content that breaches the guardrail configuration is - detected. + Indicates whether topic content that breaches the guardrail + configuration is detected. """ def serialize(self, serializer: ShapeSerializer): @@ -5170,14 +4985,10 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailTopicPolicyAssessment: - """ - A behavior assessment of a topic policy. - """ + """A behavior assessment of a topic policy.""" topics: list[GuardrailTopic] - """ - The topics in the assessment. - """ + """The topics in the assessment.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_TOPIC_POLICY_ASSESSMENT, self) @@ -5220,24 +5031,18 @@ class GuardrailWordPolicyAction(StrEnum): @dataclass(kw_only=True) class GuardrailCustomWord: - """ - A custom word configured in a guardrail. - """ + """A custom word configured in a guardrail.""" match: str - """ - The match for the custom word. - """ + """The match for the custom word.""" action: str - """ - The action for the custom word. - """ + """The action for the custom word.""" detected: bool | None = None """ - Indicates whether custom word content that breaches the guardrail configuration - is detected. + Indicates whether custom word content that breaches the guardrail + configuration is detected. """ def serialize(self, serializer: ShapeSerializer): @@ -5318,29 +5123,21 @@ class GuardrailManagedWordType(StrEnum): @dataclass(kw_only=True) class GuardrailManagedWord: - """ - A managed word configured in a guardrail. - """ + """A managed word configured in a guardrail.""" - match: str - """ - The match for the managed word. - """ + match: str + """The match for the managed word.""" type: str - """ - The type for the managed word. - """ + """The type for the managed word.""" action: str - """ - The action for the managed word. - """ + """The action for the managed word.""" detected: bool | None = None """ - Indicates whether managed word content that breaches the guardrail configuration - is detected. + Indicates whether managed word content that breaches the guardrail + configuration is detected. """ def serialize(self, serializer: ShapeSerializer): @@ -5425,19 +5222,13 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailWordPolicyAssessment: - """ - The word policy assessment. - """ + """The word policy assessment.""" custom_words: list[GuardrailCustomWord] - """ - Custom words in the assessment. - """ + """Custom words in the assessment.""" managed_word_lists: list[GuardrailManagedWord] - """ - Managed word lists in the assessment. - """ + """Managed word lists in the assessment.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_WORD_POLICY_ASSESSMENT, self) @@ -5492,56 +5283,45 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GuardrailAssessment: """ - A behavior assessment of the guardrail policies used in a call to the Converse - API. + A behavior assessment of the guardrail policies used in a call to the + Converse API. """ topic_policy: GuardrailTopicPolicyAssessment | None = None - """ - The topic policy. - """ + """The topic policy.""" content_policy: GuardrailContentPolicyAssessment | None = None - """ - The content policy. - """ + """The content policy.""" word_policy: GuardrailWordPolicyAssessment | None = None - """ - The word policy. - """ + """The word policy.""" sensitive_information_policy: ( GuardrailSensitiveInformationPolicyAssessment | None ) = None - """ - The sensitive information policy. - """ + """The sensitive information policy.""" contextual_grounding_policy: GuardrailContextualGroundingPolicyAssessment | None = ( None ) - """ - The contextual grounding policy used for the guardrail assessment. - """ + """The contextual grounding policy used for the guardrail assessment.""" automated_reasoning_policy: GuardrailAutomatedReasoningPolicyAssessment | None = ( None ) """ - The automated reasoning policy assessment results, including logical validation - findings for the input content. + The automated reasoning policy assessment results, including logical + validation findings for the input content. """ invocation_metrics: GuardrailInvocationMetrics | None = None - """ - The invocation metrics for the guardrail assessment. - """ + """The invocation metrics for the guardrail assessment.""" applied_guardrail_details: AppliedGuardrailDetails | None = None """ - Details about the specific guardrail that was applied during this assessment, - including its identifier, version, ARN, origin, and ownership information. + Details about the specific guardrail that was applied during this + assessment, including its identifier, version, ARN, origin, and + ownership information. """ def serialize(self, serializer: ShapeSerializer): @@ -5678,14 +5458,10 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailOutputContent: - """ - The output content produced by the guardrail. - """ + """The output content produced by the guardrail.""" text: str | None = None - """ - The specific text for the output content produced by the guardrail. - """ + """The specific text for the output content produced by the guardrail.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_OUTPUT_CONTENT, self) @@ -5745,35 +5521,25 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class ApplyGuardrailOutput: + """Dataclass for ApplyGuardrailOutput structure.""" + usage: GuardrailUsage - """ - The usage details in the response from the guardrail. - """ + """The usage details in the response from the guardrail.""" action: str - """ - The action taken in the response from the guardrail. - """ + """The action taken in the response from the guardrail.""" outputs: list[GuardrailOutputContent] - """ - The output details in the response from the guardrail. - """ + """The output details in the response from the guardrail.""" assessments: list[GuardrailAssessment] - """ - The assessment details in the response from the guardrail. - """ + """The assessment details in the response from the guardrail.""" action_reason: str | None = None - """ - The reason for the action taken when harmful content is detected. - """ + """The reason for the action taken when harmful content is detected.""" guardrail_coverage: GuardrailCoverage | None = None - """ - The guardrail coverage details in the apply guardrail response. - """ + """The guardrail coverage details in the apply guardrail response.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_APPLY_GUARDRAIL_OUTPUT, self) @@ -5895,24 +5661,19 @@ class GuardrailTrace(StrEnum): @dataclass(kw_only=True) class GuardrailConfiguration: """ - Configuration information for a guardrail that you use with the ``Converse ``_ + Configuration information for a guardrail that you use with the + [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) operation. """ guardrail_identifier: str = "" - """ - The identifier for the guardrail. - """ + """The identifier for the guardrail.""" guardrail_version: str = "" - """ - The version of the guardrail. - """ + """The version of the guardrail.""" trace: str = "disabled" - """ - The trace behavior for the guardrail. - """ + """The trace behavior for the guardrail.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_CONFIGURATION, self) @@ -5991,51 +5752,55 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class InferenceConfiguration: """ - Base inference parameters to pass to a model in a call to ``Converse ``_ - or ``ConverseStream - ``*. For more information, see ``Inference parameters for foundation models ``* . + Base inference parameters to pass to a model in a call to + [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) + or + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html). + For more information, see [Inference parameters for foundation + models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). - If you need to pass additional parameters that the model supports, use the - ``additionalModelRequestFields`` request field in the call to ``Converse`` or ``ConverseStream``. For more information, see ``Model parameters ``_ - . + If you need to pass additional parameters that the model supports, use + the `additionalModelRequestFields` request field in the call to + `Converse` or `ConverseStream`. For more information, see [Model + parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). """ max_tokens: int | None = None """ - The maximum number of tokens to allow in the generated response. The default - value is the maximum allowed value for the model that you are using. For more - information, see `Inference parameters for foundation models `_ - . + The maximum number of tokens to allow in the generated response. The + default value is the maximum allowed value for the model that you are + using. For more information, see [Inference parameters for foundation + models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). """ temperature: float | None = None """ The likelihood of the model selecting higher-probability options while - generating a response. A lower value makes the model more likely to choose - higher-probability options, while a higher value makes the model more likely to - choose lower-probability options. + generating a response. A lower value makes the model more likely to + choose higher-probability options, while a higher value makes the model + more likely to choose lower-probability options. - The default value is the default value for the model that you are using. For - more information, see `Inference parameters for foundation models `_ - . + The default value is the default value for the model that you are using. + For more information, see [Inference parameters for foundation + models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). """ top_p: float | None = None """ - The percentage of most-likely candidates that the model considers for the next - token. For example, if you choose a value of 0.8 for ``topP``, the model selects - from the top 80% of the probability distribution of tokens that could be next in - the sequence. + The percentage of most-likely candidates that the model considers for + the next token. For example, if you choose a value of 0.8 for `topP`, + the model selects from the top 80% of the probability distribution of + tokens that could be next in the sequence. - The default value is the default value for the model that you are using. For - more information, see `Inference parameters for foundation models `_ - . + The default value is the default value for the model that you are using. + For more information, see [Inference parameters for foundation + models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). """ stop_sequences: list[str] | None = None """ - A list of stop sequences. A stop sequence is a sequence of characters that - causes the model to stop generating the response. + A list of stop sequences. A stop sequence is a sequence of characters + that causes the model to stop generating the response. """ def serialize(self, serializer: ShapeSerializer): @@ -6108,13 +5873,12 @@ class CachePointType(StrEnum): @dataclass(kw_only=True) class CachePointBlock: """ - Defines a section of content to be cached for reuse in subsequent API calls. + Defines a section of content to be cached for reuse in subsequent API + calls. """ type: str - """ - Specifies the type of cache point within the CachePointBlock. - """ + """Specifies the type of cache point within the CachePointBlock.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CACHE_POINT_BLOCK, self) @@ -6147,24 +5911,25 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class DocumentCharLocation: """ - Specifies a character-level location within a document, providing precise - positioning information for cited content using start and end character indices. + Specifies a character-level location within a document, providing + precise positioning information for cited content using start and end + character indices. """ document_index: int | None = None """ - The index of the document within the array of documents provided in the request. + The index of the document within the array of documents provided in the + request. """ start: int | None = None """ - The starting character position of the cited content within the document. + The starting character position of the cited content within the + document. """ end: int | None = None - """ - The ending character position of the cited content within the document. - """ + """The ending character position of the cited content within the document.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_DOCUMENT_CHAR_LOCATION, self) @@ -6221,23 +5986,27 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class DocumentChunkLocation: """ - Specifies a chunk-level location within a document, providing positioning - information for cited content using logical document segments or chunks. + Specifies a chunk-level location within a document, providing + positioning information for cited content using logical document + segments or chunks. """ document_index: int | None = None """ - The index of the document within the array of documents provided in the request. + The index of the document within the array of documents provided in the + request. """ start: int | None = None """ - The starting chunk identifier or index of the cited content within the document. + The starting chunk identifier or index of the cited content within the + document. """ end: int | None = None """ - The ending chunk identifier or index of the cited content within the document. + The ending chunk identifier or index of the cited content within the + document. """ def serialize(self, serializer: ShapeSerializer): @@ -6301,18 +6070,15 @@ class DocumentPageLocation: document_index: int | None = None """ - The index of the document within the array of documents provided in the request. + The index of the document within the array of documents provided in the + request. """ start: int | None = None - """ - The starting page number of the cited content within the document. - """ + """The starting page number of the cited content within the document.""" end: int | None = None - """ - The ending page number of the cited content within the document. - """ + """The ending page number of the cited content within the document.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_DOCUMENT_PAGE_LOCATION, self) @@ -6370,24 +6136,24 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: class SearchResultLocation: """ Specifies a search result location within the content array, providing - positioning information for cited content using search result index and block - positions. + positioning information for cited content using search result index and + block positions. """ search_result_index: int | None = None """ - The index of the search result content block where the cited content is found. + The index of the search result content block where the cited content is + found. """ start: int | None = None """ - The starting position in the content array where the cited content begins. + The starting position in the content array where the cited content + begins. """ end: int | None = None - """ - The ending position in the content array where the cited content ends. - """ + """The ending position in the content array where the cited content ends.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_SEARCH_RESULT_LOCATION, self) @@ -6444,19 +6210,15 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class WebLocation: """ - Provides the URL and domain information for the website that was cited when - performing a web search. + Provides the URL and domain information for the website that was cited + when performing a web search. """ url: str | None = None - """ - The URL that was cited when performing a web search. - """ + """The URL that was cited when performing a web search.""" domain: str | None = None - """ - The domain that was cited when performing a web search. - """ + """The domain that was cited when performing a web search.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_WEB_LOCATION, self) @@ -6495,9 +6257,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class CitationLocationWeb: - """ - The web URL that was cited for this reference. - """ + """The web URL that was cited for this reference.""" value: WebLocation @@ -6515,8 +6275,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CitationLocationDocumentChar: """ - The character-level location within the document where the cited content is - found. + The character-level location within the document where the cited content + is found. """ value: DocumentCharLocation @@ -6537,7 +6297,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CitationLocationDocumentPage: """ - The page-level location within the document where the cited content is found. + The page-level location within the document where the cited content is + found. """ value: DocumentPageLocation @@ -6558,8 +6319,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CitationLocationDocumentChunk: """ - The chunk-level location within the document where the cited content is found, - typically used for documents that have been segmented into logical chunks. + The chunk-level location within the document where the cited content is + found, typically used for documents that have been segmented into + logical chunks. """ value: DocumentChunkLocation @@ -6580,8 +6342,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CitationLocationSearchResultLocation: """ - The search result location where the cited content is found, including the - search result index and block positions within the content array. + The search result location where the cited content is found, including + the search result index and block positions within the content array. """ value: SearchResultLocation @@ -6601,7 +6363,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CitationLocationUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -6630,11 +6393,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | CitationLocationSearchResultLocation | CitationLocationUnknown ] - """ -Specifies the precise location within a source document where cited content can -be found. This can include character-level positions, page numbers, or document -chunks depending on the document type and indexing method. +Specifies the precise location within a source document where cited +content can be found. This can include character-level positions, page +numbers, or document chunks depending on the document type and indexing +method. """ @@ -6682,9 +6445,7 @@ def _set_result(self, value: CitationLocation) -> None: @dataclass class CitationSourceContentText: - """ - The text content from the source document that is being cited. - """ + """The text content from the source document that is being cited.""" value: str @@ -6707,7 +6468,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CitationSourceContentUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -6729,10 +6491,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: CitationSourceContent = Union[CitationSourceContentText | CitationSourceContentUnknown] - """ -Contains the actual text content from a source document that is being cited or -referenced in the model's response. +Contains the actual text content from a source document that is being +cited or referenced in the model's response. """ @@ -6795,30 +6556,30 @@ def _read_value(d: ShapeDeserializer): class Citation: """ Contains information about a citation that references a specific source - document. Citations provide traceability between the model's generated response - and the source documents that informed that response. + document. Citations provide traceability between the model's generated + response and the source documents that informed that response. """ title: str | None = None - """ - The title or identifier of the source document being cited. - """ + """The title or identifier of the source document being cited.""" source: str | None = None """ - The source from the original search result that provided the cited content. + The source from the original search result that provided the cited + content. """ source_content: list[CitationSourceContent] | None = None """ - The specific content from the source document that was referenced or cited in - the generated response. + The specific content from the source document that was referenced or + cited in the generated response. """ location: CitationLocation | None = None """ - The precise location within the source document where the cited content can be - found, including character positions, page numbers, or chunk identifiers. + The precise location within the source document where the cited content + can be found, including character positions, page numbers, or chunk + identifiers. """ def serialize(self, serializer: ShapeSerializer): @@ -6929,7 +6690,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CitationGeneratedContentUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -6953,10 +6715,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: CitationGeneratedContent = Union[ CitationGeneratedContentText | CitationGeneratedContentUnknown ] - """ -Contains the generated text content that corresponds to or is supported by a -citation from a source document. +Contains the generated text content that corresponds to or is supported +by a citation from a source document. """ @@ -7018,21 +6779,19 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class CitationsContentBlock: """ - A content block that contains both generated text and associated citation - information. This block type is returned when document citations are enabled, - providing traceability between the generated content and the source documents - that informed the response. + A content block that contains both generated text and associated + citation information. This block type is returned when document + citations are enabled, providing traceability between the generated + content and the source documents that informed the response. """ content: list[CitationGeneratedContent] | None = None - """ - The generated content that is supported by the associated citations. - """ + """The generated content that is supported by the associated citations.""" citations: list[Citation] | None = None """ - An array of citations that reference the source documents used to generate the - associated content. + An array of citations that reference the source documents used to + generate the associated content. """ def serialize(self, serializer: ShapeSerializer): @@ -7083,16 +6842,18 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class CitationsConfig: """ - Configuration settings for enabling and controlling document citations in - Converse API responses. When enabled, the model can include citation information - that links generated content back to specific source documents. + Configuration settings for enabling and controlling document citations + in Converse API responses. When enabled, the model can include citation + information that links generated content back to specific source + documents. """ enabled: bool """ - Specifies whether citations from the selected document should be used in the - model's response. When set to true, the model can generate citations that - reference the source documents used to inform the response. + Specifies whether citations from the selected document should be used in + the model's response. When set to true, the model can generate + citations that reference the source documents used to inform the + response. """ def serialize(self, serializer: ShapeSerializer): @@ -7139,9 +6900,7 @@ class DocumentFormat(StrEnum): @dataclass class DocumentContentBlockText: - """ - The text content of the document. - """ + """The text content of the document.""" value: str @@ -7164,7 +6923,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class DocumentContentBlockUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -7186,10 +6946,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: DocumentContentBlock = Union[DocumentContentBlockText | DocumentContentBlockUnknown] - """ -Contains the actual content of a document that can be processed by the model and -potentially cited in the response. +Contains the actual content of a document that can be processed by the +model and potentially cited in the response. """ @@ -7250,18 +7009,15 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class S3Location: - """ - A storage location in an Amazon S3 bucket. - """ + """A storage location in an Amazon S3 bucket.""" uri: str - """ - An object URI starting with ``s3://``. - """ + """An object URI starting with `s3://`.""" bucket_owner: str | None = None """ - If the bucket belongs to another AWS account, specify that account's ID. + If the bucket belongs to another AWS account, specify that account's + ID. """ def serialize(self, serializer: ShapeSerializer): @@ -7302,8 +7058,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class DocumentSourceBytes: """ - The raw bytes for the document. If you use an Amazon Web Services SDK, you don't - need to encode the bytes in base64. + The raw bytes for the document. If you use an Amazon Web Services SDK, + you don't need to encode the bytes in base64. """ value: bytes @@ -7324,9 +7080,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class DocumentSourceS3Location: """ - The location of a document object in an Amazon S3 bucket. To see which models - support S3 uploads, see `Supported models and features for Converse `_ - . + The location of a document object in an Amazon S3 bucket. To see which + models support S3 uploads, see [Supported models and features for + Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html). """ value: S3Location @@ -7346,9 +7102,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class DocumentSourceText: - """ - The text content of the document source. - """ + """The text content of the document source.""" value: str @@ -7368,8 +7122,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class DocumentSourceContent: """ - The structured content of the document source, which may include various content - blocks such as text, images, or other document elements. + The structured content of the document source, which may include various + content blocks such as text, images, or other document elements. """ value: list[DocumentContentBlock] @@ -7393,7 +7147,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class DocumentSourceUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -7421,10 +7176,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | DocumentSourceContent | DocumentSourceUnknown ] - -""" -Contains the content of a document. -""" +"""Contains the content of a document.""" class _DocumentSourceDeserializer: @@ -7468,50 +7220,45 @@ def _set_result(self, value: DocumentSource) -> None: @dataclass(kw_only=True) class DocumentBlock: - """ - A document to include in a message. - """ + """A document to include in a message.""" name: str """ - A name for the document. The name can only contain the following characters: + A name for the document. The name can only contain the following + characters: - * Alphanumeric characters + - Alphanumeric characters - * Whitespace characters (no more than one in a row) + - Whitespace characters (no more than one in a row) - * Hyphens + - Hyphens - * Parentheses + - Parentheses - * Square brackets + - Square brackets - .. note:: + Note: This field is vulnerable to prompt injections, because the model might - inadvertently interpret it as instructions. Therefore, we recommend that you - specify a neutral name. + inadvertently interpret it as instructions. Therefore, we recommend that + you specify a neutral name. """ source: DocumentSource - """ - Contains the content of the document. - """ + """Contains the content of the document.""" format: str = "txt" - """ - The format of a document, or its extension. - """ + """The format of a document, or its extension.""" context: str | None = None """ - Contextual information about how the document should be processed or interpreted - by the model when generating citations. + Contextual information about how the document should be processed or + interpreted by the model when generating citations. """ citations: CitationsConfig | None = None """ - Configuration settings that control how citations should be generated for this - specific document. + Configuration settings that control how citations should be generated + for this specific document. """ def serialize(self, serializer: ShapeSerializer): @@ -7576,9 +7323,7 @@ class GuardrailConverseImageFormat(StrEnum): @dataclass class GuardrailConverseImageSourceBytes: - """ - The raw image bytes for the image. - """ + """The raw image bytes for the image.""" value: bytes @@ -7601,7 +7346,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailConverseImageSourceUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -7625,10 +7371,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: GuardrailConverseImageSource = Union[ GuardrailConverseImageSourceBytes | GuardrailConverseImageSourceUnknown ] - -""" -The image source (image bytes) of the guardrail converse image source. -""" +"""The image source (image bytes) of the guardrail converse image source.""" class _GuardrailConverseImageSourceDeserializer: @@ -7668,18 +7411,18 @@ def _set_result(self, value: GuardrailConverseImageSource) -> None: @dataclass(kw_only=True) class GuardrailConverseImageBlock: """ - An image block that contains images that you want to assess with a guardrail. + An image block that contains images that you want to assess with a + guardrail. """ format: str """ - The format details for the image type of the guardrail converse image block. + The format details for the image type of the guardrail converse image + block. """ source: GuardrailConverseImageSource = field(repr=False) - """ - The image source (image bytes) of the guardrail converse image block. - """ + """The image source (image bytes) of the guardrail converse image block.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_CONVERSE_IMAGE_BLOCK, self) @@ -7756,20 +7499,16 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailConverseTextBlock: """ - A text block that contains text that you want to assess with a guardrail. For - more information, see ``GuardrailConverseContentBlock ``_ - . + A text block that contains text that you want to assess with a + guardrail. For more information, see + [GuardrailConverseContentBlock](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_GuardrailConverseContentBlock.html). """ text: str - """ - The text that you want to guard. - """ + """The text that you want to guard.""" qualifiers: list[str] | None = None - """ - The qualifier details for the guardrails contextual grounding filter. - """ + """The qualifier details for the guardrails contextual grounding filter.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GUARDRAIL_CONVERSE_TEXT_BLOCK, self) @@ -7819,9 +7558,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class GuardrailConverseContentBlockText: - """ - The text to guard. - """ + """The text to guard.""" value: GuardrailConverseTextBlock @@ -7840,9 +7577,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailConverseContentBlockImage: - """ - Image within converse content block to be evaluated by the guardrail. - """ + """Image within converse content block to be evaluated by the guardrail.""" value: GuardrailConverseImageBlock @@ -7861,7 +7596,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class GuardrailConverseContentBlockUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -7887,11 +7623,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | GuardrailConverseContentBlockImage | GuardrailConverseContentBlockUnknown ] - """ - -A content block for selective guarding with the `Converse `_ -or `ConverseStream `_ +A content block for selective guarding with the +[Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) +or +[ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations. """ @@ -7943,8 +7679,8 @@ class ImageFormat(StrEnum): @dataclass class ImageSourceBytes: """ - The raw image bytes for the image. If you use an AWS SDK, you don't need to - encode the image bytes in base64. + The raw image bytes for the image. If you use an AWS SDK, you don't + need to encode the image bytes in base64. """ value: bytes @@ -7963,9 +7699,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ImageSourceS3Location: """ - The location of an image object in an Amazon S3 bucket. To see which models - support S3 uploads, see `Supported models and features for Converse `_ - . + The location of an image object in an Amazon S3 bucket. To see which + models support S3 uploads, see [Supported models and features for + Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html). """ value: S3Location @@ -7983,7 +7719,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ImageSourceUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -8005,10 +7742,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ImageSource = Union[ImageSourceBytes | ImageSourceS3Location | ImageSourceUnknown] - -""" -The source for an image. -""" +"""The source for an image.""" class _ImageSourceDeserializer: @@ -8046,19 +7780,13 @@ def _set_result(self, value: ImageSource) -> None: @dataclass(kw_only=True) class ImageBlock: - """ - Image content for a message. - """ + """Image content for a message.""" format: str - """ - The format of the image. - """ + """The format of the image.""" source: ImageSource - """ - The source for the image. - """ + """The source for the image.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_IMAGE_BLOCK, self) @@ -8094,20 +7822,16 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ReasoningTextBlock: - """ - Contains the reasoning that the model used to return the output. - """ + """Contains the reasoning that the model used to return the output.""" text: str - """ - The reasoning that the model used to return the output. - """ + """The reasoning that the model used to return the output.""" signature: str | None = None """ - A token that verifies that the reasoning text was generated by the model. If you - pass a reasoning block back to the API in a multi-turn conversation, include the - text and its signature unmodified. + A token that verifies that the reasoning text was generated by the + model. If you pass a reasoning block back to the API in a multi-turn + conversation, include the text and its signature unmodified. """ def serialize(self, serializer: ShapeSerializer): @@ -8149,9 +7873,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ReasoningContentBlockReasoningText: - """ - The reasoning that the model used to return the output. - """ + """The reasoning that the model used to return the output.""" value: ReasoningTextBlock @@ -8171,8 +7893,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ReasoningContentBlockRedactedContent: """ - The content in the reasoning that was encrypted by the model provider for safety - reasons. The encryption doesn't affect the quality of responses. + The content in the reasoning that was encrypted by the model provider + for safety reasons. The encryption doesn't affect the quality of + responses. """ value: bytes @@ -8196,7 +7919,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ReasoningContentBlockUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -8222,12 +7946,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | ReasoningContentBlockRedactedContent | ReasoningContentBlockUnknown ] - """ -Contains content regarding the reasoning that is carried out by the model with -respect to the content in the content block. Reasoning refers to a Chain of -Thought (CoT) that the model generates to enhance the accuracy of its final -response. +Contains content regarding the reasoning that is carried out by the +model with respect to the content in the content block. Reasoning refers +to a Chain of Thought (CoT) that the model generates to enhance the +accuracy of its final response. """ @@ -8266,14 +7989,10 @@ def _set_result(self, value: ReasoningContentBlock) -> None: @dataclass(kw_only=True) class SearchResultContentBlock: - """ - A block within a search result that contains the content. - """ + """A block within a search result that contains the content.""" text: str - """ - The actual text content - """ + """The actual text content""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_SEARCH_RESULT_CONTENT_BLOCK, self) @@ -8338,29 +8057,22 @@ class SearchResultBlock: A search result block that enables natural citations with proper source attribution for retrieved content. - .. note:: This field is only supported by Anthropic Claude Opus 4.1, Opus 4, - Sonnet 4.5, Sonnet 4, Sonnet 3.7, and 3.5 Haiku models. + Note: + This field is only supported by Anthropic Claude Opus 4.1, Opus 4, + Sonnet 4.5, Sonnet 4, Sonnet 3.7, and 3.5 Haiku models. """ source: str - """ - The source URL or identifier for the content. - """ + """The source URL or identifier for the content.""" title: str - """ - A descriptive title for the search result. - """ + """A descriptive title for the search result.""" content: list[SearchResultContentBlock] - """ - An array of search result content block. - """ + """An array of search result content block.""" citations: CitationsConfig | None = None - """ - Configuration setting for citations - """ + """Configuration setting for citations""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_SEARCH_RESULT_BLOCK, self) @@ -8429,9 +8141,7 @@ class VideoFormat(StrEnum): @dataclass class VideoSourceBytes: - """ - Video content encoded in base64. - """ + """Video content encoded in base64.""" value: bytes @@ -8449,9 +8159,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class VideoSourceS3Location: """ - The location of a video object in an Amazon S3 bucket. To see which models - support S3 uploads, see `Supported models and features for Converse `_ - . + The location of a video object in an Amazon S3 bucket. To see which + models support S3 uploads, see [Supported models and features for + Converse](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-supported-models-features.html). """ value: S3Location @@ -8469,7 +8179,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class VideoSourceUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -8491,11 +8202,10 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: VideoSource = Union[VideoSourceBytes | VideoSourceS3Location | VideoSourceUnknown] - """ -A video source. You can upload a smaller video as a base64-encoded string as -long as the encoded file is less than 25MB. You can also transfer videos up to -1GB in size from an S3 bucket. +A video source. You can upload a smaller video as a base64-encoded +string as long as the encoded file is less than 25MB. You can also +transfer videos up to 1GB in size from an S3 bucket. """ @@ -8534,19 +8244,13 @@ def _set_result(self, value: VideoSource) -> None: @dataclass(kw_only=True) class VideoBlock: - """ - A video block. - """ + """A video block.""" format: str - """ - The block's format. - """ + """The block's format.""" source: VideoSource - """ - The block's source. - """ + """The block's source.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_VIDEO_BLOCK, self) @@ -8582,9 +8286,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ToolResultContentBlockJson: - """ - A tool result that is JSON format data. - """ + """A tool result that is JSON format data.""" value: Document @@ -8607,9 +8309,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolResultContentBlockText: - """ - A tool result that is text. - """ + """A tool result that is text.""" value: str @@ -8635,8 +8335,9 @@ class ToolResultContentBlockImage: """ A tool result that is an image. - .. note:: - This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models. + Note: + This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 + models. """ value: ImageBlock @@ -8656,9 +8357,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolResultContentBlockDocument: - """ - A tool result that is a document. - """ + """A tool result that is a document.""" value: DocumentBlock @@ -8677,9 +8376,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolResultContentBlockVideo: - """ - A tool result that is video. - """ + """A tool result that is video.""" value: VideoBlock @@ -8698,9 +8395,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolResultContentBlockSearchResult: - """ - A tool result that is a search result. - """ + """A tool result that is a search result.""" value: SearchResultBlock @@ -8719,7 +8414,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolResultContentBlockUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -8749,9 +8445,10 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | ToolResultContentBlockSearchResult | ToolResultContentBlockUnknown ] - """ -The tool result content block. For more information, see `Call a tool with the Converse API `_ +The tool result content block. For more information, see [Call a tool +with the Converse +API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ @@ -8834,33 +8531,30 @@ class ToolResultStatus(StrEnum): @dataclass(kw_only=True) class ToolResultBlock: """ - A tool result block that contains the results for a tool request that the model - previously made. For more information, see ``Call a tool with the Converse API ``_ + A tool result block that contains the results for a tool request that + the model previously made. For more information, see [Call a tool with + the Converse + API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ tool_use_id: str - """ - The ID of the tool request that this is the result for. - """ + """The ID of the tool request that this is the result for.""" content: list[ToolResultContentBlock] - """ - The content for tool result content block. - """ + """The content for tool result content block.""" status: str | None = None """ The status for the tool result content block. - .. note:: - This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 models. + Note: + This field is only supported by Amazon Nova and Anthropic Claude 3 and 4 + models. """ type: str | None = None - """ - The type for the tool result content block. - """ + """The type for the tool result content block.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TOOL_RESULT_BLOCK, self) @@ -8926,31 +8620,25 @@ class ToolUseType(StrEnum): @dataclass(kw_only=True) class ToolUseBlock: """ - A tool use content block. Contains information about a tool that the model is - requesting be run., The model uses the result from the tool to generate a - response. For more information, see ``Call a tool with the Converse API ``_ + A tool use content block. Contains information about a tool that the + model is requesting be run., The model uses the result from the tool to + generate a response. For more information, see [Call a tool with the + Converse + API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ tool_use_id: str - """ - The ID for the tool request. - """ + """The ID for the tool request.""" name: str - """ - The name of the tool that the model wants to use. - """ + """The name of the tool that the model wants to use.""" input: Document - """ - The input to pass to the tool. - """ + """The input to pass to the tool.""" type: str | None = None - """ - The type for the tool request. - """ + """The type for the tool request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TOOL_USE_BLOCK, self) @@ -9003,9 +8691,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ContentBlockText: - """ - Text to include in the message. - """ + """Text to include in the message.""" value: str @@ -9027,7 +8713,7 @@ class ContentBlockImage: """ Image to include in the message. - .. note:: + Note: This field is only supported by Anthropic Claude 3 models. """ @@ -9046,9 +8732,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockDocument: - """ - A document to include in the message. - """ + """A document to include in the message.""" value: DocumentBlock @@ -9065,9 +8749,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockVideo: - """ - Video to include in the message. - """ + """Video to include in the message.""" value: VideoBlock @@ -9084,9 +8766,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockToolUse: - """ - Information about a tool use request from a model. - """ + """Information about a tool use request from a model.""" value: ToolUseBlock @@ -9103,9 +8783,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockToolResult: - """ - The result for a tool request that a model makes. - """ + """The result for a tool request that a model makes.""" value: ToolResultBlock @@ -9124,11 +8802,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: class ContentBlockGuardContent: """ Contains the content to assess with the guardrail. If you don't specify - ``guardContent`` in a call to the Converse API, the guardrail (if passed in the - Converse API) assesses the entire message. + `guardContent` in a call to the Converse API, the guardrail (if passed + in the Converse API) assesses the entire message. - For more information, see *Use a guardrail with the Converse API* in the *Amazon - Bedrock User Guide*. + For more information, see *Use a guardrail with the Converse API* in the + *Amazon Bedrock User Guide*. """ value: GuardrailConverseContentBlock @@ -9150,9 +8828,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockCachePoint: - """ - CachePoint to include in the message. - """ + """CachePoint to include in the message.""" value: CachePointBlock @@ -9170,9 +8846,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockReasoningContent: """ - Contains content regarding the reasoning that is carried out by the model. - Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance - the accuracy of its final response. + Contains content regarding the reasoning that is carried out by the + model. Reasoning refers to a Chain of Thought (CoT) that the model + generates to enhance the accuracy of its final response. """ value: ReasoningContentBlock @@ -9193,8 +8869,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockCitationsContent: """ - A content block that contains both generated text and associated citation - information, providing traceability between the response and source documents. + A content block that contains both generated text and associated + citation information, providing traceability between the response and + source documents. """ value: CitationsContentBlock @@ -9214,9 +8891,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockSearchResult: - """ - Search result to include in the message. - """ + """Search result to include in the message.""" value: SearchResultBlock @@ -9235,7 +8910,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -9270,11 +8946,12 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | ContentBlockSearchResult | ContentBlockUnknown ] - """ -A block of content for a message that you pass to, or receive from, a model with -the `Converse `_ -or `ConverseStream `_ +A block of content for a message that you pass to, or receive from, a +model with the +[Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) +or +[ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations. """ @@ -9372,30 +9049,29 @@ class ConversationRole(StrEnum): @dataclass(kw_only=True) class Message: """ - A message input, or returned from, a call to ``Converse ``_ - or ``ConverseStream ``_ - . + A message input, or returned from, a call to + [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) + or + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html). """ role: str - """ - The role that the message plays in the message. - """ + """The role that the message plays in the message.""" content: list[ContentBlock] """ The message content. Note the following restrictions: - * You can include up to 20 images. Each image's size, height, and width must be - no more than 3.75 MB, 8000 px, and 8000 px, respectively. + - You can include up to 20 images. Each image's size, height, and width + must be no more than 3.75 MB, 8000 px, and 8000 px, respectively. - * You can include up to five documents. Each document's size must be no more - than 4.5 MB. + - You can include up to five documents. Each document's size must be no + more than 4.5 MB. - * If you include a ``ContentBlock`` with a ``document`` field in the array, you - must also include a ``ContentBlock`` with a ``text`` field. + - If you include a `ContentBlock` with a `document` field in the array, + you must also include a `ContentBlock` with a `text` field. - * You can only include images and documents if the ``role`` is ``user``. + - You can only include images and documents if the `role` is `user`. """ def serialize(self, serializer: ShapeSerializer): @@ -9464,14 +9140,10 @@ class PerformanceConfigLatency(StrEnum): @dataclass(kw_only=True) class PerformanceConfiguration: - """ - Performance settings for a model. - """ + """Performance settings for a model.""" latency: str = "standard" - """ - To use a latency-optimized version of the model, set to ``optimized``. - """ + """To use a latency-optimized version of the model, set to `optimized`.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_PERFORMANCE_CONFIGURATION, self) @@ -9505,9 +9177,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class PromptVariableValuesText: - """ - The text value that the variable maps to. - """ + """The text value that the variable maps to.""" value: str @@ -9530,7 +9200,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class PromptVariableValuesUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -9552,12 +9223,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: PromptVariableValues = Union[PromptVariableValuesText | PromptVariableValuesUnknown] - """ -Contains a map of variables in a prompt from Prompt management to an object -containing the values to fill in for them when running model invocation. For -more information, see `How Prompt management works `_ -. +Contains a map of variables in a prompt from Prompt management to an +object containing the values to fill in for them when running model +invocation. For more information, see [How Prompt management +works](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management-how.html). """ @@ -9652,13 +9322,12 @@ class ServiceTierType(StrEnum): @dataclass(kw_only=True) class ServiceTier: """ - Specifies the processing tier configuration used for serving the request. + Specifies the processing tier configuration used for serving the + request. """ type: str - """ - Specifies the processing tier type used for serving the request. - """ + """Specifies the processing tier type used for serving the request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_SERVICE_TIER, self) @@ -9690,9 +9359,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class SystemContentBlockText: - """ - A system prompt for the model. - """ + """A system prompt for the model.""" value: str @@ -9714,12 +9381,14 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class SystemContentBlockGuardContent: """ - A content block to assess with the guardrail. Use with the `Converse `_ - or `ConverseStream `_ + A content block to assess with the guardrail. Use with the + [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html) + or + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) API operations. - For more information, see *Use a guardrail with the Converse API* in the *Amazon - Bedrock User Guide*. + For more information, see *Use a guardrail with the Converse API* in the + *Amazon Bedrock User Guide*. """ value: GuardrailConverseContentBlock @@ -9741,9 +9410,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class SystemContentBlockCachePoint: - """ - CachePoint to include in the system prompt. - """ + """CachePoint to include in the system prompt.""" value: CachePointBlock @@ -9762,7 +9429,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class SystemContentBlockUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -9789,11 +9457,10 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | SystemContentBlockCachePoint | SystemContentBlockUnknown ] - """ -Contains configurations for instructions to provide the model for how to handle -input. To learn more, see `Using the Converse API `_ -. +Contains configurations for instructions to provide the model for how to +handle input. To learn more, see [Using the Converse +API](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference-call.html). """ @@ -9861,8 +9528,10 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class AnyToolChoice: """ - The model must request at least one tool (no text is generated). For example, - ``{"any" : {}}``. For more information, see ``Call a tool with the Converse API ``_ + The model must request at least one tool (no text is generated). For + example, `{"any" : {}}`. For more information, see [Call a tool with the + Converse + API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ @@ -9893,7 +9562,9 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: class AutoToolChoice: """ The Model automatically decides if a tool should be called or whether to - generate text instead. For example, ``{"auto" : {}}``. For more information, see ``Call a tool with the Converse API ``_ + generate text instead. For example, `{"auto" : {}}`. For more + information, see [Call a tool with the Converse + API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide """ @@ -9923,16 +9594,18 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class SpecificToolChoice: """ - The model must request a specific tool. For example, ``{"tool" : {"name" : "Your tool name"}}``. For more information, see ``Call a tool with the Converse API ``_ + The model must request a specific tool. For example, + `{"tool" : {"name" : "Your tool name"}}`. For more information, see + [Call a tool with the Converse + API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide - .. note:: This field is only supported by Anthropic Claude 3 models. + Note: + This field is only supported by Anthropic Claude 3 models. """ name: str - """ - The name of the tool that the model must request. - """ + """The name of the tool that the model must request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_SPECIFIC_TOOL_CHOICE, self) @@ -9965,8 +9638,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ToolChoiceAuto: """ - (Default). The Model automatically decides if a tool should be called or whether - to generate text instead. + (Default). The Model automatically decides if a tool should be called or + whether to generate text instead. """ value: AutoToolChoice @@ -9984,9 +9657,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolChoiceAny: - """ - The model must request at least one tool (no text is generated). - """ + """The model must request at least one tool (no text is generated).""" value: AnyToolChoice @@ -10004,8 +9675,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolChoiceTool: """ - The Model must request the specified tool. Only supported by Anthropic Claude 3 - and Amazon Nova models. + The Model must request the specified tool. Only supported by Anthropic + Claude 3 and Amazon Nova models. """ value: SpecificToolChoice @@ -10023,7 +9694,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolChoiceUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -10045,9 +9717,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ToolChoice = Union[ToolChoiceAuto | ToolChoiceAny | ToolChoiceTool | ToolChoiceUnknown] - """ -Determines which tools the model should request in a call to ``Converse`` or ``ConverseStream``. For more information, see `Call a tool with the Converse API `_ +Determines which tools the model should request in a call to `Converse` +or `ConverseStream`. For more information, see [Call a tool with the +Converse +API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ @@ -10091,14 +9765,12 @@ def _set_result(self, value: ToolChoice) -> None: @dataclass(kw_only=True) class SystemTool: """ - Specifies a system-defined tool for the model to use. *System-defined tools* are - tools that are created and provided by the model provider. + Specifies a system-defined tool for the model to use. *System-defined + tools* are tools that are created and provided by the model provider. """ name: str - """ - The name of the system-defined tool that you want to call. - """ + """The name of the system-defined tool that you want to call.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_SYSTEM_TOOL, self) @@ -10129,8 +9801,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ToolInputSchemaJson: """ - The JSON schema for the tool. For more information, see `JSON Schema Reference `_ - . + The JSON schema for the tool. For more information, see [JSON Schema + Reference](https://json-schema.org/understanding-json-schema/reference). """ value: Document @@ -10150,7 +9822,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolInputSchemaUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -10172,9 +9845,10 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ToolInputSchema = Union[ToolInputSchemaJson | ToolInputSchemaUnknown] - """ -The schema for the tool. The top level schema type must be ``object``. For more information, see `Call a tool with the Converse API `_ +The schema for the tool. The top level schema type must be `object`. For +more information, see [Call a tool with the Converse +API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ @@ -10212,24 +9886,20 @@ def _set_result(self, value: ToolInputSchema) -> None: @dataclass(kw_only=True) class ToolSpecification: """ - The specification for the tool. For more information, see ``Call a tool with the Converse API ``_ + The specification for the tool. For more information, see [Call a tool + with the Converse + API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ name: str - """ - The name for the tool. - """ + """The name for the tool.""" input_schema: ToolInputSchema - """ - The input schema for the tool in JSON format. - """ + """The input schema for the tool in JSON format.""" description: str | None = None - """ - The description for the tool. - """ + """The description for the tool.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TOOL_SPECIFICATION, self) @@ -10279,9 +9949,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ToolToolSpec: - """ - The specfication for the tool. - """ + """The specfication for the tool.""" value: ToolSpecification @@ -10298,9 +9966,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolSystemTool: - """ - Specifies the system-defined tool that you want use. - """ + """Specifies the system-defined tool that you want use.""" value: SystemTool @@ -10317,9 +9983,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolCachePoint: - """ - CachePoint to include in the tool configuration. - """ + """CachePoint to include in the tool configuration.""" value: CachePointBlock @@ -10336,7 +10000,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -10358,10 +10023,10 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: Tool = Union[ToolToolSpec | ToolSystemTool | ToolCachePoint | ToolUnknown] - """ -Information about a tool that you can use with the Converse API. For more -information, see `Call a tool with the Converse API `_ +Information about a tool that you can use with the Converse API. For +more information, see [Call a tool with the Converse +API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ @@ -10428,20 +10093,17 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class ToolConfiguration: """ - Configuration information for the tools that you pass to a model. For more - information, see ``Tool use (function calling) ``_ + Configuration information for the tools that you pass to a model. For + more information, see [Tool use (function + calling)](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ tools: list[Tool] - """ - An array of tools that you want to pass to a model. - """ + """An array of tools that you want to pass to a model.""" tool_choice: ToolChoice | None = None - """ - If supported by model, forces the model to request a tool. - """ + """If supported by model, forces the model to request a tool.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TOOL_CONFIGURATION, self) @@ -10482,120 +10144,130 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseInput: + """Dataclass for ConverseInput structure.""" + model_id: str | None = None """ - Specifies the model or throughput with which to run inference, or the prompt - resource to use in inference. The value depends on the resource that you use: + Specifies the model or throughput with which to run inference, or the + prompt resource to use in inference. The value depends on the resource + that you use: - * If you use a base model, specify the model ID or its ARN. For a list of model - IDs for base models, see `Amazon Bedrock base model IDs (on-demand throughput) `_ + - If you use a base model, specify the model ID or its ARN. For a list + of model IDs for base models, see [Amazon Bedrock base model IDs + (on-demand + throughput)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide. - * If you use an inference profile, specify the inference profile ID or its ARN. - For a list of inference profile IDs, see `Supported Regions and models for cross-region inference `_ + - If you use an inference profile, specify the inference profile ID or + its ARN. For a list of inference profile IDs, see [Supported Regions + and models for cross-region + inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide. - * If you use a provisioned model, specify the ARN of the Provisioned Throughput. - For more information, see `Run inference using a Provisioned Throughput `_ + - If you use a provisioned model, specify the ARN of the Provisioned + Throughput. For more information, see [Run inference using a + Provisioned + Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide. - * If you use a custom model, first purchase Provisioned Throughput for it. Then - specify the ARN of the resulting provisioned model. For more information, see - `Use a custom model in Amazon Bedrock `_ + - If you use a custom model, first purchase Provisioned Throughput for + it. Then specify the ARN of the resulting provisioned model. For more + information, see [Use a custom model in Amazon + Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide. - * To include a prompt that was defined in `Prompt management `_, + - To include a prompt that was defined in [Prompt + management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), specify the ARN of the prompt version to use. - The Converse API doesn't support `imported models `_ - . + The Converse API doesn't support [imported + models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html). """ messages: list[Message] | None = None - """ - The messages that you want to send to the model. - """ + """The messages that you want to send to the model.""" system: list[SystemContentBlock] | None = None """ - A prompt that provides instructions or context to the model about the task it - should perform, or the persona it should adopt during the conversation. + A prompt that provides instructions or context to the model about the + task it should perform, or the persona it should adopt during the + conversation. """ inference_config: InferenceConfiguration | None = None """ - Inference parameters to pass to the model. ``Converse`` and ``ConverseStream`` - support a base set of inference parameters. If you need to pass additional - parameters that the model supports, use the ``additionalModelRequestFields`` - request field. + Inference parameters to pass to the model. `Converse` and + `ConverseStream` support a base set of inference parameters. If you need + to pass additional parameters that the model supports, use the + `additionalModelRequestFields` request field. """ tool_config: ToolConfiguration | None = None """ - Configuration information for the tools that the model can use when generating a - response. + Configuration information for the tools that the model can use when + generating a response. - For information about models that support tool use, see `Supported models and model features `_ - . + For information about models that support tool use, see [Supported + models and model + features](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features). """ guardrail_config: GuardrailConfiguration | None = None """ - Configuration information for a guardrail that you want to use in the request. - If you include ``guardContent`` blocks in the ``content`` field in the - ``messages`` field, the guardrail operates only on those messages. If you - include no ``guardContent`` blocks, the guardrail operates on all messages in - the request body and in any included prompt resource. + Configuration information for a guardrail that you want to use in the + request. If you include `guardContent` blocks in the `content` field in + the `messages` field, the guardrail operates only on those messages. If + you include no `guardContent` blocks, the guardrail operates on all + messages in the request body and in any included prompt resource. """ additional_model_request_fields: Document | None = None """ - Additional inference parameters that the model supports, beyond the base set of - inference parameters that ``Converse`` and ``ConverseStream`` support in the ``inferenceConfig`` field. For more information, see `Model parameters `_ - . + Additional inference parameters that the model supports, beyond the base + set of inference parameters that `Converse` and `ConverseStream` support + in the `inferenceConfig` field. For more information, see [Model + parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). """ prompt_variables: dict[str, PromptVariableValues] | None = field( repr=False, default=None ) """ - Contains a map of variables in a prompt from Prompt management to objects - containing the values to fill in for them when running model invocation. This - field is ignored if you don't specify a prompt resource in the ``modelId`` - field. + Contains a map of variables in a prompt from Prompt management to + objects containing the values to fill in for them when running model + invocation. This field is ignored if you don't specify a prompt + resource in the `modelId` field. """ additional_model_response_field_paths: list[str] | None = None """ - Additional model parameters field paths to return in the response. ``Converse`` - and ``ConverseStream`` return the requested fields as a JSON Pointer object in - the ``additionalModelResponseFields`` field. The following is example JSON for - ``additionalModelResponseFieldPaths``. + Additional model parameters field paths to return in the response. + `Converse` and `ConverseStream` return the requested fields as a JSON + Pointer object in the `additionalModelResponseFields` field. The + following is example JSON for `additionalModelResponseFieldPaths`. - ``[ "/stop_sequence" ]`` + `[ "/stop_sequence" ]` - For information about the JSON Pointer syntax, see the `Internet Engineering Task Force (IETF) `_ - documentation. + For information about the JSON Pointer syntax, see the [Internet + Engineering Task Force + (IETF)](https://datatracker.ietf.org/doc/html/rfc6901) documentation. - ``Converse`` and ``ConverseStream`` reject an empty JSON Pointer or incorrectly - structured JSON Pointer with a ``400`` error code. if the JSON Pointer is valid, - but the requested field is not in the model response, it is ignored by - ``Converse``. + `Converse` and `ConverseStream` reject an empty JSON Pointer or + incorrectly structured JSON Pointer with a `400` error code. if the JSON + Pointer is valid, but the requested field is not in the model response, + it is ignored by `Converse`. """ request_metadata: dict[str, str] | None = field(repr=False, default=None) - """ - Key-value pairs that you can use to filter invocation logs. - """ + """Key-value pairs that you can use to filter invocation logs.""" - performance_config: PerformanceConfiguration | None = None - """ - Model performance settings for the request. - """ + performance_config: PerformanceConfiguration | None = None + """Model performance settings for the request.""" service_tier: ServiceTier | None = None """ - Specifies the processing tier configuration used for serving the request. + Specifies the processing tier configuration used for serving the + request. """ def serialize(self, serializer: ShapeSerializer): @@ -10747,14 +10419,12 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseMetrics: """ - Metrics for a call to ``Converse ``_ - . + Metrics for a call to + [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html). """ latency_ms: int - """ - The latency of the call to ``Converse``, in milliseconds. - """ + """The latency of the call to `Converse`, in milliseconds.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CONVERSE_METRICS, self) @@ -10788,9 +10458,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ConverseOutputMessage: - """ - The message that the model generates. - """ + """The message that the model generates.""" value: Message @@ -10807,7 +10475,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseOutputUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -10829,10 +10498,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ConverseOutput = Union[ConverseOutputMessage | ConverseOutputUnknown] - """ -The output from a call to `Converse `_ -. +The output from a call to +[Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html). """ @@ -10961,28 +10629,23 @@ def _read_value(k: str, d: ShapeDeserializer): @dataclass(kw_only=True) class GuardrailTraceAssessment: """ - A Top level guardrail trace object. For more information, see ``ConverseTrace ``_ - . + A Top level guardrail trace object. For more information, see + [ConverseTrace](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseTrace.html). """ model_output: list[str] | None = None - """ - The output from the model. - """ + """The output from the model.""" input_assessment: dict[str, GuardrailAssessment] | None = None - """ - The input assessment. - """ + """The input assessment.""" output_assessments: dict[str, list[GuardrailAssessment]] | None = None - """ - the output assessments. - """ + """the output assessments.""" action_reason: str | None = None """ - Provides the reason for the action taken when harmful content is detected. + Provides the reason for the action taken when harmful content is + detected. """ def serialize(self, serializer: ShapeSerializer): @@ -11061,14 +10724,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class PromptRouterTrace: - """ - A prompt router trace. - """ + """A prompt router trace.""" invoked_model_id: str | None = None - """ - The ID of the invoked model. - """ + """The ID of the invoked model.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_PROMPT_ROUTER_TRACE, self) @@ -11105,19 +10764,15 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseTrace: """ - The trace object in a response from ``Converse ``_ - . + The trace object in a response from + [Converse](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_Converse.html). """ guardrail: GuardrailTraceAssessment | None = None - """ - The guardrail trace object. - """ + """The guardrail trace object.""" prompt_router: PromptRouterTrace | None = None - """ - The request's prompt router. - """ + """The request's prompt router.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CONVERSE_TRACE, self) @@ -11158,34 +10813,22 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class TokenUsage: - """ - The tokens used in a message API inference call. - """ + """The tokens used in a message API inference call.""" input_tokens: int - """ - The number of tokens sent in the request to the model. - """ + """The number of tokens sent in the request to the model.""" output_tokens: int - """ - The number of tokens that the model generated for the request. - """ + """The number of tokens that the model generated for the request.""" total_tokens: int - """ - The total of input tokens and tokens generated by the model. - """ + """The total of input tokens and tokens generated by the model.""" cache_read_input_tokens: int | None = None - """ - The number of input tokens read from the cache for the request. - """ + """The number of input tokens read from the cache for the request.""" cache_write_input_tokens: int | None = None - """ - The number of input tokens written to the cache for the request. - """ + """The number of input tokens written to the cache for the request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TOKEN_USAGE, self) @@ -11256,45 +10899,37 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseOperationOutput: + """Dataclass for ConverseOperationOutput structure.""" + output: ConverseOutput - """ - The result from the call to ``Converse``. - """ + """The result from the call to `Converse`.""" stop_reason: str - """ - The reason why the model stopped generating output. - """ + """The reason why the model stopped generating output.""" usage: TokenUsage """ - The total number of tokens used in the call to ``Converse``. The total includes - the tokens input to the model and the tokens generated by the model. + The total number of tokens used in the call to `Converse`. The total + includes the tokens input to the model and the tokens generated by the + model. """ metrics: ConverseMetrics - """ - Metrics for the call to ``Converse``. - """ + """Metrics for the call to `Converse`.""" additional_model_response_fields: Document | None = None - """ - Additional fields in the response that are unique to the model. - """ + """Additional fields in the response that are unique to the model.""" trace: ConverseTrace | None = None - """ - A trace object that contains information about the Guardrail behavior. - """ + """A trace object that contains information about the Guardrail behavior.""" performance_config: PerformanceConfiguration | None = None - """ - Model performance settings for the request. - """ + """Model performance settings for the request.""" service_tier: ServiceTier | None = None """ - Specifies the processing tier configuration used for serving the request. + Specifies the processing tier configuration used for serving the + request. """ def serialize(self, serializer: ShapeSerializer): @@ -11389,21 +11024,15 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ModelErrorException(ServiceError): - """ - The request failed due to an error while processing the model. - """ + """The request failed due to an error while processing the model.""" fault: Literal["client", "server"] | None = "client" original_status_code: int | None = None - """ - The original status code. - """ + """The original status code.""" resource_name: str | None = None - """ - The resource name. - """ + """The resource name.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_MODEL_ERROR_EXCEPTION, self) @@ -11461,9 +11090,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ModelNotReadyException(ServiceError): """ - The model specified in the request is not ready to serve inference requests. The - AWS SDK will automatically retry the operation up to 5 times. For information - about configuring automatic retries, see ``Retry behavior ``_ + The model specified in the request is not ready to serve inference + requests. The AWS SDK will automatically retry the operation up to 5 + times. For information about configuring automatic retries, see [Retry + behavior](https://docs.aws.amazon.com/sdkref/latest/guide/feature-retry-behavior.html) in the *AWS SDKs and Tools* reference guide. """ @@ -11504,8 +11134,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ModelTimeoutException(ServiceError): """ - The request took too long to process. Processing time exceeded the model timeout - length. + The request took too long to process. Processing time exceeded the model + timeout length. """ fault: Literal["client", "server"] | None = "client" @@ -11593,31 +11223,26 @@ class GuardrailStreamProcessingMode(StrEnum): @dataclass(kw_only=True) class GuardrailStreamConfiguration: """ - Configuration information for a guardrail that you use with the ``ConverseStream ``_ + Configuration information for a guardrail that you use with the + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) action. """ guardrail_identifier: str = "" - """ - The identifier for the guardrail. - """ + """The identifier for the guardrail.""" guardrail_version: str = "" - """ - The version of the guardrail. - """ + """The version of the guardrail.""" trace: str = "disabled" - """ - The trace behavior for the guardrail. - """ + """The trace behavior for the guardrail.""" stream_processing_mode: str = "sync" """ The processing mode. - The processing mode. For more information, see *Configure streaming response - behavior* in the *Amazon Bedrock User Guide*. + The processing mode. For more information, see *Configure streaming + response behavior* in the *Amazon Bedrock User Guide*. """ def serialize(self, serializer: ShapeSerializer): @@ -11687,120 +11312,130 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseStreamInput: + """Dataclass for ConverseStreamInput structure.""" + model_id: str | None = None """ - Specifies the model or throughput with which to run inference, or the prompt - resource to use in inference. The value depends on the resource that you use: + Specifies the model or throughput with which to run inference, or the + prompt resource to use in inference. The value depends on the resource + that you use: - * If you use a base model, specify the model ID or its ARN. For a list of model - IDs for base models, see `Amazon Bedrock base model IDs (on-demand throughput) `_ + - If you use a base model, specify the model ID or its ARN. For a list + of model IDs for base models, see [Amazon Bedrock base model IDs + (on-demand + throughput)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide. - * If you use an inference profile, specify the inference profile ID or its ARN. - For a list of inference profile IDs, see `Supported Regions and models for cross-region inference `_ + - If you use an inference profile, specify the inference profile ID or + its ARN. For a list of inference profile IDs, see [Supported Regions + and models for cross-region + inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide. - * If you use a provisioned model, specify the ARN of the Provisioned Throughput. - For more information, see `Run inference using a Provisioned Throughput `_ + - If you use a provisioned model, specify the ARN of the Provisioned + Throughput. For more information, see [Run inference using a + Provisioned + Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide. - * If you use a custom model, first purchase Provisioned Throughput for it. Then - specify the ARN of the resulting provisioned model. For more information, see - `Use a custom model in Amazon Bedrock `_ + - If you use a custom model, first purchase Provisioned Throughput for + it. Then specify the ARN of the resulting provisioned model. For more + information, see [Use a custom model in Amazon + Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide. - * To include a prompt that was defined in `Prompt management `_, + - To include a prompt that was defined in [Prompt + management](https://docs.aws.amazon.com/bedrock/latest/userguide/prompt-management.html), specify the ARN of the prompt version to use. - The Converse API doesn't support `imported models `_ - . + The Converse API doesn't support [imported + models](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html). """ messages: list[Message] | None = None - """ - The messages that you want to send to the model. - """ + """The messages that you want to send to the model.""" system: list[SystemContentBlock] | None = None """ - A prompt that provides instructions or context to the model about the task it - should perform, or the persona it should adopt during the conversation. + A prompt that provides instructions or context to the model about the + task it should perform, or the persona it should adopt during the + conversation. """ inference_config: InferenceConfiguration | None = None """ - Inference parameters to pass to the model. ``Converse`` and ``ConverseStream`` - support a base set of inference parameters. If you need to pass additional - parameters that the model supports, use the ``additionalModelRequestFields`` - request field. + Inference parameters to pass to the model. `Converse` and + `ConverseStream` support a base set of inference parameters. If you need + to pass additional parameters that the model supports, use the + `additionalModelRequestFields` request field. """ tool_config: ToolConfiguration | None = None """ - Configuration information for the tools that the model can use when generating a - response. + Configuration information for the tools that the model can use when + generating a response. - For information about models that support streaming tool use, see `Supported models and model features `_ - . + For information about models that support streaming tool use, see + [Supported models and model + features](https://docs.aws.amazon.com/bedrock/latest/userguide/conversation-inference.html#conversation-inference-supported-models-features). """ guardrail_config: GuardrailStreamConfiguration | None = None """ - Configuration information for a guardrail that you want to use in the request. - If you include ``guardContent`` blocks in the ``content`` field in the - ``messages`` field, the guardrail operates only on those messages. If you - include no ``guardContent`` blocks, the guardrail operates on all messages in - the request body and in any included prompt resource. + Configuration information for a guardrail that you want to use in the + request. If you include `guardContent` blocks in the `content` field in + the `messages` field, the guardrail operates only on those messages. If + you include no `guardContent` blocks, the guardrail operates on all + messages in the request body and in any included prompt resource. """ additional_model_request_fields: Document | None = None """ - Additional inference parameters that the model supports, beyond the base set of - inference parameters that ``Converse`` and ``ConverseStream`` support in the ``inferenceConfig`` field. For more information, see `Model parameters `_ - . + Additional inference parameters that the model supports, beyond the base + set of inference parameters that `Converse` and `ConverseStream` support + in the `inferenceConfig` field. For more information, see [Model + parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). """ prompt_variables: dict[str, PromptVariableValues] | None = field( repr=False, default=None ) """ - Contains a map of variables in a prompt from Prompt management to objects - containing the values to fill in for them when running model invocation. This - field is ignored if you don't specify a prompt resource in the ``modelId`` - field. + Contains a map of variables in a prompt from Prompt management to + objects containing the values to fill in for them when running model + invocation. This field is ignored if you don't specify a prompt + resource in the `modelId` field. """ additional_model_response_field_paths: list[str] | None = None """ - Additional model parameters field paths to return in the response. ``Converse`` - and ``ConverseStream`` return the requested fields as a JSON Pointer object in - the ``additionalModelResponseFields`` field. The following is example JSON for - ``additionalModelResponseFieldPaths``. + Additional model parameters field paths to return in the response. + `Converse` and `ConverseStream` return the requested fields as a JSON + Pointer object in the `additionalModelResponseFields` field. The + following is example JSON for `additionalModelResponseFieldPaths`. - ``[ "/stop_sequence" ]`` + `[ "/stop_sequence" ]` - For information about the JSON Pointer syntax, see the `Internet Engineering Task Force (IETF) `_ - documentation. + For information about the JSON Pointer syntax, see the [Internet + Engineering Task Force + (IETF)](https://datatracker.ietf.org/doc/html/rfc6901) documentation. - ``Converse`` and ``ConverseStream`` reject an empty JSON Pointer or incorrectly - structured JSON Pointer with a ``400`` error code. if the JSON Pointer is valid, - but the requested field is not in the model response, it is ignored by - ``Converse``. + `Converse` and `ConverseStream` reject an empty JSON Pointer or + incorrectly structured JSON Pointer with a `400` error code. if the JSON + Pointer is valid, but the requested field is not in the model response, + it is ignored by `Converse`. """ request_metadata: dict[str, str] | None = field(repr=False, default=None) - """ - Key-value pairs that you can use to filter invocation logs. - """ + """Key-value pairs that you can use to filter invocation logs.""" performance_config: PerformanceConfiguration | None = None - """ - Model performance settings for the request. - """ + """Model performance settings for the request.""" service_tier: ServiceTier | None = None """ - Specifies the processing tier configuration used for serving the request. + Specifies the processing tier configuration used for serving the + request. """ def serialize(self, serializer: ShapeSerializer): @@ -11968,8 +11603,8 @@ class CitationSourceContentDelta: text: str | None = None """ - An incremental update to the text content from the source document that is being - cited. + An incremental update to the text content from the source document that + is being cited. """ def serialize(self, serializer: ShapeSerializer): @@ -12033,32 +11668,32 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class CitationsDelta: """ - Contains incremental updates to citation information during streaming responses. - This allows clients to build up citation data progressively as the response is - generated. + Contains incremental updates to citation information during streaming + responses. This allows clients to build up citation data progressively + as the response is generated. """ title: str | None = None - """ - The title or identifier of the source document being cited. - """ + """The title or identifier of the source document being cited.""" source: str | None = None """ - The source from the original search result that provided the cited content. + The source from the original search result that provided the cited + content. """ source_content: list[CitationSourceContentDelta] | None = None """ - The specific content from the source document that was referenced or cited in - the generated response. + The specific content from the source document that was referenced or + cited in the generated response. """ location: CitationLocation | None = None """ - Specifies the precise location within a source document where cited content can - be found. This can include character-level positions, page numbers, or document - chunks depending on the document type and indexing method. + Specifies the precise location within a source document where cited + content can be found. This can include character-level positions, page + numbers, or document chunks depending on the document type and indexing + method. """ def serialize(self, serializer: ShapeSerializer): @@ -12126,9 +11761,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ReasoningContentBlockDeltaText: - """ - The reasoning that the model used to return the output. - """ + """The reasoning that the model used to return the output.""" value: str @@ -12152,8 +11785,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ReasoningContentBlockDeltaRedactedContent: """ - The content in the reasoning that was encrypted by the model provider for safety - reasons. The encryption doesn't affect the quality of responses. + The content in the reasoning that was encrypted by the model provider + for safety reasons. The encryption doesn't affect the quality of + responses. """ value: bytes @@ -12178,9 +11812,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ReasoningContentBlockDeltaSignature: """ - A token that verifies that the reasoning text was generated by the model. If you - pass a reasoning block back to the API in a multi-turn conversation, include the - text and its signature unmodified. + A token that verifies that the reasoning text was generated by the + model. If you pass a reasoning block back to the API in a multi-turn + conversation, include the text and its signature unmodified. """ value: str @@ -12204,7 +11838,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ReasoningContentBlockDeltaUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -12231,12 +11866,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | ReasoningContentBlockDeltaSignature | ReasoningContentBlockDeltaUnknown ] - """ -Contains content regarding the reasoning that is carried out by the model with -respect to the content in the content block. Reasoning refers to a Chain of -Thought (CoT) that the model generates to enhance the accuracy of its final -response. +Contains content regarding the reasoning that is carried out by the +model with respect to the content in the content block. Reasoning refers +to a Chain of Thought (CoT) that the model generates to enhance the +accuracy of its final response. """ @@ -12282,9 +11916,7 @@ def _set_result(self, value: ReasoningContentBlockDelta) -> None: @dataclass class ToolResultBlockDeltaText: - """ - The reasoning the model used to return the output. - """ + """The reasoning the model used to return the output.""" value: str @@ -12307,7 +11939,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ToolResultBlockDeltaUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -12329,11 +11962,10 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ToolResultBlockDelta = Union[ToolResultBlockDeltaText | ToolResultBlockDeltaUnknown] - """ -Contains incremental updates to tool results information during streaming -responses. This allows clients to build up tool results data progressively as -the response is generated. +Contains incremental updates to tool results information during +streaming responses. This allows clients to build up tool results data +progressively as the response is generated. """ @@ -12394,14 +12026,10 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class ToolUseBlockDelta: - """ - The delta for a tool use block. - """ + """The delta for a tool use block.""" input: str - """ - The input for a requested tool. - """ + """The input for a requested tool.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TOOL_USE_BLOCK_DELTA, self) @@ -12435,9 +12063,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ContentBlockDeltaText: - """ - The content text. - """ + """The content text.""" value: str @@ -12456,9 +12082,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockDeltaToolUse: - """ - Information about a tool that the model is requesting to use. - """ + """Information about a tool that the model is requesting to use.""" value: ToolUseBlockDelta @@ -12477,9 +12101,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockDeltaToolResult: - """ - An incremental update that contains the results from a tool call. - """ + """An incremental update that contains the results from a tool call.""" value: list[ToolResultBlockDelta] @@ -12503,9 +12125,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockDeltaReasoningContent: """ - Contains content regarding the reasoning that is carried out by the model. - Reasoning refers to a Chain of Thought (CoT) that the model generates to enhance - the accuracy of its final response. + Contains content regarding the reasoning that is carried out by the + model. Reasoning refers to a Chain of Thought (CoT) that the model + generates to enhance the accuracy of its final response. """ value: ReasoningContentBlockDelta @@ -12528,8 +12150,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockDeltaCitation: """ - Incremental citation information that is streamed as part of the response - generation process. + Incremental citation information that is streamed as part of the + response generation process. """ value: CitationsDelta @@ -12549,7 +12171,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockDeltaUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -12578,10 +12201,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | ContentBlockDeltaCitation | ContentBlockDeltaUnknown ] - -""" -A block of content in a streaming response. -""" +"""A block of content in a streaming response.""" class _ContentBlockDeltaDeserializer: @@ -12628,19 +12248,13 @@ def _set_result(self, value: ContentBlockDelta) -> None: @dataclass(kw_only=True) class ContentBlockDeltaEvent: - """ - The content block delta event. - """ + """The content block delta event.""" delta: ContentBlockDelta - """ - The delta for a content block delta event. - """ + """The delta for a content block delta event.""" content_block_index: int - """ - The block index for a content block delta event. - """ + """The block index for a content block delta event.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CONTENT_BLOCK_DELTA_EVENT, self) @@ -12682,24 +12296,20 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ToolResultBlockStart: """ - The start of a tool result block. For more information, see ``Call a tool with the Converse API ``_ + The start of a tool result block. For more information, see [Call a tool + with the Converse + API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ tool_use_id: str - """ - The ID of the tool that was used to generate this tool result block. - """ + """The ID of the tool that was used to generate this tool result block.""" type: str | None = None - """ - The type for the tool that was used to generate this tool result block. - """ + """The type for the tool that was used to generate this tool result block.""" status: str | None = None - """ - The status of the tool result block. - """ + """The status of the tool result block.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TOOL_RESULT_BLOCK_START, self) @@ -12753,24 +12363,20 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ToolUseBlockStart: """ - The start of a tool use block. For more information, see ``Call a tool with the Converse API ``_ + The start of a tool use block. For more information, see [Call a tool + with the Converse + API](https://docs.aws.amazon.com/bedrock/latest/userguide/tool-use.html) in the Amazon Bedrock User Guide. """ tool_use_id: str - """ - The ID for the tool request. - """ + """The ID for the tool request.""" name: str - """ - The name of the tool that the model is requesting to use. - """ + """The name of the tool that the model is requesting to use.""" type: str | None = None - """ - The type for the tool request. - """ + """The type for the tool request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_TOOL_USE_BLOCK_START, self) @@ -12819,9 +12425,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ContentBlockStartToolUse: - """ - Information about a tool that the model is requesting to use. - """ + """Information about a tool that the model is requesting to use.""" value: ToolUseBlockStart @@ -12840,9 +12444,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockStartToolResult: - """ - The - """ + """The""" value: ToolResultBlockStart @@ -12861,7 +12463,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ContentBlockStartUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -12885,10 +12488,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: ContentBlockStart = Union[ ContentBlockStartToolUse | ContentBlockStartToolResult | ContentBlockStartUnknown ] - -""" -Content block start information. -""" +"""Content block start information.""" class _ContentBlockStartDeserializer: @@ -12926,19 +12526,13 @@ def _set_result(self, value: ContentBlockStart) -> None: @dataclass(kw_only=True) class ContentBlockStartEvent: - """ - Content block start event. - """ + """Content block start event.""" start: ContentBlockStart - """ - Start information about a content block start event. - """ + """Start information about a content block start event.""" content_block_index: int - """ - The index for a content block start event. - """ + """The index for a content block start event.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CONTENT_BLOCK_START_EVENT, self) @@ -12979,14 +12573,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ContentBlockStopEvent: - """ - A content block stop event. - """ + """A content block stop event.""" content_block_index: int - """ - The index for a content block. - """ + """The index for a content block.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CONTENT_BLOCK_STOP_EVENT, self) @@ -13021,14 +12611,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class MessageStartEvent: - """ - The start of a message. - """ + """The start of a message.""" role: str - """ - The role for the message. - """ + """The role for the message.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_MESSAGE_START_EVENT, self) @@ -13060,19 +12646,13 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class MessageStopEvent: - """ - The stop event for a message. - """ + """The stop event for a message.""" stop_reason: str - """ - The reason why the model stopped generating output. - """ + """The reason why the model stopped generating output.""" additional_model_response_fields: Document | None = None - """ - The additional model response fields. - """ + """The additional model response fields.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_MESSAGE_STOP_EVENT, self) @@ -13118,14 +12698,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseStreamMetrics: - """ - Metrics for the stream. - """ + """Metrics for the stream.""" latency_ms: int - """ - The latency for the streaming request, in milliseconds. - """ + """The latency for the streaming request, in milliseconds.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CONVERSE_STREAM_METRICS, self) @@ -13160,19 +12736,15 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseStreamTrace: """ - The trace object in a response from ``ConverseStream ``_ - . + The trace object in a response from + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html). """ guardrail: GuardrailTraceAssessment | None = None - """ - The guardrail trace object. - """ + """The guardrail trace object.""" prompt_router: PromptRouterTrace | None = None - """ - The request's prompt router. - """ + """The request's prompt router.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CONVERSE_STREAM_TRACE, self) @@ -13214,34 +12786,31 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseStreamMetadataEvent: - """ - A conversation stream metadata event. - """ + """A conversation stream metadata event.""" usage: TokenUsage - """ - Usage information for the conversation stream event. - """ + """Usage information for the conversation stream event.""" metrics: ConverseStreamMetrics - """ - The metrics for the conversation stream metadata event. - """ + """The metrics for the conversation stream metadata event.""" trace: ConverseStreamTrace | None = None """ - The trace object in the response from `ConverseStream `_ + The trace object in the response from + [ConverseStream](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_runtime_ConverseStream.html) that contains information about the guardrail behavior. """ performance_config: PerformanceConfiguration | None = None """ - Model performance configuration metadata for the conversation stream event. + Model performance configuration metadata for the conversation stream + event. """ service_tier: ServiceTier | None = None """ - Specifies the processing tier configuration used for serving the request. + Specifies the processing tier configuration used for serving the + request. """ def serialize(self, serializer: ShapeSerializer): @@ -13309,21 +12878,15 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ModelStreamErrorException(ServiceError): - """ - An error occurred while streaming the response. Retry your request. - """ + """An error occurred while streaming the response. Retry your request.""" fault: Literal["client", "server"] | None = "client" original_status_code: int | None = None - """ - The original status code. - """ + """The original status code.""" original_message: str | None = None - """ - The original message. - """ + """The original message.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_MODEL_STREAM_ERROR_EXCEPTION, self) @@ -13384,9 +12947,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ConverseStreamOutputMessageStart: - """ - Message start information. - """ + """Message start information.""" value: MessageStartEvent @@ -13405,9 +12966,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputContentBlockStart: - """ - Start information for a content block. - """ + """Start information for a content block.""" value: ContentBlockStartEvent @@ -13426,9 +12985,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputContentBlockDelta: - """ - The messages output content block delta. - """ + """The messages output content block delta.""" value: ContentBlockDeltaEvent @@ -13447,9 +13004,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputContentBlockStop: - """ - Stop information for a content block. - """ + """Stop information for a content block.""" value: ContentBlockStopEvent @@ -13468,9 +13023,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputMessageStop: - """ - Message stop information. - """ + """Message stop information.""" value: MessageStopEvent @@ -13489,9 +13042,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputMetadata: - """ - Metadata for the converse output stream. - """ + """Metadata for the converse output stream.""" value: ConverseStreamMetadataEvent @@ -13510,9 +13061,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputInternalServerException: - """ - An internal server error occurred. Retry your request. - """ + """An internal server error occurred. Retry your request.""" value: InternalServerException @@ -13532,9 +13081,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputModelStreamErrorException: - """ - A streaming error occurred. Retry your request. - """ + """A streaming error occurred. Retry your request.""" value: ModelStreamErrorException @@ -13555,8 +13102,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputValidationException: """ - The input fails to satisfy the constraints specified by *Amazon Bedrock*. For - troubleshooting this error, see `ValidationError `_ + The input fails to satisfy the constraints specified by *Amazon + Bedrock*. For troubleshooting this error, see + [ValidationError](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-validation-error) in the Amazon Bedrock User Guide. """ @@ -13579,7 +13127,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: class ConverseStreamOutputThrottlingException: """ Your request was denied due to exceeding the account quotas for *Amazon - Bedrock*. For troubleshooting this error, see `ThrottlingException `_ + Bedrock*. For troubleshooting this error, see + [ThrottlingException](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-throttling-exception) in the Amazon Bedrock User Guide. """ @@ -13601,8 +13150,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputServiceUnavailableException: """ - The service isn't currently available. For troubleshooting this error, see - `ServiceUnavailable `_ + The service isn't currently available. For troubleshooting this error, + see + [ServiceUnavailable](https://docs.aws.amazon.com/bedrock/latest/userguide/troubleshooting-api-error-codes.html#ts-service-unavailable) in the Amazon Bedrock User Guide """ @@ -13624,7 +13174,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ConverseStreamOutputUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -13659,10 +13210,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | ConverseStreamOutputServiceUnavailableException | ConverseStreamOutputUnknown ] - -""" -The messages output stream -""" +"""The messages output stream""" class _ConverseStreamOutputDeserializer: @@ -13737,6 +13285,8 @@ def _set_result(self, value: ConverseStreamOutput) -> None: @dataclass(kw_only=True) class ConverseStreamOperationOutput: + """Dataclass for ConverseStreamOperationOutput structure.""" + def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CONVERSE_STREAM_OPERATION_OUTPUT, self) @@ -13814,91 +13364,103 @@ class Trace(StrEnum): @dataclass(kw_only=True) class InvokeModelInput: + """Dataclass for InvokeModelInput structure.""" + body: bytes | None = field(repr=False, default=None) """ The prompt and inference parameters in the format specified in the - ``contentType`` in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to `Inference parameters `_. - For more information, see `Run inference `_ + `contentType` in the header. You must provide the body in JSON format. + To see the format and content of the request and response bodies for + different models, refer to [Inference + parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). + For more information, see [Run + inference](https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html) in the Bedrock User Guide. """ content_type: str | None = None """ The MIME type of the input data in the request. You must specify - ``application/json``. + `application/json`. """ accept: str | None = None """ - The desired MIME type of the inference body in the response. The default value - is ``application/json``. + The desired MIME type of the inference body in the response. The default + value is `application/json`. """ model_id: str | None = None """ The unique identifier of the model to invoke to run inference. - The ``modelId`` to provide depends on the type of model or throughput that you - use: + The `modelId` to provide depends on the type of model or throughput that + you use: - * If you use a base model, specify the model ID or its ARN. For a list of model - IDs for base models, see `Amazon Bedrock base model IDs (on-demand throughput) `_ + - If you use a base model, specify the model ID or its ARN. For a list + of model IDs for base models, see [Amazon Bedrock base model IDs + (on-demand + throughput)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide. - * If you use an inference profile, specify the inference profile ID or its ARN. - For a list of inference profile IDs, see `Supported Regions and models for cross-region inference `_ + - If you use an inference profile, specify the inference profile ID or + its ARN. For a list of inference profile IDs, see [Supported Regions + and models for cross-region + inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide. - * If you use a provisioned model, specify the ARN of the Provisioned Throughput. - For more information, see `Run inference using a Provisioned Throughput `_ + - If you use a provisioned model, specify the ARN of the Provisioned + Throughput. For more information, see [Run inference using a + Provisioned + Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide. - * If you use a custom model, specify the ARN of the custom model deployment (for - on-demand inference) or the ARN of your provisioned model (for Provisioned - Throughput). For more information, see `Use a custom model in Amazon Bedrock `_ + - If you use a custom model, specify the ARN of the custom model + deployment (for on-demand inference) or the ARN of your provisioned + model (for Provisioned Throughput). For more information, see [Use a + custom model in Amazon + Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide. - * If you use an `imported model `_, - specify the ARN of the imported model. You can get the model ARN from a - successful call to `CreateModelImportJob `_ + - If you use an [imported + model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html), + specify the ARN of the imported model. You can get the model ARN from + a successful call to + [CreateModelImportJob](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html) or from the Imported models page in the Amazon Bedrock console. """ trace: str | None = None """ - Specifies whether to enable or disable the Bedrock trace. If enabled, you can - see the full Bedrock trace. + Specifies whether to enable or disable the Bedrock trace. If enabled, + you can see the full Bedrock trace. """ guardrail_identifier: str | None = None """ - The unique identifier of the guardrail that you want to use. If you don't - provide a value, no guardrail is applied to the invocation. + The unique identifier of the guardrail that you want to use. If you + don't provide a value, no guardrail is applied to the invocation. An error will be thrown in the following situations. - * You don't provide a guardrail identifier but you specify the - ``amazon-bedrock-guardrailConfig`` field in the request body. + - You don't provide a guardrail identifier but you specify the + `amazon-bedrock-guardrailConfig` field in the request body. - * You enable the guardrail but the ``contentType`` isn't ``application/json``. + - You enable the guardrail but the `contentType` isn't + `application/json`. - * You provide a guardrail identifier, but ``guardrailVersion`` isn't specified. + - You provide a guardrail identifier, but `guardrailVersion` isn't + specified. """ guardrail_version: str | None = None - """ - The version number for the guardrail. The value can also be ``DRAFT``. - """ + """The version number for the guardrail. The value can also be `DRAFT`.""" performance_config_latency: str = "standard" - """ - Model performance settings for the request. - """ + """Model performance settings for the request.""" service_tier: str | None = None - """ - Specifies the processing tier type used for serving the request. - """ + """Specifies the processing tier type used for serving the request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_INVOKE_MODEL_INPUT, self) @@ -14014,26 +13576,24 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class InvokeModelOutput: + """Dataclass for InvokeModelOutput structure.""" + body: bytes = field(repr=False) """ - Inference response from the model in the format specified in the ``contentType`` header. To see the format and content of the request and response bodies for different models, refer to `Inference parameters `_ - . + Inference response from the model in the format specified in the + `contentType` header. To see the format and content of the request and + response bodies for different models, refer to [Inference + parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). """ content_type: str - """ - The MIME type of the inference result. - """ + """The MIME type of the inference result.""" performance_config_latency: str | None = None - """ - Model performance settings for the request. - """ + """Model performance settings for the request.""" service_tier: str | None = None - """ - Specifies the processing tier type used for serving the request. - """ + """Specifies the processing tier type used for serving the request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_INVOKE_MODEL_OUTPUT, self) @@ -14141,13 +13701,12 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class BidirectionalInputPayloadPart: """ - Payload content for the bidirectional input. The input is an audio stream. + Payload content for the bidirectional input. The input is an audio + stream. """ bytes_: bytes | None = field(repr=False, default=None) - """ - The audio content for the bidirectional input. - """ + """The audio content for the bidirectional input.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_BIDIRECTIONAL_INPUT_PAYLOAD_PART, self) @@ -14184,9 +13743,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class InvokeModelWithBidirectionalStreamInputChunk: - """ - The audio chunk that is used as input for the invocation step. - """ + """The audio chunk that is used as input for the invocation step.""" value: BidirectionalInputPayloadPart @@ -14208,7 +13765,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class InvokeModelWithBidirectionalStreamInputUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -14233,10 +13791,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: InvokeModelWithBidirectionalStreamInputChunk | InvokeModelWithBidirectionalStreamInputUnknown ] - """ -Payload content, the speech chunk, for the bidirectional input of the invocation -step. +Payload content, the speech chunk, for the bidirectional input of the +invocation step. """ @@ -14278,10 +13835,15 @@ def _set_result(self, value: InvokeModelWithBidirectionalStreamInput) -> None: @dataclass(kw_only=True) class InvokeModelWithBidirectionalStreamOperationInput: + """ + Dataclass for InvokeModelWithBidirectionalStreamOperationInput + structure. + """ + model_id: str | None = None """ The model ID or ARN of the model ID to use. Currently, only - ``amazon.nova-sonic-v1:0`` is supported. + `amazon.nova-sonic-v1:0` is supported. """ def serialize(self, serializer: ShapeSerializer): @@ -14333,9 +13895,7 @@ class BidirectionalOutputPayloadPart: """ bytes_: bytes | None = field(repr=False, default=None) - """ - The speech output of the bidirectional stream. - """ + """The speech output of the bidirectional stream.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_BIDIRECTIONAL_OUTPUT_PAYLOAD_PART, self) @@ -14372,9 +13932,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class InvokeModelWithBidirectionalStreamOutputChunk: - """ - The speech chunk that was provided as output from the invocation step. - """ + """The speech chunk that was provided as output from the invocation step.""" value: BidirectionalOutputPayloadPart @@ -14396,9 +13954,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class InvokeModelWithBidirectionalStreamOutputInternalServerException: - """ - The request encountered an unknown internal error. - """ + """The request encountered an unknown internal error.""" value: InternalServerException @@ -14422,9 +13978,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class InvokeModelWithBidirectionalStreamOutputModelStreamErrorException: - """ - The request encountered an error with the model stream. - """ + """The request encountered an error with the model stream.""" value: ModelStreamErrorException @@ -14449,8 +14003,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class InvokeModelWithBidirectionalStreamOutputValidationException: """ - The input fails to satisfy the constraints specified by an Amazon Web Services - service. + The input fails to satisfy the constraints specified by an Amazon Web + Services service. """ value: ValidationException @@ -14475,9 +14029,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class InvokeModelWithBidirectionalStreamOutputThrottlingException: - """ - The request was denied due to request throttling. - """ + """The request was denied due to request throttling.""" value: ThrottlingException @@ -14502,8 +14054,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class InvokeModelWithBidirectionalStreamOutputModelTimeoutException: """ - The connection was closed because a request was not received within the timeout - period. + The connection was closed because a request was not received within the + timeout period. """ value: ModelTimeoutException @@ -14528,9 +14080,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class InvokeModelWithBidirectionalStreamOutputServiceUnavailableException: - """ - The request has failed due to a temporary failure of the server. - """ + """The request has failed due to a temporary failure of the server.""" value: ServiceUnavailableException @@ -14554,7 +14104,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class InvokeModelWithBidirectionalStreamOutputUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -14585,10 +14136,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | InvokeModelWithBidirectionalStreamOutputServiceUnavailableException | InvokeModelWithBidirectionalStreamOutputUnknown ] - -""" -Output from the bidirectional stream that was used for model invocation. -""" +"""Output from the bidirectional stream that was used for model invocation.""" class _InvokeModelWithBidirectionalStreamOutputDeserializer: @@ -14671,6 +14219,11 @@ def _set_result(self, value: InvokeModelWithBidirectionalStreamOutput) -> None: @dataclass(kw_only=True) class InvokeModelWithBidirectionalStreamOperationOutput: + """ + Dataclass for InvokeModelWithBidirectionalStreamOperationOutput + structure. + """ + def serialize(self, serializer: ShapeSerializer): serializer.write_struct( _SCHEMA_INVOKE_MODEL_WITH_BIDIRECTIONAL_STREAM_OPERATION_OUTPUT, self @@ -14751,91 +14304,103 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class InvokeModelWithResponseStreamInput: + """Dataclass for InvokeModelWithResponseStreamInput structure.""" + body: bytes | None = field(repr=False, default=None) """ The prompt and inference parameters in the format specified in the - ``contentType`` in the header. You must provide the body in JSON format. To see the format and content of the request and response bodies for different models, refer to `Inference parameters `_. - For more information, see `Run inference `_ + `contentType` in the header. You must provide the body in JSON format. + To see the format and content of the request and response bodies for + different models, refer to [Inference + parameters](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). + For more information, see [Run + inference](https://docs.aws.amazon.com/bedrock/latest/userguide/api-methods-run.html) in the Bedrock User Guide. """ content_type: str | None = None """ The MIME type of the input data in the request. You must specify - ``application/json``. + `application/json`. """ accept: str | None = None """ - The desired MIME type of the inference body in the response. The default value - is ``application/json``. + The desired MIME type of the inference body in the response. The default + value is `application/json`. """ model_id: str | None = None """ The unique identifier of the model to invoke to run inference. - The ``modelId`` to provide depends on the type of model or throughput that you - use: + The `modelId` to provide depends on the type of model or throughput that + you use: - * If you use a base model, specify the model ID or its ARN. For a list of model - IDs for base models, see `Amazon Bedrock base model IDs (on-demand throughput) `_ + - If you use a base model, specify the model ID or its ARN. For a list + of model IDs for base models, see [Amazon Bedrock base model IDs + (on-demand + throughput)](https://docs.aws.amazon.com/bedrock/latest/userguide/model-ids.html#model-ids-arns) in the Amazon Bedrock User Guide. - * If you use an inference profile, specify the inference profile ID or its ARN. - For a list of inference profile IDs, see `Supported Regions and models for cross-region inference `_ + - If you use an inference profile, specify the inference profile ID or + its ARN. For a list of inference profile IDs, see [Supported Regions + and models for cross-region + inference](https://docs.aws.amazon.com/bedrock/latest/userguide/cross-region-inference-support.html) in the Amazon Bedrock User Guide. - * If you use a provisioned model, specify the ARN of the Provisioned Throughput. - For more information, see `Run inference using a Provisioned Throughput `_ + - If you use a provisioned model, specify the ARN of the Provisioned + Throughput. For more information, see [Run inference using a + Provisioned + Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-thru-use.html) in the Amazon Bedrock User Guide. - * If you use a custom model, specify the ARN of the custom model deployment (for - on-demand inference) or the ARN of your provisioned model (for Provisioned - Throughput). For more information, see `Use a custom model in Amazon Bedrock `_ + - If you use a custom model, specify the ARN of the custom model + deployment (for on-demand inference) or the ARN of your provisioned + model (for Provisioned Throughput). For more information, see [Use a + custom model in Amazon + Bedrock](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-use.html) in the Amazon Bedrock User Guide. - * If you use an `imported model `_, - specify the ARN of the imported model. You can get the model ARN from a - successful call to `CreateModelImportJob `_ + - If you use an [imported + model](https://docs.aws.amazon.com/bedrock/latest/userguide/model-customization-import-model.html), + specify the ARN of the imported model. You can get the model ARN from + a successful call to + [CreateModelImportJob](https://docs.aws.amazon.com/bedrock/latest/APIReference/API_CreateModelImportJob.html) or from the Imported models page in the Amazon Bedrock console. """ trace: str | None = None """ - Specifies whether to enable or disable the Bedrock trace. If enabled, you can - see the full Bedrock trace. + Specifies whether to enable or disable the Bedrock trace. If enabled, + you can see the full Bedrock trace. """ guardrail_identifier: str | None = None """ - The unique identifier of the guardrail that you want to use. If you don't - provide a value, no guardrail is applied to the invocation. + The unique identifier of the guardrail that you want to use. If you + don't provide a value, no guardrail is applied to the invocation. An error is thrown in the following situations. - * You don't provide a guardrail identifier but you specify the - ``amazon-bedrock-guardrailConfig`` field in the request body. + - You don't provide a guardrail identifier but you specify the + `amazon-bedrock-guardrailConfig` field in the request body. - * You enable the guardrail but the ``contentType`` isn't ``application/json``. + - You enable the guardrail but the `contentType` isn't + `application/json`. - * You provide a guardrail identifier, but ``guardrailVersion`` isn't specified. + - You provide a guardrail identifier, but `guardrailVersion` isn't + specified. """ guardrail_version: str | None = None - """ - The version number for the guardrail. The value can also be ``DRAFT``. - """ + """The version number for the guardrail. The value can also be `DRAFT`.""" performance_config_latency: str = "standard" - """ - Model performance settings for the request. - """ + """Model performance settings for the request.""" service_tier: str | None = None - """ - Specifies the processing tier type used for serving the request. - """ + """Specifies the processing tier type used for serving the request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_INVOKE_MODEL_WITH_RESPONSE_STREAM_INPUT, self) @@ -14981,14 +14546,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class PayloadPart: - """ - Payload content included in the response. - """ + """Payload content included in the response.""" bytes_: bytes | None = field(repr=False, default=None) - """ - Base64-encoded bytes of payload data. - """ + """Base64-encoded bytes of payload data.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_PAYLOAD_PART, self) @@ -15021,9 +14582,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ResponseStreamChunk: - """ - Content included in the response. - """ + """Content included in the response.""" value: PayloadPart @@ -15040,9 +14599,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamInternalServerException: - """ - An internal server error occurred. Retry your request. - """ + """An internal server error occurred. Retry your request.""" value: InternalServerException @@ -15061,9 +14618,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamModelStreamErrorException: - """ - An error occurred while streaming the response. Retry your request. - """ + """An error occurred while streaming the response. Retry your request.""" value: ModelStreamErrorException @@ -15083,7 +14638,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamValidationException: """ - Input validation failed. Check your request parameters and retry the request. + Input validation failed. Check your request parameters and retry the + request. """ value: ValidationException @@ -15104,8 +14660,10 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamThrottlingException: """ - Your request was throttled because of service-wide limitations. Resubmit your - request later or in a different region. You can also purchase `Provisioned Throughput `_ + Your request was throttled because of service-wide limitations. Resubmit + your request later or in a different region. You can also purchase + [Provisioned + Throughput](https://docs.aws.amazon.com/bedrock/latest/userguide/prov-throughput.html) to increase the rate or number of tokens you can process. """ @@ -15127,8 +14685,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamModelTimeoutException: """ - The request took too long to process. Processing time exceeded the model timeout - length. + The request took too long to process. Processing time exceeded the model + timeout length. """ value: ModelTimeoutException @@ -15148,9 +14706,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamServiceUnavailableException: - """ - The service isn't available. Try again later. - """ + """The service isn't available. Try again later.""" value: ServiceUnavailableException @@ -15169,7 +14725,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -15200,10 +14757,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | ResponseStreamServiceUnavailableException | ResponseStreamUnknown ] - -""" -Definition of content in the response stream. -""" +"""Definition of content in the response stream.""" class _ResponseStreamDeserializer: @@ -15260,20 +14814,16 @@ def _set_result(self, value: ResponseStream) -> None: @dataclass(kw_only=True) class InvokeModelWithResponseStreamOutput: + """Dataclass for InvokeModelWithResponseStreamOutput structure.""" + content_type: str - """ - The MIME type of the inference result. - """ + """The MIME type of the inference result.""" performance_config_latency: str | None = None - """ - Model performance settings for the request. - """ + """Model performance settings for the request.""" service_tier: str | None = None - """ - Specifies the processing tier type used for serving the request. - """ + """Specifies the processing tier type used for serving the request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_INVOKE_MODEL_WITH_RESPONSE_STREAM_OUTPUT, self) @@ -15390,35 +14940,34 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConverseTokensRequest: """ - The inputs from a ``Converse`` API request for token counting. + The inputs from a `Converse` API request for token counting. - This structure mirrors the input format for the ``Converse`` operation, allowing - you to count tokens for conversation-based inference requests. + This structure mirrors the input format for the `Converse` operation, + allowing you to count tokens for conversation-based inference requests. """ messages: list[Message] | None = None - """ - An array of messages to count tokens for. - """ + """An array of messages to count tokens for.""" system: list[SystemContentBlock] | None = None """ The system content blocks to count tokens for. System content provides - instructions or context to the model about how it should behave or respond. The - token count will include any system content provided. + instructions or context to the model about how it should behave or + respond. The token count will include any system content provided. """ tool_config: ToolConfiguration | None = None """ - The toolConfig of Converse input request to count tokens for. Configuration - information for the tools that the model can use when generating a response. + The toolConfig of Converse input request to count tokens for. + Configuration information for the tools that the model can use when + generating a response. """ additional_model_request_fields: Document | None = None """ - The additionalModelRequestFields of Converse input request to count tokens for. - Use this field when you want to pass additional parameters that the model - supports. + The additionalModelRequestFields of Converse input request to count + tokens for. Use this field when you want to pass additional parameters + that the model supports. """ def serialize(self, serializer: ShapeSerializer): @@ -15490,17 +15039,17 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class InvokeModelTokensRequest: """ - The body of an ``InvokeModel`` API request for token counting. This structure - mirrors the input format for the ``InvokeModel`` operation, allowing you to - count tokens for raw text inference requests. + The body of an `InvokeModel` API request for token counting. This + structure mirrors the input format for the `InvokeModel` operation, + allowing you to count tokens for raw text inference requests. """ body: bytes = field(repr=False) """ - The request body to count tokens for, formatted according to the model's - expected input format. To learn about the input format for different models, see - `Model inference parameters and responses `_ - . + The request body to count tokens for, formatted according to the + model's expected input format. To learn about the input format for + different models, see [Model inference parameters and + responses](https://docs.aws.amazon.com/bedrock/latest/userguide/model-parameters.html). """ def serialize(self, serializer: ShapeSerializer): @@ -15538,9 +15087,9 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class CountTokensInputInvokeModel: """ - An ``InvokeModel`` request for which to count tokens. Use this field when you - want to count tokens for a raw text input that would be sent to the - ``InvokeModel`` operation. + An `InvokeModel` request for which to count tokens. Use this field when + you want to count tokens for a raw text input that would be sent to the + `InvokeModel` operation. """ value: InvokeModelTokensRequest @@ -15561,9 +15110,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CountTokensInputConverse: """ - A ``Converse`` request for which to count tokens. Use this field when you want - to count tokens for a conversation-based input that would be sent to the - ``Converse`` operation. + A `Converse` request for which to count tokens. Use this field when you + want to count tokens for a conversation-based input that would be sent + to the `Converse` operation. """ value: ConverseTokensRequest @@ -15583,7 +15132,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CountTokensInputUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -15607,10 +15157,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: CountTokensInput = Union[ CountTokensInputInvokeModel | CountTokensInputConverse | CountTokensInputUnknown ] - """ The input value for token counting. The value should be either an -``InvokeModel`` or ``Converse`` request body. +`InvokeModel` or `Converse` request body. """ @@ -15649,26 +15198,29 @@ def _set_result(self, value: CountTokensInput) -> None: @dataclass(kw_only=True) class CountTokensOperationInput: + """Dataclass for CountTokensOperationInput structure.""" + model_id: str | None = None """ - The unique identifier or ARN of the foundation model to use for token counting. - Each model processes tokens differently, so the token count is specific to the - model you specify. + The unique identifier or ARN of the foundation model to use for token + counting. Each model processes tokens differently, so the token count is + specific to the model you specify. """ input: CountTokensInput | None = None """ - The input for which to count tokens. The structure of this parameter depends on - whether you're counting tokens for an ``InvokeModel`` or ``Converse`` request: + The input for which to count tokens. The structure of this parameter + depends on whether you're counting tokens for an `InvokeModel` or + `Converse` request: - * For ``InvokeModel`` requests, provide the request body in the ``invokeModel`` - field + - For `InvokeModel` requests, provide the request body in the + `invokeModel` field - * For ``Converse`` requests, provide the messages and system content in the - ``converse`` field + - For `Converse` requests, provide the messages and system content in + the `converse` field - The input format must be compatible with the model specified in the ``modelId`` - parameter. + The input format must be compatible with the model specified in the + `modelId` parameter. """ def serialize(self, serializer: ShapeSerializer): @@ -15714,13 +15266,15 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class CountTokensOutput: + """Dataclass for CountTokensOutput structure.""" + input_tokens: int """ - The number of tokens in the provided input according to the specified model's - tokenization rules. This count represents the number of input tokens that would - be processed if the same input were sent to the model in an inference request. - Use this value to estimate costs and ensure your inputs stay within model token - limits. + The number of tokens in the provided input according to the specified + model's tokenization rules. This count represents the number of input + tokens that would be processed if the same input were sent to the model + in an inference request. Use this value to estimate costs and ensure + your inputs stay within model token limits. """ def serialize(self, serializer: ShapeSerializer): diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/Makefile b/clients/aws-sdk-sagemaker-runtime-http2/docs/Makefile deleted file mode 100644 index 59458fa..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/Makefile +++ /dev/null @@ -1,15 +0,0 @@ -# Code generated by smithy-python-codegen DO NOT EDIT. - -SPHINXBUILD = sphinx-build -BUILDDIR = build -SERVICESDIR = source/reference/services -SPHINXOPTS = -j auto -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/README.md b/clients/aws-sdk-sagemaker-runtime-http2/docs/README.md deleted file mode 100644 index 141b2c7..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/README.md +++ /dev/null @@ -1,10 +0,0 @@ -## Generating Documentation - -Sphinx is used for documentation. You can generate HTML locally with the -following: - -``` -$ uv pip install --group docs . -$ cd docs -$ make html -``` diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/client/index.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/client/index.rst deleted file mode 100644 index 371f32a..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/client/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Client -======= -.. toctree:: - :maxdepth: 1 - :titlesonly: - :glob: - - * diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/client/invoke_endpoint_with_bidirectional_stream.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/client/invoke_endpoint_with_bidirectional_stream.rst deleted file mode 100644 index 6f8143a..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/client/invoke_endpoint_with_bidirectional_stream.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -invoke_endpoint_with_bidirectional_stream -========================================= - -.. automethod:: aws_sdk_sagemaker_runtime_http2.client.SageMakerRuntimeHTTP2Client.invoke_endpoint_with_bidirectional_stream - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.InvokeEndpointWithBidirectionalStreamInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.InvokeEndpointWithBidirectionalStreamOutput - :members: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/conf.py b/clients/aws-sdk-sagemaker-runtime-http2/docs/conf.py deleted file mode 100644 index 0ff545c..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/conf.py +++ /dev/null @@ -1,24 +0,0 @@ -# Code generated by smithy-python-codegen DO NOT EDIT. - -import os -import sys - -sys.path.insert(0, os.path.abspath("..")) - -project = "Amazon SageMaker Runtime HTTP2" -author = "Amazon Web Services" -release = "0.1.0" - -extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] - -templates_path = ["_templates"] -exclude_patterns = [] - -autodoc_default_options = { - "exclude-members": "deserialize,deserialize_kwargs,serialize,serialize_members" -} - -html_theme = "pydata_sphinx_theme" -html_theme_options = {"logo": {"text": "Amazon SageMaker Runtime HTTP2"}} - -autodoc_typehints = "description" diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/index.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/index.rst deleted file mode 100644 index bebb6b1..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Amazon SageMaker Runtime HTTP2 -============================== - -.. toctree:: - :maxdepth: 2 - :titlesonly: - :glob: - - */index diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/make.bat b/clients/aws-sdk-sagemaker-runtime-http2/docs/make.bat deleted file mode 100644 index 3245132..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -REM Code generated by smithy-python-codegen DO NOT EDIT. - -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=build -set SERVICESDIR=source/reference/services -set SPHINXOPTS=-j auto -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . - -if "%1" == "" goto help - -if "%1" == "clean" ( - rmdir /S /Q %BUILDDIR% - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - echo. - echo "Build finished. The HTML pages are in %BUILDDIR%/html." - goto end -) - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InputValidationError.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InputValidationError.rst deleted file mode 100644 index 62049d4..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InputValidationError.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -InputValidationError -==================== - -.. autoexception:: aws_sdk_sagemaker_runtime_http2.models.InputValidationError - :members: - :show-inheritance: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InternalServerError.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InternalServerError.rst deleted file mode 100644 index 2056072..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InternalServerError.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -InternalServerError -=================== - -.. autoexception:: aws_sdk_sagemaker_runtime_http2.models.InternalServerError - :members: - :show-inheritance: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InternalStreamFailure.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InternalStreamFailure.rst deleted file mode 100644 index a08da4b..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/InternalStreamFailure.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -InternalStreamFailure -===================== - -.. autoexception:: aws_sdk_sagemaker_runtime_http2.models.InternalStreamFailure - :members: - :show-inheritance: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ModelError.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ModelError.rst deleted file mode 100644 index af0a19b..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ModelError.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ModelError -========== - -.. autoexception:: aws_sdk_sagemaker_runtime_http2.models.ModelError - :members: - :show-inheritance: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ModelStreamError.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ModelStreamError.rst deleted file mode 100644 index 402ca42..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ModelStreamError.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ModelStreamError -================ - -.. autoexception:: aws_sdk_sagemaker_runtime_http2.models.ModelStreamError - :members: - :show-inheritance: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestPayloadPart.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestPayloadPart.rst deleted file mode 100644 index eeeca1b..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestPayloadPart.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -RequestPayloadPart -================== - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.RequestPayloadPart - :members: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEvent.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEvent.rst deleted file mode 100644 index f1050c7..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _RequestStreamEvent: - -RequestStreamEvent -================== - -.. autodata:: aws_sdk_sagemaker_runtime_http2.models.RequestStreamEvent diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEventPayloadPart.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEventPayloadPart.rst deleted file mode 100644 index fc4834e..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEventPayloadPart.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _RequestStreamEventPayloadPart: - -RequestStreamEventPayloadPart -============================= - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.RequestStreamEventPayloadPart diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEventUnknown.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEventUnknown.rst deleted file mode 100644 index 769b832..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/RequestStreamEventUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _RequestStreamEventUnknown: - -RequestStreamEventUnknown -========================= - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.RequestStreamEventUnknown diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponsePayloadPart.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponsePayloadPart.rst deleted file mode 100644 index cc0e7a7..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponsePayloadPart.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ResponsePayloadPart -=================== - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.ResponsePayloadPart - :members: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEvent.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEvent.rst deleted file mode 100644 index 9089eef..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamEvent: - -ResponseStreamEvent -=================== - -.. autodata:: aws_sdk_sagemaker_runtime_http2.models.ResponseStreamEvent diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventInternalStreamFailure.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventInternalStreamFailure.rst deleted file mode 100644 index c6047ed..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventInternalStreamFailure.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamEventInternalStreamFailure: - -ResponseStreamEventInternalStreamFailure -======================================== - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.ResponseStreamEventInternalStreamFailure diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventModelStreamError.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventModelStreamError.rst deleted file mode 100644 index df57dcb..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventModelStreamError.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamEventModelStreamError: - -ResponseStreamEventModelStreamError -=================================== - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.ResponseStreamEventModelStreamError diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventPayloadPart.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventPayloadPart.rst deleted file mode 100644 index fab46c7..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventPayloadPart.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamEventPayloadPart: - -ResponseStreamEventPayloadPart -============================== - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.ResponseStreamEventPayloadPart diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventUnknown.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventUnknown.rst deleted file mode 100644 index 5a8f95a..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ResponseStreamEventUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _ResponseStreamEventUnknown: - -ResponseStreamEventUnknown -========================== - -.. autoclass:: aws_sdk_sagemaker_runtime_http2.models.ResponseStreamEventUnknown diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ServiceUnavailableError.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ServiceUnavailableError.rst deleted file mode 100644 index b245543..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/ServiceUnavailableError.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ServiceUnavailableError -======================= - -.. autoexception:: aws_sdk_sagemaker_runtime_http2.models.ServiceUnavailableError - :members: - :show-inheritance: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/index.rst b/clients/aws-sdk-sagemaker-runtime-http2/docs/models/index.rst deleted file mode 100644 index c403929..0000000 --- a/clients/aws-sdk-sagemaker-runtime-http2/docs/models/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Models -======= -.. toctree:: - :maxdepth: 1 - :titlesonly: - :glob: - - * diff --git a/clients/aws-sdk-sagemaker-runtime-http2/pyproject.toml b/clients/aws-sdk-sagemaker-runtime-http2/pyproject.toml index 8b9a41a..3b1e6e4 100644 --- a/clients/aws-sdk-sagemaker-runtime-http2/pyproject.toml +++ b/clients/aws-sdk-sagemaker-runtime-http2/pyproject.toml @@ -1,6 +1,5 @@ # Code generated by smithy-python-codegen DO NOT EDIT. - [project] name = "aws_sdk_sagemaker_runtime_http2" version = "0.1.0" @@ -35,21 +34,10 @@ test = [ "pytest-asyncio>=0.20.3,<0.21.0" ] -docs = [ - "pydata-sphinx-theme>=0.16.1", - "sphinx>=8.2.3" -] - [build-system] requires = ["hatchling"] build-backend = "hatchling.build" -[tool.hatch.build.targets.bdist] -exclude = [ - "tests", - "docs", -] - [tool.pyright] typeCheckingMode = "strict" reportPrivateUsage = false diff --git a/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/client.py b/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/client.py index 2829a88..682c98f 100644 --- a/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/client.py +++ b/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/client.py @@ -28,19 +28,22 @@ class SageMakerRuntimeHTTP2Client: - """ - The Amazon SageMaker AI runtime HTTP/2 API. - - :param config: Optional configuration for the client. Here you can set things like the - endpoint for HTTP services or auth credentials. - - :param plugins: A list of callables that modify the configuration dynamically. These - can be used to set defaults, for example. - """ + """The Amazon SageMaker AI runtime HTTP/2 API.""" def __init__( self, config: Config | None = None, plugins: list[Plugin] | None = None ): + """ + Constructor for `SageMakerRuntimeHTTP2Client`. + + Args: + config: + Optional configuration for the client. Here you can set things like + the endpoint for HTTP services or auth credentials. + plugins: + A list of callables that modify the configuration dynamically. These + can be used to set defaults, for example. + """ self._config = config or Config() client_plugins: list[Plugin] = [aws_user_agent_plugin, user_agent_plugin] @@ -63,39 +66,52 @@ async def invoke_endpoint_with_bidirectional_stream( ]: """ Invokes a model endpoint with bidirectional streaming capabilities. This - operation establishes a persistent connection that allows you to send multiple - requests and receive streaming responses from the model in real-time. - - Bidirectional streaming is useful for interactive applications such as chatbots, - real-time translation, or any scenario where you need to maintain a - conversation-like interaction with the model. The connection remains open, - allowing you to send additional input and receive responses without establishing - a new connection for each request. - - For an overview of Amazon SageMaker AI, see `How It Works `_ - . - - Amazon SageMaker AI strips all POST headers except those supported by the API. - Amazon SageMaker AI might add additional headers. You should not rely on the - behavior of headers outside those enumerated in the request syntax. - - Calls to ``InvokeEndpointWithBidirectionalStream`` are authenticated by using Amazon Web Services Signature Version 4. For information, see `Authenticating Requests (Amazon Web Services Signature Version 4) `_ + operation establishes a persistent connection that allows you to send + multiple requests and receive streaming responses from the model in + real-time. + + Bidirectional streaming is useful for interactive applications such as + chatbots, real-time translation, or any scenario where you need to + maintain a conversation-like interaction with the model. The connection + remains open, allowing you to send additional input and receive + responses without establishing a new connection for each request. + + For an overview of Amazon SageMaker AI, see [How It + Works](https://docs.aws.amazon.com/sagemaker/latest/dg/how-it-works.html). + + Amazon SageMaker AI strips all POST headers except those supported by + the API. Amazon SageMaker AI might add additional headers. You should + not rely on the behavior of headers outside those enumerated in the + request syntax. + + Calls to `InvokeEndpointWithBidirectionalStream` are authenticated by + using Amazon Web Services Signature Version 4. For information, see + [Authenticating Requests (Amazon Web Services Signature Version + 4)](https://docs.aws.amazon.com/AmazonS3/latest/API/sig-v4-authenticating-requests.html) in the *Amazon S3 API Reference*. - The bidirectional stream maintains the connection until either the client closes - it or the model indicates completion. Each request and response in the stream is - sent as an event with optional headers for data type and completion state. - - .. note:: - Endpoints are scoped to an individual account, and are not public. The URL does - not contain the account ID, but Amazon SageMaker AI determines the account ID - from the authentication token that is supplied by the caller. - - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + The bidirectional stream maintains the connection until either the + client closes it or the model indicates completion. Each request and + response in the stream is sent as an event with optional headers for + data type and completion state. + + Note: + Endpoints are scoped to an individual account, and are not public. The + URL does not contain the account ID, but Amazon SageMaker AI determines + the account ID from the authentication token that is supplied by the + caller. + + Args: + input: + An instance of `InvokeEndpointWithBidirectionalStreamInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + A `DuplexEventStream` for bidirectional streaming. """ operation_plugins: list[Plugin] = [] if plugins: diff --git a/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/config.py b/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/config.py index 81a3692..fd177af 100644 --- a/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/config.py +++ b/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/config.py @@ -49,23 +49,72 @@ class Config: """Configuration for SageMaker Runtime HTTP2.""" auth_scheme_resolver: HTTPAuthSchemeResolver + """ + An auth scheme resolver that determines the auth scheme for each + operation. + """ + auth_schemes: dict[ShapeID, AuthScheme[Any, Any, Any, Any]] + """A map of auth scheme ids to auth schemes.""" + aws_access_key_id: str | None + """The identifier for a secret access key.""" + aws_credentials_identity_resolver: ( IdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None ) + """Resolves AWS Credentials. Required for operations that use Sigv4 Auth.""" + aws_secret_access_key: str | None + """A secret access key that can be used to sign requests.""" + aws_session_token: str | None + """An access key ID that identifies temporary security credentials.""" + endpoint_resolver: _EndpointResolver + """ + The endpoint resolver used to resolve the final endpoint per-operation + based on the configuration. + """ + endpoint_uri: str | URI | None + """A static URI to route requests to.""" + http_request_config: HTTPRequestConfiguration | None + """Configuration for individual HTTP requests.""" + interceptors: list[_ServiceInterceptor] + """ + The list of interceptors, which are hooks that are called during the + execution of a request. + """ + protocol: ClientProtocol[Any, Any] | None + """The protocol to serialize and deserialize requests with.""" + region: str | None + """ + The AWS region to connect to. The configured region is used to determine + the service endpoint. + """ + retry_strategy: RetryStrategy | RetryStrategyOptions | None + """ + The retry strategy or options for configuring retry behavior. Can be + either a configured RetryStrategy or RetryStrategyOptions to create one. + """ + sdk_ua_app_id: str | None + """ + A unique and opaque application ID that is appended to the User-Agent + header. + """ + transport: ClientTransport[Any, Any] | None + """The transport to use to send requests (e.g. an HTTP client).""" + user_agent_extra: str | None + """Additional suffix to be added to the User-Agent header.""" def __init__( self, @@ -90,61 +139,6 @@ def __init__( transport: ClientTransport[Any, Any] | None = None, user_agent_extra: str | None = None, ): - """ - Constructor. - - :param auth_scheme_resolver: - An auth scheme resolver that determines the auth scheme for each operation. - - :param auth_schemes: - A map of auth scheme ids to auth schemes. - - :param aws_access_key_id: - The identifier for a secret access key. - - :param aws_credentials_identity_resolver: - Resolves AWS Credentials. Required for operations that use Sigv4 Auth. - - :param aws_secret_access_key: - A secret access key that can be used to sign requests. - - :param aws_session_token: - An access key ID that identifies temporary security credentials. - - :param endpoint_resolver: - The endpoint resolver used to resolve the final endpoint per-operation based on - the configuration. - - :param endpoint_uri: - A static URI to route requests to. - - :param http_request_config: - Configuration for individual HTTP requests. - - :param interceptors: - The list of interceptors, which are hooks that are called during the execution - of a request. - - :param protocol: - The protocol to serialize and deserialize requests with. - - :param region: - The AWS region to connect to. The configured region is used to determine the - service endpoint. - - :param retry_strategy: - The retry strategy or options for configuring retry behavior. Can be either a - configured RetryStrategy or RetryStrategyOptions to create one. - - :param sdk_ua_app_id: - A unique and opaque application ID that is appended to the User-Agent header. - - :param transport: - The transport to use to send requests (e.g. an HTTP client). - - :param user_agent_extra: - Additional suffix to be added to the User-Agent header. - """ self.auth_scheme_resolver = auth_scheme_resolver or HTTPAuthSchemeResolver() self.auth_schemes = auth_schemes or { ShapeID("aws.auth#sigv4"): SigV4AuthScheme(service="sagemaker") @@ -169,16 +163,17 @@ def __init__( self.user_agent_extra = user_agent_extra def set_auth_scheme(self, scheme: AuthScheme[Any, Any, Any, Any]) -> None: - """Sets the implementation of an auth scheme. + """ + Sets the implementation of an auth scheme. Using this method ensures the correct key is used. - :param scheme: The auth scheme to add. + Args: + scheme: + The auth scheme to add. """ self.auth_schemes[scheme.scheme_id] = scheme -# -# A callable that allows customizing the config object on each request. -# Plugin: TypeAlias = Callable[[Config], None] +"""A callable that allows customizing the config object on each request.""" diff --git a/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/models.py b/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/models.py index 02539c6..37544c6 100644 --- a/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/models.py +++ b/clients/aws-sdk-sagemaker-runtime-http2/src/aws_sdk_sagemaker_runtime_http2/models.py @@ -32,7 +32,8 @@ class ServiceError(ModeledError): - """Base error for all errors in the service. + """ + Base error for all errors in the service. Some exceptions do not extend from this class, including synthetic, implicit, and shared exception types. @@ -41,16 +42,12 @@ class ServiceError(ModeledError): @dataclass(kw_only=True) class InputValidationError(ServiceError): - """ - The input fails to satisfy the constraints specified by an AWS service. - """ + """The input fails to satisfy the constraints specified by an AWS service.""" fault: Literal["client", "server"] | None = "client" error_code: str | None = None - """ - Error code. - """ + """Error code.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_INPUT_VALIDATION_ERROR, self) @@ -96,16 +93,14 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class InternalServerError(ServiceError): """ - The request processing has failed because of an unknown error, exception or - failure. + The request processing has failed because of an unknown error, exception + or failure. """ fault: Literal["client", "server"] | None = "server" error_code: str | None = None - """ - Error code. - """ + """Error code.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_INTERNAL_SERVER_ERROR, self) @@ -150,9 +145,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class InternalStreamFailure(ServiceError): - """ - Internal stream failure that occurs during streaming. - """ + """Internal stream failure that occurs during streaming.""" fault: Literal["client", "server"] | None = "server" @@ -189,30 +182,25 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class RequestPayloadPart: - """ - Request payload part structure. - """ + """Request payload part structure.""" bytes_: bytes | None = field(repr=False, default=None) - """ - The payload bytes. - """ + """The payload bytes.""" data_type: str | None = None """ - Data type header. Can be one of these possible values: "UTF8", "BINARY". + Data type header. Can be one of these possible values: \"UTF8\", + \"BINARY\". """ completion_state: str | None = None """ - Completion state header. Can be one of these possible values: "PARTIAL", - "COMPLETE". + Completion state header. Can be one of these possible values: + \"PARTIAL\", \"COMPLETE\". """ p: str | None = None - """ - Padding string for alignment. - """ + """Padding string for alignment.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_REQUEST_PAYLOAD_PART, self) @@ -276,9 +264,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class RequestStreamEventPayloadPart: - """ - Payload part event. - """ + """Payload part event.""" value: RequestPayloadPart @@ -297,7 +283,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class RequestStreamEventUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -319,10 +306,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: RequestStreamEvent = Union[RequestStreamEventPayloadPart | RequestStreamEventUnknown] - -""" -Request stream event union. -""" +"""Request stream event union.""" class _RequestStreamEventDeserializer: @@ -357,25 +341,19 @@ def _set_result(self, value: RequestStreamEvent) -> None: @dataclass(kw_only=True) class InvokeEndpointWithBidirectionalStreamInput: + """Dataclass for InvokeEndpointWithBidirectionalStreamInput structure.""" + endpoint_name: str | None = None - """ - The name of the endpoint to invoke. - """ + """The name of the endpoint to invoke.""" target_variant: str | None = None - """ - Target variant for the request. - """ + """Target variant for the request.""" model_invocation_path: str | None = None - """ - Model invocation path. - """ + """Model invocation path.""" model_query_string: str | None = None - """ - Model query string. - """ + """Model query string.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct( @@ -464,16 +442,12 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ModelStreamError(ServiceError): - """ - Model stream error that occurs during streaming. - """ + """Model stream error that occurs during streaming.""" fault: Literal["client", "server"] | None = "client" error_code: str | None = None - """ - Error code. - """ + """Error code.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_MODEL_STREAM_ERROR, self) @@ -518,30 +492,25 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ResponsePayloadPart: - """ - Response payload part structure. - """ + """Response payload part structure.""" bytes_: bytes | None = field(repr=False, default=None) - """ - The payload bytes. - """ + """The payload bytes.""" data_type: str | None = None """ - Data type header. Can be one of these possible values: "UTF8", "BINARY". + Data type header. Can be one of these possible values: \"UTF8\", + \"BINARY\". """ completion_state: str | None = None """ - Completion state header. Can be one of these possible values: "PARTIAL", - "COMPLETE". + Completion state header. Can be one of these possible values: + \"PARTIAL\", \"COMPLETE\". """ p: str | None = None - """ - Padding string for alignment. - """ + """Padding string for alignment.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_RESPONSE_PAYLOAD_PART, self) @@ -605,9 +574,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class ResponseStreamEventPayloadPart: - """ - Payload part event. - """ + """Payload part event.""" value: ResponsePayloadPart @@ -626,9 +593,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamEventModelStreamError: - """ - Model stream error event. - """ + """Model stream error event.""" value: ModelStreamError @@ -647,9 +612,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamEventInternalStreamFailure: - """ - Internal stream failure event. - """ + """Internal stream failure event.""" value: InternalStreamFailure @@ -668,7 +631,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class ResponseStreamEventUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -695,10 +659,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | ResponseStreamEventInternalStreamFailure | ResponseStreamEventUnknown ] - -""" -Response stream event union. -""" +"""Response stream event union.""" class _ResponseStreamEventDeserializer: @@ -741,10 +702,10 @@ def _set_result(self, value: ResponseStreamEvent) -> None: @dataclass(kw_only=True) class InvokeEndpointWithBidirectionalStreamOutput: + """Dataclass for InvokeEndpointWithBidirectionalStreamOutput structure.""" + invoked_production_variant: str | None = None - """ - The invoked production variant. - """ + """The invoked production variant.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct( @@ -788,31 +749,21 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ModelError(ServiceError): - """ - An error occurred while processing the model. - """ + """An error occurred while processing the model.""" fault: Literal["client", "server"] | None = "client" original_status_code: int | None = None - """ - HTTP status code returned by model. - """ + """HTTP status code returned by model.""" original_message: str | None = None - """ - Original error message from the model. - """ + """Original error message from the model.""" log_stream_arn: str | None = None - """ - CloudWatch log stream ARN. - """ + """CloudWatch log stream ARN.""" error_code: str | None = None - """ - Error code. - """ + """Error code.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_MODEL_ERROR, self) @@ -888,16 +839,12 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ServiceUnavailableError(ServiceError): - """ - The request has failed due to a temporary failure of the server. - """ + """The request has failed due to a temporary failure of the server.""" fault: Literal["client", "server"] | None = "server" error_code: str | None = None - """ - Error code. - """ + """Error code.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_SERVICE_UNAVAILABLE_ERROR, self) diff --git a/clients/aws-sdk-transcribe-streaming/docs/Makefile b/clients/aws-sdk-transcribe-streaming/docs/Makefile deleted file mode 100644 index 59458fa..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/Makefile +++ /dev/null @@ -1,15 +0,0 @@ -# Code generated by smithy-python-codegen DO NOT EDIT. - -SPHINXBUILD = sphinx-build -BUILDDIR = build -SERVICESDIR = source/reference/services -SPHINXOPTS = -j auto -ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(SPHINXOPTS) . - -clean: - -rm -rf $(BUILDDIR)/* - -html: - $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html - @echo - @echo "Build finished. The HTML pages are in $(BUILDDIR)/html." diff --git a/clients/aws-sdk-transcribe-streaming/docs/README.md b/clients/aws-sdk-transcribe-streaming/docs/README.md deleted file mode 100644 index 141b2c7..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/README.md +++ /dev/null @@ -1,10 +0,0 @@ -## Generating Documentation - -Sphinx is used for documentation. You can generate HTML locally with the -following: - -``` -$ uv pip install --group docs . -$ cd docs -$ make html -``` diff --git a/clients/aws-sdk-transcribe-streaming/docs/client/get_medical_scribe_stream.rst b/clients/aws-sdk-transcribe-streaming/docs/client/get_medical_scribe_stream.rst deleted file mode 100644 index 5fe7a3c..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/client/get_medical_scribe_stream.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -get_medical_scribe_stream -========================= - -.. automethod:: aws_sdk_transcribe_streaming.client.TranscribeStreamingClient.get_medical_scribe_stream - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.GetMedicalScribeStreamInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.GetMedicalScribeStreamOutput - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/client/index.rst b/clients/aws-sdk-transcribe-streaming/docs/client/index.rst deleted file mode 100644 index 371f32a..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/client/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Client -======= -.. toctree:: - :maxdepth: 1 - :titlesonly: - :glob: - - * diff --git a/clients/aws-sdk-transcribe-streaming/docs/client/start_call_analytics_stream_transcription.rst b/clients/aws-sdk-transcribe-streaming/docs/client/start_call_analytics_stream_transcription.rst deleted file mode 100644 index 25a0b14..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/client/start_call_analytics_stream_transcription.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -start_call_analytics_stream_transcription -========================================= - -.. automethod:: aws_sdk_transcribe_streaming.client.TranscribeStreamingClient.start_call_analytics_stream_transcription - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.StartCallAnalyticsStreamTranscriptionInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.StartCallAnalyticsStreamTranscriptionOutput - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/client/start_medical_scribe_stream.rst b/clients/aws-sdk-transcribe-streaming/docs/client/start_medical_scribe_stream.rst deleted file mode 100644 index d48c9f9..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/client/start_medical_scribe_stream.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -start_medical_scribe_stream -=========================== - -.. automethod:: aws_sdk_transcribe_streaming.client.TranscribeStreamingClient.start_medical_scribe_stream - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.StartMedicalScribeStreamInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.StartMedicalScribeStreamOutput - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/client/start_medical_stream_transcription.rst b/clients/aws-sdk-transcribe-streaming/docs/client/start_medical_stream_transcription.rst deleted file mode 100644 index 5adf99a..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/client/start_medical_stream_transcription.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -start_medical_stream_transcription -================================== - -.. automethod:: aws_sdk_transcribe_streaming.client.TranscribeStreamingClient.start_medical_stream_transcription - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.StartMedicalStreamTranscriptionInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.StartMedicalStreamTranscriptionOutput - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/client/start_stream_transcription.rst b/clients/aws-sdk-transcribe-streaming/docs/client/start_stream_transcription.rst deleted file mode 100644 index d910aca..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/client/start_stream_transcription.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -start_stream_transcription -========================== - -.. automethod:: aws_sdk_transcribe_streaming.client.TranscribeStreamingClient.start_stream_transcription - -.. toctree:: - :hidden: - :maxdepth: 2 - -================= -Input: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.StartStreamTranscriptionInput - :members: - -================= -Output: -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.StartStreamTranscriptionOutput - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/conf.py b/clients/aws-sdk-transcribe-streaming/docs/conf.py deleted file mode 100644 index e746b4c..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/conf.py +++ /dev/null @@ -1,24 +0,0 @@ -# Code generated by smithy-python-codegen DO NOT EDIT. - -import os -import sys - -sys.path.insert(0, os.path.abspath("..")) - -project = "Amazon Transcribe Streaming Service" -author = "Amazon Web Services" -release = "0.2.0" - -extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode"] - -templates_path = ["_templates"] -exclude_patterns = [] - -autodoc_default_options = { - "exclude-members": "deserialize,deserialize_kwargs,serialize,serialize_members" -} - -html_theme = "pydata_sphinx_theme" -html_theme_options = {"logo": {"text": "Amazon Transcribe Streaming Service"}} - -autodoc_typehints = "description" diff --git a/clients/aws-sdk-transcribe-streaming/docs/index.rst b/clients/aws-sdk-transcribe-streaming/docs/index.rst deleted file mode 100644 index 1b4bc25..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Amazon Transcribe Streaming Service -=================================== - -.. toctree:: - :maxdepth: 2 - :titlesonly: - :glob: - - */index diff --git a/clients/aws-sdk-transcribe-streaming/docs/make.bat b/clients/aws-sdk-transcribe-streaming/docs/make.bat deleted file mode 100644 index 3245132..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/make.bat +++ /dev/null @@ -1,35 +0,0 @@ -REM Code generated by smithy-python-codegen DO NOT EDIT. - -@ECHO OFF - -pushd %~dp0 - -REM Command file for Sphinx documentation - -if "%SPHINXBUILD%" == "" ( - set SPHINXBUILD=sphinx-build -) -set BUILDDIR=build -set SERVICESDIR=source/reference/services -set SPHINXOPTS=-j auto -set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% . - -if "%1" == "" goto help - -if "%1" == "clean" ( - rmdir /S /Q %BUILDDIR% - goto end -) - -if "%1" == "html" ( - %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html - echo. - echo "Build finished. The HTML pages are in %BUILDDIR%/html." - goto end -) - -:help -%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% - -:end -popd diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/Alternative.rst b/clients/aws-sdk-transcribe-streaming/docs/models/Alternative.rst deleted file mode 100644 index ee174ab..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/Alternative.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Alternative -=========== - -.. autoclass:: aws_sdk_transcribe_streaming.models.Alternative - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/AudioEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/AudioEvent.rst deleted file mode 100644 index 4bf335b..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/AudioEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -AudioEvent -========== - -.. autoclass:: aws_sdk_transcribe_streaming.models.AudioEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/AudioStream.rst b/clients/aws-sdk-transcribe-streaming/docs/models/AudioStream.rst deleted file mode 100644 index f4339e7..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/AudioStream.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _AudioStream: - -AudioStream -=========== - -.. autodata:: aws_sdk_transcribe_streaming.models.AudioStream diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamAudioEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamAudioEvent.rst deleted file mode 100644 index af2cb41..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamAudioEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _AudioStreamAudioEvent: - -AudioStreamAudioEvent -===================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.AudioStreamAudioEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamConfigurationEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamConfigurationEvent.rst deleted file mode 100644 index 7434ac7..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamConfigurationEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _AudioStreamConfigurationEvent: - -AudioStreamConfigurationEvent -============================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.AudioStreamConfigurationEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamUnknown.rst b/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamUnknown.rst deleted file mode 100644 index ce98717..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/AudioStreamUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _AudioStreamUnknown: - -AudioStreamUnknown -================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.AudioStreamUnknown diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/BadRequestException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/BadRequestException.rst deleted file mode 100644 index c576514..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/BadRequestException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -BadRequestException -=================== - -.. autoexception:: aws_sdk_transcribe_streaming.models.BadRequestException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsEntity.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsEntity.rst deleted file mode 100644 index b2250c4..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsEntity.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CallAnalyticsEntity -=================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsEntity - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsItem.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsItem.rst deleted file mode 100644 index 9f61e32..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsItem.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CallAnalyticsItem -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsItem - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsLanguageWithScore.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsLanguageWithScore.rst deleted file mode 100644 index c3e7cdd..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsLanguageWithScore.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CallAnalyticsLanguageWithScore -============================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsLanguageWithScore - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStream.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStream.rst deleted file mode 100644 index edd3755..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStream.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStream: - -CallAnalyticsTranscriptResultStream -=================================== - -.. autodata:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStream diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamBadRequestException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamBadRequestException.rst deleted file mode 100644 index 2857cf2..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamBadRequestException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStreamBadRequestException: - -CallAnalyticsTranscriptResultStreamBadRequestException -====================================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStreamBadRequestException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamCategoryEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamCategoryEvent.rst deleted file mode 100644 index c4d4441..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamCategoryEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStreamCategoryEvent: - -CallAnalyticsTranscriptResultStreamCategoryEvent -================================================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStreamCategoryEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamConflictException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamConflictException.rst deleted file mode 100644 index 7055f3f..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamConflictException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStreamConflictException: - -CallAnalyticsTranscriptResultStreamConflictException -==================================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStreamConflictException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamInternalFailureException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamInternalFailureException.rst deleted file mode 100644 index 733bc5f..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamInternalFailureException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStreamInternalFailureException: - -CallAnalyticsTranscriptResultStreamInternalFailureException -=========================================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStreamInternalFailureException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamLimitExceededException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamLimitExceededException.rst deleted file mode 100644 index 008ef72..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamLimitExceededException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStreamLimitExceededException: - -CallAnalyticsTranscriptResultStreamLimitExceededException -========================================================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStreamLimitExceededException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamServiceUnavailableException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamServiceUnavailableException.rst deleted file mode 100644 index 6853d26..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStreamServiceUnavailableException: - -CallAnalyticsTranscriptResultStreamServiceUnavailableException -============================================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStreamServiceUnavailableException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamUnknown.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamUnknown.rst deleted file mode 100644 index 62f8856..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStreamUnknown: - -CallAnalyticsTranscriptResultStreamUnknown -========================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStreamUnknown diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamUtteranceEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamUtteranceEvent.rst deleted file mode 100644 index e932f2a..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CallAnalyticsTranscriptResultStreamUtteranceEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _CallAnalyticsTranscriptResultStreamUtteranceEvent: - -CallAnalyticsTranscriptResultStreamUtteranceEvent -================================================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.CallAnalyticsTranscriptResultStreamUtteranceEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CategoryEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CategoryEvent.rst deleted file mode 100644 index 95606c4..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CategoryEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CategoryEvent -============= - -.. autoclass:: aws_sdk_transcribe_streaming.models.CategoryEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/ChannelDefinition.rst b/clients/aws-sdk-transcribe-streaming/docs/models/ChannelDefinition.rst deleted file mode 100644 index 2c2b54d..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/ChannelDefinition.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ChannelDefinition -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.ChannelDefinition - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/CharacterOffsets.rst b/clients/aws-sdk-transcribe-streaming/docs/models/CharacterOffsets.rst deleted file mode 100644 index 301b03a..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/CharacterOffsets.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -CharacterOffsets -================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.CharacterOffsets - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/ClinicalNoteGenerationResult.rst b/clients/aws-sdk-transcribe-streaming/docs/models/ClinicalNoteGenerationResult.rst deleted file mode 100644 index d569b4b..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/ClinicalNoteGenerationResult.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ClinicalNoteGenerationResult -============================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.ClinicalNoteGenerationResult - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/ClinicalNoteGenerationSettings.rst b/clients/aws-sdk-transcribe-streaming/docs/models/ClinicalNoteGenerationSettings.rst deleted file mode 100644 index 3ed0212..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/ClinicalNoteGenerationSettings.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ClinicalNoteGenerationSettings -============================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.ClinicalNoteGenerationSettings - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/ConfigurationEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/ConfigurationEvent.rst deleted file mode 100644 index ab14a02..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/ConfigurationEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConfigurationEvent -================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.ConfigurationEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/ConflictException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/ConflictException.rst deleted file mode 100644 index a2b0aff..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/ConflictException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ConflictException -================= - -.. autoexception:: aws_sdk_transcribe_streaming.models.ConflictException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/Entity.rst b/clients/aws-sdk-transcribe-streaming/docs/models/Entity.rst deleted file mode 100644 index 3285153..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/Entity.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Entity -====== - -.. autoclass:: aws_sdk_transcribe_streaming.models.Entity - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/InternalFailureException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/InternalFailureException.rst deleted file mode 100644 index 5037404..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/InternalFailureException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -InternalFailureException -======================== - -.. autoexception:: aws_sdk_transcribe_streaming.models.InternalFailureException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/IssueDetected.rst b/clients/aws-sdk-transcribe-streaming/docs/models/IssueDetected.rst deleted file mode 100644 index a697448..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/IssueDetected.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -IssueDetected -============= - -.. autoclass:: aws_sdk_transcribe_streaming.models.IssueDetected - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/Item.rst b/clients/aws-sdk-transcribe-streaming/docs/models/Item.rst deleted file mode 100644 index e4a6385..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/Item.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Item -==== - -.. autoclass:: aws_sdk_transcribe_streaming.models.Item - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/LanguageWithScore.rst b/clients/aws-sdk-transcribe-streaming/docs/models/LanguageWithScore.rst deleted file mode 100644 index 340adef..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/LanguageWithScore.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -LanguageWithScore -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.LanguageWithScore - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/LimitExceededException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/LimitExceededException.rst deleted file mode 100644 index d4c037a..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/LimitExceededException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -LimitExceededException -====================== - -.. autoexception:: aws_sdk_transcribe_streaming.models.LimitExceededException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalAlternative.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalAlternative.rst deleted file mode 100644 index d145a1d..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalAlternative.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalAlternative -================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalAlternative - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalEntity.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalEntity.rst deleted file mode 100644 index 5e2e50f..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalEntity.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalEntity -============= - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalEntity - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalItem.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalItem.rst deleted file mode 100644 index 0bc804e..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalItem.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalItem -=========== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalItem - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalResult.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalResult.rst deleted file mode 100644 index e7a7025..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalResult.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalResult -============= - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalResult - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeAudioEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeAudioEvent.rst deleted file mode 100644 index 26d7dea..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeAudioEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeAudioEvent -======================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeAudioEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeChannelDefinition.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeChannelDefinition.rst deleted file mode 100644 index 50417c9..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeChannelDefinition.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeChannelDefinition -============================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeChannelDefinition - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeConfigurationEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeConfigurationEvent.rst deleted file mode 100644 index bab62c1..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeConfigurationEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeConfigurationEvent -=============================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeConfigurationEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeContext.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeContext.rst deleted file mode 100644 index df72ef9..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeContext.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeContext -==================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeContext - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeEncryptionSettings.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeEncryptionSettings.rst deleted file mode 100644 index 4eae4d7..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeEncryptionSettings.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeEncryptionSettings -=============================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeEncryptionSettings - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStream.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStream.rst deleted file mode 100644 index 96c37ee..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStream.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeInputStream: - -MedicalScribeInputStream -======================== - -.. autodata:: aws_sdk_transcribe_streaming.models.MedicalScribeInputStream diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamAudioEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamAudioEvent.rst deleted file mode 100644 index 0a8229e..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamAudioEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeInputStreamAudioEvent: - -MedicalScribeInputStreamAudioEvent -================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeInputStreamAudioEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamConfigurationEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamConfigurationEvent.rst deleted file mode 100644 index 7a62924..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamConfigurationEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeInputStreamConfigurationEvent: - -MedicalScribeInputStreamConfigurationEvent -========================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeInputStreamConfigurationEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamSessionControlEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamSessionControlEvent.rst deleted file mode 100644 index 8900307..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamSessionControlEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeInputStreamSessionControlEvent: - -MedicalScribeInputStreamSessionControlEvent -=========================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeInputStreamSessionControlEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamUnknown.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamUnknown.rst deleted file mode 100644 index 063c2c3..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeInputStreamUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeInputStreamUnknown: - -MedicalScribeInputStreamUnknown -=============================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeInputStreamUnknown diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePatientContext.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePatientContext.rst deleted file mode 100644 index f73f6fe..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePatientContext.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribePatientContext -=========================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribePatientContext - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePostStreamAnalyticsResult.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePostStreamAnalyticsResult.rst deleted file mode 100644 index bf0f57f..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePostStreamAnalyticsResult.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribePostStreamAnalyticsResult -====================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribePostStreamAnalyticsResult - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePostStreamAnalyticsSettings.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePostStreamAnalyticsSettings.rst deleted file mode 100644 index 807ec06..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribePostStreamAnalyticsSettings.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribePostStreamAnalyticsSettings -======================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribePostStreamAnalyticsSettings - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStream.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStream.rst deleted file mode 100644 index 1833384..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStream.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeResultStream: - -MedicalScribeResultStream -========================= - -.. autodata:: aws_sdk_transcribe_streaming.models.MedicalScribeResultStream diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamBadRequestException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamBadRequestException.rst deleted file mode 100644 index c54f1b2..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamBadRequestException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeResultStreamBadRequestException: - -MedicalScribeResultStreamBadRequestException -============================================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeResultStreamBadRequestException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamConflictException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamConflictException.rst deleted file mode 100644 index 6eacead..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamConflictException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeResultStreamConflictException: - -MedicalScribeResultStreamConflictException -========================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeResultStreamConflictException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamInternalFailureException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamInternalFailureException.rst deleted file mode 100644 index 60731be..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamInternalFailureException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeResultStreamInternalFailureException: - -MedicalScribeResultStreamInternalFailureException -================================================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeResultStreamInternalFailureException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamLimitExceededException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamLimitExceededException.rst deleted file mode 100644 index 2b3ae11..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamLimitExceededException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeResultStreamLimitExceededException: - -MedicalScribeResultStreamLimitExceededException -=============================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeResultStreamLimitExceededException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamServiceUnavailableException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamServiceUnavailableException.rst deleted file mode 100644 index 23b9d09..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeResultStreamServiceUnavailableException: - -MedicalScribeResultStreamServiceUnavailableException -==================================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeResultStreamServiceUnavailableException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamTranscriptEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamTranscriptEvent.rst deleted file mode 100644 index 6c60845..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamTranscriptEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeResultStreamTranscriptEvent: - -MedicalScribeResultStreamTranscriptEvent -======================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeResultStreamTranscriptEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamUnknown.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamUnknown.rst deleted file mode 100644 index 42940ee..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeResultStreamUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalScribeResultStreamUnknown: - -MedicalScribeResultStreamUnknown -================================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeResultStreamUnknown diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeSessionControlEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeSessionControlEvent.rst deleted file mode 100644 index 3943c66..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeSessionControlEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeSessionControlEvent -================================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeSessionControlEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeStreamDetails.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeStreamDetails.rst deleted file mode 100644 index f55a4a4..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeStreamDetails.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeStreamDetails -========================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeStreamDetails - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptEvent.rst deleted file mode 100644 index 97d0f77..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeTranscriptEvent -============================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeTranscriptEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptItem.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptItem.rst deleted file mode 100644 index 0e6387e..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptItem.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeTranscriptItem -=========================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeTranscriptItem - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptSegment.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptSegment.rst deleted file mode 100644 index ea22bcb..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalScribeTranscriptSegment.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalScribeTranscriptSegment -============================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalScribeTranscriptSegment - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscript.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscript.rst deleted file mode 100644 index 86463a6..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscript.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalTranscript -================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscript - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptEvent.rst deleted file mode 100644 index 9b76292..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -MedicalTranscriptEvent -====================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscriptEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStream.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStream.rst deleted file mode 100644 index 66b7ed7..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStream.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalTranscriptResultStream: - -MedicalTranscriptResultStream -============================= - -.. autodata:: aws_sdk_transcribe_streaming.models.MedicalTranscriptResultStream diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamBadRequestException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamBadRequestException.rst deleted file mode 100644 index 805ea08..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamBadRequestException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalTranscriptResultStreamBadRequestException: - -MedicalTranscriptResultStreamBadRequestException -================================================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscriptResultStreamBadRequestException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamConflictException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamConflictException.rst deleted file mode 100644 index 1cc36bd..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamConflictException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalTranscriptResultStreamConflictException: - -MedicalTranscriptResultStreamConflictException -============================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscriptResultStreamConflictException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamInternalFailureException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamInternalFailureException.rst deleted file mode 100644 index 951bba5..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamInternalFailureException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalTranscriptResultStreamInternalFailureException: - -MedicalTranscriptResultStreamInternalFailureException -===================================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscriptResultStreamInternalFailureException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamLimitExceededException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamLimitExceededException.rst deleted file mode 100644 index dbef22b..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamLimitExceededException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalTranscriptResultStreamLimitExceededException: - -MedicalTranscriptResultStreamLimitExceededException -=================================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscriptResultStreamLimitExceededException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamServiceUnavailableException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamServiceUnavailableException.rst deleted file mode 100644 index c9fd5d8..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalTranscriptResultStreamServiceUnavailableException: - -MedicalTranscriptResultStreamServiceUnavailableException -======================================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscriptResultStreamServiceUnavailableException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamTranscriptEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamTranscriptEvent.rst deleted file mode 100644 index 3cbfb89..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamTranscriptEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalTranscriptResultStreamTranscriptEvent: - -MedicalTranscriptResultStreamTranscriptEvent -============================================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscriptResultStreamTranscriptEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamUnknown.rst b/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamUnknown.rst deleted file mode 100644 index dc72681..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/MedicalTranscriptResultStreamUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _MedicalTranscriptResultStreamUnknown: - -MedicalTranscriptResultStreamUnknown -==================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.MedicalTranscriptResultStreamUnknown diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/PointsOfInterest.rst b/clients/aws-sdk-transcribe-streaming/docs/models/PointsOfInterest.rst deleted file mode 100644 index f7bc7fe..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/PointsOfInterest.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -PointsOfInterest -================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.PointsOfInterest - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/PostCallAnalyticsSettings.rst b/clients/aws-sdk-transcribe-streaming/docs/models/PostCallAnalyticsSettings.rst deleted file mode 100644 index a8cb78a..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/PostCallAnalyticsSettings.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -PostCallAnalyticsSettings -========================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.PostCallAnalyticsSettings - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/ResourceNotFoundException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/ResourceNotFoundException.rst deleted file mode 100644 index ae64cbf..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/ResourceNotFoundException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ResourceNotFoundException -========================= - -.. autoexception:: aws_sdk_transcribe_streaming.models.ResourceNotFoundException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/Result.rst b/clients/aws-sdk-transcribe-streaming/docs/models/Result.rst deleted file mode 100644 index a887496..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/Result.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Result -====== - -.. autoclass:: aws_sdk_transcribe_streaming.models.Result - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/ServiceUnavailableException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/ServiceUnavailableException.rst deleted file mode 100644 index 8a2453b..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/ServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -ServiceUnavailableException -=========================== - -.. autoexception:: aws_sdk_transcribe_streaming.models.ServiceUnavailableException - :members: - :show-inheritance: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TimestampRange.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TimestampRange.rst deleted file mode 100644 index c1cb0ce..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TimestampRange.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -TimestampRange -============== - -.. autoclass:: aws_sdk_transcribe_streaming.models.TimestampRange - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/Transcript.rst b/clients/aws-sdk-transcribe-streaming/docs/models/Transcript.rst deleted file mode 100644 index a9d97b2..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/Transcript.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Transcript -========== - -.. autoclass:: aws_sdk_transcribe_streaming.models.Transcript - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptEvent.rst deleted file mode 100644 index 799f1fc..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -TranscriptEvent -=============== - -.. autoclass:: aws_sdk_transcribe_streaming.models.TranscriptEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStream.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStream.rst deleted file mode 100644 index 2e11dc5..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStream.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _TranscriptResultStream: - -TranscriptResultStream -====================== - -.. autodata:: aws_sdk_transcribe_streaming.models.TranscriptResultStream diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamBadRequestException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamBadRequestException.rst deleted file mode 100644 index 245f4f7..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamBadRequestException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _TranscriptResultStreamBadRequestException: - -TranscriptResultStreamBadRequestException -========================================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.TranscriptResultStreamBadRequestException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamConflictException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamConflictException.rst deleted file mode 100644 index e024b7c..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamConflictException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _TranscriptResultStreamConflictException: - -TranscriptResultStreamConflictException -======================================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.TranscriptResultStreamConflictException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamInternalFailureException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamInternalFailureException.rst deleted file mode 100644 index 9fcc830..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamInternalFailureException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _TranscriptResultStreamInternalFailureException: - -TranscriptResultStreamInternalFailureException -============================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.TranscriptResultStreamInternalFailureException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamLimitExceededException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamLimitExceededException.rst deleted file mode 100644 index 2d8031b..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamLimitExceededException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _TranscriptResultStreamLimitExceededException: - -TranscriptResultStreamLimitExceededException -============================================ - -.. autoclass:: aws_sdk_transcribe_streaming.models.TranscriptResultStreamLimitExceededException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamServiceUnavailableException.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamServiceUnavailableException.rst deleted file mode 100644 index b8a988a..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamServiceUnavailableException.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _TranscriptResultStreamServiceUnavailableException: - -TranscriptResultStreamServiceUnavailableException -================================================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.TranscriptResultStreamServiceUnavailableException diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamTranscriptEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamTranscriptEvent.rst deleted file mode 100644 index 30e1562..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamTranscriptEvent.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _TranscriptResultStreamTranscriptEvent: - -TranscriptResultStreamTranscriptEvent -===================================== - -.. autoclass:: aws_sdk_transcribe_streaming.models.TranscriptResultStreamTranscriptEvent diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamUnknown.rst b/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamUnknown.rst deleted file mode 100644 index 5e07d9c..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/TranscriptResultStreamUnknown.rst +++ /dev/null @@ -1,9 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -.. _TranscriptResultStreamUnknown: - -TranscriptResultStreamUnknown -============================= - -.. autoclass:: aws_sdk_transcribe_streaming.models.TranscriptResultStreamUnknown diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/UtteranceEvent.rst b/clients/aws-sdk-transcribe-streaming/docs/models/UtteranceEvent.rst deleted file mode 100644 index 4009e0c..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/UtteranceEvent.rst +++ /dev/null @@ -1,8 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -UtteranceEvent -============== - -.. autoclass:: aws_sdk_transcribe_streaming.models.UtteranceEvent - :members: diff --git a/clients/aws-sdk-transcribe-streaming/docs/models/index.rst b/clients/aws-sdk-transcribe-streaming/docs/models/index.rst deleted file mode 100644 index c403929..0000000 --- a/clients/aws-sdk-transcribe-streaming/docs/models/index.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. - Code generated by smithy-python-codegen DO NOT EDIT. - -Models -======= -.. toctree:: - :maxdepth: 1 - :titlesonly: - :glob: - - * diff --git a/clients/aws-sdk-transcribe-streaming/pyproject.toml b/clients/aws-sdk-transcribe-streaming/pyproject.toml index 17e258a..ed871d6 100644 --- a/clients/aws-sdk-transcribe-streaming/pyproject.toml +++ b/clients/aws-sdk-transcribe-streaming/pyproject.toml @@ -1,6 +1,5 @@ # Code generated by smithy-python-codegen DO NOT EDIT. - [project] name = "aws_sdk_transcribe_streaming" version = "0.2.0" @@ -35,21 +34,10 @@ test = [ "pytest-asyncio>=0.20.3,<0.21.0" ] -docs = [ - "pydata-sphinx-theme>=0.16.1", - "sphinx>=8.2.3" -] - [build-system] requires = ["hatchling"] build-backend = "hatchling.build" -[tool.hatch.build.targets.bdist] -exclude = [ - "tests", - "docs", -] - [tool.pyright] typeCheckingMode = "strict" reportPrivateUsage = false diff --git a/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/client.py b/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/client.py index d8155f9..4cdd33e 100644 --- a/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/client.py +++ b/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/client.py @@ -48,26 +48,41 @@ class TranscribeStreamingClient: """ - Amazon Transcribe streaming offers four main types of real-time transcription: **Standard**, **Medical**, **Call Analytics**, and **Health Scribe**. + Amazon Transcribe streaming offers four main types of real-time + transcription: **Standard**, **Medical**, **Call Analytics**, and + **Health Scribe**. - * **Standard transcriptions** are the most common option. Refer to for details. + - **Standard transcriptions** are the most common option. Refer to for + details. - * **Medical transcriptions** are tailored to medical professionals and incorporate medical terms. A common use case for this service is transcribing doctor-patient dialogue in real time, so doctors can focus on their patient instead of taking notes. Refer to for details. + - **Medical transcriptions** are tailored to medical professionals and + incorporate medical terms. A common use case for this service is + transcribing doctor-patient dialogue in real time, so doctors can + focus on their patient instead of taking notes. Refer to for details. - * **Call Analytics transcriptions** are designed for use with call center audio on two different channels; if you're looking for insight into customer service calls, use this option. Refer to for details. + - **Call Analytics transcriptions** are designed for use with call + center audio on two different channels; if you're looking for insight + into customer service calls, use this option. Refer to for details. - * **HealthScribe transcriptions** are designed to automatically create clinical notes from patient-clinician conversations using generative AI. Refer to [here] for details. - - :param config: Optional configuration for the client. Here you can set things like the - endpoint for HTTP services or auth credentials. - - :param plugins: A list of callables that modify the configuration dynamically. These - can be used to set defaults, for example. + - **HealthScribe transcriptions** are designed to automatically create + clinical notes from patient-clinician conversations using generative + AI. Refer to [here] for details. """ def __init__( self, config: Config | None = None, plugins: list[Plugin] | None = None ): + """ + Constructor for `TranscribeStreamingClient`. + + Args: + config: + Optional configuration for the client. Here you can set things like + the endpoint for HTTP services or auth credentials. + plugins: + A list of callables that modify the configuration dynamically. These + can be used to set defaults, for example. + """ self._config = config or Config() client_plugins: list[Plugin] = [aws_user_agent_plugin, user_agent_plugin] @@ -83,16 +98,23 @@ async def get_medical_scribe_stream( self, input: GetMedicalScribeStreamInput, plugins: list[Plugin] | None = None ) -> GetMedicalScribeStreamOutput: """ - Provides details about the specified Amazon Web Services HealthScribe streaming - session. To view the status of the streaming session, check the ``StreamStatus`` - field in the response. To get the details of post-stream analytics, including - its status, check the ``PostStreamAnalyticsResult`` field in the response. - - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Provides details about the specified Amazon Web Services HealthScribe + streaming session. To view the status of the streaming session, check + the `StreamStatus` field in the response. To get the details of + post-stream analytics, including its status, check the + `PostStreamAnalyticsResult` field in the response. + + Args: + input: + An instance of `GetMedicalScribeStreamInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + An instance of `GetMedicalScribeStreamOutput`. """ operation_plugins: list[Plugin] = [] if plugins: @@ -146,27 +168,35 @@ async def start_call_analytics_stream_transcription( StartCallAnalyticsStreamTranscriptionOutput, ]: """ - Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to - Amazon Transcribe and the transcription results are streamed to your - application. Use this operation for `Call Analytics `_ + Starts a bidirectional HTTP/2 or WebSocket stream where audio is + streamed to Amazon Transcribe and the transcription results are streamed + to your application. Use this operation for [Call + Analytics](https://docs.aws.amazon.com/transcribe/latest/dg/call-analytics.html) transcriptions. The following parameters are required: - * ``language-code`` or ``identify-language`` + - `language-code` or `identify-language` - * ``media-encoding`` + - `media-encoding` - * ``sample-rate`` + - `sample-rate` - For more information on streaming with Amazon Transcribe, see `Transcribing streaming audio `_ - . + For more information on streaming with Amazon Transcribe, see + [Transcribing streaming + audio](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). - :param input: The operation's input. + Args: + input: + An instance of `StartCallAnalyticsStreamTranscriptionInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Returns: + A `DuplexEventStream` for bidirectional streaming. """ operation_plugins: list[Plugin] = [] if plugins: @@ -223,48 +253,55 @@ async def start_medical_scribe_stream( StartMedicalScribeStreamOutput, ]: """ - Starts a bidirectional HTTP/2 stream, where audio is streamed to Amazon Web - Services HealthScribe and the transcription results are streamed to your - application. + Starts a bidirectional HTTP/2 stream, where audio is streamed to Amazon + Web Services HealthScribe and the transcription results are streamed to + your application. When you start a stream, you first specify the stream configuration in a - ``MedicalScribeConfigurationEvent``. This event includes channel definitions, - encryption settings, medical scribe context, and post-stream analytics settings, - such as the output configuration for aggregated transcript and clinical note - generation. These are additional streaming session configurations beyond those - provided in your initial start request headers. Whether you are starting a new - session or resuming an existing session, your first event must be a - ``MedicalScribeConfigurationEvent``. - - After you send a ``MedicalScribeConfigurationEvent``, you start ``AudioEvents`` - and Amazon Web Services HealthScribe responds with real-time transcription - results. When you are finished, to start processing the results with the - post-stream analytics, send a ``MedicalScribeSessionControlEvent`` with a - ``Type`` of ``END_OF_SESSION`` and Amazon Web Services HealthScribe starts the - analytics. - - You can pause or resume streaming. To pause streaming, complete the input stream - without sending the ``MedicalScribeSessionControlEvent``. To resume streaming, - call the ``StartMedicalScribeStream`` and specify the same SessionId you used to - start the stream. + `MedicalScribeConfigurationEvent`. This event includes channel + definitions, encryption settings, medical scribe context, and + post-stream analytics settings, such as the output configuration for + aggregated transcript and clinical note generation. These are additional + streaming session configurations beyond those provided in your initial + start request headers. Whether you are starting a new session or + resuming an existing session, your first event must be a + `MedicalScribeConfigurationEvent`. + + After you send a `MedicalScribeConfigurationEvent`, you start + `AudioEvents` and Amazon Web Services HealthScribe responds with + real-time transcription results. When you are finished, to start + processing the results with the post-stream analytics, send a + `MedicalScribeSessionControlEvent` with a `Type` of `END_OF_SESSION` and + Amazon Web Services HealthScribe starts the analytics. + + You can pause or resume streaming. To pause streaming, complete the + input stream without sending the `MedicalScribeSessionControlEvent`. To + resume streaming, call the `StartMedicalScribeStream` and specify the + same SessionId you used to start the stream. The following parameters are required: - * ``language-code`` + - `language-code` - * ``media-encoding`` + - `media-encoding` - * ``media-sample-rate-hertz`` + - `media-sample-rate-hertz` - For more information on streaming with Amazon Web Services HealthScribe, see - `Amazon Web Services HealthScribe `_ - . + For more information on streaming with Amazon Web Services HealthScribe, + see [Amazon Web Services + HealthScribe](https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html). - :param input: The operation's input. + Args: + input: + An instance of `StartMedicalScribeStreamInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Returns: + A `DuplexEventStream` for bidirectional streaming. """ operation_plugins: list[Plugin] = [] if plugins: @@ -323,27 +360,33 @@ async def start_medical_stream_transcription( StartMedicalStreamTranscriptionOutput, ]: """ - Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to - Amazon Transcribe Medical and the transcription results are streamed to your - application. + Starts a bidirectional HTTP/2 or WebSocket stream where audio is + streamed to Amazon Transcribe Medical and the transcription results are + streamed to your application. The following parameters are required: - * ``language-code`` + - `language-code` - * ``media-encoding`` + - `media-encoding` - * ``sample-rate`` + - `sample-rate` For more information on streaming with Amazon Transcribe Medical, see - `Transcribing streaming audio `_ - . - - :param input: The operation's input. - - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + [Transcribing streaming + audio](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). + + Args: + input: + An instance of `StartMedicalStreamTranscriptionInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. + + Returns: + A `DuplexEventStream` for bidirectional streaming. """ operation_plugins: list[Plugin] = [] if plugins: @@ -398,26 +441,33 @@ async def start_stream_transcription( AudioStream, TranscriptResultStream, StartStreamTranscriptionOutput ]: """ - Starts a bidirectional HTTP/2 or WebSocket stream where audio is streamed to - Amazon Transcribe and the transcription results are streamed to your - application. + Starts a bidirectional HTTP/2 or WebSocket stream where audio is + streamed to Amazon Transcribe and the transcription results are streamed + to your application. The following parameters are required: - * ``language-code`` or ``identify-language`` or ``identify-multiple-language`` + - `language-code` or `identify-language` or `identify-multiple-language` - * ``media-encoding`` + - `media-encoding` - * ``sample-rate`` + - `sample-rate` - For more information on streaming with Amazon Transcribe, see `Transcribing streaming audio `_ - . + For more information on streaming with Amazon Transcribe, see + [Transcribing streaming + audio](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). - :param input: The operation's input. + Args: + input: + An instance of `StartStreamTranscriptionInput`. + plugins: + A list of callables that modify the configuration dynamically. + Changes made by these plugins only apply for the duration of the + operation execution and will not affect any other operation + invocations. - :param plugins: A list of callables that modify the configuration dynamically. - Changes made by these plugins only apply for the duration of the operation - execution and will not affect any other operation invocations. + Returns: + A `DuplexEventStream` for bidirectional streaming. """ operation_plugins: list[Plugin] = [] if plugins: diff --git a/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/config.py b/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/config.py index 054c513..09d28bf 100644 --- a/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/config.py +++ b/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/config.py @@ -68,23 +68,72 @@ class Config: """Configuration for Transcribe Streaming.""" auth_scheme_resolver: HTTPAuthSchemeResolver + """ + An auth scheme resolver that determines the auth scheme for each + operation. + """ + auth_schemes: dict[ShapeID, AuthScheme[Any, Any, Any, Any]] + """A map of auth scheme ids to auth schemes.""" + aws_access_key_id: str | None + """The identifier for a secret access key.""" + aws_credentials_identity_resolver: ( IdentityResolver[AWSCredentialsIdentity, AWSIdentityProperties] | None ) + """Resolves AWS Credentials. Required for operations that use Sigv4 Auth.""" + aws_secret_access_key: str | None + """A secret access key that can be used to sign requests.""" + aws_session_token: str | None + """An access key ID that identifies temporary security credentials.""" + endpoint_resolver: _EndpointResolver + """ + The endpoint resolver used to resolve the final endpoint per-operation + based on the configuration. + """ + endpoint_uri: str | URI | None + """A static URI to route requests to.""" + http_request_config: HTTPRequestConfiguration | None + """Configuration for individual HTTP requests.""" + interceptors: list[_ServiceInterceptor] + """ + The list of interceptors, which are hooks that are called during the + execution of a request. + """ + protocol: ClientProtocol[Any, Any] | None + """The protocol to serialize and deserialize requests with.""" + region: str | None + """ + The AWS region to connect to. The configured region is used to determine + the service endpoint. + """ + retry_strategy: RetryStrategy | RetryStrategyOptions | None + """ + The retry strategy or options for configuring retry behavior. Can be + either a configured RetryStrategy or RetryStrategyOptions to create one. + """ + sdk_ua_app_id: str | None + """ + A unique and opaque application ID that is appended to the User-Agent + header. + """ + transport: ClientTransport[Any, Any] | None + """The transport to use to send requests (e.g. an HTTP client).""" + user_agent_extra: str | None + """Additional suffix to be added to the User-Agent header.""" def __init__( self, @@ -109,61 +158,6 @@ def __init__( transport: ClientTransport[Any, Any] | None = None, user_agent_extra: str | None = None, ): - """ - Constructor. - - :param auth_scheme_resolver: - An auth scheme resolver that determines the auth scheme for each operation. - - :param auth_schemes: - A map of auth scheme ids to auth schemes. - - :param aws_access_key_id: - The identifier for a secret access key. - - :param aws_credentials_identity_resolver: - Resolves AWS Credentials. Required for operations that use Sigv4 Auth. - - :param aws_secret_access_key: - A secret access key that can be used to sign requests. - - :param aws_session_token: - An access key ID that identifies temporary security credentials. - - :param endpoint_resolver: - The endpoint resolver used to resolve the final endpoint per-operation based on - the configuration. - - :param endpoint_uri: - A static URI to route requests to. - - :param http_request_config: - Configuration for individual HTTP requests. - - :param interceptors: - The list of interceptors, which are hooks that are called during the execution - of a request. - - :param protocol: - The protocol to serialize and deserialize requests with. - - :param region: - The AWS region to connect to. The configured region is used to determine the - service endpoint. - - :param retry_strategy: - The retry strategy or options for configuring retry behavior. Can be either a - configured RetryStrategy or RetryStrategyOptions to create one. - - :param sdk_ua_app_id: - A unique and opaque application ID that is appended to the User-Agent header. - - :param transport: - The transport to use to send requests (e.g. an HTTP client). - - :param user_agent_extra: - Additional suffix to be added to the User-Agent header. - """ self.auth_scheme_resolver = auth_scheme_resolver or HTTPAuthSchemeResolver() self.auth_schemes = auth_schemes or { ShapeID("aws.auth#sigv4"): SigV4AuthScheme(service="transcribe") @@ -186,16 +180,17 @@ def __init__( self.user_agent_extra = user_agent_extra def set_auth_scheme(self, scheme: AuthScheme[Any, Any, Any, Any]) -> None: - """Sets the implementation of an auth scheme. + """ + Sets the implementation of an auth scheme. Using this method ensures the correct key is used. - :param scheme: The auth scheme to add. + Args: + scheme: + The auth scheme to add. """ self.auth_schemes[scheme.scheme_id] = scheme -# -# A callable that allows customizing the config object on each request. -# Plugin: TypeAlias = Callable[[Config], None] +"""A callable that allows customizing the config object on each request.""" diff --git a/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/models.py b/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/models.py index be1d07f..658f8b7 100644 --- a/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/models.py +++ b/clients/aws-sdk-transcribe-streaming/src/aws_sdk_transcribe_streaming/models.py @@ -89,7 +89,8 @@ class ServiceError(ModeledError): - """Base error for all errors in the service. + """ + Base error for all errors in the service. Some exceptions do not extend from this class, including synthetic, implicit, and shared exception types. @@ -99,46 +100,44 @@ class ServiceError(ModeledError): @dataclass(kw_only=True) class Entity: """ - Contains entities identified as personally identifiable information (PII) in - your transcription output, along with various associated attributes. Examples - include category, confidence score, type, stability score, and start and end - times. + Contains entities identified as personally identifiable information + (PII) in your transcription output, along with various associated + attributes. Examples include category, confidence score, type, stability + score, and start and end times. """ start_time: float = 0 """ - The start time of the utterance that was identified as PII in seconds, with - millisecond precision (e.g., 1.056) + The start time of the utterance that was identified as PII in seconds, + with millisecond precision (e.g., 1.056) """ end_time: float = 0 """ - The end time of the utterance that was identified as PII in seconds, with - millisecond precision (e.g., 1.056) + The end time of the utterance that was identified as PII in seconds, + with millisecond precision (e.g., 1.056) """ category: str | None = None - """ - The category of information identified. The only category is ``PII``. - """ + """The category of information identified. The only category is `PII`.""" type: str | None = None """ - The type of PII identified. For example, ``NAME`` or ``CREDIT_DEBIT_NUMBER``. + The type of PII identified. For example, `NAME` or + `CREDIT_DEBIT_NUMBER`. """ content: str | None = None - """ - The word or words identified as PII. - """ + """The word or words identified as PII.""" confidence: float | None = None """ - The confidence score associated with the identified PII entity in your audio. + The confidence score associated with the identified PII entity in your + audio. - Confidence scores are values between 0 and 1. A larger value indicates a higher - probability that the identified entity correctly matches the entity spoken in - your media. + Confidence scores are values between 0 and 1. A larger value indicates a + higher probability that the identified entity correctly matches the + entity spoken in your media. """ def serialize(self, serializer: ShapeSerializer): @@ -239,60 +238,60 @@ class ItemType(StrEnum): @dataclass(kw_only=True) class Item: """ - A word, phrase, or punctuation mark in your transcription output, along with - various associated attributes, such as confidence score, type, and start and end - times. + A word, phrase, or punctuation mark in your transcription output, along + with various associated attributes, such as confidence score, type, and + start and end times. """ start_time: float = 0 """ - The start time of the transcribed item in seconds, with millisecond precision - (e.g., 1.056) + The start time of the transcribed item in seconds, with millisecond + precision (e.g., 1.056) """ end_time: float = 0 """ - The end time of the transcribed item in seconds, with millisecond precision - (e.g., 1.056) + The end time of the transcribed item in seconds, with millisecond + precision (e.g., 1.056) """ type: str | None = None """ - The type of item identified. Options are: ``PRONUNCIATION`` (spoken words) and - ``PUNCTUATION``. + The type of item identified. Options are: `PRONUNCIATION` (spoken words) + and `PUNCTUATION`. """ content: str | None = None - """ - The word or punctuation that was transcribed. - """ + """The word or punctuation that was transcribed.""" vocabulary_filter_match: bool = False """ - Indicates whether the specified item matches a word in the vocabulary filter - included in your request. If ``true``, there is a vocabulary filter match. + Indicates whether the specified item matches a word in the vocabulary + filter included in your request. If `true`, there is a vocabulary filter + match. """ speaker: str | None = None """ - If speaker partitioning is enabled, ``Speaker`` labels the speaker of the + If speaker partitioning is enabled, `Speaker` labels the speaker of the specified item. """ confidence: float | None = None """ - The confidence score associated with a word or phrase in your transcript. + The confidence score associated with a word or phrase in your + transcript. - Confidence scores are values between 0 and 1. A larger value indicates a higher - probability that the identified item correctly matches the item spoken in your - media. + Confidence scores are values between 0 and 1. A larger value indicates a + higher probability that the identified item correctly matches the item + spoken in your media. """ stable: bool | None = None """ - If partial result stabilization is enabled, ``Stable`` indicates whether the - specified item is stable (``true``) or if it may change when the segment is - complete (``false``). + If partial result stabilization is enabled, `Stable` indicates whether + the specified item is stable (`true`) or if it may change when the + segment is complete (`false`). """ def serialize(self, serializer: ShapeSerializer): @@ -395,24 +394,23 @@ def _read_value(d: ShapeDeserializer): class Alternative: """ A list of possible alternative transcriptions for the input audio. Each - alternative may contain one or more of ``Items``, ``Entities``, or - ``Transcript``. + alternative may contain one or more of `Items`, `Entities`, or + `Transcript`. """ transcript: str | None = None - """ - Contains transcribed text. - """ + """Contains transcribed text.""" items: list[Item] | None = None """ - Contains words, phrases, or punctuation marks in your transcription output. + Contains words, phrases, or punctuation marks in your transcription + output. """ entities: list[Entity] | None = None """ - Contains entities identified as personally identifiable information (PII) in - your transcription output. + Contains entities identified as personally identifiable information + (PII) in your transcription output. """ def serialize(self, serializer: ShapeSerializer): @@ -494,30 +492,30 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class AudioEvent: """ - A wrapper for your audio chunks. Your audio stream consists of one or more audio - events, which consist of one or more audio chunks. + A wrapper for your audio chunks. Your audio stream consists of one or + more audio events, which consist of one or more audio chunks. - For more information, see ``Event stream encoding ``_ - . + For more information, see [Event stream + encoding](https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html). """ audio_chunk: bytes | None = None """ - An audio blob containing the next segment of audio from your application, with a - maximum duration of 1 second. The maximum size in bytes varies based on audio - properties. + An audio blob containing the next segment of audio from your + application, with a maximum duration of 1 second. The maximum size in + bytes varies based on audio properties. - Find recommended size in `Transcribing streaming best practices `_ - . + Find recommended size in [Transcribing streaming best + practices](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#best-practices). - Size calculation: ``Duration (s) * Sample Rate (Hz) * Number of Channels * 2 - (Bytes per Sample)`` + Size calculation: + `Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample)` - For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be ``1 * - 16000 * 2 * 2 = 64000 bytes``. + For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would + be `1 * 16000 * 2 * 2 = 64000 bytes`. - For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be ``1 * 8000 * 1 * 2 - = 16000 bytes``. + For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be + `1 * 8000 * 1 * 2 = 16000 bytes`. """ def serialize(self, serializer: ShapeSerializer): @@ -559,22 +557,21 @@ class ParticipantRole(StrEnum): @dataclass(kw_only=True) class ChannelDefinition: """ - Makes it possible to specify which speaker is on which audio channel. For - example, if your agent is the first participant to speak, you would set - ``ChannelId`` to ``0`` (to indicate the first channel) and ``ParticipantRole`` - to ``AGENT`` (to indicate that it's the agent speaking). + Makes it possible to specify which speaker is on which audio channel. + For example, if your agent is the first participant to speak, you would + set `ChannelId` to `0` (to indicate the first channel) and + `ParticipantRole` to `AGENT` (to indicate that it's the agent + speaking). """ participant_role: str """ - Specify the speaker you want to define. Omitting this parameter is equivalent to - specifying both participants. + Specify the speaker you want to define. Omitting this parameter is + equivalent to specifying both participants. """ channel_id: int = 0 - """ - Specify the audio channel you want to define. - """ + """Specify the audio channel you want to define.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_CHANNEL_DEFINITION, self) @@ -647,81 +644,86 @@ class ContentRedactionOutput(StrEnum): @dataclass(kw_only=True) class PostCallAnalyticsSettings: """ - Allows you to specify additional settings for your Call Analytics post-call - request, including output locations for your redacted transcript, which IAM role - to use, and which encryption key to use. + Allows you to specify additional settings for your Call Analytics + post-call request, including output locations for your redacted + transcript, which IAM role to use, and which encryption key to use. - ``DataAccessRoleArn`` and ``OutputLocation`` are required fields. + `DataAccessRoleArn` and `OutputLocation` are required fields. - ``PostCallAnalyticsSettings`` provides you with the same insights as a Call Analytics post-call transcription. Refer to ``Post-call analytics ``_ + `PostCallAnalyticsSettings` provides you with the same insights as a + Call Analytics post-call transcription. Refer to [Post-call + analytics](https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html) for more information on this feature. """ output_location: str """ The Amazon S3 location where you want your Call Analytics post-call - transcription output stored. You can use any of the following formats to specify - the output location: + transcription output stored. You can use any of the following formats to + specify the output location: - * s3://DOC-EXAMPLE-BUCKET + 1. s3://DOC-EXAMPLE-BUCKET - * s3://DOC-EXAMPLE-BUCKET/my-output-folder/ + 2. s3://DOC-EXAMPLE-BUCKET/my-output-folder/ - * s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json + 3. s3://DOC-EXAMPLE-BUCKET/my-output-folder/my-call-analytics-job.json """ data_access_role_arn: str """ - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - Amazon S3 bucket that contains your input files. If the role that you specify - doesn’t have the appropriate permissions to access the specified Amazon S3 - location, your request fails. + The Amazon Resource Name (ARN) of an IAM role that has permissions to + access the Amazon S3 bucket that contains your input files. If the role + that you specify doesn't have the appropriate permissions to access the + specified Amazon S3 location, your request fails. IAM role ARNs have the format - ``arn:partition:iam::account:role/role-name-with-path``. For example: ``arn:aws:iam::111122223333:role/Admin``. For more information, see `IAM ARNs `_ - . + `arn:partition:iam::account:role/role-name-with-path`. For example: + `arn:aws:iam::111122223333:role/Admin`. For more information, see [IAM + ARNs](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_identifiers.html#identifiers-arns). """ content_redaction_output: str | None = None """ - Specify whether you want only a redacted transcript or both a redacted and an - unredacted transcript. If you choose redacted and unredacted, two JSON files are - generated and stored in the Amazon S3 output location you specify. + Specify whether you want only a redacted transcript or both a redacted + and an unredacted transcript. If you choose redacted and unredacted, two + JSON files are generated and stored in the Amazon S3 output location you + specify. - Note that to include ``ContentRedactionOutput`` in your request, you must enable - content redaction (``ContentRedactionType``). + Note that to include `ContentRedactionOutput` in your request, you must + enable content redaction (`ContentRedactionType`). """ output_encryption_kms_key_id: str | None = None """ - The KMS key you want to use to encrypt your Call Analytics post-call output. + The KMS key you want to use to encrypt your Call Analytics post-call + output. - If using a key located in the **current** Amazon Web Services account, you can - specify your KMS key in one of four ways: + If using a key located in the **current** Amazon Web Services account, + you can specify your KMS key in one of four ways: - * Use the KMS key ID itself. For example, - ``1234abcd-12ab-34cd-56ef-1234567890ab``. + 1. Use the KMS key ID itself. For example, + `1234abcd-12ab-34cd-56ef-1234567890ab`. - * Use an alias for the KMS key ID. For example, ``alias/ExampleAlias``. + 2. Use an alias for the KMS key ID. For example, `alias/ExampleAlias`. - * Use the Amazon Resource Name (ARN) for the KMS key ID. For example, - ``arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + 3. Use the Amazon Resource Name (ARN) for the KMS key ID. For example, + `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`. - * Use the ARN for the KMS key alias. For example, - ``arn:aws:kms:region:account-ID:alias/ExampleAlias``. + 4. Use the ARN for the KMS key alias. For example, + `arn:aws:kms:region:account-ID:alias/ExampleAlias`. - If using a key located in a **different** Amazon Web Services account than the - current Amazon Web Services account, you can specify your KMS key in one of two - ways: + If using a key located in a **different** Amazon Web Services account + than the current Amazon Web Services account, you can specify your KMS + key in one of two ways: - * Use the ARN for the KMS key ID. For example, - ``arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab``. + 1. Use the ARN for the KMS key ID. For example, + `arn:aws:kms:region:account-ID:key/1234abcd-12ab-34cd-56ef-1234567890ab`. - * Use the ARN for the KMS key alias. For example, - ``arn:aws:kms:region:account-ID:alias/ExampleAlias``. + 2. Use the ARN for the KMS key alias. For example, + `arn:aws:kms:region:account-ID:alias/ExampleAlias`. - Note that the role making the request must have permission to use the specified - KMS key. + Note that the role making the request must have permission to use the + specified KMS key. """ def serialize(self, serializer: ShapeSerializer): @@ -798,20 +800,22 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConfigurationEvent: """ - Allows you to set audio channel definitions and post-call analytics settings. + Allows you to set audio channel definitions and post-call analytics + settings. """ channel_definitions: list[ChannelDefinition] | None = None - """ - Indicates which speaker is on which audio channel. - """ + """Indicates which speaker is on which audio channel.""" post_call_analytics_settings: PostCallAnalyticsSettings | None = None """ - Provides additional optional settings for your Call Analytics post-call request, - including encryption and output locations for your redacted transcript. + Provides additional optional settings for your Call Analytics post-call + request, including encryption and output locations for your redacted + transcript. - ``PostCallAnalyticsSettings`` provides you with the same insights as a Call Analytics post-call transcription. Refer to `Post-call analytics `_ + `PostCallAnalyticsSettings` provides you with the same insights as a + Call Analytics post-call transcription. Refer to [Post-call + analytics](https://docs.aws.amazon.com/transcribe/latest/dg/tca-post-call.html) for more information on this feature. """ @@ -862,11 +866,11 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class AudioStreamAudioEvent: """ - A blob of audio from your application. Your audio stream consists of one or more - audio events. + A blob of audio from your application. Your audio stream consists of one + or more audio events. - For more information, see `Event stream encoding `_ - . + For more information, see [Event stream + encoding](https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html). """ value: AudioEvent @@ -884,9 +888,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class AudioStreamConfigurationEvent: - """ - Contains audio channel definitions and post-call analytics settings. - """ + """Contains audio channel definitions and post-call analytics settings.""" value: ConfigurationEvent @@ -905,7 +907,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class AudioStreamUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -929,13 +932,12 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: AudioStream = Union[ AudioStreamAudioEvent | AudioStreamConfigurationEvent | AudioStreamUnknown ] - """ -An encoded stream of audio blobs. Audio streams are encoded as either HTTP/2 or -WebSocket data frames. +An encoded stream of audio blobs. Audio streams are encoded as either +HTTP/2 or WebSocket data frames. -For more information, see `Transcribing streaming audio `_ -. +For more information, see [Transcribing streaming +audio](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html). """ @@ -975,11 +977,11 @@ def _set_result(self, value: AudioStream) -> None: @dataclass(kw_only=True) class BadRequestException(ServiceError): """ - One or more arguments to the ``StartStreamTranscription``, - ``StartMedicalStreamTranscription``, or - ``StartCallAnalyticsStreamTranscription`` operation was not valid. For example, - ``MediaEncoding`` or ``LanguageCode`` used unsupported values. Check the - specified parameters and try your request again. + One or more arguments to the `StartStreamTranscription`, + `StartMedicalStreamTranscription`, or + `StartCallAnalyticsStreamTranscription` operation was not valid. For + example, `MediaEncoding` or `LanguageCode` used unsupported values. + Check the specified parameters and try your request again. """ fault: Literal["client", "server"] | None = "client" @@ -1018,46 +1020,44 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class CallAnalyticsEntity: """ - Contains entities identified as personally identifiable information (PII) in - your transcription output, along with various associated attributes. Examples - include category, confidence score, content, type, and start and end times. + Contains entities identified as personally identifiable information + (PII) in your transcription output, along with various associated + attributes. Examples include category, confidence score, content, type, + and start and end times. """ begin_offset_millis: int | None = None """ - The time, in milliseconds, from the beginning of the audio stream to the start - of the identified entity. + The time, in milliseconds, from the beginning of the audio stream to the + start of the identified entity. """ end_offset_millis: int | None = None """ - The time, in milliseconds, from the beginning of the audio stream to the end of - the identified entity. + The time, in milliseconds, from the beginning of the audio stream to the + end of the identified entity. """ category: str | None = None - """ - The category of information identified. For example, ``PII``. - """ + """The category of information identified. For example, `PII`.""" type: str | None = None """ - The type of PII identified. For example, ``NAME`` or ``CREDIT_DEBIT_NUMBER``. + The type of PII identified. For example, `NAME` or + `CREDIT_DEBIT_NUMBER`. """ content: str | None = None - """ - The word or words that represent the identified entity. - """ + """The word or words that represent the identified entity.""" confidence: float | None = None """ - The confidence score associated with the identification of an entity in your - transcript. + The confidence score associated with the identification of an entity in + your transcript. - Confidence scores are values between 0 and 1. A larger value indicates a higher - probability that the identified entity correctly matches the entity spoken in - your media. + Confidence scores are values between 0 and 1. A larger value indicates a + higher probability that the identified entity correctly matches the + entity spoken in your media. """ def serialize(self, serializer: ShapeSerializer): @@ -1171,55 +1171,54 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class CallAnalyticsItem: """ - A word, phrase, or punctuation mark in your Call Analytics transcription output, - along with various associated attributes, such as confidence score, type, and - start and end times. + A word, phrase, or punctuation mark in your Call Analytics transcription + output, along with various associated attributes, such as confidence + score, type, and start and end times. """ begin_offset_millis: int | None = None """ - The time, in milliseconds, from the beginning of the audio stream to the start - of the identified item. + The time, in milliseconds, from the beginning of the audio stream to the + start of the identified item. """ end_offset_millis: int | None = None """ - The time, in milliseconds, from the beginning of the audio stream to the end of - the identified item. + The time, in milliseconds, from the beginning of the audio stream to the + end of the identified item. """ type: str | None = None """ - The type of item identified. Options are: ``PRONUNCIATION`` (spoken words) and - ``PUNCTUATION``. + The type of item identified. Options are: `PRONUNCIATION` (spoken words) + and `PUNCTUATION`. """ content: str | None = None - """ - The word or punctuation that was transcribed. - """ + """The word or punctuation that was transcribed.""" confidence: float | None = None """ - The confidence score associated with a word or phrase in your transcript. + The confidence score associated with a word or phrase in your + transcript. - Confidence scores are values between 0 and 1. A larger value indicates a higher - probability that the identified item correctly matches the item spoken in your - media. + Confidence scores are values between 0 and 1. A larger value indicates a + higher probability that the identified item correctly matches the item + spoken in your media. """ vocabulary_filter_match: bool = False """ - Indicates whether the specified item matches a word in the vocabulary filter - included in your Call Analytics request. If ``true``, there is a vocabulary - filter match. + Indicates whether the specified item matches a word in the vocabulary + filter included in your Call Analytics request. If `true`, there is a + vocabulary filter match. """ stable: bool | None = None """ - If partial result stabilization is enabled, ``Stable`` indicates whether the - specified item is stable (``true``) or if it may change when the segment is - complete (``false``). + If partial result stabilization is enabled, `Stable` indicates whether + the specified item is stable (`true`) or if it may change when the + segment is complete (`false`). """ def serialize(self, serializer: ShapeSerializer): @@ -1359,15 +1358,13 @@ class CallAnalyticsLanguageWithScore: """ language_code: str | None = None - """ - The language code of the identified language. - """ + """The language code of the identified language.""" score: float = 0 """ - The confidence score associated with the identified language code. Confidence - scores are values between zero and one; larger values indicate a higher - confidence in the identified language. + The confidence score associated with the identified language code. + Confidence scores are values between zero and one; larger values + indicate a higher confidence in the identified language. """ def serialize(self, serializer: ShapeSerializer): @@ -1477,14 +1474,14 @@ class TimestampRange: begin_offset_millis: int | None = None """ - The time, in milliseconds, from the beginning of the audio stream to the start - of the category match. + The time, in milliseconds, from the beginning of the audio stream to the + start of the category match. """ end_offset_millis: int | None = None """ - The time, in milliseconds, from the beginning of the audio stream to the end of - the category match. + The time, in milliseconds, from the beginning of the audio stream to the + end of the category match. """ def serialize(self, serializer: ShapeSerializer): @@ -1557,9 +1554,7 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class PointsOfInterest: - """ - Contains the timestamps of matched categories. - """ + """Contains the timestamps of matched categories.""" timestamp_ranges: list[TimestampRange] | None = None """ @@ -1629,20 +1624,18 @@ def _read_value(k: str, d: ShapeDeserializer): @dataclass(kw_only=True) class CategoryEvent: """ - Provides information on any ``TranscriptFilterType`` categories that matched - your transcription output. Matches are identified for each segment upon - completion of that segment. + Provides information on any `TranscriptFilterType` categories that + matched your transcription output. Matches are identified for each + segment upon completion of that segment. """ matched_categories: list[str] | None = None - """ - Lists the categories that were matched in your audio segment. - """ + """Lists the categories that were matched in your audio segment.""" matched_details: dict[str, PointsOfInterest] | None = None """ - Contains information about the matched categories, including category names and - timestamps. + Contains information about the matched categories, including category + names and timestamps. """ def serialize(self, serializer: ShapeSerializer): @@ -1693,8 +1686,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ConflictException(ServiceError): """ - A new stream started with the same session ID. The current stream has been - terminated. + A new stream started with the same session ID. The current stream has + been terminated. """ fault: Literal["client", "server"] | None = "client" @@ -1733,8 +1726,8 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class InternalFailureException(ServiceError): """ - A problem occurred while processing the audio. Amazon Transcribe terminated - processing. + A problem occurred while processing the audio. Amazon Transcribe + terminated processing. """ fault: Literal["client", "server"] | None = "server" @@ -1773,9 +1766,9 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class LimitExceededException(ServiceError): """ - Your client has exceeded one of the Amazon Transcribe limits. This is typically - the audio length limit. Break your audio stream into smaller chunks and try your - request again. + Your client has exceeded one of the Amazon Transcribe limits. This is + typically the audio length limit. Break your audio stream into smaller + chunks and try your request again. """ fault: Literal["client", "server"] | None = "client" @@ -1813,9 +1806,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ServiceUnavailableException(ServiceError): - """ - The service is currently unavailable. Try your request later. - """ + """The service is currently unavailable. Try your request later.""" fault: Literal["client", "server"] | None = "server" @@ -1855,23 +1846,23 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class CharacterOffsets: """ - Provides the location, using character count, in your transcript where a match - is identified. For example, the location of an issue or a category match within - a segment. + Provides the location, using character count, in your transcript where a + match is identified. For example, the location of an issue or a category + match within a segment. """ begin: int | None = None """ - Provides the character count of the first character where a match is identified. - For example, the first character associated with an issue or a category match in - a segment transcript. + Provides the character count of the first character where a match is + identified. For example, the first character associated with an issue or + a category match in a segment transcript. """ end: int | None = None """ - Provides the character count of the last character where a match is identified. - For example, the last character associated with an issue or a category match in - a segment transcript. + Provides the character count of the last character where a match is + identified. For example, the last character associated with an issue or + a category match in a segment transcript. """ def serialize(self, serializer: ShapeSerializer): @@ -1915,14 +1906,12 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class IssueDetected: - """ - Lists the issues that were identified in your audio segment. - """ + """Lists the issues that were identified in your audio segment.""" character_offsets: CharacterOffsets | None = None """ - Provides the timestamps that identify when in an audio segment the specified - issue occurs. + Provides the timestamps that identify when in an audio segment the + specified issue occurs. """ def serialize(self, serializer: ShapeSerializer): @@ -1990,77 +1979,71 @@ class Sentiment(StrEnum): @dataclass(kw_only=True) class UtteranceEvent: """ - Contains set of transcription results from one or more audio segments, along - with additional information about the parameters included in your request. For - example, channel definitions, partial result stabilization, sentiment, and issue - detection. + Contains set of transcription results from one or more audio segments, + along with additional information about the parameters included in your + request. For example, channel definitions, partial result stabilization, + sentiment, and issue detection. """ utterance_id: str | None = None """ - The unique identifier that is associated with the specified ``UtteranceEvent``. + The unique identifier that is associated with the specified + `UtteranceEvent`. """ is_partial: bool = False """ - Indicates whether the segment in the ``UtteranceEvent`` is complete (``FALSE``) - or partial (``TRUE``). + Indicates whether the segment in the `UtteranceEvent` is complete + (`FALSE`) or partial (`TRUE`). """ participant_role: str | None = None """ - Provides the role of the speaker for each audio channel, either ``CUSTOMER`` or - ``AGENT``. + Provides the role of the speaker for each audio channel, either + `CUSTOMER` or `AGENT`. """ begin_offset_millis: int | None = None """ - The time, in milliseconds, from the beginning of the audio stream to the start - of the ``UtteranceEvent``. + The time, in milliseconds, from the beginning of the audio stream to the + start of the `UtteranceEvent`. """ end_offset_millis: int | None = None """ - The time, in milliseconds, from the beginning of the audio stream to the start - of the ``UtteranceEvent``. + The time, in milliseconds, from the beginning of the audio stream to the + start of the `UtteranceEvent`. """ transcript: str | None = None - """ - Contains transcribed text. - """ + """Contains transcribed text.""" items: list[CallAnalyticsItem] | None = None """ - Contains words, phrases, or punctuation marks that are associated with the - specified ``UtteranceEvent``. + Contains words, phrases, or punctuation marks that are associated with + the specified `UtteranceEvent`. """ entities: list[CallAnalyticsEntity] | None = None """ - Contains entities identified as personally identifiable information (PII) in - your transcription output. + Contains entities identified as personally identifiable information + (PII) in your transcription output. """ sentiment: str | None = None - """ - Provides the sentiment that was detected in the specified segment. - """ + """Provides the sentiment that was detected in the specified segment.""" issues_detected: list[IssueDetected] | None = None - """ - Provides the issue that was detected in the specified segment. - """ + """Provides the issue that was detected in the specified segment.""" language_code: str | None = None """ - The language code that represents the language spoken in your audio stream. + The language code that represents the language spoken in your audio + stream. """ language_identification: list[CallAnalyticsLanguageWithScore] | None = None - """ - The language code of the dominant language identified in your stream. - """ + """The language code of the dominant language identified in your stream.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_UTTERANCE_EVENT, self) @@ -2214,10 +2197,11 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class CallAnalyticsTranscriptResultStreamUtteranceEvent: """ - Contains set of transcription results from one or more audio segments, along - with additional information per your request parameters. This can include - information relating to channel definitions, partial result stabilization, - sentiment, issue detection, and other transcription-related data. + Contains set of transcription results from one or more audio segments, + along with additional information per your request parameters. This can + include information relating to channel definitions, partial result + stabilization, sentiment, issue detection, and other + transcription-related data. """ value: UtteranceEvent @@ -2239,8 +2223,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CallAnalyticsTranscriptResultStreamCategoryEvent: """ - Provides information on matched categories that were used to generate real-time - supervisor alerts. + Provides information on matched categories that were used to generate + real-time supervisor alerts. """ value: CategoryEvent @@ -2262,11 +2246,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CallAnalyticsTranscriptResultStreamBadRequestException: """ - One or more arguments to the ``StartStreamTranscription``, - ``StartMedicalStreamTranscription``, or - ``StartCallAnalyticsStreamTranscription`` operation was not valid. For example, - ``MediaEncoding`` or ``LanguageCode`` used unsupported values. Check the - specified parameters and try your request again. + One or more arguments to the `StartStreamTranscription`, + `StartMedicalStreamTranscription`, or + `StartCallAnalyticsStreamTranscription` operation was not valid. For + example, `MediaEncoding` or `LanguageCode` used unsupported values. + Check the specified parameters and try your request again. """ value: BadRequestException @@ -2290,9 +2274,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CallAnalyticsTranscriptResultStreamLimitExceededException: """ - Your client has exceeded one of the Amazon Transcribe limits. This is typically - the audio length limit. Break your audio stream into smaller chunks and try your - request again. + Your client has exceeded one of the Amazon Transcribe limits. This is + typically the audio length limit. Break your audio stream into smaller + chunks and try your request again. """ value: LimitExceededException @@ -2316,8 +2300,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CallAnalyticsTranscriptResultStreamInternalFailureException: """ - A problem occurred while processing the audio. Amazon Transcribe terminated - processing. + A problem occurred while processing the audio. Amazon Transcribe + terminated processing. """ value: InternalFailureException @@ -2341,8 +2325,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CallAnalyticsTranscriptResultStreamConflictException: """ - A new stream started with the same session ID. The current stream has been - terminated. + A new stream started with the same session ID. The current stream has + been terminated. """ value: ConflictException @@ -2365,9 +2349,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CallAnalyticsTranscriptResultStreamServiceUnavailableException: - """ - The service is currently unavailable. Try your request later. - """ + """The service is currently unavailable. Try your request later.""" value: ServiceUnavailableException @@ -2389,7 +2371,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class CallAnalyticsTranscriptResultStreamUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -2420,10 +2403,10 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | CallAnalyticsTranscriptResultStreamServiceUnavailableException | CallAnalyticsTranscriptResultStreamUnknown ] - """ -Contains detailed information about your real-time Call Analytics session. These -details are provided in the ``UtteranceEvent`` and ``CategoryEvent`` objects. +Contains detailed information about your real-time Call Analytics +session. These details are provided in the `UtteranceEvent` and +`CategoryEvent` objects. """ @@ -2510,20 +2493,16 @@ class ClinicalNoteGenerationStatus(StrEnum): @dataclass(kw_only=True) class ClinicalNoteGenerationResult: """ - The details for clinical note generation, including status, and output locations - for clinical note and aggregated transcript if the analytics completed, or - failure reason if the analytics failed. + The details for clinical note generation, including status, and output + locations for clinical note and aggregated transcript if the analytics + completed, or failure reason if the analytics failed. """ clinical_note_output_location: str | None = None - """ - Holds the Amazon S3 URI for the output Clinical Note. - """ + """Holds the Amazon S3 URI for the output Clinical Note.""" transcript_output_location: str | None = None - """ - Holds the Amazon S3 URI for the output Transcript. - """ + """Holds the Amazon S3 URI for the output Transcript.""" status: str | None = None """ @@ -2531,23 +2510,24 @@ class ClinicalNoteGenerationResult: Possible Values: - * ``IN_PROGRESS`` + - `IN_PROGRESS` - * ``FAILED`` + - `FAILED` - * ``COMPLETED`` + - `COMPLETED` - After audio streaming finishes, and you send a - ``MedicalScribeSessionControlEvent`` event (with END_OF_SESSION as the Type), - the status is set to ``IN_PROGRESS``. If the status is ``COMPLETED``, the - analytics completed successfully, and you can find the results at the locations - specified in ``ClinicalNoteOutputLocation`` and ``TranscriptOutputLocation``. If - the status is ``FAILED``, ``FailureReason`` provides details about the failure. + After audio streaming finishes, and you send a + `MedicalScribeSessionControlEvent` event (with END_OF_SESSION as the + Type), the status is set to `IN_PROGRESS`. If the status is `COMPLETED`, + the analytics completed successfully, and you can find the results at + the locations specified in `ClinicalNoteOutputLocation` and + `TranscriptOutputLocation`. If the status is `FAILED`, `FailureReason` + provides details about the failure. """ failure_reason: str | None = None """ - If ``ClinicalNoteGenerationResult`` is ``FAILED``, information about why it + If `ClinicalNoteGenerationResult` is `FAILED`, information about why it failed. """ @@ -2638,49 +2618,60 @@ class MedicalScribeNoteTemplate(StrEnum): @dataclass(kw_only=True) class ClinicalNoteGenerationSettings: """ - The output configuration for aggregated transcript and clinical note generation. + The output configuration for aggregated transcript and clinical note + generation. """ output_bucket_name: str """ The name of the Amazon S3 bucket where you want the output of Amazon Web - Services HealthScribe post-stream analytics stored. Don't include the ``S3://`` - prefix of the specified bucket. - - HealthScribe outputs transcript and clinical note files under the prefix: - ``S3://$$output-bucket-name/healthscribe-streaming/session-id/post-stream-analytics/clinical-notes`` - - The role ``ResourceAccessRoleArn`` specified in the ``MedicalScribeConfigurationEvent`` must have permission to use the specified location. You can change Amazon S3 permissions using the ` Amazon Web Services Management Console `_. - See also `Permissions Required for IAM User Roles `_ + Services HealthScribe post-stream analytics stored. Don't include the + `S3://` prefix of the specified bucket. + + HealthScribe outputs transcript and clinical note files under the + prefix: + `S3://$output-bucket-name/healthscribe-streaming/session-id/post-stream-analytics/clinical-notes` + + The role `ResourceAccessRoleArn` specified in the + `MedicalScribeConfigurationEvent` must have permission to use the + specified location. You can change Amazon S3 permissions using the + [Amazon Web Services Management + Console](https://console.aws.amazon.com/s3) . See also [Permissions + Required for IAM User + Roles](https://docs.aws.amazon.com/transcribe/latest/dg/security_iam_id-based-policy-examples.html#auth-role-iam-user) . """ note_template: str | None = None """ - Specify one of the following templates to use for the clinical note summary. The - default is ``HISTORY_AND_PHYSICAL``. + Specify one of the following templates to use for the clinical note + summary. The default is `HISTORY_AND_PHYSICAL`. - * HISTORY_AND_PHYSICAL: Provides summaries for key sections of the clinical - documentation. Examples of sections include Chief Complaint, History of Present - Illness, Review of Systems, Past Medical History, Assessment, and Plan. + - HISTORY_AND_PHYSICAL: Provides summaries for key sections of the + clinical documentation. Examples of sections include Chief Complaint, + History of Present Illness, Review of Systems, Past Medical History, + Assessment, and Plan. - * GIRPP: Provides summaries based on the patients progress toward goals. - Examples of sections include Goal, Intervention, Response, Progress, and Plan. + - GIRPP: Provides summaries based on the patients progress toward goals. + Examples of sections include Goal, Intervention, Response, Progress, + and Plan. - * BIRP: Focuses on the patient's behavioral patterns and responses. Examples of - sections include Behavior, Intervention, Response, and Plan. + - BIRP: Focuses on the patient's behavioral patterns and responses. + Examples of sections include Behavior, Intervention, Response, and + Plan. - * SIRP: Emphasizes the situational context of therapy. Examples of sections - include Situation, Intervention, Response, and Plan. + - SIRP: Emphasizes the situational context of therapy. Examples of + sections include Situation, Intervention, Response, and Plan. - * DAP: Provides a simplified format for clinical documentation. Examples of - sections include Data, Assessment, and Plan. + - DAP: Provides a simplified format for clinical documentation. Examples + of sections include Data, Assessment, and Plan. - * BEHAVIORAL_SOAP: Behavioral health focused documentation format. Examples of - sections include Subjective, Objective, Assessment, and Plan. + - BEHAVIORAL_SOAP: Behavioral health focused documentation format. + Examples of sections include Subjective, Objective, Assessment, and + Plan. - * PHYSICAL_SOAP: Physical health focused documentation format. Examples of - sections include Subjective, Objective, Assessment, and Plan. + - PHYSICAL_SOAP: Physical health focused documentation format. Examples + of sections include Subjective, Objective, Assessment, and Plan. """ def serialize(self, serializer: ShapeSerializer): @@ -2740,9 +2731,12 @@ class ContentRedactionType(StrEnum): @dataclass(kw_only=True) class GetMedicalScribeStreamInput: + """Dataclass for GetMedicalScribeStreamInput structure.""" + session_id: str | None = None """ - The identifier of the HealthScribe streaming session you want information about. + The identifier of the HealthScribe streaming session you want + information about. """ def serialize(self, serializer: ShapeSerializer): @@ -2787,28 +2781,27 @@ class MedicalScribeParticipantRole(StrEnum): @dataclass(kw_only=True) class MedicalScribeChannelDefinition: """ - Makes it possible to specify which speaker is on which channel. For example, if - the clinician is the first participant to speak, you would set the ``ChannelId`` - of the first ``ChannelDefinition`` in the list to ``0`` (to indicate the first - channel) and ``ParticipantRole`` to ``CLINICIAN`` (to indicate that it's the - clinician speaking). Then you would set the ``ChannelId`` of the second - ``ChannelDefinition`` in the list to ``1`` (to indicate the second channel) and - ``ParticipantRole`` to ``PATIENT`` (to indicate that it's the patient speaking). + Makes it possible to specify which speaker is on which channel. For + example, if the clinician is the first participant to speak, you would + set the `ChannelId` of the first `ChannelDefinition` in the list to `0` + (to indicate the first channel) and `ParticipantRole` to `CLINICIAN` (to + indicate that it's the clinician speaking). Then you would set the + `ChannelId` of the second `ChannelDefinition` in the list to `1` (to + indicate the second channel) and `ParticipantRole` to `PATIENT` (to + indicate that it's the patient speaking). - If you don't specify a channel definition, HealthScribe will diarize the - transcription and identify speaker roles for each speaker. + If you don't specify a channel definition, HealthScribe will diarize + the transcription and identify speaker roles for each speaker. """ participant_role: str """ Specify the participant that you want to flag. The allowed options are - ``CLINICIAN`` and ``PATIENT``. + `CLINICIAN` and `PATIENT`. """ channel_id: int = 0 - """ - Specify the audio channel you want to define. - """ + """Specify the audio channel you want to define.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_MEDICAL_SCRIBE_CHANNEL_DEFINITION, self) @@ -2910,50 +2903,57 @@ def _read_value(k: str, d: ShapeDeserializer): @dataclass(kw_only=True) class MedicalScribeEncryptionSettings: """ - Contains encryption related settings to be used for data encryption with Key - Management Service, including KmsEncryptionContext and KmsKeyId. The KmsKeyId is - required, while KmsEncryptionContext is optional for additional layer of - security. + Contains encryption related settings to be used for data encryption with + Key Management Service, including KmsEncryptionContext and KmsKeyId. The + KmsKeyId is required, while KmsEncryptionContext is optional for + additional layer of security. - By default, Amazon Web Services HealthScribe provides encryption at rest to - protect sensitive customer data using Amazon S3-managed keys. HealthScribe uses - the KMS key you specify as a second layer of encryption. + By default, Amazon Web Services HealthScribe provides encryption at rest + to protect sensitive customer data using Amazon S3-managed keys. + HealthScribe uses the KMS key you specify as a second layer of + encryption. - Your ``ResourceAccessRoleArn`` must permission to use your KMS key. For more information, see ``Data Encryption at rest for Amazon Web Services HealthScribe ``_ - . + Your `ResourceAccessRoleArn` must permission to use your KMS key. For + more information, see [Data Encryption at rest for Amazon Web Services + HealthScribe](https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe-encryption.html). """ kms_key_id: str """ - The ID of the KMS key you want to use for your streaming session. You can - specify its KMS key ID, key Amazon Resource Name (ARN), alias name, or alias - ARN. When using an alias name, prefix it with ``"alias/"``. To specify a KMS key - in a different Amazon Web Services account, you must use the key ARN or alias - ARN. + The ID of the KMS key you want to use for your streaming session. You + can specify its KMS key ID, key Amazon Resource Name (ARN), alias name, + or alias ARN. When using an alias name, prefix it with `"alias/"`. To + specify a KMS key in a different Amazon Web Services account, you must + use the key ARN or alias ARN. For example: - * Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab + - Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab - * Key ARN: + - Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab - * Alias name: alias/ExampleAlias + - Alias name: alias/ExampleAlias - * Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias + - Alias ARN: arn:aws:kms:us-east-2:111122223333:alias/ExampleAlias - To get the key ID and key ARN for a KMS key, use the `ListKeys `_ - or `DescribeKey `_ - KMS API operations. To get the alias name and alias ARN, use `ListKeys `_ - API operation. + To get the key ID and key ARN for a KMS key, use the + [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) + or + [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) + KMS API operations. To get the alias name and alias ARN, use + [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListAliases.html) + API operation. """ kms_encryption_context: dict[str, str] | None = None """ - A map of plain text, non-secret key:value pairs, known as encryption context - pairs, that provide an added layer of security for your data. For more - information, see `KMSencryption context `_ - and `Asymmetric keys in KMS `_ + A map of plain text, non-secret key:value pairs, known as encryption + context pairs, that provide an added layer of security for your data. + For more information, see [KMSencryption + context](https://docs.aws.amazon.com/transcribe/latest/dg/key-management.html#kms-context) + and [Asymmetric keys in + KMS](https://docs.aws.amazon.com/transcribe/latest/dg/symmetric-asymmetric.html) . """ @@ -3021,14 +3021,10 @@ class MedicalScribeMediaEncoding(StrEnum): @dataclass(kw_only=True) class MedicalScribePostStreamAnalyticsResult: - """ - Contains details for the result of post-stream analytics. - """ + """Contains details for the result of post-stream analytics.""" clinical_note_generation_result: ClinicalNoteGenerationResult | None = None - """ - Provides the Clinical Note Generation result for post-stream analytics. - """ + """Provides the Clinical Note Generation result for post-stream analytics.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct( @@ -3070,14 +3066,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class MedicalScribePostStreamAnalyticsSettings: - """ - The settings for post-stream analytics. - """ + """The settings for post-stream analytics.""" clinical_note_generation_settings: ClinicalNoteGenerationSettings - """ - Specify settings for the post-stream clinical note generation. - """ + """Specify settings for the post-stream clinical note generation.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct( @@ -3132,69 +3124,54 @@ class MedicalScribeVocabularyFilterMethod(StrEnum): @dataclass(kw_only=True) class MedicalScribeStreamDetails: """ - Contains details about a Amazon Web Services HealthScribe streaming session. + Contains details about a Amazon Web Services HealthScribe streaming + session. """ session_id: str | None = None - """ - The identifier of the HealthScribe streaming session. - """ + """The identifier of the HealthScribe streaming session.""" stream_created_at: datetime | None = None - """ - The date and time when the HealthScribe streaming session was created. - """ + """The date and time when the HealthScribe streaming session was created.""" stream_ended_at: datetime | None = None - """ - The date and time when the HealthScribe streaming session was ended. - """ + """The date and time when the HealthScribe streaming session was ended.""" language_code: str | None = None - """ - The Language Code of the HealthScribe streaming session. - """ + """The Language Code of the HealthScribe streaming session.""" media_sample_rate_hertz: int | None = None - """ - The sample rate (in hertz) of the HealthScribe streaming session. - """ + """The sample rate (in hertz) of the HealthScribe streaming session.""" media_encoding: str | None = None - """ - The Media Encoding of the HealthScribe streaming session. - """ + """The Media Encoding of the HealthScribe streaming session.""" vocabulary_name: str | None = None - """ - The vocabulary name of the HealthScribe streaming session. - """ + """The vocabulary name of the HealthScribe streaming session.""" vocabulary_filter_name: str | None = None """ - The name of the vocabulary filter used for the HealthScribe streaming session . + The name of the vocabulary filter used for the HealthScribe streaming + session . """ vocabulary_filter_method: str | None = None """ - The method of the vocabulary filter for the HealthScribe streaming session. + The method of the vocabulary filter for the HealthScribe streaming + session. """ resource_access_role_arn: str | None = None """ - The Amazon Resource Name (ARN) of the role used in the HealthScribe streaming - session. + The Amazon Resource Name (ARN) of the role used in the HealthScribe + streaming session. """ channel_definitions: list[MedicalScribeChannelDefinition] | None = None - """ - The Channel Definitions of the HealthScribe streaming session. - """ + """The Channel Definitions of the HealthScribe streaming session.""" encryption_settings: MedicalScribeEncryptionSettings | None = None - """ - The Encryption Settings of the HealthScribe streaming session. - """ + """The Encryption Settings of the HealthScribe streaming session.""" stream_status: str | None = None """ @@ -3202,38 +3179,40 @@ class MedicalScribeStreamDetails: Possible Values: - * ``IN_PROGRESS`` + - `IN_PROGRESS` - * ``PAUSED`` + - `PAUSED` - * ``FAILED`` + - `FAILED` - * ``COMPLETED`` + - `COMPLETED` - .. note:: - This status is specific to real-time streaming. A ``COMPLETED`` status doesn't - mean that the post-stream analytics is complete. To get status of an analytics - result, check the ``Status`` field for the analytics result within the - ``MedicalScribePostStreamAnalyticsResult``. For example, you can view the status - of the ``ClinicalNoteGenerationResult``. + Note: + This status is specific to real-time streaming. A `COMPLETED` status + doesn't mean that the post-stream analytics is complete. To get status + of an analytics result, check the `Status` field for the analytics + result within the `MedicalScribePostStreamAnalyticsResult`. For example, + you can view the status of the `ClinicalNoteGenerationResult`. """ post_stream_analytics_settings: MedicalScribePostStreamAnalyticsSettings | None = ( None ) """ - The post-stream analytics settings of the HealthScribe streaming session. + The post-stream analytics settings of the HealthScribe streaming + session. """ post_stream_analytics_result: MedicalScribePostStreamAnalyticsResult | None = None """ - The result of post-stream analytics for the HealthScribe streaming session. + The result of post-stream analytics for the HealthScribe streaming + session. """ medical_scribe_context_provided: bool | None = None """ - Indicates whether the ``MedicalScribeContext`` object was provided when the - stream was started. + Indicates whether the `MedicalScribeContext` object was provided when + the stream was started. """ def serialize(self, serializer: ShapeSerializer): @@ -3459,10 +3438,10 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class GetMedicalScribeStreamOutput: + """Dataclass for GetMedicalScribeStreamOutput structure.""" + medical_scribe_stream_details: MedicalScribeStreamDetails | None = None - """ - Provides details about a HealthScribe streaming session. - """ + """Provides details about a HealthScribe streaming session.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_GET_MEDICAL_SCRIBE_STREAM_OUTPUT, self) @@ -3502,9 +3481,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class ResourceNotFoundException(ServiceError): - """ - The request references a resource which doesn't exist. - """ + """The request references a resource which doesn't exist.""" fault: Literal["client", "server"] | None = "client" @@ -3673,21 +3650,19 @@ class LanguageCode(StrEnum): class LanguageWithScore: """ The language code that represents the language identified in your audio, - including the associated confidence score. If you enabled channel identification - in your request and each channel contained a different language, you will have - more than one ``LanguageWithScore`` result. + including the associated confidence score. If you enabled channel + identification in your request and each channel contained a different + language, you will have more than one `LanguageWithScore` result. """ language_code: str | None = None - """ - The language code of the identified language. - """ + """The language code of the identified language.""" score: float = 0 """ - The confidence score associated with the identified language code. Confidence - scores are values between zero and one; larger values indicate a higher - confidence in the identified language. + The confidence score associated with the identified language code. + Confidence scores are values between zero and one; larger values + indicate a higher confidence in the identified language. """ def serialize(self, serializer: ShapeSerializer): @@ -3764,38 +3739,32 @@ class MediaEncoding(StrEnum): @dataclass(kw_only=True) class MedicalEntity: """ - Contains entities identified as personal health information (PHI) in your - transcription output, along with various associated attributes. Examples include - category, confidence score, type, stability score, and start and end times. + Contains entities identified as personal health information (PHI) in + your transcription output, along with various associated attributes. + Examples include category, confidence score, type, stability score, and + start and end times. """ start_time: float = 0 - """ - The start time, in seconds, of the utterance that was identified as PHI. - """ + """The start time, in seconds, of the utterance that was identified as PHI.""" end_time: float = 0 - """ - The end time, in seconds, of the utterance that was identified as PHI. - """ + """The end time, in seconds, of the utterance that was identified as PHI.""" category: str | None = None - """ - The category of information identified. The only category is ``PHI``. - """ + """The category of information identified. The only category is `PHI`.""" content: str | None = None - """ - The word or words identified as PHI. - """ + """The word or words identified as PHI.""" confidence: float | None = None """ - The confidence score associated with the identified PHI entity in your audio. + The confidence score associated with the identified PHI entity in your + audio. - Confidence scores are values between 0 and 1. A larger value indicates a higher - probability that the identified entity correctly matches the entity spoken in - your media. + Confidence scores are values between 0 and 1. A larger value indicates a + higher probability that the identified entity correctly matches the + entity spoken in your media. """ def serialize(self, serializer: ShapeSerializer): @@ -3893,44 +3862,39 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class MedicalItem: """ - A word, phrase, or punctuation mark in your transcription output, along with - various associated attributes, such as confidence score, type, and start and end - times. + A word, phrase, or punctuation mark in your transcription output, along + with various associated attributes, such as confidence score, type, and + start and end times. """ start_time: float = 0 - """ - The start time, in seconds, of the transcribed item. - """ + """The start time, in seconds, of the transcribed item.""" end_time: float = 0 - """ - The end time, in seconds, of the transcribed item. - """ + """The end time, in seconds, of the transcribed item.""" type: str | None = None """ - The type of item identified. Options are: ``PRONUNCIATION`` (spoken words) and - ``PUNCTUATION``. + The type of item identified. Options are: `PRONUNCIATION` (spoken words) + and `PUNCTUATION`. """ content: str | None = None - """ - The word or punctuation that was transcribed. - """ + """The word or punctuation that was transcribed.""" confidence: float | None = None """ - The confidence score associated with a word or phrase in your transcript. + The confidence score associated with a word or phrase in your + transcript. - Confidence scores are values between 0 and 1. A larger value indicates a higher - probability that the identified item correctly matches the item spoken in your - media. + Confidence scores are values between 0 and 1. A larger value indicates a + higher probability that the identified item correctly matches the item + spoken in your media. """ speaker: str | None = None """ - If speaker partitioning is enabled, ``Speaker`` labels the speaker of the + If speaker partitioning is enabled, `Speaker` labels the speaker of the specified item. """ @@ -4036,24 +4000,23 @@ def _read_value(d: ShapeDeserializer): class MedicalAlternative: """ A list of possible alternative transcriptions for the input audio. Each - alternative may contain one or more of ``Items``, ``Entities``, or - ``Transcript``. + alternative may contain one or more of `Items`, `Entities`, or + `Transcript`. """ transcript: str | None = None - """ - Contains transcribed text. - """ + """Contains transcribed text.""" items: list[MedicalItem] | None = None """ - Contains words, phrases, or punctuation marks in your transcription output. + Contains words, phrases, or punctuation marks in your transcription + output. """ entities: list[MedicalEntity] | None = None """ - Contains entities identified as personal health information (PHI) in your - transcription output. + Contains entities identified as personal health information (PHI) in + your transcription output. """ def serialize(self, serializer: ShapeSerializer): @@ -4141,49 +4104,41 @@ class MedicalContentIdentificationType(StrEnum): @dataclass(kw_only=True) class MedicalResult: """ - The ``Result`` associated with a ````. + The `Result` associated with a . - Contains a set of transcription results from one or more audio segments, along - with additional information per your request parameters. This can include - information relating to alternative transcriptions, channel identification, - partial result stabilization, language identification, and other - transcription-related data. + Contains a set of transcription results from one or more audio segments, + along with additional information per your request parameters. This can + include information relating to alternative transcriptions, channel + identification, partial result stabilization, language identification, + and other transcription-related data. """ result_id: str | None = None - """ - Provides a unique identifier for the ``Result``. - """ + """Provides a unique identifier for the `Result`.""" start_time: float = 0 - """ - The start time, in seconds, of the ``Result``. - """ + """The start time, in seconds, of the `Result`.""" end_time: float = 0 - """ - The end time, in seconds, of the ``Result``. - """ + """The end time, in seconds, of the `Result`.""" is_partial: bool = False """ Indicates if the segment is complete. - If ``IsPartial`` is ``true``, the segment is not complete. If ``IsPartial`` is - ``false``, the segment is complete. + If `IsPartial` is `true`, the segment is not complete. If `IsPartial` is + `false`, the segment is complete. """ alternatives: list[MedicalAlternative] | None = None """ A list of possible alternative transcriptions for the input audio. Each - alternative may contain one or more of ``Items``, ``Entities``, or - ``Transcript``. + alternative may contain one or more of `Items`, `Entities`, or + `Transcript`. """ channel_id: str | None = None - """ - Indicates the channel identified for the ``Result``. - """ + """Indicates the channel identified for the `Result`.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_MEDICAL_RESULT, self) @@ -4292,27 +4247,27 @@ class MedicalScribeAudioEvent: """ A wrapper for your audio chunks - For more information, see ``Event stream encoding ``_ - . + For more information, see [Event stream + encoding](https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html). """ audio_chunk: bytes """ - An audio blob containing the next segment of audio from your application, with a - maximum duration of 1 second. The maximum size in bytes varies based on audio - properties. + An audio blob containing the next segment of audio from your + application, with a maximum duration of 1 second. The maximum size in + bytes varies based on audio properties. - Find recommended size in `Transcribing streaming best practices `_ - . + Find recommended size in [Transcribing streaming best + practices](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#best-practices). - Size calculation: ``Duration (s) * Sample Rate (Hz) * Number of Channels * 2 - (Bytes per Sample)`` + Size calculation: + `Duration (s) * Sample Rate (Hz) * Number of Channels * 2 (Bytes per Sample)` - For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would be ``1 * - 16000 * 2 * 2 = 64000 bytes``. + For example, a 1-second chunk of 16 kHz, 2-channel, 16-bit audio would + be `1 * 16000 * 2 * 2 = 64000 bytes`. - For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be ``1 * 8000 * 1 * 2 - = 16000 bytes``. + For 8 kHz, 1-channel, 16-bit audio, a 1-second chunk would be + `1 * 8000 * 1 * 2 = 16000 bytes`. """ def serialize(self, serializer: ShapeSerializer): @@ -4353,14 +4308,12 @@ class Pronouns(StrEnum): @dataclass(kw_only=True) class MedicalScribePatientContext: - """ - Contains patient-specific information. - """ + """Contains patient-specific information.""" pronouns: str | None = field(repr=False, default=None) """ - The patient's preferred pronouns that the user wants to provide as a context for - clinical note generation . + The patient's preferred pronouns that the user wants to provide as a + context for clinical note generation . """ def serialize(self, serializer: ShapeSerializer): @@ -4400,14 +4353,15 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class MedicalScribeContext: """ - The ``MedicalScribeContext`` object that contains contextual information which - is used during clinical note generation to add relevant context to the note. + The `MedicalScribeContext` object that contains contextual information + which is used during clinical note generation to add relevant context to + the note. """ patient_context: MedicalScribePatientContext | None = None """ - Contains patient-specific information used to customize the clinical note - generation. + Contains patient-specific information used to customize the clinical + note generation. """ def serialize(self, serializer: ShapeSerializer): @@ -4446,77 +4400,72 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: class MedicalScribeConfigurationEvent: """ Specify details to configure the streaming session, including channel - definitions, encryption settings, post-stream analytics settings, resource - access role ARN and vocabulary settings. + definitions, encryption settings, post-stream analytics settings, + resource access role ARN and vocabulary settings. - Whether you are starting a new session or resuming an existing session, your - first event must be a ``MedicalScribeConfigurationEvent``. If you are resuming a - session, then this event must have the same configurations that you provided to - start the session. + Whether you are starting a new session or resuming an existing session, + your first event must be a `MedicalScribeConfigurationEvent`. If you are + resuming a session, then this event must have the same configurations + that you provided to start the session. """ resource_access_role_arn: str """ - The Amazon Resource Name (ARN) of an IAM role that has permissions to access the - Amazon S3 output bucket you specified, and use your KMS key if supplied. If the - role that you specify doesn’t have the appropriate permissions, your request - fails. + The Amazon Resource Name (ARN) of an IAM role that has permissions to + access the Amazon S3 output bucket you specified, and use your KMS key + if supplied. If the role that you specify doesn't have the appropriate + permissions, your request fails. - IAM role ARNs have the format - ``arn:partition:iam::account:role/role-name-with-path``. For example: - ``arn:aws:iam::111122223333:role/Admin``. + IAM role ARNs have the format + `arn:partition:iam::account:role/role-name-with-path`. For example: + `arn:aws:iam::111122223333:role/Admin`. - For more information, see `Amazon Web Services HealthScribe `_ - . + For more information, see [Amazon Web Services + HealthScribe](https://docs.aws.amazon.com/transcribe/latest/dg/health-scribe-streaming.html). """ post_stream_analytics_settings: MedicalScribePostStreamAnalyticsSettings - """ - Specify settings for post-stream analytics. - """ + """Specify settings for post-stream analytics.""" vocabulary_name: str | None = None """ - Specify the name of the custom vocabulary you want to use for your streaming - session. Custom vocabulary names are case-sensitive. + Specify the name of the custom vocabulary you want to use for your + streaming session. Custom vocabulary names are case-sensitive. """ vocabulary_filter_name: str | None = None """ - Specify the name of the custom vocabulary filter you want to include in your - streaming session. Custom vocabulary filter names are case-sensitive. + Specify the name of the custom vocabulary filter you want to include in + your streaming session. Custom vocabulary filter names are + case-sensitive. - If you include ``VocabularyFilterName`` in the - ``MedicalScribeConfigurationEvent``, you must also include - ``VocabularyFilterMethod``. + If you include `VocabularyFilterName` in the + `MedicalScribeConfigurationEvent`, you must also include + `VocabularyFilterMethod`. """ vocabulary_filter_method: str | None = None """ - Specify how you want your custom vocabulary filter applied to the streaming - session. + Specify how you want your custom vocabulary filter applied to the + streaming session. - To replace words with ``***``, specify ``mask``. + To replace words with `***`, specify `mask`. - To delete words, specify ``remove``. + To delete words, specify `remove`. - To flag words without changing them, specify ``tag``. + To flag words without changing them, specify `tag`. """ channel_definitions: list[MedicalScribeChannelDefinition] | None = None - """ - Specify which speaker is on which audio channel. - """ + """Specify which speaker is on which audio channel.""" encryption_settings: MedicalScribeEncryptionSettings | None = None - """ - Specify the encryption settings for your streaming session. - """ + """Specify the encryption settings for your streaming session.""" medical_scribe_context: MedicalScribeContext | None = None """ - The ``MedicalScribeContext`` object that contains contextual information used to - generate customized clinical notes. + The `MedicalScribeContext` object that contains contextual information + used to generate customized clinical notes. """ def serialize(self, serializer: ShapeSerializer): @@ -4658,20 +4607,24 @@ class MedicalScribeSessionControlEventType(StrEnum): @dataclass(kw_only=True) class MedicalScribeSessionControlEvent: - """ - Specify the lifecycle of your streaming session. - """ + """Specify the lifecycle of your streaming session.""" type: str """ - The type of ``MedicalScribeSessionControlEvent``. + The type of `MedicalScribeSessionControlEvent`. Possible Values: - * ``END_OF_SESSION`` - Indicates the audio streaming is complete. After you send an END_OF_SESSION event, Amazon Web Services HealthScribe starts the post-stream analytics. The session can't be resumed after this event is sent. After Amazon Web Services HealthScribe processes the event, the real-time ``StreamStatus`` is ``COMPLETED``. You get the ``StreamStatus`` and other stream details with the `GetMedicalScribeStream `_ - API operation. For more information about different streaming statuses, see the - ``StreamStatus`` description in the `MedicalScribeStreamDetails `_ - . + - `END_OF_SESSION` - Indicates the audio streaming is complete. After + you send an END_OF_SESSION event, Amazon Web Services HealthScribe + starts the post-stream analytics. The session can't be resumed after + this event is sent. After Amazon Web Services HealthScribe processes + the event, the real-time `StreamStatus` is `COMPLETED`. You get the + `StreamStatus` and other stream details with the + [GetMedicalScribeStream](https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_GetMedicalScribeStream.html) + API operation. For more information about different streaming + statuses, see the `StreamStatus` description in the + [MedicalScribeStreamDetails](https://docs.aws.amazon.com/transcribe/latest/APIReference/API_streaming_MedicalScribeStreamDetails.html). """ def serialize(self, serializer: ShapeSerializer): @@ -4711,8 +4664,8 @@ class MedicalScribeInputStreamAudioEvent: """ A wrapper for your audio chunks - For more information, see `Event stream encoding `_ - . + For more information, see [Event stream + encoding](https://docs.aws.amazon.com/transcribe/latest/dg/event-stream.html). """ value: MedicalScribeAudioEvent @@ -4733,7 +4686,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeInputStreamSessionControlEvent: """ - Specify the lifecycle of your streaming session, such as ending the session. + Specify the lifecycle of your streaming session, such as ending the + session. """ value: MedicalScribeSessionControlEvent @@ -4755,12 +4709,13 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeInputStreamConfigurationEvent: """ - Specify additional streaming session configurations beyond those provided in - your initial start request headers. For example, specify channel definitions, - encryption settings, and post-stream analytics settings. + Specify additional streaming session configurations beyond those + provided in your initial start request headers. For example, specify + channel definitions, encryption settings, and post-stream analytics + settings. - Whether you are starting a new session or resuming an existing session, your - first event must be a ``MedicalScribeConfigurationEvent``. + Whether you are starting a new session or resuming an existing session, + your first event must be a `MedicalScribeConfigurationEvent`. """ value: MedicalScribeConfigurationEvent @@ -4781,7 +4736,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeInputStreamUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -4808,18 +4764,19 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | MedicalScribeInputStreamConfigurationEvent | MedicalScribeInputStreamUnknown ] - """ -An encoded stream of events. The stream is encoded as HTTP/2 data frames. +An encoded stream of events. The stream is encoded as HTTP/2 data +frames. -An input stream consists of the following types of events. The first element of -the input stream must be the ``MedicalScribeConfigurationEvent`` event type. +An input stream consists of the following types of events. The first +element of the input stream must be the +`MedicalScribeConfigurationEvent` event type. -* ``MedicalScribeConfigurationEvent`` +- `MedicalScribeConfigurationEvent` -* ``MedicalScribeAudioEvent`` +- `MedicalScribeAudioEvent` -* ``MedicalScribeSessionControlEvent`` +- `MedicalScribeSessionControlEvent` """ @@ -4871,46 +4828,41 @@ class MedicalScribeTranscriptItemType(StrEnum): @dataclass(kw_only=True) class MedicalScribeTranscriptItem: """ - A word, phrase, or punctuation mark in your transcription output, along with - various associated attributes, such as confidence score, type, and start and end - times. + A word, phrase, or punctuation mark in your transcription output, along + with various associated attributes, such as confidence score, type, and + start and end times. """ begin_audio_time: float = 0 - """ - The start time, in milliseconds, of the transcribed item. - """ + """The start time, in milliseconds, of the transcribed item.""" end_audio_time: float = 0 - """ - The end time, in milliseconds, of the transcribed item. - """ + """The end time, in milliseconds, of the transcribed item.""" type: str | None = None """ - The type of item identified. Options are: ``PRONUNCIATION`` (spoken words) and - ``PUNCTUATION``. + The type of item identified. Options are: `PRONUNCIATION` (spoken words) + and `PUNCTUATION`. """ confidence: float | None = None """ - The confidence score associated with a word or phrase in your transcript. + The confidence score associated with a word or phrase in your + transcript. - Confidence scores are values between 0 and 1. A larger value indicates a higher - probability that the identified item correctly matches the item spoken in your - media. + Confidence scores are values between 0 and 1. A larger value indicates a + higher probability that the identified item correctly matches the item + spoken in your media. """ content: str | None = None - """ - The word, phrase or punctuation mark that was transcribed. - """ + """The word, phrase or punctuation mark that was transcribed.""" vocabulary_filter_match: bool | None = None """ - Indicates whether the specified item matches a word in the vocabulary filter - included in your configuration event. If ``true``, there is a vocabulary filter - match. + Indicates whether the specified item matches a word in the vocabulary + filter included in your configuration event. If `true`, there is a + vocabulary filter match. """ def serialize(self, serializer: ShapeSerializer): @@ -5028,50 +4980,40 @@ def _read_value(d: ShapeDeserializer): @dataclass(kw_only=True) class MedicalScribeTranscriptSegment: """ - Contains a set of transcription results, along with additional information of - the segment. + Contains a set of transcription results, along with additional + information of the segment. """ segment_id: str | None = None - """ - The identifier of the segment. - """ + """The identifier of the segment.""" begin_audio_time: float = 0 - """ - The start time, in milliseconds, of the segment. - """ + """The start time, in milliseconds, of the segment.""" end_audio_time: float = 0 - """ - The end time, in milliseconds, of the segment. - """ + """The end time, in milliseconds, of the segment.""" content: str | None = None - """ - Contains transcribed text of the segment. - """ + """Contains transcribed text of the segment.""" items: list[MedicalScribeTranscriptItem] | None = None - """ - Contains words, phrases, or punctuation marks in your segment. - """ + """Contains words, phrases, or punctuation marks in your segment.""" is_partial: bool = False """ Indicates if the segment is complete. - If ``IsPartial`` is ``true``, the segment is not complete. If ``IsPartial`` is - ``false``, the segment is complete. + If `IsPartial` is `true`, the segment is not complete. If `IsPartial` is + `false`, the segment is complete. """ channel_id: str | None = None """ Indicates which audio channel is associated with the - ``MedicalScribeTranscriptSegment``. + `MedicalScribeTranscriptSegment`. - If ``MedicalScribeChannelDefinition`` is not provided in the - ``MedicalScribeConfigurationEvent``, then this field will not be included. + If `MedicalScribeChannelDefinition` is not provided in the + `MedicalScribeConfigurationEvent`, then this field will not be included. """ def serialize(self, serializer: ShapeSerializer): @@ -5176,15 +5118,16 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class MedicalScribeTranscriptEvent: """ - The event associated with ``MedicalScribeResultStream``. + The event associated with `MedicalScribeResultStream`. - Contains ``MedicalScribeTranscriptSegment``, which contains segment related - information. + Contains `MedicalScribeTranscriptSegment`, which contains segment + related information. """ transcript_segment: MedicalScribeTranscriptSegment | None = None """ - The ``TranscriptSegment`` associated with a ``MedicalScribeTranscriptEvent``. + The `TranscriptSegment` associated with a + `MedicalScribeTranscriptEvent`. """ def serialize(self, serializer: ShapeSerializer): @@ -5223,9 +5166,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class MedicalScribeResultStreamTranscriptEvent: - """ - The transcript event that contains real-time transcription results. - """ + """The transcript event that contains real-time transcription results.""" value: MedicalScribeTranscriptEvent @@ -5245,11 +5186,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeResultStreamBadRequestException: """ - One or more arguments to the ``StartStreamTranscription``, - ``StartMedicalStreamTranscription``, or - ``StartCallAnalyticsStreamTranscription`` operation was not valid. For example, - ``MediaEncoding`` or ``LanguageCode`` used unsupported values. Check the - specified parameters and try your request again. + One or more arguments to the `StartStreamTranscription`, + `StartMedicalStreamTranscription`, or + `StartCallAnalyticsStreamTranscription` operation was not valid. For + example, `MediaEncoding` or `LanguageCode` used unsupported values. + Check the specified parameters and try your request again. """ value: BadRequestException @@ -5271,9 +5212,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeResultStreamLimitExceededException: """ - Your client has exceeded one of the Amazon Transcribe limits. This is typically - the audio length limit. Break your audio stream into smaller chunks and try your - request again. + Your client has exceeded one of the Amazon Transcribe limits. This is + typically the audio length limit. Break your audio stream into smaller + chunks and try your request again. """ value: LimitExceededException @@ -5295,8 +5236,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeResultStreamInternalFailureException: """ - A problem occurred while processing the audio. Amazon Transcribe terminated - processing. + A problem occurred while processing the audio. Amazon Transcribe + terminated processing. """ value: InternalFailureException @@ -5318,8 +5259,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeResultStreamConflictException: """ - A new stream started with the same session ID. The current stream has been - terminated. + A new stream started with the same session ID. The current stream has + been terminated. """ value: ConflictException @@ -5340,9 +5281,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeResultStreamServiceUnavailableException: - """ - The service is currently unavailable. Try your request later. - """ + """The service is currently unavailable. Try your request later.""" value: ServiceUnavailableException @@ -5362,7 +5301,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalScribeResultStreamUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -5392,10 +5332,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | MedicalScribeResultStreamServiceUnavailableException | MedicalScribeResultStreamUnknown ] - """ -Result stream where you will receive the output events. The details are provided -in the ``MedicalScribeTranscriptEvent`` object. +Result stream where you will receive the output events. The details are +provided in the `MedicalScribeTranscriptEvent` object. """ @@ -5459,20 +5398,20 @@ def _set_result(self, value: MedicalScribeResultStream) -> None: @dataclass(kw_only=True) class MedicalTranscript: """ - The ``MedicalTranscript`` associated with a ````. + The `MedicalTranscript` associated with a . - ``MedicalTranscript`` contains ``Results``, which contains a set of - transcription results from one or more audio segments, along with additional - information per your request parameters. + `MedicalTranscript` contains `Results`, which contains a set of + transcription results from one or more audio segments, along with + additional information per your request parameters. """ results: list[MedicalResult] | None = None """ - Contains a set of transcription results from one or more audio segments, along - with additional information per your request parameters. This can include - information relating to alternative transcriptions, channel identification, - partial result stabilization, language identification, and other - transcription-related data. + Contains a set of transcription results from one or more audio segments, + along with additional information per your request parameters. This can + include information relating to alternative transcriptions, channel + identification, partial result stabilization, language identification, + and other transcription-related data. """ def serialize(self, serializer: ShapeSerializer): @@ -5509,20 +5448,20 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class MedicalTranscriptEvent: """ - The ``MedicalTranscriptEvent`` associated with a - ``MedicalTranscriptResultStream``. + The `MedicalTranscriptEvent` associated with a + `MedicalTranscriptResultStream`. - Contains a set of transcription results from one or more audio segments, along - with additional information per your request parameters. + Contains a set of transcription results from one or more audio segments, + along with additional information per your request parameters. """ transcript: MedicalTranscript | None = None """ - Contains ``Results``, which contains a set of transcription results from one or - more audio segments, along with additional information per your request - parameters. This can include information relating to alternative transcriptions, - channel identification, partial result stabilization, language identification, - and other transcription-related data. + Contains `Results`, which contains a set of transcription results from + one or more audio segments, along with additional information per your + request parameters. This can include information relating to alternative + transcriptions, channel identification, partial result stabilization, + language identification, and other transcription-related data. """ def serialize(self, serializer: ShapeSerializer): @@ -5557,14 +5496,14 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class MedicalTranscriptResultStreamTranscriptEvent: """ - The ``MedicalTranscriptEvent`` associated with a - ``MedicalTranscriptResultStream``. + The `MedicalTranscriptEvent` associated with a + `MedicalTranscriptResultStream`. - Contains a set of transcription results from one or more audio segments, along - with additional information per your request parameters. This can include - information relating to alternative transcriptions, channel identification, - partial result stabilization, language identification, and other - transcription-related data. + Contains a set of transcription results from one or more audio segments, + along with additional information per your request parameters. This can + include information relating to alternative transcriptions, channel + identification, partial result stabilization, language identification, + and other transcription-related data. """ value: MedicalTranscriptEvent @@ -5586,11 +5525,11 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalTranscriptResultStreamBadRequestException: """ - One or more arguments to the ``StartStreamTranscription``, - ``StartMedicalStreamTranscription``, or - ``StartCallAnalyticsStreamTranscription`` operation was not valid. For example, - ``MediaEncoding`` or ``LanguageCode`` used unsupported values. Check the - specified parameters and try your request again. + One or more arguments to the `StartStreamTranscription`, + `StartMedicalStreamTranscription`, or + `StartCallAnalyticsStreamTranscription` operation was not valid. For + example, `MediaEncoding` or `LanguageCode` used unsupported values. + Check the specified parameters and try your request again. """ value: BadRequestException @@ -5612,9 +5551,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalTranscriptResultStreamLimitExceededException: """ - Your client has exceeded one of the Amazon Transcribe limits. This is typically - the audio length limit. Break your audio stream into smaller chunks and try your - request again. + Your client has exceeded one of the Amazon Transcribe limits. This is + typically the audio length limit. Break your audio stream into smaller + chunks and try your request again. """ value: LimitExceededException @@ -5636,8 +5575,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalTranscriptResultStreamInternalFailureException: """ - A problem occurred while processing the audio. Amazon Transcribe terminated - processing. + A problem occurred while processing the audio. Amazon Transcribe + terminated processing. """ value: InternalFailureException @@ -5661,8 +5600,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalTranscriptResultStreamConflictException: """ - A new stream started with the same session ID. The current stream has been - terminated. + A new stream started with the same session ID. The current stream has + been terminated. """ value: ConflictException @@ -5683,9 +5622,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalTranscriptResultStreamServiceUnavailableException: - """ - The service is currently unavailable. Try your request later. - """ + """The service is currently unavailable. Try your request later.""" value: ServiceUnavailableException @@ -5707,7 +5644,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class MedicalTranscriptResultStreamUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -5737,10 +5675,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | MedicalTranscriptResultStreamServiceUnavailableException | MedicalTranscriptResultStreamUnknown ] - -""" -Contains detailed information about your streaming session. -""" +"""Contains detailed information about your streaming session.""" class _MedicalTranscriptResultStreamDeserializer: @@ -5817,63 +5752,60 @@ class PartialResultsStability(StrEnum): @dataclass(kw_only=True) class Result: """ - The ``Result`` associated with a ````. + The `Result` associated with a . - Contains a set of transcription results from one or more audio segments, along - with additional information per your request parameters. This can include - information relating to alternative transcriptions, channel identification, - partial result stabilization, language identification, and other - transcription-related data. + Contains a set of transcription results from one or more audio segments, + along with additional information per your request parameters. This can + include information relating to alternative transcriptions, channel + identification, partial result stabilization, language identification, + and other transcription-related data. """ result_id: str | None = None - """ - Provides a unique identifier for the ``Result``. - """ + """Provides a unique identifier for the `Result`.""" start_time: float = 0 """ - The start time of the ``Result`` in seconds, with millisecond precision (e.g., - 1.056). + The start time of the `Result` in seconds, with millisecond precision + (e.g., 1.056). """ end_time: float = 0 """ - The end time of the ``Result`` in seconds, with millisecond precision (e.g., - 1.056). + The end time of the `Result` in seconds, with millisecond precision + (e.g., 1.056). """ is_partial: bool = False """ Indicates if the segment is complete. - If ``IsPartial`` is ``true``, the segment is not complete. If ``IsPartial`` is - ``false``, the segment is complete. + If `IsPartial` is `true`, the segment is not complete. If `IsPartial` is + `false`, the segment is complete. """ alternatives: list[Alternative] | None = None """ A list of possible alternative transcriptions for the input audio. Each - alternative may contain one or more of ``Items``, ``Entities``, or - ``Transcript``. + alternative may contain one or more of `Items`, `Entities`, or + `Transcript`. """ channel_id: str | None = None - """ - Indicates which audio channel is associated with the ``Result``. - """ + """Indicates which audio channel is associated with the `Result`.""" language_code: str | None = None """ - The language code that represents the language spoken in your audio stream. + The language code that represents the language spoken in your audio + stream. """ language_identification: list[LanguageWithScore] | None = None """ The language code of the dominant language identified in your stream. - If you enabled channel identification and each channel of your audio contains a - different language, you may have more than one result. + If you enabled channel identification and each channel of your audio + contains a different language, you may have more than one result. """ def serialize(self, serializer: ShapeSerializer): @@ -6009,81 +5941,86 @@ class VocabularyFilterMethod(StrEnum): @dataclass(kw_only=True) class StartCallAnalyticsStreamTranscriptionInput: + """Dataclass for StartCallAnalyticsStreamTranscriptionInput structure.""" + language_code: str | None = None """ - Specify the language code that represents the language spoken in your audio. + Specify the language code that represents the language spoken in your + audio. - For a list of languages supported with real-time Call Analytics, refer to the - `Supported languages `_ + For a list of languages supported with real-time Call Analytics, refer + to the [Supported + languages](https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) table. """ media_sample_rate_hertz: int | None = None """ - The sample rate of the input audio (in hertz). Low-quality audio, such as - telephone audio, is typically around 8,000 Hz. High-quality audio typically - ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must - match that of your audio. + The sample rate of the input audio (in hertz). Low-quality audio, such + as telephone audio, is typically around 8,000 Hz. High-quality audio + typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate + you specify must match that of your audio. """ media_encoding: str | None = None """ Specify the encoding of your input audio. Supported formats are: - * FLAC + - FLAC - * OPUS-encoded audio in an Ogg container + - OPUS-encoded audio in an Ogg container - * PCM (only signed 16-bit little-endian audio formats, which does not include - WAV) + - PCM (only signed 16-bit little-endian audio formats, which does not + include WAV) - For more information, see `Media formats `_ - . + For more information, see [Media + formats](https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). """ vocabulary_name: str | None = None """ - Specify the name of the custom vocabulary that you want to use when processing - your transcription. Note that vocabulary names are case sensitive. + Specify the name of the custom vocabulary that you want to use when + processing your transcription. Note that vocabulary names are case + sensitive. - If the language of the specified custom vocabulary doesn't match the language - identified in your media, the custom vocabulary is not applied to your - transcription. + If the language of the specified custom vocabulary doesn't match the + language identified in your media, the custom vocabulary is not applied + to your transcription. - For more information, see `Custom vocabularies `_ - . + For more information, see [Custom + vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). """ session_id: str | None = None """ - Specify a name for your Call Analytics transcription session. If you don't - include this parameter in your request, Amazon Transcribe generates an ID and - returns it in the response. + Specify a name for your Call Analytics transcription session. If you + don't include this parameter in your request, Amazon Transcribe + generates an ID and returns it in the response. """ vocabulary_filter_name: str | None = None """ - Specify the name of the custom vocabulary filter that you want to use when - processing your transcription. Note that vocabulary filter names are case - sensitive. + Specify the name of the custom vocabulary filter that you want to use + when processing your transcription. Note that vocabulary filter names + are case sensitive. - If the language of the specified custom vocabulary filter doesn't match the - language identified in your media, the vocabulary filter is not applied to your - transcription. + If the language of the specified custom vocabulary filter doesn't match + the language identified in your media, the vocabulary filter is not + applied to your transcription. - For more information, see `Using vocabulary filtering with unwanted words `_ - . + For more information, see [Using vocabulary filtering with unwanted + words](https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). """ vocabulary_filter_method: str | None = None """ Specify how you want your vocabulary filter applied to your transcript. - To replace words with ``***``, choose ``mask``. + To replace words with `***`, choose `mask`. - To delete words, choose ``remove``. + To delete words, choose `remove`. - To flag words without changing them, choose ``tag``. + To flag words without changing them, choose `tag`. """ language_model_name: str | None = None @@ -6092,114 +6029,118 @@ class StartCallAnalyticsStreamTranscriptionInput: processing your transcription. Note that language model names are case sensitive. - The language of the specified language model must match the language code you - specify in your transcription request. If the languages don't match, the custom - language model isn't applied. There are no errors or warnings associated with a - language mismatch. + The language of the specified language model must match the language + code you specify in your transcription request. If the languages don't + match, the custom language model isn't applied. There are no errors or + warnings associated with a language mismatch. - For more information, see `Custom language models `_ - . + For more information, see [Custom language + models](https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html). """ identify_language: bool = False """ - Enables automatic language identification for your Call Analytics transcription. + Enables automatic language identification for your Call Analytics + transcription. - If you include ``IdentifyLanguage``, you must include a list of language codes, - using ``LanguageOptions``, that you think may be present in your audio stream. - You must provide a minimum of two language selections. + If you include `IdentifyLanguage`, you must include a list of language + codes, using `LanguageOptions`, that you think may be present in your + audio stream. You must provide a minimum of two language selections. - You can also include a preferred language using ``PreferredLanguage``. Adding a - preferred language can help Amazon Transcribe identify the language faster than - if you omit this parameter. + You can also include a preferred language using `PreferredLanguage`. + Adding a preferred language can help Amazon Transcribe identify the + language faster than if you omit this parameter. - Note that you must include either ``LanguageCode`` or ``IdentifyLanguage`` in - your request. If you include both parameters, your transcription job fails. + Note that you must include either `LanguageCode` or `IdentifyLanguage` + in your request. If you include both parameters, your transcription job + fails. """ language_options: str | None = None """ - Specify two or more language codes that represent the languages you think may be - present in your media. + Specify two or more language codes that represent the languages you + think may be present in your media. - Including language options can improve the accuracy of language identification. + Including language options can improve the accuracy of language + identification. - If you include ``LanguageOptions`` in your request, you must also include - ``IdentifyLanguage``. + If you include `LanguageOptions` in your request, you must also include + `IdentifyLanguage`. - For a list of languages supported with Call Analytics streaming, refer to the - `Supported languages `_ + For a list of languages supported with Call Analytics streaming, refer + to the [Supported + languages](https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) table. - .. important:: - You can only include one language dialect per language per stream. For example, - you cannot include ``en-US`` and ``en-AU`` in the same request. + Warning: + You can only include one language dialect per language per stream. For + example, you cannot include `en-US` and `en-AU` in the same request. """ preferred_language: str | None = None """ - Specify a preferred language from the subset of languages codes you specified in - ``LanguageOptions``. + Specify a preferred language from the subset of languages codes you + specified in `LanguageOptions`. - You can only use this parameter if you've included ``IdentifyLanguage`` and - ``LanguageOptions`` in your request. + You can only use this parameter if you've included `IdentifyLanguage` + and `LanguageOptions` in your request. """ vocabulary_names: str | None = None """ Specify the names of the custom vocabularies that you want to use when - processing your Call Analytics transcription. Note that vocabulary names are - case sensitive. + processing your Call Analytics transcription. Note that vocabulary names + are case sensitive. - If the custom vocabulary's language doesn't match the identified media language, - it won't be applied to the transcription. + If the custom vocabulary's language doesn't match the identified media + language, it won't be applied to the transcription. - .. important:: - This parameter is only intended for use **with** the ``IdentifyLanguage`` - parameter. If you're **not** including ``IdentifyLanguage`` in your request and - want to use a custom vocabulary with your transcription, use the - ``VocabularyName`` parameter instead. + Warning: + This parameter is only intended for use **with** the `IdentifyLanguage` + parameter. If you're **not** including `IdentifyLanguage` in your + request and want to use a custom vocabulary with your transcription, use + the `VocabularyName` parameter instead. - For more information, see `Custom vocabularies `_ - . + For more information, see [Custom + vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). """ vocabulary_filter_names: str | None = None """ - Specify the names of the custom vocabulary filters that you want to use when - processing your Call Analytics transcription. Note that vocabulary filter names - are case sensitive. + Specify the names of the custom vocabulary filters that you want to use + when processing your Call Analytics transcription. Note that vocabulary + filter names are case sensitive. These filters serve to customize the transcript output. - .. important:: - This parameter is only intended for use **with** the ``IdentifyLanguage`` - parameter. If you're **not** including ``IdentifyLanguage`` in your request and - want to use a custom vocabulary filter with your transcription, use the - ``VocabularyFilterName`` parameter instead. + Warning: + This parameter is only intended for use **with** the `IdentifyLanguage` + parameter. If you're **not** including `IdentifyLanguage` in your + request and want to use a custom vocabulary filter with your + transcription, use the `VocabularyFilterName` parameter instead. - For more information, see `Using vocabulary filtering with unwanted words `_ - . + For more information, see [Using vocabulary filtering with unwanted + words](https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). """ enable_partial_results_stabilization: bool = False """ - Enables partial result stabilization for your transcription. Partial result - stabilization can reduce latency in your output, but may impact accuracy. For - more information, see `Partial-result stabilization `_ - . + Enables partial result stabilization for your transcription. Partial + result stabilization can reduce latency in your output, but may impact + accuracy. For more information, see [Partial-result + stabilization](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). """ partial_results_stability: str | None = None """ Specify the level of stability to use when you enable partial results - stabilization (``EnablePartialResultsStabilization``). + stabilization (`EnablePartialResultsStabilization`). - Low stability provides the highest accuracy. High stability transcribes faster, - but with slightly lower accuracy. + Low stability provides the highest accuracy. High stability transcribes + faster, but with slightly lower accuracy. - For more information, see `Partial-result stabilization `_ - . + For more information, see [Partial-result + stabilization](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). """ content_identification_type: str | None = None @@ -6207,15 +6148,18 @@ class StartCallAnalyticsStreamTranscriptionInput: Labels all personally identifiable information (PII) identified in your transcript. - Content identification is performed at the segment level; PII specified in - ``PiiEntityTypes`` is flagged upon complete transcription of an audio segment. - If you don't include ``PiiEntityTypes`` in your request, all PII is identified. + Content identification is performed at the segment level; PII specified + in `PiiEntityTypes` is flagged upon complete transcription of an audio + segment. If you don't include `PiiEntityTypes` in your request, all PII + is identified. - You can’t set ``ContentIdentificationType`` and ``ContentRedactionType`` in the - same request. If you set both, your request returns a ``BadRequestException``. + You can't set `ContentIdentificationType` and `ContentRedactionType` in + the same request. If you set both, your request returns a + `BadRequestException`. - For more information, see `Redacting or identifying personally identifiable information `_ - . + For more information, see [Redacting or identifying personally + identifiable + information](https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). """ content_redaction_type: str | None = None @@ -6224,33 +6168,36 @@ class StartCallAnalyticsStreamTranscriptionInput: transcript. Content redaction is performed at the segment level; PII specified in - ``PiiEntityTypes`` is redacted upon complete transcription of an audio segment. - If you don't include ``PiiEntityTypes`` in your request, all PII is redacted. + `PiiEntityTypes` is redacted upon complete transcription of an audio + segment. If you don't include `PiiEntityTypes` in your request, all PII + is redacted. - You can’t set ``ContentRedactionType`` and ``ContentIdentificationType`` in the - same request. If you set both, your request returns a ``BadRequestException``. + You can't set `ContentRedactionType` and `ContentIdentificationType` in + the same request. If you set both, your request returns a + `BadRequestException`. - For more information, see `Redacting or identifying personally identifiable information `_ - . + For more information, see [Redacting or identifying personally + identifiable + information](https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). """ pii_entity_types: str | None = None """ - Specify which types of personally identifiable information (PII) you want to - redact in your transcript. You can include as many types as you'd like, or you - can select ``ALL``. + Specify which types of personally identifiable information (PII) you + want to redact in your transcript. You can include as many types as + you'd like, or you can select `ALL`. - Values must be comma-separated and can include: ``ADDRESS``, - ``BANK_ACCOUNT_NUMBER``, ``BANK_ROUTING``, ``CREDIT_DEBIT_CVV``, - ``CREDIT_DEBIT_EXPIRY``, ``CREDIT_DEBIT_NUMBER``, ``EMAIL``, ``NAME``, - ``PHONE``, ``PIN``, ``SSN``, or ``ALL``. + Values must be comma-separated and can include: `ADDRESS`, + `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_CVV`, + `CREDIT_DEBIT_EXPIRY`, `CREDIT_DEBIT_NUMBER`, `EMAIL`, `NAME`, `PHONE`, + `PIN`, `SSN`, or `ALL`. - Note that if you include ``PiiEntityTypes`` in your request, you must also - include ``ContentIdentificationType`` or ``ContentRedactionType``. + Note that if you include `PiiEntityTypes` in your request, you must also + include `ContentIdentificationType` or `ContentRedactionType`. - If you include ``ContentRedactionType`` or ``ContentIdentificationType`` in your - request, but do not include ``PiiEntityTypes``, all PII is redacted or - identified. + If you include `ContentRedactionType` or `ContentIdentificationType` in + your request, but do not include `PiiEntityTypes`, all PII is redacted + or identified. """ def serialize(self, serializer: ShapeSerializer): @@ -6550,41 +6497,42 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class StartCallAnalyticsStreamTranscriptionOutput: + """Dataclass for StartCallAnalyticsStreamTranscriptionOutput structure.""" + request_id: str | None = None - """ - Provides the identifier for your real-time Call Analytics request. - """ + """Provides the identifier for your real-time Call Analytics request.""" language_code: str | None = None """ - Provides the language code that you specified in your Call Analytics request. + Provides the language code that you specified in your Call Analytics + request. """ media_sample_rate_hertz: int | None = None """ - Provides the sample rate that you specified in your Call Analytics request. + Provides the sample rate that you specified in your Call Analytics + request. """ media_encoding: str | None = None """ - Provides the media encoding you specified in your Call Analytics request. + Provides the media encoding you specified in your Call Analytics + request. """ vocabulary_name: str | None = None """ - Provides the name of the custom vocabulary that you specified in your Call - Analytics request. + Provides the name of the custom vocabulary that you specified in your + Call Analytics request. """ session_id: str | None = None - """ - Provides the identifier for your Call Analytics transcription session. - """ + """Provides the identifier for your Call Analytics transcription session.""" vocabulary_filter_name: str | None = None """ - Provides the name of the custom vocabulary filter that you specified in your - Call Analytics request. + Provides the name of the custom vocabulary filter that you specified in + your Call Analytics request. """ vocabulary_filter_method: str | None = None @@ -6595,49 +6543,48 @@ class StartCallAnalyticsStreamTranscriptionOutput: language_model_name: str | None = None """ - Provides the name of the custom language model that you specified in your Call - Analytics request. + Provides the name of the custom language model that you specified in + your Call Analytics request. """ identify_language: bool = False """ - Shows whether automatic language identification was enabled for your Call - Analytics transcription. + Shows whether automatic language identification was enabled for your + Call Analytics transcription. """ language_options: str | None = None """ - Provides the language codes that you specified in your Call Analytics request. + Provides the language codes that you specified in your Call Analytics + request. """ preferred_language: str | None = None """ - Provides the preferred language that you specified in your Call Analytics - request. + Provides the preferred language that you specified in your Call + Analytics request. """ vocabulary_names: str | None = None """ - Provides the names of the custom vocabularies that you specified in your Call - Analytics request. + Provides the names of the custom vocabularies that you specified in your + Call Analytics request. """ vocabulary_filter_names: str | None = None """ - Provides the names of the custom vocabulary filters that you specified in your - Call Analytics request. + Provides the names of the custom vocabulary filters that you specified + in your Call Analytics request. """ enable_partial_results_stabilization: bool = False """ - Shows whether partial results stabilization was enabled for your Call Analytics - transcription. + Shows whether partial results stabilization was enabled for your Call + Analytics transcription. """ partial_results_stability: str | None = None - """ - Provides the stabilization level used for your transcription. - """ + """Provides the stabilization level used for your transcription.""" content_identification_type: str | None = None """ @@ -6652,9 +6599,7 @@ class StartCallAnalyticsStreamTranscriptionOutput: """ pii_entity_types: str | None = None - """ - Lists the PII entity types you specified in your Call Analytics request. - """ + """Lists the PII entity types you specified in your Call Analytics request.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct( @@ -6993,23 +6938,23 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class StartMedicalScribeStreamInput: + """Dataclass for StartMedicalScribeStreamInput structure.""" + session_id: str | None = None """ - Specify an identifier for your streaming session (in UUID format). If you don't - include a SessionId in your request, Amazon Web Services HealthScribe generates - an ID and returns it in the response. + Specify an identifier for your streaming session (in UUID format). If + you don't include a SessionId in your request, Amazon Web Services + HealthScribe generates an ID and returns it in the response. """ language_code: str | None = None - """ - Specify the language code for your HealthScribe streaming session. - """ + """Specify the language code for your HealthScribe streaming session.""" media_sample_rate_hertz: int | None = None """ - Specify the sample rate of the input audio (in hertz). Amazon Web Services - HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The sample rate you - specify must match that of your audio. + Specify the sample rate of the input audio (in hertz). Amazon Web + Services HealthScribe supports a range from 16,000 Hz to 48,000 Hz. The + sample rate you specify must match that of your audio. """ media_encoding: str | None = None @@ -7018,15 +6963,15 @@ class StartMedicalScribeStreamInput: Supported formats are: - * FLAC + - FLAC - * OPUS-encoded audio in an Ogg container + - OPUS-encoded audio in an Ogg container - * PCM (only signed 16-bit little-endian audio formats, which does not include - WAV) + - PCM (only signed 16-bit little-endian audio formats, which does not + include WAV) - For more information, see `Media formats `_ - . + For more information, see [Media + formats](https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). """ def serialize(self, serializer: ShapeSerializer): @@ -7106,35 +7051,35 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class StartMedicalScribeStreamOutput: + """Dataclass for StartMedicalScribeStreamOutput structure.""" + session_id: str | None = None """ The identifier (in UUID format) for your streaming session. - If you already started streaming, this is same ID as the one you specified in - your initial ``StartMedicalScribeStreamRequest``. + If you already started streaming, this is same ID as the one you + specified in your initial `StartMedicalScribeStreamRequest`. """ request_id: str | None = None - """ - The unique identifier for your streaming request. - """ + """The unique identifier for your streaming request.""" language_code: str | None = None """ - The Language Code that you specified in your request. Same as provided in the - ``StartMedicalScribeStreamRequest``. + The Language Code that you specified in your request. Same as provided + in the `StartMedicalScribeStreamRequest`. """ media_sample_rate_hertz: int | None = None """ - The sample rate (in hertz) that you specified in your request. Same as provided - in the ``StartMedicalScribeStreamRequest`` + The sample rate (in hertz) that you specified in your request. Same as + provided in the `StartMedicalScribeStreamRequest` """ media_encoding: str | None = None """ - The Media Encoding you specified in your request. Same as provided in the - ``StartMedicalScribeStreamRequest`` + The Media Encoding you specified in your request. Same as provided in + the `StartMedicalScribeStreamRequest` """ def serialize(self, serializer: ShapeSerializer): @@ -7259,107 +7204,113 @@ class Type(StrEnum): @dataclass(kw_only=True) class StartMedicalStreamTranscriptionInput: + """Dataclass for StartMedicalStreamTranscriptionInput structure.""" + language_code: str | None = None """ - Specify the language code that represents the language spoken in your audio. + Specify the language code that represents the language spoken in your + audio. - .. important:: - Amazon Transcribe Medical only supports US English (``en-US``). + Warning: + Amazon Transcribe Medical only supports US English (`en-US`). """ media_sample_rate_hertz: int | None = None """ The sample rate of the input audio (in hertz). Amazon Transcribe Medical - supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate you - specify must match that of your audio. + supports a range from 16,000 Hz to 48,000 Hz. Note that the sample rate + you specify must match that of your audio. """ media_encoding: str | None = None """ Specify the encoding used for the input audio. Supported formats are: - * FLAC + - FLAC - * OPUS-encoded audio in an Ogg container + - OPUS-encoded audio in an Ogg container - * PCM (only signed 16-bit little-endian audio formats, which does not include - WAV) + - PCM (only signed 16-bit little-endian audio formats, which does not + include WAV) - For more information, see `Media formats `_ - . + For more information, see [Media + formats](https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). """ vocabulary_name: str | None = None """ - Specify the name of the custom vocabulary that you want to use when processing - your transcription. Note that vocabulary names are case sensitive. + Specify the name of the custom vocabulary that you want to use when + processing your transcription. Note that vocabulary names are case + sensitive. """ specialty: str | None = None - """ - Specify the medical specialty contained in your audio. - """ + """Specify the medical specialty contained in your audio.""" type: str | None = None """ - Specify the type of input audio. For example, choose ``DICTATION`` for a - provider dictating patient notes and ``CONVERSATION`` for a dialogue between a - patient and a medical professional. + Specify the type of input audio. For example, choose `DICTATION` for a + provider dictating patient notes and `CONVERSATION` for a dialogue + between a patient and a medical professional. """ show_speaker_label: bool = False """ - Enables speaker partitioning (diarization) in your transcription output. Speaker - partitioning labels the speech from individual speakers in your media file. + Enables speaker partitioning (diarization) in your transcription output. + Speaker partitioning labels the speech from individual speakers in your + media file. - For more information, see `Partitioning speakers (diarization) `_ - . + For more information, see [Partitioning speakers + (diarization)](https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). """ session_id: str | None = None """ - Specify a name for your transcription session. If you don't include this - parameter in your request, Amazon Transcribe Medical generates an ID and returns - it in the response. + Specify a name for your transcription session. If you don't include + this parameter in your request, Amazon Transcribe Medical generates an + ID and returns it in the response. """ enable_channel_identification: bool = False """ Enables channel identification in multi-channel audio. - Channel identification transcribes the audio on each channel independently, then - appends the output for each channel into one transcript. + Channel identification transcribes the audio on each channel + independently, then appends the output for each channel into one + transcript. - If you have multi-channel audio and do not enable channel identification, your - audio is transcribed in a continuous manner and your transcript is not separated - by channel. + If you have multi-channel audio and do not enable channel + identification, your audio is transcribed in a continuous manner and + your transcript is not separated by channel. - If you include ``EnableChannelIdentification`` in your request, you must also - include ``NumberOfChannels``. + If you include `EnableChannelIdentification` in your request, you must + also include `NumberOfChannels`. - For more information, see `Transcribing multi-channel audio `_ - . + For more information, see [Transcribing multi-channel + audio](https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). """ number_of_channels: int | None = None """ - Specify the number of channels in your audio stream. This value must be ``2``, - as only two channels are supported. If your audio doesn't contain multiple - channels, do not include this parameter in your request. + Specify the number of channels in your audio stream. This value must be + `2`, as only two channels are supported. If your audio doesn't contain + multiple channels, do not include this parameter in your request. - If you include ``NumberOfChannels`` in your request, you must also include - ``EnableChannelIdentification``. + If you include `NumberOfChannels` in your request, you must also include + `EnableChannelIdentification`. """ content_identification_type: str | None = None """ - Labels all personal health information (PHI) identified in your transcript. + Labels all personal health information (PHI) identified in your + transcript. - Content identification is performed at the segment level; PHI is flagged upon - complete transcription of an audio segment. + Content identification is performed at the segment level; PHI is flagged + upon complete transcription of an audio segment. - For more information, see `Identifying personal health information (PHI) in a transcription `_ - . + For more information, see [Identifying personal health information (PHI) + in a + transcription](https://docs.aws.amazon.com/transcribe/latest/dg/phi-id.html). """ def serialize(self, serializer: ShapeSerializer): @@ -7544,66 +7495,49 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class StartMedicalStreamTranscriptionOutput: + """Dataclass for StartMedicalStreamTranscriptionOutput structure.""" + request_id: str | None = None - """ - Provides the identifier for your streaming request. - """ + """Provides the identifier for your streaming request.""" language_code: str | None = None """ - Provides the language code that you specified in your request. This must be - ``en-US``. + Provides the language code that you specified in your request. This must + be `en-US`. """ media_sample_rate_hertz: int | None = None - """ - Provides the sample rate that you specified in your request. - """ + """Provides the sample rate that you specified in your request.""" media_encoding: str | None = None - """ - Provides the media encoding you specified in your request. - """ + """Provides the media encoding you specified in your request.""" vocabulary_name: str | None = None """ - Provides the name of the custom vocabulary that you specified in your request. + Provides the name of the custom vocabulary that you specified in your + request. """ specialty: str | None = None - """ - Provides the medical specialty that you specified in your request. - """ + """Provides the medical specialty that you specified in your request.""" type: str | None = None - """ - Provides the type of audio you specified in your request. - """ + """Provides the type of audio you specified in your request.""" show_speaker_label: bool = False - """ - Shows whether speaker partitioning was enabled for your transcription. - """ + """Shows whether speaker partitioning was enabled for your transcription.""" session_id: str | None = None - """ - Provides the identifier for your transcription session. - """ + """Provides the identifier for your transcription session.""" enable_channel_identification: bool = False - """ - Shows whether channel identification was enabled for your transcription. - """ + """Shows whether channel identification was enabled for your transcription.""" number_of_channels: int | None = None - """ - Provides the number of channels that you specified in your request. - """ + """Provides the number of channels that you specified in your request.""" content_identification_type: str | None = None - """ - Shows whether content identification was enabled for your transcription. - """ + """Shows whether content identification was enabled for your transcription.""" def serialize(self, serializer: ShapeSerializer): serializer.write_struct(_SCHEMA_START_MEDICAL_STREAM_TRANSCRIPTION_OUTPUT, self) @@ -7827,153 +7761,160 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class StartStreamTranscriptionInput: + """Dataclass for StartStreamTranscriptionInput structure.""" + language_code: str | None = None """ - Specify the language code that represents the language spoken in your audio. + Specify the language code that represents the language spoken in your + audio. If you're unsure of the language spoken in your audio, consider using - ``IdentifyLanguage`` to enable automatic language identification. + `IdentifyLanguage` to enable automatic language identification. - For a list of languages supported with Amazon Transcribe streaming, refer to the - `Supported languages `_ + For a list of languages supported with Amazon Transcribe streaming, + refer to the [Supported + languages](https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) table. """ media_sample_rate_hertz: int | None = None """ - The sample rate of the input audio (in hertz). Low-quality audio, such as - telephone audio, is typically around 8,000 Hz. High-quality audio typically - ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate you specify must - match that of your audio. + The sample rate of the input audio (in hertz). Low-quality audio, such + as telephone audio, is typically around 8,000 Hz. High-quality audio + typically ranges from 16,000 Hz to 48,000 Hz. Note that the sample rate + you specify must match that of your audio. """ media_encoding: str | None = None """ Specify the encoding of your input audio. Supported formats are: - * FLAC + - FLAC - * OPUS-encoded audio in an Ogg container + - OPUS-encoded audio in an Ogg container - * PCM (only signed 16-bit little-endian audio formats, which does not include - WAV) + - PCM (only signed 16-bit little-endian audio formats, which does not + include WAV) - For more information, see `Media formats `_ - . + For more information, see [Media + formats](https://docs.aws.amazon.com/transcribe/latest/dg/how-input.html#how-input-audio). """ vocabulary_name: str | None = None """ - Specify the name of the custom vocabulary that you want to use when processing - your transcription. Note that vocabulary names are case sensitive. + Specify the name of the custom vocabulary that you want to use when + processing your transcription. Note that vocabulary names are case + sensitive. - If the language of the specified custom vocabulary doesn't match the language - identified in your media, the custom vocabulary is not applied to your - transcription. + If the language of the specified custom vocabulary doesn't match the + language identified in your media, the custom vocabulary is not applied + to your transcription. - .. important:: - This parameter is **not** intended for use with the ``IdentifyLanguage`` - parameter. If you're including ``IdentifyLanguage`` in your request and want to - use one or more custom vocabularies with your transcription, use the - ``VocabularyNames`` parameter instead. + Warning: + This parameter is **not** intended for use with the `IdentifyLanguage` + parameter. If you're including `IdentifyLanguage` in your request and + want to use one or more custom vocabularies with your transcription, use + the `VocabularyNames` parameter instead. - For more information, see `Custom vocabularies `_ - . + For more information, see [Custom + vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). """ session_id: str | None = None """ - Specify a name for your transcription session. If you don't include this - parameter in your request, Amazon Transcribe generates an ID and returns it in - the response. + Specify a name for your transcription session. If you don't include + this parameter in your request, Amazon Transcribe generates an ID and + returns it in the response. """ vocabulary_filter_name: str | None = None """ - Specify the name of the custom vocabulary filter that you want to use when - processing your transcription. Note that vocabulary filter names are case - sensitive. + Specify the name of the custom vocabulary filter that you want to use + when processing your transcription. Note that vocabulary filter names + are case sensitive. - If the language of the specified custom vocabulary filter doesn't match the - language identified in your media, the vocabulary filter is not applied to your - transcription. + If the language of the specified custom vocabulary filter doesn't match + the language identified in your media, the vocabulary filter is not + applied to your transcription. - .. important:: - This parameter is **not** intended for use with the ``IdentifyLanguage`` - parameter. If you're including ``IdentifyLanguage`` in your request and want to - use one or more vocabulary filters with your transcription, use the - ``VocabularyFilterNames`` parameter instead. + Warning: + This parameter is **not** intended for use with the `IdentifyLanguage` + parameter. If you're including `IdentifyLanguage` in your request and + want to use one or more vocabulary filters with your transcription, use + the `VocabularyFilterNames` parameter instead. - For more information, see `Using vocabulary filtering with unwanted words `_ - . + For more information, see [Using vocabulary filtering with unwanted + words](https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). """ vocabulary_filter_method: str | None = None """ Specify how you want your vocabulary filter applied to your transcript. - To replace words with ``***``, choose ``mask``. + To replace words with `***`, choose `mask`. - To delete words, choose ``remove``. + To delete words, choose `remove`. - To flag words without changing them, choose ``tag``. + To flag words without changing them, choose `tag`. """ show_speaker_label: bool = False """ - Enables speaker partitioning (diarization) in your transcription output. Speaker - partitioning labels the speech from individual speakers in your media file. + Enables speaker partitioning (diarization) in your transcription output. + Speaker partitioning labels the speech from individual speakers in your + media file. - For more information, see `Partitioning speakers (diarization) `_ - . + For more information, see [Partitioning speakers + (diarization)](https://docs.aws.amazon.com/transcribe/latest/dg/diarization.html). """ enable_channel_identification: bool = False """ Enables channel identification in multi-channel audio. - Channel identification transcribes the audio on each channel independently, then - appends the output for each channel into one transcript. + Channel identification transcribes the audio on each channel + independently, then appends the output for each channel into one + transcript. - If you have multi-channel audio and do not enable channel identification, your - audio is transcribed in a continuous manner and your transcript is not separated - by channel. + If you have multi-channel audio and do not enable channel + identification, your audio is transcribed in a continuous manner and + your transcript is not separated by channel. - If you include ``EnableChannelIdentification`` in your request, you must also - include ``NumberOfChannels``. + If you include `EnableChannelIdentification` in your request, you must + also include `NumberOfChannels`. - For more information, see `Transcribing multi-channel audio `_ - . + For more information, see [Transcribing multi-channel + audio](https://docs.aws.amazon.com/transcribe/latest/dg/channel-id.html). """ number_of_channels: int | None = None """ - Specify the number of channels in your audio stream. This value must be ``2``, - as only two channels are supported. If your audio doesn't contain multiple - channels, do not include this parameter in your request. + Specify the number of channels in your audio stream. This value must be + `2`, as only two channels are supported. If your audio doesn't contain + multiple channels, do not include this parameter in your request. - If you include ``NumberOfChannels`` in your request, you must also include - ``EnableChannelIdentification``. + If you include `NumberOfChannels` in your request, you must also include + `EnableChannelIdentification`. """ enable_partial_results_stabilization: bool = False """ - Enables partial result stabilization for your transcription. Partial result - stabilization can reduce latency in your output, but may impact accuracy. For - more information, see `Partial-result stabilization `_ - . + Enables partial result stabilization for your transcription. Partial + result stabilization can reduce latency in your output, but may impact + accuracy. For more information, see [Partial-result + stabilization](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). """ partial_results_stability: str | None = None """ Specify the level of stability to use when you enable partial results - stabilization (``EnablePartialResultsStabilization``). + stabilization (`EnablePartialResultsStabilization`). - Low stability provides the highest accuracy. High stability transcribes faster, - but with slightly lower accuracy. + Low stability provides the highest accuracy. High stability transcribes + faster, but with slightly lower accuracy. - For more information, see `Partial-result stabilization `_ - . + For more information, see [Partial-result + stabilization](https://docs.aws.amazon.com/transcribe/latest/dg/streaming.html#streaming-partial-result-stabilization). """ content_identification_type: str | None = None @@ -7981,15 +7922,18 @@ class StartStreamTranscriptionInput: Labels all personally identifiable information (PII) identified in your transcript. - Content identification is performed at the segment level; PII specified in - ``PiiEntityTypes`` is flagged upon complete transcription of an audio segment. - If you don't include ``PiiEntityTypes`` in your request, all PII is identified. + Content identification is performed at the segment level; PII specified + in `PiiEntityTypes` is flagged upon complete transcription of an audio + segment. If you don't include `PiiEntityTypes` in your request, all PII + is identified. - You can’t set ``ContentIdentificationType`` and ``ContentRedactionType`` in the - same request. If you set both, your request returns a ``BadRequestException``. + You can't set `ContentIdentificationType` and `ContentRedactionType` in + the same request. If you set both, your request returns a + `BadRequestException`. - For more information, see `Redacting or identifying personally identifiable information `_ - . + For more information, see [Redacting or identifying personally + identifiable + information](https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). """ content_redaction_type: str | None = None @@ -7998,33 +7942,36 @@ class StartStreamTranscriptionInput: transcript. Content redaction is performed at the segment level; PII specified in - ``PiiEntityTypes`` is redacted upon complete transcription of an audio segment. - If you don't include ``PiiEntityTypes`` in your request, all PII is redacted. + `PiiEntityTypes` is redacted upon complete transcription of an audio + segment. If you don't include `PiiEntityTypes` in your request, all PII + is redacted. - You can’t set ``ContentRedactionType`` and ``ContentIdentificationType`` in the - same request. If you set both, your request returns a ``BadRequestException``. + You can't set `ContentRedactionType` and `ContentIdentificationType` in + the same request. If you set both, your request returns a + `BadRequestException`. - For more information, see `Redacting or identifying personally identifiable information `_ - . + For more information, see [Redacting or identifying personally + identifiable + information](https://docs.aws.amazon.com/transcribe/latest/dg/pii-redaction.html). """ pii_entity_types: str | None = None """ - Specify which types of personally identifiable information (PII) you want to - redact in your transcript. You can include as many types as you'd like, or you - can select ``ALL``. + Specify which types of personally identifiable information (PII) you + want to redact in your transcript. You can include as many types as + you'd like, or you can select `ALL`. - Values must be comma-separated and can include: ``ADDRESS``, - ``BANK_ACCOUNT_NUMBER``, ``BANK_ROUTING``, ``CREDIT_DEBIT_CVV``, - ``CREDIT_DEBIT_EXPIRY``, ``CREDIT_DEBIT_NUMBER``, ``EMAIL``, ``NAME``, - ``PHONE``, ``PIN``, ``SSN``, or ``ALL``. + Values must be comma-separated and can include: `ADDRESS`, + `BANK_ACCOUNT_NUMBER`, `BANK_ROUTING`, `CREDIT_DEBIT_CVV`, + `CREDIT_DEBIT_EXPIRY`, `CREDIT_DEBIT_NUMBER`, `EMAIL`, `NAME`, `PHONE`, + `PIN`, `SSN`, or `ALL`. - Note that if you include ``PiiEntityTypes`` in your request, you must also - include ``ContentIdentificationType`` or ``ContentRedactionType``. + Note that if you include `PiiEntityTypes` in your request, you must also + include `ContentIdentificationType` or `ContentRedactionType`. - If you include ``ContentRedactionType`` or ``ContentIdentificationType`` in your - request, but do not include ``PiiEntityTypes``, all PII is redacted or - identified. + If you include `ContentRedactionType` or `ContentIdentificationType` in + your request, but do not include `PiiEntityTypes`, all PII is redacted + or identified. """ language_model_name: str | None = None @@ -8033,120 +7980,127 @@ class StartStreamTranscriptionInput: processing your transcription. Note that language model names are case sensitive. - The language of the specified language model must match the language code you - specify in your transcription request. If the languages don't match, the custom - language model isn't applied. There are no errors or warnings associated with a - language mismatch. + The language of the specified language model must match the language + code you specify in your transcription request. If the languages don't + match, the custom language model isn't applied. There are no errors or + warnings associated with a language mismatch. - For more information, see `Custom language models `_ - . + For more information, see [Custom language + models](https://docs.aws.amazon.com/transcribe/latest/dg/custom-language-models.html). """ identify_language: bool = False """ Enables automatic language identification for your transcription. - If you include ``IdentifyLanguage``, you must include a list of language codes, - using ``LanguageOptions``, that you think may be present in your audio stream. + If you include `IdentifyLanguage`, you must include a list of language + codes, using `LanguageOptions`, that you think may be present in your + audio stream. - You can also include a preferred language using ``PreferredLanguage``. Adding a - preferred language can help Amazon Transcribe identify the language faster than - if you omit this parameter. + You can also include a preferred language using `PreferredLanguage`. + Adding a preferred language can help Amazon Transcribe identify the + language faster than if you omit this parameter. - If you have multi-channel audio that contains different languages on each - channel, and you've enabled channel identification, automatic language - identification identifies the dominant language on each audio channel. + If you have multi-channel audio that contains different languages on + each channel, and you've enabled channel identification, automatic + language identification identifies the dominant language on each audio + channel. - Note that you must include either ``LanguageCode`` or ``IdentifyLanguage`` or - ``IdentifyMultipleLanguages`` in your request. If you include more than one of - these parameters, your transcription job fails. + Note that you must include either `LanguageCode` or `IdentifyLanguage` + or `IdentifyMultipleLanguages` in your request. If you include more than + one of these parameters, your transcription job fails. - Streaming language identification can't be combined with custom language models - or redaction. + Streaming language identification can't be combined with custom + language models or redaction. """ language_options: str | None = None """ - Specify two or more language codes that represent the languages you think may be - present in your media; including more than five is not recommended. + Specify two or more language codes that represent the languages you + think may be present in your media; including more than five is not + recommended. - Including language options can improve the accuracy of language identification. + Including language options can improve the accuracy of language + identification. - If you include ``LanguageOptions`` in your request, you must also include - ``IdentifyLanguage`` or ``IdentifyMultipleLanguages``. + If you include `LanguageOptions` in your request, you must also include + `IdentifyLanguage` or `IdentifyMultipleLanguages`. - For a list of languages supported with Amazon Transcribe streaming, refer to the - `Supported languages `_ + For a list of languages supported with Amazon Transcribe streaming, + refer to the [Supported + languages](https://docs.aws.amazon.com/transcribe/latest/dg/supported-languages.html) table. - .. important:: - You can only include one language dialect per language per stream. For example, - you cannot include ``en-US`` and ``en-AU`` in the same request. + Warning: + You can only include one language dialect per language per stream. For + example, you cannot include `en-US` and `en-AU` in the same request. """ preferred_language: str | None = None """ - Specify a preferred language from the subset of languages codes you specified in - ``LanguageOptions``. + Specify a preferred language from the subset of languages codes you + specified in `LanguageOptions`. - You can only use this parameter if you've included ``IdentifyLanguage`` and - ``LanguageOptions`` in your request. + You can only use this parameter if you've included `IdentifyLanguage` + and `LanguageOptions` in your request. """ identify_multiple_languages: bool = False """ - Enables automatic multi-language identification in your transcription job - request. Use this parameter if your stream contains more than one language. If - your stream contains only one language, use IdentifyLanguage instead. + Enables automatic multi-language identification in your transcription + job request. Use this parameter if your stream contains more than one + language. If your stream contains only one language, use + IdentifyLanguage instead. - If you include ``IdentifyMultipleLanguages``, you must include a list of - language codes, using ``LanguageOptions``, that you think may be present in your - stream. + If you include `IdentifyMultipleLanguages`, you must include a list of + language codes, using `LanguageOptions`, that you think may be present + in your stream. - If you want to apply a custom vocabulary or a custom vocabulary filter to your - automatic multiple language identification request, include ``VocabularyNames`` - or ``VocabularyFilterNames``. + If you want to apply a custom vocabulary or a custom vocabulary filter + to your automatic multiple language identification request, include + `VocabularyNames` or `VocabularyFilterNames`. - Note that you must include one of ``LanguageCode``, ``IdentifyLanguage``, or - ``IdentifyMultipleLanguages`` in your request. If you include more than one of - these parameters, your transcription job fails. + Note that you must include one of `LanguageCode`, `IdentifyLanguage`, or + `IdentifyMultipleLanguages` in your request. If you include more than + one of these parameters, your transcription job fails. """ vocabulary_names: str | None = None """ Specify the names of the custom vocabularies that you want to use when - processing your transcription. Note that vocabulary names are case sensitive. + processing your transcription. Note that vocabulary names are case + sensitive. - If none of the languages of the specified custom vocabularies match the language - identified in your media, your job fails. + If none of the languages of the specified custom vocabularies match the + language identified in your media, your job fails. - .. important:: - This parameter is only intended for use **with** the ``IdentifyLanguage`` - parameter. If you're **not** including ``IdentifyLanguage`` in your request and - want to use a custom vocabulary with your transcription, use the - ``VocabularyName`` parameter instead. + Warning: + This parameter is only intended for use **with** the `IdentifyLanguage` + parameter. If you're **not** including `IdentifyLanguage` in your + request and want to use a custom vocabulary with your transcription, use + the `VocabularyName` parameter instead. - For more information, see `Custom vocabularies `_ - . + For more information, see [Custom + vocabularies](https://docs.aws.amazon.com/transcribe/latest/dg/custom-vocabulary.html). """ vocabulary_filter_names: str | None = None """ - Specify the names of the custom vocabulary filters that you want to use when - processing your transcription. Note that vocabulary filter names are case - sensitive. + Specify the names of the custom vocabulary filters that you want to use + when processing your transcription. Note that vocabulary filter names + are case sensitive. - If none of the languages of the specified custom vocabulary filters match the - language identified in your media, your job fails. + If none of the languages of the specified custom vocabulary filters + match the language identified in your media, your job fails. - .. important:: - This parameter is only intended for use **with** the ``IdentifyLanguage`` - parameter. If you're **not** including ``IdentifyLanguage`` in your request and - want to use a custom vocabulary filter with your transcription, use the - ``VocabularyFilterName`` parameter instead. + Warning: + This parameter is only intended for use **with** the `IdentifyLanguage` + parameter. If you're **not** including `IdentifyLanguage` in your + request and want to use a custom vocabulary filter with your + transcription, use the `VocabularyFilterName` parameter instead. - For more information, see `Using vocabulary filtering with unwanted words `_ - . + For more information, see [Using vocabulary filtering with unwanted + words](https://docs.aws.amazon.com/transcribe/latest/dg/vocabulary-filtering.html). """ def serialize(self, serializer: ShapeSerializer): @@ -8477,20 +8431,20 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class Transcript: """ - The ``Transcript`` associated with a ````. + The `Transcript` associated with a . - ``Transcript`` contains ``Results``, which contains a set of transcription - results from one or more audio segments, along with additional information per - your request parameters. + `Transcript` contains `Results`, which contains a set of transcription + results from one or more audio segments, along with additional + information per your request parameters. """ results: list[Result] | None = None """ - Contains a set of transcription results from one or more audio segments, along - with additional information per your request parameters. This can include - information relating to alternative transcriptions, channel identification, - partial result stabilization, language identification, and other - transcription-related data. + Contains a set of transcription results from one or more audio segments, + along with additional information per your request parameters. This can + include information relating to alternative transcriptions, channel + identification, partial result stabilization, language identification, + and other transcription-related data. """ def serialize(self, serializer: ShapeSerializer): @@ -8527,19 +8481,19 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass(kw_only=True) class TranscriptEvent: """ - The ``TranscriptEvent`` associated with a ``TranscriptResultStream``. + The `TranscriptEvent` associated with a `TranscriptResultStream`. - Contains a set of transcription results from one or more audio segments, along - with additional information per your request parameters. + Contains a set of transcription results from one or more audio segments, + along with additional information per your request parameters. """ transcript: Transcript | None = None """ - Contains ``Results``, which contains a set of transcription results from one or - more audio segments, along with additional information per your request - parameters. This can include information relating to alternative transcriptions, - channel identification, partial result stabilization, language identification, - and other transcription-related data. + Contains `Results`, which contains a set of transcription results from + one or more audio segments, along with additional information per your + request parameters. This can include information relating to alternative + transcriptions, channel identification, partial result stabilization, + language identification, and other transcription-related data. """ def serialize(self, serializer: ShapeSerializer): @@ -8574,7 +8528,7 @@ def _consumer(schema: Schema, de: ShapeDeserializer) -> None: @dataclass class TranscriptResultStreamTranscriptEvent: """ - Contains ``Transcript``, which contains ``Results``. The ```` object contains a + Contains `Transcript`, which contains `Results`. The object contains a set of transcription results from one or more audio segments, along with additional information per your request parameters. """ @@ -8597,8 +8551,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class TranscriptResultStreamBadRequestException: """ - A client error occurred when the stream was created. Check the parameters of the - request and try your request again. + A client error occurred when the stream was created. Check the + parameters of the request and try your request again. """ value: BadRequestException @@ -8619,9 +8573,9 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class TranscriptResultStreamLimitExceededException: """ - Your client has exceeded one of the Amazon Transcribe limits. This is typically - the audio length limit. Break your audio stream into smaller chunks and try your - request again. + Your client has exceeded one of the Amazon Transcribe limits. This is + typically the audio length limit. Break your audio stream into smaller + chunks and try your request again. """ value: LimitExceededException @@ -8643,8 +8597,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class TranscriptResultStreamInternalFailureException: """ - A problem occurred while processing the audio. Amazon Transcribe terminated - processing. + A problem occurred while processing the audio. Amazon Transcribe + terminated processing. """ value: InternalFailureException @@ -8666,8 +8620,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class TranscriptResultStreamConflictException: """ - A new stream started with the same session ID. The current stream has been - terminated. + A new stream started with the same session ID. The current stream has + been terminated. """ value: ConflictException @@ -8687,9 +8641,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class TranscriptResultStreamServiceUnavailableException: - """ - The service is currently unavailable. Try your request later. - """ + """The service is currently unavailable. Try your request later.""" value: ServiceUnavailableException @@ -8709,7 +8661,8 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: @dataclass class TranscriptResultStreamUnknown: - """Represents an unknown variant. + """ + Represents an unknown variant. If you receive this value, you will need to update your library to receive the parsed value. @@ -8739,10 +8692,7 @@ def deserialize(cls, deserializer: ShapeDeserializer) -> Self: | TranscriptResultStreamServiceUnavailableException | TranscriptResultStreamUnknown ] - -""" -Contains detailed information about your streaming session. -""" +"""Contains detailed information about your streaming session.""" class _TranscriptResultStreamDeserializer: @@ -8802,91 +8752,69 @@ def _set_result(self, value: TranscriptResultStream) -> None: @dataclass(kw_only=True) class StartStreamTranscriptionOutput: + """Dataclass for StartStreamTranscriptionOutput structure.""" + request_id: str | None = None - """ - Provides the identifier for your streaming request. - """ + """Provides the identifier for your streaming request.""" language_code: str | None = None - """ - Provides the language code that you specified in your request. - """ + """Provides the language code that you specified in your request.""" media_sample_rate_hertz: int | None = None - """ - Provides the sample rate that you specified in your request. - """ + """Provides the sample rate that you specified in your request.""" media_encoding: str | None = None - """ - Provides the media encoding you specified in your request. - """ + """Provides the media encoding you specified in your request.""" vocabulary_name: str | None = None """ - Provides the name of the custom vocabulary that you specified in your request. + Provides the name of the custom vocabulary that you specified in your + request. """ session_id: str | None = None - """ - Provides the identifier for your transcription session. - """ + """Provides the identifier for your transcription session.""" vocabulary_filter_name: str | None = None """ - Provides the name of the custom vocabulary filter that you specified in your - request. + Provides the name of the custom vocabulary filter that you specified in + your request. """ vocabulary_filter_method: str | None = None - """ - Provides the vocabulary filtering method used in your transcription. - """ + """Provides the vocabulary filtering method used in your transcription.""" show_speaker_label: bool = False - """ - Shows whether speaker partitioning was enabled for your transcription. - """ + """Shows whether speaker partitioning was enabled for your transcription.""" enable_channel_identification: bool = False - """ - Shows whether channel identification was enabled for your transcription. - """ + """Shows whether channel identification was enabled for your transcription.""" number_of_channels: int | None = None - """ - Provides the number of channels that you specified in your request. - """ + """Provides the number of channels that you specified in your request.""" enable_partial_results_stabilization: bool = False """ - Shows whether partial results stabilization was enabled for your transcription. + Shows whether partial results stabilization was enabled for your + transcription. """ partial_results_stability: str | None = None - """ - Provides the stabilization level used for your transcription. - """ + """Provides the stabilization level used for your transcription.""" content_identification_type: str | None = None - """ - Shows whether content identification was enabled for your transcription. - """ + """Shows whether content identification was enabled for your transcription.""" content_redaction_type: str | None = None - """ - Shows whether content redaction was enabled for your transcription. - """ + """Shows whether content redaction was enabled for your transcription.""" pii_entity_types: str | None = None - """ - Lists the PII entity types you specified in your request. - """ + """Lists the PII entity types you specified in your request.""" language_model_name: str | None = None """ - Provides the name of the custom language model that you specified in your - request. + Provides the name of the custom language model that you specified in + your request. """ identify_language: bool = False @@ -8896,19 +8824,15 @@ class StartStreamTranscriptionOutput: """ language_options: str | None = None - """ - Provides the language codes that you specified in your request. - """ + """Provides the language codes that you specified in your request.""" preferred_language: str | None = None - """ - Provides the preferred language that you specified in your request. - """ + """Provides the preferred language that you specified in your request.""" identify_multiple_languages: bool = False """ - Shows whether automatic multi-language identification was enabled for your - transcription. + Shows whether automatic multi-language identification was enabled for + your transcription. """ vocabulary_names: str | None = None @@ -8919,8 +8843,8 @@ class StartStreamTranscriptionOutput: vocabulary_filter_names: str | None = None """ - Provides the names of the custom vocabulary filters that you specified in your - request. + Provides the names of the custom vocabulary filters that you specified + in your request. """ def serialize(self, serializer: ShapeSerializer):