概要
Power Automate Desktop(以下PAD) と自然言語処理APIプラットフォーム「COTOHA API」の連携を検証しました。
俺のデスクトップはきたないです。興味を持ったことをデスクトップにポイポイして気づくとこんな感じです。完全にダメな人です。そこで、身近なことからコツコツということでデスクトップの掃除+分析を題材にしてみようと思います。
散らかったブックマークのデータを収集してタグ付けを行います。
データとして収集整理してしまえばお好みでいろいろできちゃいます。
今回やること
PADをつかってファイル操作、変数を使ったリストやデータテーブル作成、なるべく速いExcel操作、JSON、カスタムオブジェクトによるCOTOHA APIとの連携からキーワード抽出を行います。
準備
- Power Automate Desktopのインストール。
@Maekawaさん記事と@K2_kzyさんの記事が参考になります。
- COTOHA API for Developersアカウントの取得
スタートガイドを参考に認証情報を準備しておきます。
注意事項等
- 長めのフローになるため要点のアクションのみ解説します。
- ファイル操作がフローに含まれるためサンプルコードの利用は十分理解した上でお願いいたします。
- 自己責任でお願いいたします。
- API利用は規約にしたがってください。詳しくは[FAQ](https://api.ce-cotoha.com/contents/faq.html参照。
- 2021年3月の情報です。
フロー概要
- パスを取得や保存フォルダーの作成等の準備作業
- ブックマークファイルの各種データを読み取ってデーターテーブルを生成およファイルのを移動、Excelに転写
- 作成したデータテーブルからCOTOHA APIでキーワード抽出を行いExcelに追記
- 終了
フロー作成
シンプルな構成ですが、より分かりやすくするためにMainではコントロールのみ行い、処理はサブフローで行います。Mainの「サブフローの実行」アクションはサブフローを作るまで選択肢に出てこないため作りながら追加します。
Get_readyサブフローの作成
2「フォルダー内のファイルを取得」
ファイルフィルターに*.urlを指定することでブックマークファイルのパスリスト変数Filesを作成できます。
Filesは各種プロパティをもっているのでこの情報を利用します。
Steamゲームのショートカットも「.url」であるためご注意ください。
5「フォルダーの作成」
ブックマークファイルを移動するフォルダーをBookmarks%FormattedDateTime%
としておきます。
6「変数の設定」
変数でデータテーブルを作成し列名をハードコートします。%{['Title', 'Created', 'URL', 'TAG1', 'TAG2', 'TAG3'] }%
「^」とせず1行目にしているのはデータテーブル内で列名にしてしまうとExcelに転写できなくなるためです。
また今後取得したデータをこのデータテーブルに結合します。
Get_ready
Folder.GetSpecialFolder SpecialFolder: Folder.SpecialFolder.DesktopDirectory SpecialFolderPath=> SpecialFolderPath
Folder.GetFiles Folder: SpecialFolderPath FileFilter: $'''*.url''' IncludeSubfolders: False FailOnAccessDenied: True SortBy1: Folder.SortBy.NoSort SortDescending1: False SortBy2: Folder.SortBy.NoSort SortDescending2: False SortBy3: Folder.SortBy.NoSort SortDescending3: False Files=> Files
DateTime.Local DateTimeFormat: DateTime.DateTimeFormat.DateAndTime CurrentDateTime=> CurrentDateTime
Text.FromCustomDateTime DateTime: CurrentDateTime CustomFormat: $'''yyyyMMdd''' Result=> FormattedDateTime
Folder.Create FolderPath: SpecialFolderPath FolderName: $'''Bookmarks%FormattedDateTime%''' Folder=> NewFolder
SET Table TO {['Title', 'Created', 'URL', 'TAG1', 'TAG2', 'TAG3'] }
Make_excel_and_move_filesサブフローの作成
このサブフローでは変数の記事に書いたことをフルに使っていきます。
データテーブルを変数に作成することで、一括で転写することができ、セル毎でexcelに書き込むよりフローもすっきりします。
2「ファイルからテキストを読み取ります」
このアクションでブックマークファイルの中のURLを読み取ることができます。
5「変数の設定」
FilesContentsのURLはURL=となっているためスライスを使ってURL部分を抜き出します。URLを抜き出す場合、正規表現を使うことが多いかもしれませんがPADは%が特別な意味を持つためURL抜き出しではうまく機能しないケースがあります。このケースではスライスが簡単です。
FilesContentsリストのインデックス番号1、文字列のインデックス番号4より後を指定しています。
6「変数の設定」
この段階ではTAGをAPIから取得していないためnullを作成します。%''%
7「変数の設定」
行リストを作成します。
3~6で取得した値をリスト化しています。
8「変数の設定」
Get_Readyサブフローで準備した変数Tableに結合します。
9「ファイルの移動」
Get_Readyサブフローで準備したフォルダーに移動します。
15 キーの送信
Excelをショートカットで素早く操作できます。
昇竜拳はでません。
いろいろ試すと楽しいです。
Make_excel_and_move_files
File.ReadTextAsList File: CurrentItem Encoding: File.TextFileEncoding.UTF8 Contents=> FileContents
SET Title TO CurrentItem.NameWithoutExtension
SET Created TO CurrentItem.CreationTime
SET URL TO FileContents[1][4:]
SET null TO $'''%''%'''
SET list TO [Title, Created, URL, null, null, null]
SET Table TO Table + list
File.Move Files: CurrentItem Destination: $'''%SpecialFolderPath%/Bookmarks%FormattedDateTime%''' IfFileExists: File.IfExists.DoNothing MovedFiles=> MovedFiles
END
Excel.Launch Visible: True LoadAddInsAndMacros: False Instance=> ExcelInstance
Excel.WriteCell Instance: ExcelInstance Value: Table Column: 1 Row: 1
UIAutomation.Windows.FocusByInstanceOrHandle WindowInstance: ExcelInstance
UIAutomation.Windows.SetStateByInstanceOrHandle WindowInstance: ExcelInstance State: UIAutomation.WindowState.Maximized
MouseAndKeyboard.SendKeys TextToSend: $'''{Control}({A})
{ALT}({O}{C}{A})
{ALT}(hba)
{Control}{Home}{Right}
''' DelayBetweenKeystrokes: 10 SendTextAsHardwareKeys: False
Cotoha_APIサブフローの作成
クライアントID、クライアントシークレット、アクセストークン発行URL、APIベースURLはマイページで発行されます。
これらの情報についてはフローの共有をことを考えてハードコードせずテキストとして外にだしてあります。
1~9 アクセストークンの取得
COTOHA APIのリファレンスを参考にフローを作成します。
アクセストークン取得
https://api.ce-cotoha.com/contents/reference/accesstoken.html
1 「ファイルからテキストを読み取ります」
今回は認証情報Secret.txtをデスクトップ作成しています。デスクトップを片づけるフローのなのにデスクトップにファイルを置くとはけしからんと思いますが、検証記事なので勘弁してください。
2~5 「変数の設定」
テキストから読み込んだSecretKeyはリスト形式なのでそれぞれの値を変数に設定しておきます。
6 「変数の設定」
認証情報をJSON形式のテキストをとし記述します。リファレンス通りに書き、2~4で設定した変数を使います。
{"grantType": "client_credentials","clientId": "%ClientId%","clientSecret": "%ClientSecret%"}
7「WEBサービスを呼び出します」
8「JSONをカスタムオブジェクトに変換」
返却されたJSONをカスタムオブジェクトに格納することで簡単に値にアクセスできます。
9「変数の設定」
カスタムオブジェクトからアクセストークンを変数に格納しておきます。
10~21ブックマークのタイトルからキーワード抽出を行います
このフローではCOTOHA APIを使って「キーワード抽出」を行いタグとしてExcelに記録します。APIの仕様についてはリファレンスを参考にしてください。
10 Loop
すでに前のサブフローでデータテーブルは作成済みなので、%Table%変数に格納されているデータを使用します。ここでは1行目を列名にしていたので行数から -1します。%Table.RowsCount - 1%
また開始値が1であることにも注意が必要です。
11「変数の設定」
データテーブルの[0]]列からAPIに送信するテキストを設定します。
12「WEBサービスを呼び出します」
%で囲んでいる文字列はこれまでに設定してある変数名です。あとはリファレンスにしたがって書いています。
URL %APIBaseURL%/nlp/v1/keyword
受け入れる: application/json
コンテンツタイプ:application/json;charset=UTF-8
カスタムヘッダー: Authorization: Bearer %Token%
要求本文 : {"document":"%SendDoc%","type": "default","do_segment":true,"max_keyword_num":3}
13「JSONをカスタムオブジェクトに変換」
14「変数の設定」
13のカスタムオブジェクト内のresultはリストとして格納されています。
入れ子になっているカスタムオブジェクトのリストを数えます。
%count(JsonAsCustomObject2['result'])%
PADで唯一使うことができる関数count関数を使うことでカスタムオブジェクト内のリストを数えることできます。(他にあったらすいません)
15~19リストを作成してカスタムオブジェクトのformから値をループを使って取得します
Resultの変数設定は次のようにしています%JsonAsCustomObject2['result'][LoopIndex]['form']%
LoopIndexは変数なのでシングルクオーテーションで囲いません。
20「Excelワークシートに書き込み」
前のアクションで作成したFormListはリスト形式です。波括弧で囲い行データに変換します。
これを指定セルに書き込むことで一度に書き込みことができます。
Cotoha_API
File.ReadTextAsList File: $'''%SpecialFolderPath%\\Secret.txt''' Encoding: File.TextFileEncoding.UTF8 Contents=> SecretKey
SET ClientId TO SecretKey[0]
SET ClientSecret TO SecretKey[1]
SET AccessTokenPublishURL TO SecretKey[2]
SET APIBaseURL TO SecretKey[3]
SET Auth TO $'''{\"grantType\": \"client_credentials\",\"clientId\": \"%ClientId%\",\"clientSecret\": \"%ClientSecret%\"}'''
Web.InvokeWebService Url: AccessTokenPublishURL Method: Web.Method.Post Accept: $'''application/json''' ContentType: $'''application/json''' RequestBody: Auth ConnectionTimeout: 30 FollowRedirection: True ClearCookies: False FailOnErrorStatus: False EncodeRequestBody: False UserAgent: $'''Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.21) Gecko/20100312 Firefox/3.6''' Encoding: Web.Encoding.AutoDetect AcceptUntrustedCertificates: False ResponseHeaders=> WebServiceResponseHeaders Response=> WebServiceResponse StatusCode=> StatusCode
Variables.ConvertJsonToCustomObject Json: WebServiceResponse CustomObject=> JsonAsCustomObject
SET Token TO JsonAsCustomObject['access_token']
LOOP LoopIndex2 FROM 1 TO Table.RowsCount - 1 STEP 1
SET SendDoc TO Table[LoopIndex2][0]
Web.InvokeWebService Url: $'''%APIBaseURL%/nlp/v1/keyword''' Method: Web.Method.Post Accept: $'''application/json''' ContentType: $'''application/json;charset=UTF-8''' CustomHeaders: $'''Authorization: Bearer %Token%''' RequestBody: $'''{\"document\":\"%SendDoc%\",\"type\": \"default\",\"do_segment\":true,\"max_keyword_num\":3}''' ConnectionTimeout: 30 FollowRedirection: True ClearCookies: False FailOnErrorStatus: False EncodeRequestBody: False UserAgent: $'''Mozilla/5.0 (Windows; U; Windows NT 5.1; en-US; rv:1.8.1.21) Gecko/20100312 Firefox/3.6''' Encoding: Web.Encoding.AutoDetect AcceptUntrustedCertificates: False ResponseHeaders=> WebServiceResponseHeaders2 Response=> WebServiceResponse2 StatusCode=> StatusCode2
Variables.ConvertJsonToCustomObject Json: WebServiceResponse2 CustomObject=> JsonAsCustomObject2
SET ResultCount TO count(JsonAsCustomObject2['result'])
Variables.CreateNewList List=> FormList
LOOP LoopIndex FROM 0 TO ResultCount - 1 STEP 1
SET Result TO JsonAsCustomObject2['result'][LoopIndex]['form']
Variables.AddItemToList Item: Result List: FormList NewList=> FormList
END
Excel.WriteCell Instance: ExcelInstance Value: {FormList } Column: 4 Row: LoopIndex2 + 1
END
Cotoha API for Developersまたはfor EnterPriseの認証情報をSecret.txtをデスクトップに作成する必要があります。
Exit_flowサブフロー
Excelの体裁を適当に整えて名前を付けて保存しています。
ビジュアル化はPower BIをつかうといろいろできますのでこの稿では省略いたします。
Exit_flow
MouseAndKeyboard.SendKeys TextToSend: $'''{Control}({A})
{ALT}({O}{C}{A})
{Up}{Up}
{Control}{Home}
''' DelayBetweenKeystrokes: 10 SendTextAsHardwareKeys: False
Excel.CloseAndSaveAs Instance: ExcelInstance DocumentFormat: Excel.ExcelFormat.FromExtension DocumentPath: $'''%SpecialFolderPath%\\Bookmarks%FormattedDateTime%\\Bookmarks%FormattedDateTime%.xlsx'''
まとめ
PADとCOTOHA APIの連携することでデスクトップに散らかったファイルを片づけるだけでなく、内容をデータとして整理する作業も比較的簡単に行えることが検証出来ました。
Windows 10のライセンスがあればPADが使えるようになりました!
あれもこれもできるわけではないですが適材を上手くつなげることで、身の回りのちょっとメンドクサイを少し進めたカタチで解決することが身近になるかもしれません。
今回はこれまで変数の記事に書いた要素たくさんを使いました。
詳細は以前記事に書いております。興味がある方はご覧いただければと思います。