https://github.com/alexa/alexa-skills-kit-sdk-for-python
The Alexa Skills Kit SDK for Python helps you get a skill up and running quickly, letting you focus on skill logic instead of boilerplate code.
https://github.com/alexa/alexa-skills-kit-sdk-for-python
alexa alexa-sdk alexa-skill alexa-skill-development alexa-skills-kit python sdk sdk-python skills software-development-kit
Last synced: 5 months ago
JSON representation
The Alexa Skills Kit SDK for Python helps you get a skill up and running quickly, letting you focus on skill logic instead of boilerplate code.
- Host: GitHub
- URL: https://github.com/alexa/alexa-skills-kit-sdk-for-python
- Owner: alexa
- License: apache-2.0
- Created: 2018-04-19T23:40:46.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-11T05:19:21.000Z (over 1 year ago)
- Last Synced: 2024-11-08T08:09:24.472Z (6 months ago)
- Topics: alexa, alexa-sdk, alexa-skill, alexa-skill-development, alexa-skills-kit, python, sdk, sdk-python, skills, software-development-kit
- Language: Python
- Homepage: https://developer.amazon.com/en-US/docs/alexa/alexa-skills-kit-sdk-for-python/overview.html
- Size: 782 KB
- Stars: 811
- Watchers: 76
- Forks: 206
- Open Issues: 6
-
Metadata Files:
- Readme: README.ja.rst
- Changelog: CHANGELOG.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
ASK SDK for Python
===============================
`English `_ | `日本語 `_
|Build Status| |License|
**ASK SDK for Python**\ を使うと、ボイラープレートコード（毎回書かなければならないお決まりのコード）を書く手間が不要になります。これにより空いた時間をさまざまな機能の実装に充てることができ、人気のスキルをより簡単に作成できるようになります。
.. |Build Status| image:: https://github.com/alexa/alexa-skills-kit-sdk-for-python/workflows/Tox%20tests%20on%20SDK%20packages/badge.svg?style=flat
:target: https://github.com/alexa/alexa-skills-kit-sdk-for-python/actions?query=workflow%3A%22Tox+tests+on+SDK+packages%22
:alt: Build Status
.. |Runtime Version| image:: http://img.shields.io/pypi/v/ask-sdk-runtime.svg?style=flat
:target: https://pypi.python.org/pypi/ask-sdk-runtime/
:alt: Version
.. |Runtime Downloads| image:: https://pepy.tech/badge/ask-sdk-runtime
:target: https://pepy.tech/project/ask-sdk-runtime
:alt: Downloads
.. |Core Version| image:: http://img.shields.io/pypi/v/ask-sdk-core.svg?style=flat
:target: https://pypi.python.org/pypi/ask-sdk-core/
:alt: Version
.. |Core Downloads| image:: https://pepy.tech/badge/ask-sdk-core
:target: https://pepy.tech/project/ask-sdk-core
:alt: Downloads
.. |DynamoDb Version| image:: http://img.shields.io/pypi/v/ask-sdk-dynamodb-persistence-adapter.svg?style=flat
:target: https://pypi.python.org/pypi/ask-sdk-dynamodb-persistence-adapter/
:alt: Version
.. |DynamoDb Downloads| image:: https://pepy.tech/badge/ask-sdk-dynamodb-persistence-adapter
:target: https://pepy.tech/project/ask-sdk-dynamodb-persistence-adapter
:alt: Downloads
.. |Standard Version| image:: http://img.shields.io/pypi/v/ask-sdk.svg?style=flat
:target: https://pypi.python.org/pypi/ask-sdk/
:alt: Version
.. |Standard Downloads| image:: https://pepy.tech/badge/ask-sdk
:target: https://pepy.tech/project/ask-sdk
:alt: Downloads
.. |Webservice Version| image:: http://img.shields.io/pypi/v/ask-sdk-webservice-support.svg?style=flat
:target: https://pypi.python.org/pypi/ask-sdk-webservice-support/
:alt: Version
.. |Webservice Downloads| image:: https://pepy.tech/badge/ask-sdk-webservice-support
:target: https://pepy.tech/project/ask-sdk-webservice-support
:alt: Downloads
.. |Flask Sdk Version| image:: http://img.shields.io/pypi/v/flask-ask-sdk.svg?style=flat
:target: https://pypi.python.org/pypi/flask-ask-sdk/
:alt: Version
.. |Flask Sdk Downloads| image:: https://pepy.tech/badge/flask-ask-sdk
:target: https://pepy.tech/project/flask-ask-sdk
:alt: Downloads
.. |Django Sdk Version| image:: http://img.shields.io/pypi/v/django-ask-sdk.svg?style=flat
:target: https://pypi.python.org/pypi/django-ask-sdk/
:alt: Version
.. |Django Sdk Downloads| image:: https://pepy.tech/badge/django-ask-sdk
:target: https://pepy.tech/project/django-ask-sdk
:alt: Downloads
.. |Jinja Renderer SDK Version| image:: http://img.shields.io/pypi/v/ask-sdk-jinja-renderer.svg?style=flat
:target: https://pypi.python.org/pypi/ask-sdk-jinja-renderer/
:alt: Version
.. |Jinja Renderer SDK Downloads| image:: https://pepy.tech/badge/ask-sdk-jinja-renderer
:target: https://pepy.tech/project/ask-sdk-jinja-renderer
:alt: Downloads
.. |Smapi Sdk Version| image:: http://img.shields.io/pypi/v/ask-smapi-sdk.svg?style=flat
:target: https://pypi.python.org/pypi/ask-smapi-sdk/
:alt: Version
.. |Smapi Sdk Downloads| image:: https://pepy.tech/badge/ask-smapi-sdk
:target: https://pepy.tech/project/ask-smapi-sdk
:alt: Downloads
.. |Ask Sdk Local Debug Version| image:: http://img.shields.io/pypi/v/ask-sdk-local-debug.svg?style=flat
:target: https://pypi.python.org/pypi/ask-sdk-local-debug/
:alt: Version
.. |Ask Sdk Local Debug Downloads| image:: https://pepy.tech/badge/ask-sdk-local-debug
:target: https://pepy.tech/project/ask-sdk-local-debug
:alt: Downloads
.. |License| image:: http://img.shields.io/pypi/l/ask-sdk-core.svg?style=flat
:target: https://github.com/alexa/alexa-skills-kit-sdk-for-python/blob/master/LICENSE
:alt: License
Package Versions
----------------
==================================== ==================
Package Version
------------------------------------ ------------------
ask-sdk-runtime |Runtime Version| |Runtime Downloads|
ask-sdk-core |Core Version| |Core Downloads|
ask-sdk-dynamodb-persistence-adapter |DynamoDb Version| |DynamoDb Downloads|
ask-sdk |Standard Version| |Standard Downloads|
ask-sdk-local-debug |Ask Sdk Local Debug Version| |Ask Sdk Local Debug Downloads|
ask-sdk-webservice-support |Webservice Version| |Webservice Downloads|
flask-ask-sdk |Flask Sdk Version| |Flask Sdk Downloads|
django-ask-sdk |Django Sdk Version| |Django Sdk Downloads|
ask-sdk-jinja-renderer |Jinja Renderer Sdk Version| |Jinja Renderer Sdk Downloads|
ask-smapi-sdk |Smapi Sdk Version| |Smapi Sdk Downloads|
==================================== ==================
SDKの使用をより迅速に開始するには、次のリソースを参照してください。
技術文書
-------
- `English `__
- `日本語 `__
モデル
------
SDKはネイティブのAlexa JSONリクエストおよびレスポンスではなく、モデルクラスで動作します。これらのモデルクラスは、 `開発者向けドキュメント ` __のRequest、Response JSONスキーマを使用して生成されます。モデルクラスのソースコードは `ここに ` __にあります。
モデルクラスのドキュメントは `here ` __にあります。
サンプル
--------
このセクションでは、ASK SDK for
Pythonを使って魅力的なAlexaスキルを開発する方法を説明するスキルサンプルを紹介します。
`Hello World（クラス使用） `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
このコードサンプルでは、サンプルがトリガーされたときのAlexaの応答を聞くことができます。Alexa
Skills KitやAWS
Lambdaに慣れるための最小限のサンプルです。このサンプルでは、リクエストハンドラーのクラスを使用してスキルを作成する方法を説明します。詳細については、 `リクエスト処理 `__ を参照してください。
`Hello World（デコレーター使用） `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
このコードサンプルでは、サンプルがトリガーされたときのAlexaの応答を聞くことができます。Alexa
Skills KitやAWS
Lambdaに慣れるための最小限のサンプルです。このサンプルでは、リクエストハンドラーのデコレーターを使用してスキルを作成する方法を説明します。詳細については、 `リクエスト処理 `__ を参照してください。
`カラーピッカー `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Hello
Worldから機能を一歩進めて、ユーザーが好きな色を指定したら、Alexaが覚えてユーザーに知らせるようにします。ユーザーからの入力をキャプチャーできるようにします。スロットの使い方についても説明します。さらに、セッションアトリビュートと、リクエスト、応答のインターセプターの使い方も説明します。
`ファクト `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
基本的な豆知識スキルのテンプレートです。トピックについての豆知識のリストを提供すると、ユーザーがスキルを呼び出したときに、Alexaがリストから豆知識をランダムに選んでユーザーに伝えます。スキルで複数のロケールを使用し国際化する方法を説明します。
`クイズゲーム `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
基本的なクイズゲームスキルのテンプレートです。あらかじめ提供しておいた豆知識のリストの中から、Alexaがユーザーにクイズを出します。画面付きのAlexa搭載デバイスでの表示をサポートする、テンプレートレンダリングディレクティブの使い方について説明します。
`デバイスのアドレス `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ユーザーのデバイス設定で設定したアドレスをリクエストし、設定されたアドレスにアクセスするサンプルスキルです。SDKを使用したAlexa
APIの使い方について説明します。詳細については、\ `Alexaサービスクライアント `__\ を参照してください。
`スキル内課金を使用した豆知識 `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
`スキル内課金 `__ 機能を使用した豆知識スキルのサンプルです。購入を促進するさまざまなパックや、パックを一括でロック解除するサブスクリプションを提供します。収益化Alexaサービスの呼び出し方とASK
CLIを使ってスキル内課金を有効にする方法を説明します。
`シティガイド `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
周辺地域のお勧め情報スキルのテンプレートです。Alexaはユーザーのリクエストに従って、開発者が提供したデータからお勧め情報をユーザーに知らせます。スキルから外部APIを呼び出す方法を説明します。
`ペットマッチ `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
ユーザーとペットをマッチングするサンプルスキルです。Alexaは一致するペットを見つけるのに必要な情報をユーザーにたずねます。必要な情報をすべて収集できたら、スキルはデータを外部のウェブサービスに送信し、そこでデータが処理されてマッチングデータが返されます。ダイアログ管理と `エンティティ解決 `__ を使って、プロンプトを出してユーザーから複数の値を受け取り解析する方法を説明します。
`ハイ＆ローゲーム `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
基本的なハイ＆ローゲームスキルのテンプレートです。ユーザーが数字を推測し、Alexaがその数字が正解より大きいか小さいかを答えます。SDKの永続アトリビュートと永続アダプターの使い方について説明します。
`AudioPlayer SingleStreamおよびMultiStream `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Alexaの `AudioPlayerインターフェース `__ と `PlaybackControllerインターフェース `__ を使ってAudioPlayerスキルを開発する方法を説明するスキルサンプルです。SingleStreamスキルサンプルでは、ローカリゼーションのサポート付きでライブラジオスキルを作成する方法を説明します。MultiStreamスキルサンプルでは、録音済みの複数のオーディオストリームを再生できる基本的なポッドキャストスキルを作成する方法を説明します。
`Pager Karaoke `__
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
このサンプルでは、APLの3つの機能である `Pagerコンポーネント `__ 、 `SpeakItemコマンド `__ 、スキルコードの `デバイスの特性 `__ へのアクセスについて説明します。
------------
SDKでサポートされているAlexaの機能
==================================
このセクションでは、現在SDKでサポートされているAlexaのすべての機能を紹介します。
正式版
------
- `Amazon Pay `__
- `Audio Player `__
- `Display – 画面付きデバイス用のBodyテンプレート `__
- `GadgetsGame Engine – Echo Buttons（日本未対応） `__
- `Directiveサービス（プログレッシブ応答） `__
- `メッセージ `__
- `収益化 `__
- `ビデオ `__
- `デバイスのアドレス `__
- `リスト `__
- `ユーザー連絡先情報のリクエスト `__
- `ユーザー設定情報の取得 `__
- `アカウントリンク `__
- `スロットタイプ値の同義語とIDを定義する（エンティティ解決） `__
- `ダイアログ管理 `__
- `位置情報サービス `__
- `リマインダー `__
- `プロアクティブイベント `__
- `動的エンティティ `__
- `スキルメッセージ `__
- `Connections `__
プレビュー版
------------
..警告::
以下の機能は、プレビュー版としてリリースされています。インターフェースは正式版リリースの際に変更される可能性があります。
- `Alexa Presentation Language `__
- `無指名対話 `__
Lambda以外のリソースでのスキルのホスティング
--------------------------------------------
SDKはホスティングを可能にする `` ask-sdk-webservice-support``パッケージを提供します
カスタムWebサービスとしてのスキルフレームワーク固有のアダプタも提供します。
統合するために `` flask-ask-sdk``と `` django-ask-sdk``パッケージの下に
それぞれのフレームワークのスキルとWebサービスとして展開します。
これらのパッケージの使用方法に関する詳細はこちらにあります。
`ドキュメントのリンク` __。
フィードバック
---------------
- バグ、機能のリクエスト、ご質問、簡単なフィードバックがあればぜひお聞かせください。新しく問題を提起する前に\ `既存の問題 `__\ を検索してください。また、問題やプルリクエストはテンプレートに従って作成してください。プルリクエストの場合は\ `投稿のガイドライン `__\ に従ってください。
- Alexaの機能に関するリクエストや投票は、\ `こちら `__\ をご覧ください。
その他のリソース
-----------------
その他の言語AlexaスキルキットSDK
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. raw:: html
コミュニティ
~~~~~~~~~~~~~
- `Amazon開発者フォーラム `__\ ：
ぜひ会話に参加してください。
- `Hackster.io `__ ー
他の人がAlexaでどんなものをビルドしているか見てみましょう。
チュートリアルとガイド
~~~~~~~~~~~~~~~~~~~~~~~
- `音声デザインガイド `__
ー
会話型スキルや音声ユーザーインターフェースのデザインを学ぶことができる優れたリソースです。
NodeJS用のAlexaスキルキットSDK
AlexaスキルキットSDK for Java