Logo
Classes

AgentClient

Defined in: packages/cloud/src/beta/agent/client.ts:25

Async client for agent data operations

Type Parameters

T

T = unknown

Constructors

Constructor

new AgentClient<T>(__namedParameters): AgentClient<T>

Defined in: packages/cloud/src/beta/agent/client.ts:32

Parameters

__namedParameters
apiKey?

string = ...

baseUrl?

string = "https://api.cloud.llamaindex.ai/"

collection?

string = "default"

agentUrlId?

string = "default"

Returns

AgentClient<T>

Methods

createItem()

createItem(data): Promise<TypedAgentData<T>>

Defined in: packages/cloud/src/beta/agent/client.ts:64

Create new agent data

Parameters

data

T

Returns

Promise<TypedAgentData<T>>


getItem()

getItem(id): Promise<null | TypedAgentData<T>>

Defined in: packages/cloud/src/beta/agent/client.ts:81

Get agent data by ID

Parameters

id

string

Returns

Promise<null | TypedAgentData<T>>


updateItem()

updateItem(id, data): Promise<TypedAgentData<T>>

Defined in: packages/cloud/src/beta/agent/client.ts:105

Update agent data

Parameters

id

string

data

T

Returns

Promise<TypedAgentData<T>>


deleteItem()

deleteItem(id): Promise<void>

Defined in: packages/cloud/src/beta/agent/client.ts:121

Delete agent data

Parameters

id

string

Returns

Promise<void>


search(options): Promise<TypedAgentDataItems<T>>

Defined in: packages/cloud/src/beta/agent/client.ts:132

List agent data

Parameters

options

SearchAgentDataOptions

Returns

Promise<TypedAgentDataItems<T>>


aggregate()

aggregate(options): Promise<TypedAggregateGroupItems<T>>

Defined in: packages/cloud/src/beta/agent/client.ts:179

Aggregate agent data into groups

Parameters

options

AggregateAgentDataOptions

Returns

Promise<TypedAggregateGroupItems<T>>