翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。
アクショングループでアクションを定義する
アクショングループは、次のいずれかの方法で定義できます (アクショングループごとに異なる方法を使用できます)。
-
OpenAPI スキーマを設定する: 説明、構文、パラメータでスキーマを設定し、アクショングループの各アクションを API オペレーションとして定義します。この方法を使用すると、より明示的にアクションを定義して、システムの API オペレーションにマッピングできます。API スキーマは、次のいずれかの方法でアクショングループに追加します。
-
作成したスキーマを Amazon Simple Storage Service (Amazon S3) バケットにアップロードします。
-
アクショングループを追加する AWS Management Console ときに、 のインラインスキーマエディタにOpenAPIスキーマを書き込みます。この方法は、アクショングループが属するエージェントが既に作成されている場合にのみ使用できます。
-
-
関数の詳細を設定する: エージェントがユーザーから取得する必要があるパラメータで関数の詳細を設定します。この方法を使用すると、アクショングループの作成プロセスを簡素化し、定義した一連のパラメータを取得するようにエージェントを設定できます。その後、パラメータをアプリケーションに渡し、それを使用して独自のシステムでアクションを実行する方法をカスタマイズできます。
上記の例を使うと、CreateBooking アクションは次のいずれかの方法で定義できます。
-
API スキーマを使用した場合、
CreateBookingは、リクエスト本文にHotelName、LengthOfStay、UserEmailなどのフィールドが含まれ、レスポンス本文でBookingIdを返す API オペレーションになることがあります。 -
関数の詳細を使用した場合、
CreateBookingは、HotelName、LengthOfStay、UserEmailなどのパラメータで定義される関数になることがあります。これらのパラメータの値がエージェントによってユーザーから取得されたら、それらをシステムに渡すことができます。
エージェントがユーザーとやり取りすると、呼び出す必要があるアクショングループ内のアクションが決まります。その後、エージェントは、API リクエストを完了するために必要なパラメータやその他の情報、または関数で必須としてマークされたパラメータやその他の情報を取得します。
アクショングループを定義するさまざまな方法について、トピックを選択して確認してください。
トピック
