コンテンツにスキップ

インテリジェントモニタリング V2 YAML 生成



POST /api/v1/checker/smart_monitor/generate

概要

Body リクエストパラメータ

パラメータ名 タイプ 必須 説明
stream boolean デフォルトでは true の場合 SSE を返し、false の場合は同期 JSON を返します。
prompt string Y
空文字列を許可: False
language string
選択可能な値: ['zh', 'zh-hant', 'en', 'id', 'ja', 'ko']
checkerUUID string
existingYaml string

パラメータ補足説明

デフォルトでは SSE ストリーミングで Copilot POST /runs(stream=true)を呼び出し、StreamEvent JSON をそのまま透過します。最終結果は終端状態の data.response に格納されます。

stream=false の場合は同期 JSON の content RunResponse を保持します。モニターは保存も有効化もされません。

succeeded かつ result が空の場合でも上流のレスポンスを保持するため、呼び出し側は手順内の理由を読み取ります。ストリーム確立前の失敗はエラーを返し、ストリームが切断されて終端状態を受信できない場合は未完了とみなされます。

X-Smart-Monitor-Generation-Id はストリーミングレスポンスヘッダーで事前に割り当てられます。成功した終端状態の有効な YAML の場合にのみ、24時間の下書きが生成されます。中断、失敗、空の結果は保存できません。

OpenAPI は有効な V2 YAML を直接送信してモニターを作成でき、生成インターフェースを呼び出す必要はありません。言語とワークスペースの識別情報はサーバー側で制約されます。

レスポンス


フィードバック

このページは役に立ちましたか?