エージェントの公開

このチャプターのゴール

  • エージェントの公開について理解ができている
  • エージェントが公開できる
  • 公開用のチャット画面URLをカスタムできる

エージェントの公開の仕組み

作成したエージェントには、プレビュー版と公開版の状態が2つ存在します。公開したエージェントは、他のユーザーに共有し、会話をしてもらうことができるようになります。


公開されたエージェント

公開設定画面で公開を行うと、エージェントの最新の状態が公開版に反映されます。

エージェントを公開すると、下記が可能になります。

  • 一般公開の場合はURLシェアが可能
  • 外部サービス連携が可能 (LINE, Slack, API経由の会話)

公開の範囲について

エージェントの公開には2種類の範囲があります。


一般公開

一般公開の範囲を指定してエージェントを公開すると、誰でもエージェントと会話ができるようになります。
一般公開を行うと、下記のようなURLが発行されます。

このURLをシェアすることで、誰でもチャット画面で会話ができます。後のチャプターで紹介する外部サービスと連携させることも可能です。

また、埋め込みタグを利用することにより、Webサイトにチャット画面を埋め込むことも可能です。埋め込みタグの利用方法は後のチャプターで解説します。


限定公開

限定公開を行った場合は、エージェントの権限を持つユーザーのみチャット画面で会話を行うことができます。

一般公開と同様に外部サービス連携が可能です。チャット画面を一般に公開せずに、LINEやSlackもしくはAPIからのみエージェントの会話を利用したい時は限定公開を利用しましょう。
※外部サービスとの連携に関しては、後のチャプターで詳細にご説明します。


チャットページのURLをカスタムする

チャットページのURLにはクエリパラメータを付与できます。利用できるクエリパラメータは3種類です。

  1. name
  2. utterance
  3. 任意

nameパラメータ

URLの末尾にnameというパラメータをつけると、チャット画面のページ名が指定された名前になります。

例)

<URL>?name=サンプルエージェント

「サンプルエージェント」を指定した例

utteranceパラメータ

utteranceというパラメータを付けると、エージェントに対して投げかける最初の発話を指定できます。

例)

<URL>?name=サンプルエージェント&utterance=おはよう

任意のパラメータ

上記のパラメータ以外に自由なパラメータをURLに付与できます。付与したパラメータは、ユーザのステートとして保持されます。

例)

<URL>?name=サンプルエージェント&platform=web&version=1

上記の例のパラメータを付与した状態でチャット画面を開くと、「platform」というステート名で「web」が、「version」というステート名で「1」がユーザのステートに格納されます。詳しくは後のチャプターで詳しくステートの利活用について説明をします。