Class: NekteClient

nekte-protocol / client/src / NekteClient

Class: NekteClient

Defined in: nekte-source/packages/client/src/client.ts:108

@nekte/client — NEKTE Protocol Client

Client library for interacting with NEKTE agents. Features progressive discovery (L0/L1/L2), zero-schema invocation via version hash caching, and budget-aware requests.

Example

const client = new NekteClient('http://localhost:4001');
const catalog = await client.catalog();
const result = await client.invoke('sentiment', {
  input: { text: 'Great product!' },
  budget: { max_tokens: 50, detail_level: 'minimal' },
});

Constructors

Constructor

new NekteClient(endpoint, config?): NekteClient

Defined in: nekte-source/packages/client/src/client.ts:116

Parameters

endpoint

string

config?

NekteClientConfig

Returns

NekteClient

Properties

cache

readonly cache: CapabilityCache

Defined in: nekte-source/packages/client/src/client.ts:110

endpoint

readonly endpoint: string

Defined in: nekte-source/packages/client/src/client.ts:109

Methods

agentCard()

agentCard(): Promise<AgentCard>

Defined in: nekte-source/packages/client/src/client.ts:160

Returns

Promise<AgentCard>

cancelTask()

cancelTask(taskId, reason?): Promise<TaskLifecycleResult>

Defined in: nekte-source/packages/client/src/client.ts:279

Parameters

taskId

string

reason?

string

Returns

Promise<TaskLifecycleResult>

catalog()

catalog(filter?): Promise<DiscoverResult>

Defined in: nekte-source/packages/client/src/client.ts:186

Parameters

filter?

any

Returns

Promise<DiscoverResult>

close()

close(): Promise<void>

Defined in: nekte-source/packages/client/src/client.ts:333

Returns

Promise<void>

delegateStream()

delegateStream(task, context?): DelegateStream

Defined in: nekte-source/packages/client/src/client.ts:254

Delegate a task with streaming and lifecycle control.

Returns a DelegateStream: iterate events to consume SSE events, call cancel() to abort the task server-side.

Parameters

task

Omit<Task, "budget"> & object

context?

any

Returns

DelegateStream

Example

const stream = client.delegateStream(task);
for await (const event of stream.events) {
  if (event.event === 'progress') console.log(`${event.data.processed}/${event.data.total}`);
  if (event.event === 'complete') console.log('Done:', event.data.out);
  if (shouldAbort) await stream.cancel('user requested');
}

describe()

describe(capId): Promise<DiscoverResult>

Defined in: nekte-source/packages/client/src/client.ts:190

Parameters

capId

string

Returns

Promise<DiscoverResult>

discover()

discover(params): Promise<DiscoverResult>

Defined in: nekte-source/packages/client/src/client.ts:170

Parameters

params

DiscoverParams

Returns

Promise<DiscoverResult>

invoke()

invoke(capId, options): Promise<InvokeResult>

Defined in: nekte-source/packages/client/src/client.ts:202

Parameters

capId

string

options

budget?

any

input

Record<string, unknown>

Returns

Promise<InvokeResult>

resumeTask()

resumeTask(taskId, budget?): Promise<TaskLifecycleResult>

Defined in: nekte-source/packages/client/src/client.ts:286

Parameters

taskId

string

budget?

any

Returns

Promise<TaskLifecycleResult>

schema()

schema(capId): Promise<DiscoverResult>

Defined in: nekte-source/packages/client/src/client.ts:194

Parameters

capId

string

Returns

Promise<DiscoverResult>

taskStatus()

taskStatus(taskId): Promise<TaskStatusResult>

Defined in: nekte-source/packages/client/src/client.ts:293

Parameters

taskId

string

Returns

Promise<TaskStatusResult>

verify()

verify(taskId, checks?, budget?): Promise<unknown>

Defined in: nekte-source/packages/client/src/client.ts:303

Parameters

taskId

string

checks?

VerifyParams = ...

budget?

any

Returns

Promise<unknown>