AgentsClient class

パッケージ:

@azure/ai-agents

コンストラクター

AgentsClient(string, TokenCredential, AgentsClientOptionalParams)

プロパティ

files	ファイルの操作グループ
messages	メッセージの操作グループ
pipeline	このクライアントが要求を行うために使用するパイプライン
runs	実行の操作グループ
runSteps	runSteps の操作グループ
threads	スレッドの操作グループ
vectorStoreFileBatches	vectorStoreFileBatches の操作グループ
vectorStoreFiles	vectorStoreFiles の操作グループ
vectorStores	vectorStores の操作グループ

メソッド

createAgent(string, CreateAgentOptionalParams)	新しいエージェントを作成します。
deleteAgent(string, DeleteAgentOptionalParams)	エージェントを削除します。
getAgent(string, GetAgentOptionalParams)	既存のエージェントを取得します。
listAgents(ListAgentsOptionalParams)	以前に作成されたエージェントの一覧を取得します。
updateAgent(string, UpdateAgentOptionalParams)	既存のエージェントを変更します。

コンストラクターの詳細

AgentsClient(string, TokenCredential, AgentsClientOptionalParams)

new AgentsClient(endpointParam: string, credential: TokenCredential, options?: AgentsClientOptionalParams)

パラメーター

endpointParam

string

credential

TokenCredential

options

AgentsClientOptionalParams

プロパティの詳細

files

ファイルの操作グループ

files: FilesOperations

プロパティ値

FilesOperations

messages

メッセージの操作グループ

messages: MessagesOperations

プロパティ値

MessagesOperations

pipeline

このクライアントが要求を行うために使用するパイプライン

pipeline: Pipeline

プロパティ値

Pipeline

runs

実行の操作グループ

runs: RunsOperations

プロパティ値

RunsOperations

runSteps

runSteps の操作グループ

runSteps: RunStepsOperations

プロパティ値

RunStepsOperations

threads

スレッドの操作グループ

threads: ThreadsOperations

プロパティ値

ThreadsOperations

vectorStoreFileBatches

vectorStoreFileBatches の操作グループ

vectorStoreFileBatches: VectorStoreFileBatchesOperations

プロパティ値

VectorStoreFileBatchesOperations

vectorStoreFiles

vectorStoreFiles の操作グループ

vectorStoreFiles: VectorStoreFilesOperations

プロパティ値

VectorStoreFilesOperations

vectorStores

vectorStores の操作グループ

vectorStores: VectorStoresOperations

プロパティ値

VectorStoresOperations

メソッドの詳細

createAgent(string, CreateAgentOptionalParams)

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

function createAgent(model: string, options?: CreateAgentOptionalParams): Promise<Agent>

パラメーター

model

string

options

CreateAgentOptionalParams

戻り値

Promise<Agent>

deleteAgent(string, DeleteAgentOptionalParams)

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

function deleteAgent(assistantId: string, options?: DeleteAgentOptionalParams): Promise<AgentDeletionStatus>

パラメーター

assistantId

string

options

DeleteAgentOptionalParams

戻り値

Promise<AgentDeletionStatus>

getAgent(string, GetAgentOptionalParams)

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

function getAgent(assistantId: string, options?: GetAgentOptionalParams): Promise<Agent>

パラメーター

assistantId

string

options

GetAgentOptionalParams

戻り値

Promise<Agent>

listAgents(ListAgentsOptionalParams)

以前に作成されたエージェントの一覧を取得します。

function listAgents(options?: ListAgentsOptionalParams): PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

パラメーター

options

ListAgentsOptionalParams

戻り値

PagedAsyncIterableIterator<Agent, Agent[], PageSettings>

updateAgent(string, UpdateAgentOptionalParams)

既存のエージェントを変更します。

function updateAgent(assistantId: string, options?: UpdateAgentOptionalParams): Promise<Agent>

パラメーター

assistantId

string

options

UpdateAgentOptionalParams

戻り値

Promise<Agent>