クエリを作成する

アカウントでレポートの表示権限を持つすべてのメンバーが、Sigma クエリエディターを使用して新しいクエリを作成したり、既存のクエリを変更したりできます。Stripe の大規模言語モデル (LLM) ベースのクエリアシスタントは、自然言語プロンプトから必要な SQL を生成することもできます。

クエリリソース

エディターの左側のナビゲーションウィンドウには、クエリの構築に役立つツールセットが表示されています。以下を確認できます。

• 以前に保存されたクエリ
• チームが保存したクエリ
• データソースを検索するテーブルスキーマ
• Stripe クエリテンプレート

保存済みのクエリとテンプレート

クエリタブには、お客様とチームがこれまで保存したクエリのリストが表示されます。テンプレートタブには、最も一般的な指標とレポートを表すサンプルクエリが含まれています。

保存済みのクエリまたはテンプレートを選択すると、クエリエディターに読み込まれます。ここで、実行をクリックすると、結果を再生成して表示できます。

保存済みのクエリまたはテンプレートを自社用のカスタムレポートの開始点として使用するには、オーバーフローメニュー () をクリックしてコピーを作成を選択するか、エディターに読み込んでコピーを作成をクリックします。これにより、エディターでコンテンツを変更し、その変更内容を新しいクエリとして保存できます。

クエリを作成する

クエリエディターを開いて、以下を実行できます。

• 標準の ANSI SQL をエディターに直接記述します。
• 以前に保存したクエリまたは Stripe のテンプレートから既存のクエリを選択し、エディターで変更して、返されるデータを微調整します。

以下のクエリは、balance_transactions テーブルを使用して、返金に関連する直近 5 件の取引残高についての情報を取得します。

select
  date_format(created, '%Y-%m-%d') as day,
  id,
  amount,
  currency,
  source_id
from balance_transactions
where type = 'refund'
order by day desc
limit 5

実行をクリックしてクエリを実行すると、エディターの下のテーブルに結果が表示されます。クエリが複雑な場合は、完了して結果を表示するまで少し時間がかかることがあります。無効なクエリを実行するとエラーメッセージが生成され、その中でエラーの行番号と場所が示されます。

サンプルクエリの結果は 5 つの行を返します。各行は特定の取引残高アイテムに対応しており、それに関するリクエストした情報が表示されます。

テーブルを結合する

タイプが「プライマリキー」または「外部キー」の列は、他のテーブルの同様の列に結合できます。

• プライマリキーは、テーブル内の各レコードの一意の識別子 (ID) を表します
• 外部キーは、他のテーブルのプライマリキーを参照するデータを表します

たとえば、disputes テーブルの charge_id 列 (外部キー) を、charges テーブルの id 列 (プライマリキー) に結合できます。

テーブルを結合すると、データセットでより豊富な結果を返すことができます。たとえば、取引残高のサンプルを変更して refunds テーブルと結合し、より詳細な情報を提供することができます。

select
  date_format(date_trunc('day', balance_transactions.created), '%Y-%m-%d') as day,
  balance_transactions.amount,
  balance_transactions.currency,
  balance_transactions.source_id,
  refunds.charge_id
from
  balance_transactions
inner join refunds -- Joining these tables to retrieve additional information
on balance_transactions.source_id=refunds.id
where balance_transactions.type = 'refund'
order by day desc
limit 5

この拡張されたクエリは、返金が関連付けられている元の支払い ID を返すようになります。

アシスタントを使用する

Stripe のクエリエディターには、LLM アシスタントが内蔵されており、自然言語プロンプトから標準の ANSI SQL を出力します。エディターでは以下のモードを実行できます。

• 生成では、プロンプトの質問を使用して新しいクエリを作成し、エディターウィンドウにすでに読み込まれている SQL を上書きします。
• 編集では、プロンプトの質問を使用してクエリエディターの SQL を変更します。

アシスタントを使用する

1. ダッシュボードで Sigma クエリエディターを開きます。
2. 生成モードを選択して、プロンプトフィールドに質問を入力します。アシスタントは以下を実行します。
   • クエリの推奨内容をエディターに読み込みます。
   • 推奨内容を説明するサマリーを表示します。
   • 推奨されたクエリを実行し、エディターの下のテーブルに結果を返します。
   • モードを編集に切り替えて、必要に応じて別の質問を行い、クエリを微調整できるようにします。
3. 必要な情報を取得できるまで、引き続きアシスタントを使用して結果データを表示します。

以下のスクリーンショットは、このドキュメントの最初に示したサンプルクエリと同じ SQL を、プロンプトがどのように生成したかを示しています。

推奨内容を修正するための追加質問には、以下のようなものがあります。

• これらの結果を金額で並べ替えます。
• automatic_transfer 列や reporting_category 列を含めないでください。
• 各取引の顧客を確認できますか？

チャットの履歴を表示する

Sigma は、対象のクエリのチャット履歴に、アシスタントとのやり取りをすべて保存します。エディターの右上にある ボタンをクリックして、チャット履歴スライダーを開きます。

チャット履歴では、クエリの期間 (現在のセッションだけではなく) 内にアシスタントに入力された各プロンプトと、アシスタントの応答を確認できます。SQL を表示をクリックすると、プロンプトに関連付けられた SQL の推奨を確認できます。開いたときにエディターで表示をクリックすると、その推奨をメインのエディターウィンドウに再度読み込むことができます。

制限事項

• クエリエディターのアシスタントは、英語での質問にのみ回答します。
• クエリエディターのアシスタントは、Stripe スキーマに関連する質問にのみ回答します。「Stripe のロゴは何色ですか？」や、「今日のサンフランシスコの天気は？」などの一般的な質問には回答できません。

フィードバック

エディターと結果テーブルの間の**この対応はお役に立ちましたか？**というプロンプトに応答して、アシスタントの継続的な改善にご協力ください。

1. はいまたはいいえをクリックします。
2. アシスタントの対応についての具体的な詳細と、改善すべき点を入力してください。推奨内容の正確さ、UI、アシスタントを使用する際のその他の機能についてなど、あらゆるご意見をお待ちしております。

トレーニングデータへの同意

Sigma Assistant を使用することで、お客様のチャットへの入力を Stripe が記録し、Sigma Assistant の機能のトレーニングと改善のために Stripe が利用することに同意したとみなされます。このような目的でのチャットへの入力の使用を望まない場合は、設定でオプトアウトできます。

クエリ結果を表示およびダウンロードする

クエリ結果は、エディターの下のテーブルに表示されます。以下の操作を実行できます。

• 最大 1,000 件の結果を表示できます。
• 列ヘッダーをクリックして、結果を並べ替えます。
• 結果を読みやすくするために、各列のサイズを変更します。
• 結果出力の高さを調整します。

クエリの結果が 10,000 件未満の場合は、視覚化したチャートを作成することもできます。以下が可能です。

• カスタムの y 軸と x 軸を使用して、折れ線グラフまたは棒グラフを作成します。
• 任意のテーブル列でグループ化する

チャートをクエリに保存すると、クエリを実行するたびに選択した設定でチャートが表示されます。チャートを編集できるのはクエリの作成者のみです。

金額は USD ではセント、JPY では円のように、支払い通貨の最小単位で表示されます。たとえば、通貨 usd の金額 1,000 は、10 USD に相当します。

CSV をダウンロードをクリックして、スプレッドシートアプリケーションやその他のレポートツールで使用するために結果をエクスポートします。ダウンロードされた CSV にはすべてのクエリ結果が含まれるため、表示可能な結果は 1,000 件に制限されません。

クエリを保存する

クエリを保存するには、そのタイトル (新しいクエリの場合は新しいレポートというラベルが付けられています) をクリックして、名前を新たに入力します。次に、保存をクリックします。

クエリを共有する

自分が保存したクエリはすべてセクションに追加され、アカウントのすべてのチームメンバーが利用できます。保存されたそれぞれのクエリには一意の URL が設定されるため、リンクをコピーをクリックして共有できます。このリンクを、定期的に使用する特定のレポートへのショートカットとして使用したり、Stripe アカウントの他のチームメンバーと直接共有したりすることができます。

クエリはチームメンバーとのみ共有できます。また、共有されたクエリは読み取り専用であるため、他のチームメンバーはお客様が作成したクエリを変更できません。チームメンバーがクエリに変更を加えるには、各自コピーを作成してそれを編集できます。