Skip to main content

認証

Connect AI API へのすべてのリクエストは、OAuth または基本認証を使用して適切に認証される必要があります。詳細については、認証 を参照してください。

ワークスペース

ワークスペースをクエリするには、REST API URL に「workspace」という名前の URL パラメータを追加します。クエリするワークスペースの名前をこれに設定します。これはメタデータエンドポイントの GET 操作と、クエリおよびバッチエンドポイントの POST 操作の両方で機能します。なお、/exec エンドポイントはワークスペースをサポートしていません。

レスポンス形式

Connect AI API の操作は、操作によって以下を含む可能性がある共通のレスポンス形式を共有しています。
  • 1つ以上の結果セット(以下を含む):
    • 結果カラムのメタデータ
    • 行の値(存在する場合)
    • 影響を受けた行数
  • 出力パラメータと戻りパラメータ(該当するストアドプロシージャ実行時)
  • リクエスト処理の前、実行中、または実行後に発生したエラー
API が返すレスポンスオブジェクトには、以下に示す 1つ以上のトップレベルプロパティが含まれます。

プロパティ

エラー

Connect AI が API リクエストを受信すると、検証し、実行し、結果が届き次第シリアライズしてストリーミングで返します。実行前または実行中にエラーが発生した場合、レスポンスオブジェクトにはエラー情報のみが含まれます。ただし、クエリの結果の返却が開始された にエラーが発生することもあります。その場合、レスポンスオブジェクトには部分的な結果とともに、結果が不完全であることを示すエラー情報が含まれることがあります。 HTTP ステータスコードはボディの前に返されるため、不完全なレスポンスの HTTP ステータスは 200 OK になります。そのため、HTTP ステータスコードのみに頼らず、レスポンスにエラー情報が含まれているかどうかを常に確認することが重要です。

データ型

次の表は、結果セットのシリアライズにおける dataType プロパティの有効な値を示しています。