WorkatoコネクターCoPilot ​

WorkatoコネクターCoPilotは、大規模言語モデル（LLM）を使用して、コネクター構築エクスペリエンスを強化し、加速します。 これにより、経験豊富なSDK開発者である場合も、コーディングやWebサービスにある程度精通したSDK初心者である場合も、コネクターを迅速に開発できます。 WorkatoコネクターCoPilotを使用して、Workato SDKの詳細を学習したり、認証ロジックを構築したり、要件に固有のアクションを構築したりできます。

前提条件 ​

• ワークスペースでCopilotが有効になっていることを確認してください。 Copilotを有効にするには、Environment管理者ロール、または従来の管理者システムロールが必要です。 これらのロールのいずれも割り当てられていない場合は、ワークスペース管理者に連絡してこの機能を有効にしてください。 詳細については、Copilotのドキュメントを参照してください。

標準ワークスペース ​

AHQワークスペース ​

コネクターCoPilotの使用方法 ​

次の手順を使用する前に、ワークスペースでコネクターCoPilotが有効になっていることを確認してください。

コネクター開発の加速 ​

コネクターCoPilotを使用すると、コネクターを迅速かつ効率的に構築できます。 ビジネス目標とコネクターのニーズを説明すると、コネクターCoPilotによりプロダクションへの移行を迅速化できます。

コネクターCoPilotインターフェイス

コネクターCoPilotチャットに初めて入るとき、コネクター、API、Workato SDKドキュメントについて、いつでも任意の順序で質問できます。 コネクターCoPilotの機能について質問すると、現在の機能の一覧が表示されます。

コネクターCoPilotの機能

Copilotの機能 ​

コネクターCoPilotは、次のタスクを支援できます。

• コネクションブロックを作成し、OAuth 2.0、基本認証、APIキーなどの各種認証方法を使用します。
• さまざまなHTTPメソッドを使用して、各種APIエンドポイントのアクションを作成します。
• コネクションとアクションの構築に必要な情報を収集するために、関連するAPIドキュメントを検索します。
• コネクターの構築方法を理解するために、Workato SDKドキュメントの例とリファレンスにアクセスします。

認証ロジックの作成 ​

コネクターCoPilotは、各種APIの認証ロジックの作成を支援できます。 特定の認証オプションについて、APIドキュメントをコネクターCoPilotと共有することも、フリーフォームチャットでドキュメントなしに進めることもできます。 次のセクションでは、コネクターの認証を設定するためのガイダンスを示します。

APIドキュメントの提供 ​

コネクターCoPilotは、Webを閲覧して関連するAPIドキュメントを検索します。 必要な情報が見つからない場合は、APIドキュメントを直接指定できます。 URLを指定するか、ドキュメントをコピーして貼り付けます。 URLは10,000文字に制限されていることに注意してください。 URLがこの制限を超える場合は、コピーアンドペーストを使用します。

指定されたドキュメントに基づいて、コネクターCoPilotはAPIと互換性のある認証方法を提案します。 適切なオプションが見つからない場合は、独自の認証方法を指定できます。

カスタム認証の構築 ​

または、コネクターCoPilotの支援を受けながら認証を段階的に構築できます。 コネクターCoPilotは、認証のタイプ、エンドポイント、必要な特定のパラメーターなど、必要な詳細の入力を求め、メソッドを1ステップずつ構築するのに役立ちます。

すべての認証タイプに関する一般的なガイダンス ​

認証を設定する際は、コネクターCoPilotに包括的な情報を提供することが重要です。 これには、認証タイプ、外部システムのベースURI、コネクションを検証するテストエンドポイントの指定が含まれます。 これらの共通事項により、コネクターCoPilotは必要なコードを正確に構築できます。

一般的な認証タイプ ​

コネクターCoPilotが正確で効果的な認証ロジックを生成できるように、関連するコンテキストをできるだけ多く提供してください。 特定の認証タイプに必要な詳細は次のとおりです。

OAuth 2.0 Authorization Code Grant ​

OAuth 2.0 Authorization Code Grantは、通常Webサーバーアプリケーションで使用されます。 このフローでは、ユーザーを認可サーバーにリダイレクトして認可コードを取得し、そのコードをアクセストークンと交換します。 この方法では、コネクターCoPilotに次の詳細を提供します。

• 認可URL

• ユーザーが認証のためにリダイレクトされるエンドポイント。

• トークンURL

• 認可コードをアクセストークンと交換するために使用されるエンドポイント。

• アクセストークンを取得するためのロジック

• 認可後にアクセストークンを取得する方法のロジックを提供します。

• アクセストークンを更新するためのロジック

• アクセストークンの有効期限が切れたときに更新する方法のロジックを提供します。

OAuth 2.0 Client Credentials Grant ​

OAuth 2.0 Client Credentials Grantは、ユーザー操作を伴わないサーバー間通信に使用されます。 このフローでは、クライアント資格情報を使用してアクセストークンを直接取得します。 この方法では、コネクターCoPilotに次の詳細を提供します。

• トークンURL

• クライアント資格情報を使用してアクセストークンを取得するために使用されるエンドポイント。

• アクセストークンを取得するためのロジック

• クライアント資格情報を使用してアクセストークンを取得する方法のロジックを提供します。

基本認証 ​

基本認証では、各APIリクエストでユーザー名とパスワードを送信します。 これらの資格情報は通常、base64でエンコードされます。 基本認証の資格情報をAPIリクエストに含めるためのロジックをコネクターCoPilotに提供し、エンコードプロセスと必要な正確なHTTPヘッダー形式を網羅します。

APIキー認証 ​

APIキー認証では、各APIリクエストでAPIキーを送信します。リクエストヘッダーに含めるか、クエリパラメーターとして送信します。 APIキーをAPIリクエストに含めるためのロジックをコネクターCoPilotに提供し、キーをヘッダーに含めるかクエリパラメーターに含めるか、およびAPIが想定する正確な形式を詳述します。

追加の認証タイプ ​

コネクターCoPilotは、他のタイプの認証にも対応できます。 これらの方法を使用する場合は、効果的に認証するために必要な特定のエンドポイント、パラメーター、ロジックなど、関連するコンテキストをできるだけ多く提供します。 詳細かつ正確な情報を提供することで、コネクターCoPilotはコードを正確かつ効果的に構造化できます。

コネクションの確認と調整 ​

コネクターCoPilotがコネクションブロックコードを生成したら、次の手順を完了してコネクションを確認、調整、テストします。

アクションの生成 ​

アクションを作成するには、特定のAPIエンドポイントとのやり取り方法を定義します。 コネクションの作成後、コネクターCoPilotからアクションを作成する予定があるかを尋ねられる場合があります。 または、アクションを作成する予定であることをプロンプトに入力できます。

APIドキュメントの提供 ​

コネクターCoPilotは、Webを閲覧して関連するAPIドキュメントを検索します。 必要な情報が見つからない場合は、APIドキュメントを直接指定できます。 URLを指定するか、ドキュメントをコピーして貼り付けます。 URLは10,000文字に制限されていることに注意してください。 URLがこの制限を超える場合は、コピーアンドペーストを使用します。

指定されたドキュメントに基づいて、コネクターCoPilotはAPIと互換性のあるアクションコンポーネントを提案します。 適切なオプションが見つからない場合は、コネクターCoPilotの支援を受けながら、手動でアクションコンポーネントを定義できます。

アクションコンポーネントの定義 ​

コネクターCoPilotは、アクションのコンポーネントの定義を支援します。 コネクターCoPilotはこの情報を自動的に収集しますが、次の詳細を提供することで精度を高めることができます。

• アクション名

• アクションの一意の識別子。通常はverb_object形式です。 例: create_contact。

• アクションタイトル

• 動詞-オブジェクト形式のアクションのタイトル。 例: Create contact。

• アクションの説明

• アクションの詳細な説明。

• HTTPメソッド

• GET、POST、PUT、PATCH、DELETE、HEADなど、APIリクエストに使用するHTTPメソッド。

• 実行URI

• 呼び出すAPIエンドポイント。パスパラメーターは中かっこで示します。 例: /v1/contacts/{id}。

• APIコンテンツタイプ

• JSON、XML、URL_FORM_ENCODED、MULTIPARTなど、APIエンドポイントで想定されるコンテンツタイプ。

• リクエストヘッダー

• 任意です。 認証およびコンテンツタイプに関連するものを除く、必要なリクエストヘッダー。

• リクエストパスパラメーター

• 任意です。 APIエンドポイントで必要なパス、クエリ、または本文パラメーター。

アクションの確認と調整 ​

コネクターCoPilotがアクションコードを生成したら、次の手順を完了してアクションを確認、調整、テストします。

エラーの修正とSDKの説明 ​

コネクションまたはアクションコードを生成した後、コネクターCoPilotはコードの改善とトラブルシューティングに役立つ追加オプションを提供します。 エラーやコードスニペットをコネクターCoPilotに貼り付けて、説明や解決策を得ることができます。 これにより、編集の依頼、APIエラーの修正、またはその他のクエリの入力ができます。 要件を具体的に示すことで、コネクターCoPilotはより良い結果を提供できます。

トラブルシューティングでコネクターCoPilotを使用する方法 ​

コネクターCoPilotの支援を受けてコード内のエラーを特定し修正するには、次の手順を完了します。

コネクターCoPilotは、説明の提供、編集の提案、トラブルシューティングプロセスの案内を行うことができます。

関連するAPIドキュメントの検索 ​

コネクターCoPilotは、Workatoと外部APIの両方のドキュメントの検索を支援し、APIエンドポイント、認証方法、リクエスト/レスポンス形式に関する情報を収集できるようにします。 これにより、効果的なコネクターの作成に必要なすべての詳細を入手できます。

要件をコネクターCoPilotに提供すると、関連情報の検索を支援します。 キーワード、ベースURL、ドキュメントパスなどの具体的な詳細を含めると、結果の精度を高めることができます。 収集したドキュメントを使用して、コネクションとアクションを構築または改善します。

Workato SDKドキュメントの例とリファレンスへのアクセス ​

コネクターCoPilotは、Workato SDKドキュメントの例とリファレンスへのアクセスを提供できます。 この機能は、さまざまなSDKコンポーネントの実用的な例と詳細な説明を提供することで、コネクターの構築方法を理解するのに役立ちます。

カスタムコネクター構築のベストプラクティスと例 ​

コネクターCoPilotは、カスタムコネクターを構築するための次のベストプラクティスを案内します。

• APIの理解
• コードの整理
• 安全な認証方法の使用
• コネクションパラメーターのドキュメント化
• パフォーマンスの最適化

コネクションブロックまたはアクションの例が必要な場合、コネクターCoPilotはWorkato SDKドキュメントのスニペットとリファレンスを提供します。 これには、OAuth 2.0コネクションブロック、エラー処理、命名規則の例が含まれます。

SDKコンポーネントの説明 ​

コネクターCoPilotは、コネクションブロック、アクション、トリガー、メソッドなどの特定のSDKコンポーネントを説明できます。 詳細な説明を提供することで、コネクターCoPilotは、これらのコンポーネントをコネクターで効果的に実装する方法を理解するのに役立ちます。

リファレンスドキュメント ​

特定のSDKメソッドまたはコンポーネントについて不明な場合は、コネクターCoPilotにWorkato SDKドキュメントを参照するよう依頼できます。 これにより、コードが公式ドキュメントに記載されたサポート対象メソッドとベストプラクティスに準拠していることを確認できます。

会話のクリア ​

省略記号（...）メニューをクリックすると、現在の会話をクリアするオプションが表示されます。 このオプションはコネクターCoPilotとのチャット履歴をクリアします。コネクターCoPilotをリセットして、より良く正確な回答を得る場合に便利です。 このアクションでは、コネクターにコピーしたコードはクリアされません。

会話をクリア

トリガーの生成 ​

コネクターCoPilotは、新しいレコードの作成など、Workatoでレシピをトリガーするイベントの定義を支援できます。

コネクターのトリガーを作成するための詳細なガイダンスについては、トリガーの構築ドキュメントを参照してください。