QVeris
文档目录

方法

call()

call(toolId, options): Promise<ExecuteResponse>

Call a capability. The response may include pre-settlement billing; final charges are reflected in usage() and ledger().

参数

toolId

string

options

CallOptions

返回

Promise<ExecuteResponse>

capabilityDetail()

capabilityDetail(capabilityId, options?): Promise<CapabilityDetailResponse>

Inspect a published CAP contract. This operation does not execute it.

参数

capabilityId

string

options?

providerId?

string

runId?

string

timeoutMs?

number

返回

Promise<CapabilityDetailResponse>

capabilityQuery()

capabilityQuery(request, options?): Promise<CapabilityQueryResponse>

Execute a published CAP Query once. A budget is a ceiling, not a reserved quote.

参数

request

CapabilityQueryRequest

options?

timeoutMs?

number

返回

Promise<CapabilityQueryResponse>

credits()

credits(): Promise<CreditsResponse>

Get current credit balance and bucket details.

返回

Promise<CreditsResponse>

discover()

discover(query, options?): Promise<SearchResponse>

Discover capabilities from a natural-language query. Free.

参数

query

string

options?

DiscoverOptions = {}

返回

Promise<SearchResponse>

inspect()

inspect(toolIds, options?): Promise<SearchResponse>

Inspect capabilities by id to get current parameter schemas. Free. An empty id list resolves locally without a network request.

参数

toolIds

string | string[]

options?

InspectOptions = {}

返回

Promise<SearchResponse>

ledger()

ledger(filters?): Promise<CreditsLedgerResponse>

Query final credits ledger entries.

参数

filters?

CreditsLedgerRequest = {}

返回

Promise<CreditsLedgerResponse>

probe()

probe(toolId, options?): Promise<ProbeResponse>

Validate candidate parameters and request a zero-cost quote without executing the capability.

参数

toolId

string

options?

ProbeOptions = {}

返回

Promise<ProbeResponse>

reconcileCall()

reconcileCall(idempotencyKey, options?): Promise<ToolExecutionReconciliationData>

Read-only lookup for the original Call identified by its idempotency key.

参数

idempotencyKey

string

options?

timeoutMs?

number

返回

Promise<ToolExecutionReconciliationData>

usage()

usage(filters?): Promise<UsageEventsResponse>

Query request-level usage audit history.

参数

filters?

UsageHistoryRequest = {}

返回

Promise<UsageEventsResponse>

fromEnv()

static fromEnv(overrides?): Qveris

Create a client from the QVERIS_API_KEY environment variable. An explicit baseUrl override takes priority over QVERIS_BASE_URL.

参数

overrides?

Omit<QverisClientOptions, "apiKey" | "publicReadOnly" | "credentialProvider">

返回

Qveris

publicReadOnly()

static publicReadOnly(options?): PublicDiscoveryClient

Explicit, credential-free Discover/Inspect; never creates an account.

参数

options?

PublicDiscoveryClientOptions = {}

返回

PublicDiscoveryClient


这个页面对你有帮助吗?