AgentsOperations interface

エージェントエンドポイント用の新しいセッションを作成します。 エンドポイントは version_indicator からバックエージェントのバージョンを解決し、提供されたアイソレーションキーを使ってセッションの所有権を強制し、セッションのミューテーション操作を行います。

createSession: (agentName: string, versionIndicator: VersionIndicatorUnion, options?: AgentsCreateSessionOptionalParams) => Promise<AgentSessionResource>

プロパティ値

コードから新しいエージェントバージョンを作成します。 コードをzipにアップロードし、既存のエージェント用に新しいバージョンを作成します。 SHA-256の6進進取ダイジェストは、完全性とデアップのために x-ms-code-zip-sha256 ヘッダーに提供されています。 リクエストボディはマルチパート/フォームデータで、JSONメタデータパートとバイナリコードパート(パートの順序は関係ありません)があります。 最大アップロードサイズは250MBです。

createVersionFromCode: (agentName: string, codeZipSha256: string, content: CreateAgentVersionFromCodeContent, options?: AgentsCreateVersionFromCodeOptionalParams) => Promise<AgentVersion>

プロパティ値

エージェントを削除します。 ホストエージェントの場合、どのバージョンでもアクティブなセッションがある場合、 force がtrueに設定されていない限りHTTP 409でリクエストは拒否されます。 力が真の場合、関連するすべてのセッションはエージェントおよびそのバージョンとともにカスケード削除されます。

delete: (agentName: string, options?: AgentsDeleteOptionalParams) => Promise<DeleteAgentResponse>

プロパティ値

同期的にセッションを削除します。 セッションが削除されたり存在しないと、204 No Contentを返します。

deleteSession: (agentName: string, sessionId: string, options?: AgentsDeleteSessionOptionalParams) => Promise<void>

プロパティ値

指定されたファイルやディレクトリをセッションサンドボックスから削除します。 recursiveがfalseの場合、空でないディレクトリを削除すると409のコンフリクトが返されます。

deleteSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDeleteSessionFileOptionalParams) => Promise<void>

プロパティ値

エージェントの特定のバージョンを削除します。 ホストエージェントの場合、そのバージョンにアクティブなセッションがある場合、 force がtrueに設定されていない限り、HTTP 409でリクエストは拒否されます。 力が真の場合、このバージョンに関連付けられたすべてのセッションはカスケード削除されます。

deleteVersion: (agentName: string, agentVersion: string, options?: AgentsDeleteVersionOptionalParams) => Promise<DeleteAgentVersionResponse>

プロパティ値

指定されたエージェントを無効化し、新しいセッションの受け入れやリクエストの処理を妨げます。 既存のアクティブセッションは優雅に減量できますが、新しいセッションは作成できません。 この操作は冪등 — すでに無効化されたエージェントを無効化すると、副作用なしで成功が戻ります。

disable: (agentName: string, options?: AgentsDisableOptionalParams) => Promise<void>

プロパティ値

コードベースのホストエージェント用のコードzipをダウンロードします。 以前アップロードしたzipファイル(application/zip)を返します。

agent_versionが提供された場合は、そのバージョンのコードzipを返します。そうでなければ、最新バージョンのコードzipを返します。

返されたバイトのSHA-256ダイジェストは、解決されたバージョンのcontent_hashのcode_configurationと一致します。

downloadAgentCode: (agentName: string, options?: AgentsDownloadAgentCodeOptionalParams) => Promise<AgentsDownloadAgentCodeResponse>

プロパティ値

指定されたサンドボックスパスでファイルをバイナリストリームとしてダウンロードします。 パスはセッションホームディレクトリに対して解決されます。

downloadSessionFile: (agentName: string, sessionId: string, path: string, options?: AgentsDownloadSessionFileOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

プロパティ値

指定されたエージェントを有効にし、新しいセッションや処理リクエストを受け入れることを可能にします。 この操作は冪等性であり、すでに有効になっている薬剤が副作用なく成功を収める。

enable: (agentName: string, options?: AgentsEnableOptionalParams) => Promise<void>

プロパティ値

エージェントを取得します。

get: (agentName: string, options?: AgentsGetOptionalParams) => Promise<Agent>

プロパティ値

ホストされたエージェントセッションの詳細をエージェント名とセッション識別子で取得します。

getSession: (agentName: string, sessionId: string, options?: AgentsGetSessionOptionalParams) => Promise<AgentSessionResource>

プロパティ値

特定のホストエージェントセッションのコンソールログ(stdout / stderr)を Server-Sent イベント(SSE)ストリームとしてストリーミングします。

各SSEフレームには以下が含まれます:

• event:いつも "log"
• data: プレーンテキストのログライン(現在はJSON形式ですが、スキーマは契約的ではなく、追加のキーを含むか時間とともにフォーマットを変更することがあります。クライアントは不透明な文字列として扱うべきです)

SSEフレームの例:

event: log
data: {"timestamp":"2026-03-10T09:33:17.121Z","stream":"stdout","message":"Starting FoundryCBAgent server on port 8088"}

event: log
data: {"timestamp":"2026-03-10T09:33:17.130Z","stream":"stderr","message":"INFO: Application startup complete."}

event: log
data: {"timestamp":"2026-03-10T09:34:52.714Z","stream":"status","message":"Successfully connected to container"}

event: log
data: {"timestamp":"2026-03-10T09:35:52.714Z","stream":"status","message":"No logs since last 60 seconds"}

ストリームはクライアントが切断するかサーバーが接続を終了するまで開いたままです。 クライアントは必要に応じて再接続に対応します。

getSessionLogStream: (agentName: string, agentVersion: string, sessionId: string, options?: AgentsGetSessionLogStreamOptionalParams) => Promise<AgentsDownloadSessionFileResponse>

プロパティ値

エージェントの特定のバージョンを取得します。

getVersion: (agentName: string, agentVersion: string, options?: AgentsGetVersionOptionalParams) => Promise<AgentVersion>

プロパティ値

すべてのエージェントのリストを返します。

list: (options?: AgentsListOptionalParams) => PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

プロパティ値

セッションサンドボックス内の指定されたパスでファイルとディレクトリを返します。 応答はターゲットディレクトリの直接的な子ノードのみを含み、パスが提供されていない場合はセッションのホームディレクトリにデフォルトで移行します。

listSessionFiles: (agentName: string, sessionId: string, options?: AgentsListSessionFilesOptionalParams) => PagedAsyncIterableIterator<SessionDirectoryEntry, SessionDirectoryEntry[], PageSettings>

プロパティ値

指定されたエージェントエンドポイントに関連付けられたセッションのページ集合を返します。

listSessions: (agentName: string, options?: AgentsListSessionsOptionalParams) => PagedAsyncIterableIterator<AgentSessionResource, AgentSessionResource[], PageSettings>

プロパティ値

エージェントのバージョンのリストを返します。

listVersions: (agentName: string, options?: AgentsListVersionsOptionalParams) => PagedAsyncIterableIterator<AgentVersion, AgentVersion[], PageSettings>

プロパティ値

指定されたホストエージェントセッションを終了し、リクエストが成功すると204 No Contentを返します。

stopSession: (agentName: string, sessionId: string, options?: AgentsStopSessionOptionalParams) => Promise<void>

プロパティ値

指定されたエージェントエンドポイント構成にマージパッチの更新を適用します。

updateAgent: (agentName: string, options?: AgentsUpdateAgentObjectOptionalParams) => Promise<Agent>

プロパティ値

セッションサンドボックス内の指定されたパスにバイナリファイルの内容をアップロードします。 サービスはファイルをセッションホームディレクトリに対して保存し、50MBを超えるペイロードは拒否します。

uploadSessionFile: (agentName: string, sessionId: string, path: string, content: Uint8Array, options?: AgentsUploadSessionFileOptionalParams) => Promise<SessionFileWriteResponse>

プロパティ値

エージェントを作成します。

function create(name: string, definition: AgentDefinitionUnion, options?: AgentsCreateOptionalParams): Promise<Agent>

パラメーター

返品

マニフェストからエージェントを作成します。

function create(name: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentFromManifestOptionalParams): Promise<Agent>

パラメーター

返品

新しいエージェント バージョンを作成します。

function createVersion(agentName: string, definition: AgentDefinitionUnion, options?: AgentsCreateVersionOptionalParams): Promise<AgentVersion>

パラメーター

返品

マニフェストから新しいエージェントバージョンを作成します。

function createVersion(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsCreateAgentVersionFromManifestOptionalParams): Promise<AgentVersion>

パラメーター

返品

エージェント定義に変更がある場合は、新しいバージョンを追加してエージェントを更新します。 変更がない場合は、既存のエージェントバージョンを返します。

function update(agentName: string, definition: AgentDefinitionUnion, options?: AgentsUpdateOptionalParams): Promise<Agent>

パラメーター

返品

エージェント定義に変更がある場合は、新しいバージョンを追加して、マニフェストからエージェントを更新します。 変更がない場合は、既存のエージェントバージョンを返します。

function update(agentName: string, manifestId: string, parameterValues: Record<string, unknown>, options?: AgentsUpdateAgentFromManifestOptionalParams): Promise<Agent>

パラメーター

返品