AgentsOperations interface

パッケージ:

@azure/ai-projects

エージェントの操作を表すインターフェイス。

プロパティ

delete	エージェントを削除します。
deleteVersion	エージェントの特定のバージョンを削除します。
get	エージェントを取得します。
getVersion	エージェントの特定のバージョンを取得します。
list	すべてのエージェントのリストを返します。
listVersions	エージェントのバージョンのリストを返します。

メソッド

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	エージェントを作成します。
create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)	マニフェストからエージェントを作成します。
createVersion(string, AgentDefinitionUnion, AgentsCreateOptionalParams)	新しいエージェント バージョンを作成します。
createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)	マニフェストから新しいエージェントバージョンを作成します。
update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)	エージェント定義に変更がある場合は、新しいバージョンを追加してエージェントを更新します。 変更がない場合は、既存のエージェントバージョンを返します。
update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)	エージェント定義に変更がある場合は、新しいバージョンを追加して、マニフェストからエージェントを更新します。 変更がない場合は、既存のエージェントバージョンを返します。

プロパティの詳細

delete

エージェントを削除します。

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

プロパティ値

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

deleteVersion

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

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

プロパティ値

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

get

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

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

プロパティ値

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

getVersion

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

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

プロパティ値

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

list

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

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

プロパティ値

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

listVersions

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

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

プロパティ値

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

メソッドの詳細

create(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

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

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

パラメーター

name

string

definition

AgentDefinitionUnion

options

AgentsCreateOptionalParams

戻り値

Promise<Agent>

create(string, string, Record<string, unknown>, AgentsCreateAgentFromManifestOptionalParams)

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

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

パラメーター

name

string

manifestId

string

parameterValues

Record<string, unknown>

options

AgentsCreateAgentFromManifestOptionalParams

戻り値

Promise<Agent>

createVersion(string, AgentDefinitionUnion, AgentsCreateOptionalParams)

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

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

パラメーター

agentName

string

definition

AgentDefinitionUnion

options

AgentsCreateOptionalParams

戻り値

Promise<AgentVersion>

createVersion(string, string, Record<string, unknown>, AgentsCreateAgentVersionFromManifestOptionalParams)

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

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

パラメーター

agentName

string

manifestId

string

parameterValues

Record<string, unknown>

options

AgentsCreateAgentVersionFromManifestOptionalParams

戻り値

Promise<AgentVersion>

update(string, AgentDefinitionUnion, AgentsUpdateOptionalParams)

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

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

パラメーター

agentName

string

definition

AgentDefinitionUnion

options

AgentsUpdateOptionalParams

戻り値

Promise<Agent>

update(string, string, Record<string, unknown>, AgentsUpdateAgentFromManifestOptionalParams)

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

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

パラメーター

agentName

string

manifestId

string

parameterValues

Record<string, unknown>

options

AgentsUpdateAgentFromManifestOptionalParams

戻り値

Promise<Agent>