セットアップガイド

目次

ファイルパスの記述方法

Gravioアクションコンポーネントでファイルパスを指定する際の記述方法について説明します。

絶対パス

ファイルの完全なパスを指定します。

  • Windows: C:\Users\username\Documents\file.txt
  • macOS/Linux: /Users/username/Documents/file.txt

相対パス

Gravioの実行ディレクトリからの相対的なパスを指定します。

  • data/file.txt - dataフォルダ内のfile.txt
  • ../file.txt - 一つ上の階層のfile.txt

環境変数の使用

環境変数を使用してパスを指定することも可能です。

  • Windows: %USERPROFILE%\Documents\file.txt
  • macOS/Linux: $HOME/Documents/file.txt

注意事項

  • Windowsでは区切り文字として\または/を使用できます
  • ファイル名に日本語などの多バイト文字が含まれる場合は、UTF-8エンコーディングを使用してください
  • スペースが含まれるパスは引用符で囲むことを推奨します

OpenAI API Key取得方法

OpenAIコンポーネントを使用するために必要なAPI Keyの取得方法を説明します。

1. OpenAIアカウントの作成

OpenAI Platformにアクセスしてアカウントを作成します。

2. API Keyの生成

  1. OpenAI Platformにログインします
  2. 右上のアカウントメニューから「View API keys」を選択します
  3. 「Create new secret key」ボタンをクリックします
  4. 適切な名前を付けてAPI Keyを作成します
  5. 表示されたAPI Keyをコピーして安全な場所に保存します

3. 使用量制限の設定

予期しない高額請求を避けるため、使用量制限を設定することを強く推奨します。

  1. 「Billing」セクションに移動します
  2. 「Usage limits」で月額制限を設定します
  3. 必要に応じてアラート設定も行います

4. Gravioでの設定

取得したAPI KeyをGravioのOpenAIコンポーネントで使用します。

これでOpenAIのAPI Keysの取得ができました。

Text2SQLの使い方

データベース関係のコンポーネントで提供されているText2SQL機能は、OpenAIChatGPTの機能を使用して取得したいデータをプロンプトに入力した日本語からSQL文を生成できる機能です。Text2SQL機能を使用するには事前にOpenAIのAPI KeyとOrganizationIdを取得する必要があります。取得する方法は OpenAI API Key取得方法 を確認してください。

1. 事前準備

OpenAIのAPI KeyとOrganizationIdを取得してください。そして各データベース関係のコンポーネントでデータベースに正しく接続できるようにプロパティを設定してください。

2. Text2SQLでのテーブルの選択

Text2SQLボタンを押すとText2SQLパネルが開きます。

text2sql1

3. プロンプトからSQL文の生成

Text2SQLパネルが開くと、正しくデータベースに接続できている場合はテーブルが一覧で表示されますので、使用するテーブルを選択します。

Nextボタンを押すとプロンプトの入力パネルが表示されます。

text2sql3

プロンプトに取得したいデータを日本語で入力します。Generateボタンを押すとGENERATED SQLに生成されたSQL文が表示されます。

Test Queryボタンを押すとSQLを実行してデータを取得するパネルが表示されます。

Acceptボタンを押すと生成したSQL文をコンポーネントのSQLプロパティにコピーされます。

注意事項

  • OpenAI API keyがChatGPTアクセスに必要です
  • 明確で具体的な日本語プロンプトで最適に動作します
  • 生成されたSQLは実行前に必ず検証してください
  • データベース接続が正しく設定されている必要があります

LINE WORKSのBot登録方法

LINE WORKSコンポーネントを使用するためにLINE WORKSの管理者はBotの初期設定を行ってください。

LINE WORKS Developers

1. LINE WORKS Developers アカウントの作成

こちらからアカウントを作成して LINE WORKSのBotを作成します。

2. アプリの作成

LINE WORKS2コンポーネントはAPI2.0を使用しますので、API2.0メニューからアプリを新規作成します。

oauth2-2b

アプリを作成するとClient ID、Client Secretが生成されますので、LINE WORKSコンポーネントプロパティで使用します。 Redirect URLは "http://127.0.0.1:48888/callback" を指定してください。LINE WORKSコンポーネントプロパティで使用します。

oauth2-3

OAuth Scopesは 管理ボタンを押して、一覧からbotを選択してください。

3. Botの作成

lineworks-2b2

BotメニューからBotの登録ボタンを押します。

oauth2-1b2

Bot名、説明を入力し、API InterfaceはAPI 2.0を選択します。Botポリシーは複数人のトークルームに招待可にチェックを入れて、管理者の主担当を設定します。 登録が完了するとBot No:が表示されますので、LINE WORKSコンポーネントプロパティで使用します。

LINE WORKS Admin

1. LINE WORKS 管理画面 へのログイン

管理者は こちらからログインして LINE WORKS管理画面を表示します。

2. Botの設定

lineworks-8

サービスメニューよりBotを選択してBot追加ボタンを押します。

lineworks-9

LINE WORKS Developers で作成したBotが表示されますので追加ボタンを押します。

lineworks-10

Bot画面を再表示すると追加されたBotが表示されます。

lineworks-11

3. Botのトークルームへの追加

Botをトークルーム内で使用する場合には、新規にトークルームを作成するか、既存のトークルームに追加してください。

4. トークルームIDの確認

lineworks-12

LINE WORKSアプリやWebサイトでトークルームを作成した場合でもトークルームIDは表示されません。 そこで、Botを使用するトークルームでメンバーで何かメッセージを送信してください。

しばらくして監査メニューよりトークを選択して検索するとトークルームIDが表示されますので、LINE WORKSコンポーネントプロパティで使用します。

これで事前準備は完了です。

OAuth2設定

このセクションでは、メールサービスやGoogle Driveなど、様々なGravioコンポーネントでのOAuth2認証の設定方法について説明します。

OAuth2.0でのメール送信設定方法 : 先進認証(OAuth2)

Mailコンポーネントでのメール送信における先進認証(OAuth2)による認証方式について設定方法を説明します。

先進認証(OAuth2)による認証方式で動作確認しているのはGmailとOutlookとなります。

OAuth2の設定を行うにはGmailではGCPを使用し、OutlookではAzureを使用します。

設定を正しく行うにはGCPまたはAzureの正しい知識が必要となります。

詳細な設定方法がご不明な場合にはGCPはGoogle社まで、AzureはMincrosoft社までお問い合わせください。

1. Gmailでのメール送信設定方法

設定方法の流れ

GCPで以下の手順で設定を行います。

1-1. APIサービスのライブラリからGMail APIを有効にします。
gmail-oauth1

APIサービスメニューからライブラリを選択します。

gmail-oauth2

Gmail APIを選択します。

gmail-oauth3

Gmail APIを有効にします。

1-2. OAuth同意画面メニューから「外部」を選択して作成ボタンを押します。
gmail-oauth4

1-3. スコープではGMailのスコープを登録します。
gmail-oauth5

スコープはGmail "Gmail のすべてのメールの閲覧、作成、送信、完全な削除"など必要な権限を指定してください。

1-4. テストユーザーではGMailのメール送信を行うGmailのメールアドレスを登録します。

1-5. 概要で登録した内容を確認します。
gmail-oauth6

1-6.認証情報メニューから認証情報を作成をクリックしてOAuth 2.0クライアントIDを選択します。
gmail-oauth7

1-7.アプリケーションの種類は"Webアプリケーション"を選択して名前をつけてください。認証済みのリダイレクトURIには"http://127.0.0.1:48888/callback"を追加して保存してください。
gmail-oauth8

1-8.認証情報メニューからOAuth2.0クライアントID2保存したデータを確認するとクライアントID、クライアントシークレットIDと承認済みのリダイレクトURIが表示されますので、コンポーネントで使用するためメモしてください。
gmail-oauth9

※上記設定では公開ステータスは"テスト"となり、テストユーザーにのみメールが送信できるモードとなっています。このモードを"公開"することでテストユーザー以外のメールアドレスからもメールが送信できるようになります。詳細な設定方法がご不明な場合にはGoogle社までお問い合わせください。個別のGCPの設定方法についてはサポート出来ない場合がございます。

これでOAuth 2.0に必要となるクライアントID、クライアントシークレットIDと承認済みのリダイレクトURIがそろい事前準備は完了です。

2. Outlookでのメール送信設定方法

OutlookでOAuth2.0を使用するには、Microsoft365 for Businessの契約が必要です。

設定方法の流れ

Azureで以下の手順で設定を行います。 メール送信時に MailSend: failed to send mail: 535 5.7.139 Authentication unsuccessful, SmtpClientAuthentication is disabled for the Tenant. Visit https://aka.ms/smtp_auth_disabled for more information. このようなエラーが発生する場合には、2-9以降でMicrosoft 365 管理センターで認証済みSMTPの設定を有効にしてください。

2-1. Azureサービスでアプリの登録をします。
oauth-outlook1

アプリの作成ボタンをクリックします。

oauth-outlook2

新規登録ボタンをクリックします。

oauth-outlook2a

アプリケーションの名前、サポートされているアカウントの情報とリダイレクトURIを指定します。リダイレクトURIには "http://localhost:48888/callback"を指定します。

2-2. アプリが登録されると概要に基本情報が表示されます。
oauth-outlook3

2-3. APIのアクセス許可メニューからアクセス許可の追加をクリックします。
oauth-outlook4

2-4. Microsoft APIのMicrosoft Graphを選択して、Mail.Sendとoffline_accessにチェックをして追加します。
oauth-outlook5 oauth-outlook6 oauth-outlook14

2-5. 保存されたら構成されたアクセス許可に表示されます。組織に管理者の同意を与えますをクリックして同意を付与します。
oauth-outlook15

2-6. クライアントIDとリダイレクトURIをメモします。
oauth-outlook9

2-7. 証明書とシークレットメニューから新しいクライアントシークレットをクリックして作成します。
oauth-outlook10

クライアントシークレットを作成します。

oauth-outlook12

クライアントシークレットには有効期限が設定出来ますので指定します。

2-8. クライアントシークレットを表示します。
oauth-outlook13

値がクライアントシークレットとなりますのでメモします。

これでOAuth 2.0に必要となるクライアントID、クライアントシークレットとリダイレクトURIがそろい事前準備は完了です。

2-9. Microsoft 365 管理センターで認証済みSMTPの設定を有効にする。

Microsoft 365 管理センターを開きます。

oauth-ms1

左のメニューから アクティブユーザーを選択します。

oauth-ms2

目的のユーザーを選択すると、右側にパネルが開きます。

oauth-ms3

メールタブにある メールアプリを管理する を選択します。

oauth-ms4b

認証済みSMTP を有効にして保存してください。設定した内容はすぐには反映されないためメール送信で引き続き同じエラーが発生する場合にはしばらく待ってから再度実行してください。引き続きエラーが発生するようでしたらもう一度設定して内容を確認してください。

OAuth2.0でのGoogle Drive設定方法

Google Drive Upload/DownloadコンポーネントでのGoogle DriveへのOAuth2による認証についての設定方法を説明します。

OAuth2の設定を行うにはGoogle DriveではGCPを使用します。

設定を正しく行うにはGCPの正しい知識が必要となります。

詳細な設定方法がご不明な場合にはGCPはGoogle社までお問い合わせください。

1. Google Driveへのアクセス設定方法

設定方法の流れ

GCPで以下の手順で設定を行います。

1-1. APIサービスのライブラリからGoogle Drive APIを有効にします。

APIサービスメニューからライブラリを選択します。

Google Drive APIを選択して有効にしてください。

1-2. OAuth同意画面メニューから「外部」を選択して作成ボタンを押します。
gmail-oauth4

1-3. テストユーザーではGoogle アカウントのメールアドレスを登録してください。

1-4. 概要で登録した内容を確認します。
gmail-oauth6

1-5.認証情報メニューから認証情報を作成をクリックしてOAuth 2.0クライアントIDを選択します。
gmail-oauth7

1-7.アプリケーションの種類は"Webアプリケーション"を選択して名前をつけてください。認証済みのリダイレクトURIには"http://127.0.0.1:48888/callback"を追加して保存してください。
gmail-oauth8

1-8.認証情報メニューからOAuth2.0クライアントID2保存したデータを確認するとクライアントID、クライアントシークレットIDと承認済みのリダイレクトURIが表示されますので、コンポーネントで使用するためメモしてください。
gmail-oauth9

※上記設定では公開ステータスは"テスト"となり、テストユーザーにのみ使用できるモードとなっています。このモードを"公開"することでテストユーザー以外からも使用できるようになります。詳細な設定方法がご不明な場合にはGoogle社までお問い合わせください。個別のGCPの設定方法についてはサポート出来ない場合がございます。

これでOAuth 2.0に必要となるクライアントID、クライアントシークレットIDと承認済みのリダイレクトURIがそろい事前準備は完了です。

OAuth2アクセストークンの取得方法

※3 OAuth2アクセストークンを取得するボタンを押すとOAuth 2.0 アクセストークンを取得 パネルが表示されます。ブラウザを開く ボタンを押してトークンを取得してください。トークンを取得すると 設定ボタンを押すとOAuth2アクセストークン プロパティに自動的に設定されます。

oauth2-4

Gravio Studio for Windowsの場合も同様にブラウザを開く ボタンを押してトークンを取得しますが、エラー画面となります。この状態でURLをアドレスバーからコピーして、そのURLをパネルにペースとして取得ボタンを押してください。トークンが取得されますので 設定ボタンを押すとOAuth2アクセストークン プロパティに自動的に設定されます。

oauth-gswin-1

ブラウザを開くボタンを押すと自動的にブラウザで認証が行われます。必要がありましたらログイン処理など画面の指示に合わせて操作してください。

oauth-gswin-2

認証が完了すると「このページに到達できません」とエラーが表示されるので、この時にURLをアドレスバーからコピーしてください。

oauth-gswin-4

コピーしたURLをパネルにペーストして取得ボタンを押すとOAuth2アクセストークンが"取得済み"となります。設定ボタンを押してパネルを閉じます。

OAuth2.0でのBox設定方法

Box Upload/DownloadコンポーネントでのBoxへのOAuth2による認証についての設定方法を説明します。

OAuth2の設定を行うには Box Developer サイト を使用します。

設定を正しく行うにはBoxの正しい知識が必要となります。

詳細な設定方法がご不明な場合にはBox社までお問い合わせください。

1. Boxへのアクセス設定方法

設定方法の流れ

Box Developerで以下の手順で設定を行います

1-1. My Appを作成にします。

Custom Appを選択します。

box-developer1

1-2. アプリの名前を入力して作成します

PurposeはAutomationを選択します。

box-developer2

User Authentication (OAuth2.0)を指定します。

box-developer3

1-3. 作成したアプリを選択します
box-developer4

1-4. OAuth2.0の情報を取得します

OAuth 2.0 CredentialsのClient IDをクライアントIDとして、Client Secretをクライアントシークレットとしてメモします。

box-developer5

OAuth 2.0 Redirect URL に http://localhost:4999のようにURLを指定してリダイレクトURLとしてメモします。 Application Scopesに Write all files and folders stores in Box にチェックして保存します。

box-developer6

これでOAuth 2.0に必要となるクライアントID、クライアントシークレットIDとリダイレクトURLがそろい事前準備は完了です。

ソフトウェアセンサーの設定

Gravioはソフトウェアセンサーもサポートしています。ソフトウェアセンサーの例は、部屋にいる人の数を検出し、特定のしきい値に達すると特定のアクションをトリガーするカメラです。これらのセンサーは、ソフトウェアおよび人工知能(推論ファイル)を使用して作成されます。

ソフトウェアセンサーの作成

Gravioで利用できるカメラデバイスはUSBのシリアル接続が可能な場合および、ONVIF (Profile T)をサポートしたカメラでデバイスになります。

# 「デバイス」で、カメラのセンサーの種類(DataKind)を選択して新しいエリアとレイヤーを追加します。

gs4-device-onvif-1b

# 以下のボタンを押して、OnVifとして認識されているカメラの設定画面を表示します。

gs4-device-onvif-2c

# 新しく追加されたカメラデバイスをクリックし、プロパティを設定します

gs4-device-onvif-3a

# 以下の設定をプロパティーとして設定できます。

gs4-device-onvif-5a

・カメラの種類のビデオまたは画像を選択します。画像の場合はjpeg形式となります。ビデオの場合はmp4形式となります。

・撮影する頻度(秒)

・あなたが使用したい推論ファイル、例えば "NumberOfPeople"

・画像を保存するか、処理した直後に破棄することができます。画像を保存する場合、Linuxなら /var/opt/hubkit/mediadata/に、Windowsなら C:\ProgramData\HubKit\mediadataに、Macなら /Library/Application Support/HubKit/mediadata に保存されます。

# +ボタンをクリックしてバインド設定画面を表示します。

gs4-device-onvif-6c

# 設定したカメラをレイヤーにバインドにします。

gs4-device-onvif-7a

# 最後にセンサー取得をONにします。

gs4-device-onvif-8c

推論ファイルを使用する

Gravio Freeアカウントのサービスを契約されている方は1つの推論ファイルを、Gravio Basicアカウント以上のサービスを契約されている方は、1つ以上の推論ファイルをGravio Cloudからダウンロードしてご利用いただけまます。

# 設定画面の画像推論モデルを表示します。

gs4-device-onvif-9

# 推論するモデルを配置するボタンを押してダウンロードします。

gs4-device-onvif-10

# 推論ファイルを使用する場合にはレイヤーを作成するときにCameraではなく推論ファイルを選択します。

gs4-device-onvif-11a

# 設定した推論ファイルをレイヤーにバインドにします。

gs4-device-onvif-12

# 最後にセンサー取得をONにします。

gs4-device-onvif-13b

推論ファイルを使用する時のパフォーマンスの目安

推論ファイルを使用する場合のハードウェア環境につきましては Inference Modelコンポーネント を確認してください。