@zhivex-ai/sdk 0.4.0-next.0 → 0.4.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -40
- package/dist/index.d.ts +2 -5
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +1 -2
- package/dist/index.js.map +1 -1
- package/package.json +2 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @zhivex-ai/sdk
|
|
2
2
|
|
|
3
|
-
Recommended entry point for Zhivex AI SDK. Re-exports the high-level public API for text generation, streaming, structured output, tools, multimodal messages,
|
|
3
|
+
Recommended entry point for Zhivex AI SDK. Re-exports the high-level public API for text generation, streaming, structured output, tools, multimodal messages, and embeddings.
|
|
4
4
|
|
|
5
5
|
## Install
|
|
6
6
|
|
|
@@ -8,45 +8,6 @@ Recommended entry point for Zhivex AI SDK. Re-exports the high-level public API
|
|
|
8
8
|
bun add @zhivex-ai/sdk
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
-
## Agent Runtime
|
|
12
|
-
|
|
13
|
-
```ts
|
|
14
|
-
import { createAgent, runAgent } from "@zhivex-ai/sdk";
|
|
15
|
-
import { createOpenAI } from "@zhivex-ai/openai";
|
|
16
|
-
|
|
17
|
-
const openai = createOpenAI({
|
|
18
|
-
apiKey: process.env.OPENAI_API_KEY
|
|
19
|
-
});
|
|
20
|
-
|
|
21
|
-
const agent = createAgent({
|
|
22
|
-
name: "assistant",
|
|
23
|
-
instructions: "Be helpful and concise.",
|
|
24
|
-
model: openai("gpt-4o-mini")
|
|
25
|
-
});
|
|
26
|
-
|
|
27
|
-
const result = await runAgent({
|
|
28
|
-
agent,
|
|
29
|
-
prompt: "Summarize the migration risks for moving to Bun."
|
|
30
|
-
});
|
|
31
|
-
|
|
32
|
-
console.log(result.text);
|
|
33
|
-
```
|
|
34
|
-
|
|
35
|
-
`@zhivex-ai/sdk` now re-exports:
|
|
36
|
-
|
|
37
|
-
- `createAgent()`
|
|
38
|
-
- `createAgentRegistry()`
|
|
39
|
-
- `runAgent()`
|
|
40
|
-
- `streamAgent()`
|
|
41
|
-
- `resumeAgent()`
|
|
42
|
-
- in-memory and file-backed session, checkpoint, and memory stores
|
|
43
|
-
|
|
44
|
-
Agent runs support the same operational controls as the core generation APIs, including `abortSignal`, `timeoutMs`, `maxRetries`, and `retryBackoffMs`. The runtime also respects agent `toolExecution` settings for parallel tool calls, concurrency limits, timeouts, and stop-on-error behavior.
|
|
45
|
-
|
|
46
|
-
If an agent defines `outputSchema`, `runAgent()` returns the validated object on `result.object`, and `streamAgent()` exposes both `eventStream` object events and `partialObjectStream` for progressive structured UI updates. Delegate fan-out can also run in parallel when `toolExecution.parallel` is enabled and the run budget allows it.
|
|
47
|
-
|
|
48
|
-
For production workflows, `runAgent()` can emit the same runtime events through `eventHandler` even when you are not consuming streams, approval history is persisted on `result.approvals`, tool access can be constrained with per-tool `policy` metadata plus agent-level `toolPolicy` rules, and `result.metrics` exposes latency, token usage, per-model attribution, and estimated cost.
|
|
49
|
-
|
|
50
11
|
Repository and full documentation:
|
|
51
12
|
|
|
52
13
|
- <https://github.com/Zhivex/zhivex-ai-sdk>
|
package/dist/index.d.ts
CHANGED
|
@@ -1,6 +1,3 @@
|
|
|
1
|
-
export { createAgent,
|
|
2
|
-
export {
|
|
3
|
-
export type { AudioInput, CatalogProviderId, CallableProviderAdapter, CircuitBreakerState, ContentPart, EmbedOutput, FinishReason, GenerateGroundedTextOptions, GenerateGroundedTextOutput, GenerateSpeechOptions, GenerateObjectOptions, GenerateObjectOutput, GenerateTextOptions, GenerateTextOutput, GroundedGenerateResult, GroundedLanguageModel, GroundingSource, LanguageModel, LanguageModelMiddleware, LanguageModelStreamMiddlewareContext, LanguageModelStreamMiddlewareNext, LanguageModelTelemetryEvent, ModelCatalog, ModelCatalogEntry, ModelMessage, ObjectStreamEvent, ProviderAdapter, ProviderOptions, ProviderOptionsOf, ReasoningConfig, StreamEvent, StreamObjectResult, StreamTextResult, SpeechModel, SpeechOutput, TelemetryStreamErrorEvent, TelemetryStreamFinishEvent, TelemetryStreamStartEvent, TelemetryToolExecutionErrorEvent, TelemetryToolExecutionFinishEvent, TelemetryToolExecutionStartEvent, ToolExecutionOptions, ToolDefinition, ToolPolicy, ToolExecutionResult, ToolSandboxLevel, ToolSideEffectLevel, ToolSet, TranscribeAudioOptions, TranscriptionModel, TranscriptionOutput, UIMessage, UIMessageChunk } from "@zhivex-ai/core";
|
|
4
|
-
export type { AgentBudget, AgentCheckpoint, AgentDefinition, AgentEvent, AgentModelUsageSummary, AgentApprovalDecidedEvent, AgentApprovalPolicy, AgentRunMetrics, AgentToolPolicy, AgentObjectCompleteEvent, AgentObjectPartialEvent, AgentRegistry, AgentRunInput, AgentRunResult, AgentRunStatus, AgentSession, AgentStepType, AgentStreamResult, ApprovalRecord, ApprovalDecision, ApprovalRequest, CheckpointStore, MemoryRecord, MemoryStore, SessionStore, ToolExecutionContext } from "@zhivex-ai/core";
|
|
5
|
-
export type { AgentExecutionOptions, AgentExecutionStores, AgentGateway } from "@zhivex-ai/agents";
|
|
1
|
+
export { assistant, agentApprovalResponsePart, createFileGenerateCache, createAgent, createAgentHandoff, createAgentApprovalMessage, createFileAgentMemoryStore, createFileAgentRunStore, createMcpToolRegistry, createMcpToolSet, createOtelAgentObserver, createOtelObserver, createOtelTelemetryMiddleware, createPostgresAgentMemoryStore, createPostgresAgentRunStore, createModelCatalog, createSqliteAgentMemoryStore, createSqliteAgentRunStore, createTextMessage, embed, embedMany, generateGroundedText, generateSpeech, generateObject, generateText, hostedTool, streamObject, streamAgent, streamLiveAgent, streamText, system, textPart, deserializeUIMessage, defaultModelCatalog, fromUIMessage, fromUIMessages, createCachedGenerateMiddleware, createCircuitBreakerMiddleware, createInMemoryGenerateCache, createTelemetryMiddleware, createToolRegistry, createInMemoryAgentMemoryStore, createInMemoryAgentRunStore, createUIMessageJsonResponse, createUIMessageLinesResponse, parseUIMessageRequest, serializeUIMessage, toSSEStream, toSSEResponse, toTextReadableStream, toTextStreamResponse, toToolSet, toUIAgentStreamResponse, toUIMessage, toUIMessageStream, toUIMessageStreamResponse, toUIMessages, wrapLanguageModel, ToolRegistry, OTelObserver, OTelSpanHandle, tool, transcribeAudio, getAgentApprovalRequestFromPart, resumeAgent, runAgent, runAgentHandoff, getAgentApprovalRequests, getAgentCapabilities, getAgentSupportTier, getHostedToolClass, user } from "@zhivex-ai/core";
|
|
2
|
+
export type { AgentCapabilities, AgentSupportTier, AgentApprovalRequest, AgentApprovalResponse, AgentDefinition, AgentGuardrailTrigger, AgentHandoff, AgentInputGuardrail, AgentInputGuardrailRequest, AgentLiveEvent, AgentLiveStreamResult, AgentMemoryContext, AgentMemoryStore, AgentOutputGuardrail, AgentOutputGuardrailRequest, AgentRunInput, AgentRunOutput, AgentRunStore, AgentRunState, AgentStatus, AgentStreamEvent, AgentStep, AgentStepRequest, AgentStepResponse, AgentStepStatus, AgentStreamResult, AgentTelemetryEvent, AgentTelemetryObserver, AnyToolDefinition, AudioInput, CatalogProviderId, CallableProviderAdapter, CircuitBreakerState, ContentPart, EmbedOutput, FinishReason, GenerateGroundedTextOptions, GenerateGroundedTextOutput, GenerateSpeechOptions, GenerateObjectOptions, GenerateObjectOutput, GenerateTextOptions, GenerateTextOutput, GroundedGenerateResult, GroundedLanguageModel, GroundingSource, LanguageModel, LanguageModelMiddleware, LanguageModelStreamMiddlewareContext, LanguageModelStreamMiddlewareNext, LanguageModelTelemetryEvent, McpCallToolRequest, McpCallToolResponse, McpClient, McpListedTool, McpListToolsResponse, McpToolAnnotations, McpToolSetOptions, ModelCatalog, ModelCatalogEntry, ModelMessage, ObjectStreamEvent, OTelSpanLike, OTelTracerLike, ProviderAdapter, PostgresAgentMemoryStoreOptions, PostgresAgentRunStoreOptions, PostgresClientLike, ProviderDataPart, ProviderOptions, ProviderOptionsOf, RealtimeAudioOutputEvent, RealtimeConnectOptions, RealtimeErrorEvent, RealtimeEvent, RealtimeGoAwayEvent, RealtimeModel, RealtimeResponseCompleteEvent, RealtimeSession, RealtimeSessionConfig, RealtimeSessionEndedEvent, RealtimeSessionResumptionEvent, RealtimeSessionStartedEvent, RealtimeTextDeltaEvent, RealtimeTokenResult, RealtimeToolCallEvent, RealtimeToolResultEvent, RealtimeTranscriptEvent, ReasoningConfig, SqliteAgentMemoryStoreOptions, SqliteAgentRunStoreOptions, SqliteDatabaseLike, SqliteStatementLike, StreamEvent, StreamObjectResult, StreamTextResult, SpeechModel, SpeechOutput, TelemetryStreamErrorEvent, TelemetryStreamFinishEvent, TelemetryStreamStartEvent, TelemetryToolExecutionErrorEvent, TelemetryToolExecutionFinishEvent, TelemetryToolExecutionStartEvent, ToolExecutionOptions, ToolApprovalDecision, ToolApprovalEvent, ToolApprovalObserver, ToolApprovalPolicy, ToolDefinition, ToolExecutionResult, ToolCollection, ToolRegistryLike, LiveAgentDefinition, LiveAgentRunInput, LiveAgentRunOutput, HostedToolDefinition, HostedToolClass, ToolSet, TranscribeAudioOptions, TranscriptionModel, TranscriptionOutput, UIMessage, UIMessageChunk } from "@zhivex-ai/core";
|
|
6
3
|
//# sourceMappingURL=index.d.ts.map
|
package/dist/index.d.ts.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,yBAAyB,EACzB,uBAAuB,EACvB,WAAW,EACX,kBAAkB,EAClB,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,6BAA6B,EAC7B,8BAA8B,EAC9B,2BAA2B,EAC3B,kBAAkB,EAClB,4BAA4B,EAC5B,yBAAyB,EACzB,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,WAAW,EACX,eAAe,EACf,UAAU,EACV,MAAM,EACN,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,8BAA8B,EAC9B,8BAA8B,EAC9B,2BAA2B,EAC3B,yBAAyB,EACzB,kBAAkB,EAClB,8BAA8B,EAC9B,2BAA2B,EAC3B,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,kBAAkB,EAClB,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,oBAAoB,EACpB,SAAS,EACT,uBAAuB,EACvB,WAAW,EACX,iBAAiB,EACjB,yBAAyB,EACzB,YAAY,EACZ,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,IAAI,EACJ,eAAe,EACf,+BAA+B,EAC/B,WAAW,EACX,QAAQ,EACR,eAAe,EACf,wBAAwB,EACxB,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,IAAI,EACL,MAAM,iBAAiB,CAAC;AACzB,YAAY,EACV,iBAAiB,EACjB,gBAAgB,EAChB,oBAAoB,EACpB,qBAAqB,EACrB,eAAe,EACf,qBAAqB,EACrB,YAAY,EACZ,mBAAmB,EACnB,0BAA0B,EAC1B,cAAc,EACd,qBAAqB,EACrB,kBAAkB,EAClB,gBAAgB,EAChB,oBAAoB,EACpB,2BAA2B,EAC3B,aAAa,EACb,cAAc,EACd,aAAa,EACb,aAAa,EACb,WAAW,EACX,gBAAgB,EAChB,SAAS,EACT,gBAAgB,EAChB,iBAAiB,EACjB,eAAe,EACf,iBAAiB,EACjB,mBAAmB,EACnB,sBAAsB,EACtB,iBAAiB,EACjB,UAAU,EACV,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,WAAW,EACX,WAAW,EACX,YAAY,EACZ,2BAA2B,EAC3B,0BAA0B,EAC1B,qBAAqB,EACrB,qBAAqB,EACrB,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,sBAAsB,EACtB,qBAAqB,EACrB,eAAe,EACf,aAAa,EACb,uBAAuB,EACvB,oCAAoC,EACpC,iCAAiC,EACjC,2BAA2B,EAC3B,kBAAkB,EAClB,mBAAmB,EACnB,SAAS,EACT,aAAa,EACb,oBAAoB,EACpB,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,iBAAiB,EACjB,YAAY,EACZ,iBAAiB,EACjB,YAAY,EACZ,cAAc,EACd,eAAe,EACf,+BAA+B,EAC/B,4BAA4B,EAC5B,kBAAkB,EAClB,gBAAgB,EAChB,eAAe,EACf,iBAAiB,EACjB,wBAAwB,EACxB,sBAAsB,EACtB,kBAAkB,EAClB,aAAa,EACb,mBAAmB,EACnB,aAAa,EACb,6BAA6B,EAC7B,eAAe,EACf,qBAAqB,EACrB,yBAAyB,EACzB,8BAA8B,EAC9B,2BAA2B,EAC3B,sBAAsB,EACtB,mBAAmB,EACnB,qBAAqB,EACrB,uBAAuB,EACvB,uBAAuB,EACvB,eAAe,EACf,6BAA6B,EAC7B,0BAA0B,EAC1B,kBAAkB,EAClB,mBAAmB,EACnB,WAAW,EACX,kBAAkB,EAClB,gBAAgB,EAChB,WAAW,EACX,YAAY,EACZ,yBAAyB,EACzB,0BAA0B,EAC1B,yBAAyB,EACzB,gCAAgC,EAChC,iCAAiC,EACjC,gCAAgC,EAChC,oBAAoB,EACpB,oBAAoB,EACpB,iBAAiB,EACjB,oBAAoB,EACpB,kBAAkB,EAClB,cAAc,EACd,mBAAmB,EACnB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,oBAAoB,EACpB,eAAe,EACf,OAAO,EACP,sBAAsB,EACtB,kBAAkB,EAClB,mBAAmB,EACnB,SAAS,EACT,cAAc,EACf,MAAM,iBAAiB,CAAC"}
|
package/dist/index.js
CHANGED
|
@@ -1,3 +1,2 @@
|
|
|
1
|
-
export { createAgent,
|
|
2
|
-
export { assistant, createFileGenerateCache, createModelCatalog, createTextMessage, embed, embedMany, generateGroundedText, generateSpeech, generateObject, generateText, streamObject, streamText, system, textPart, deserializeUIMessage, defaultModelCatalog, fromUIMessage, fromUIMessages, createCachedGenerateMiddleware, createCircuitBreakerMiddleware, createInMemoryGenerateCache, createTelemetryMiddleware, createUIMessageJsonResponse, createUIMessageLinesResponse, parseUIMessageRequest, serializeUIMessage, toSSEStream, toSSEResponse, toTextReadableStream, toTextStreamResponse, toUIMessage, toUIMessageStream, toUIMessageStreamResponse, toUIMessages, wrapLanguageModel, tool, transcribeAudio, user } from "@zhivex-ai/core";
|
|
1
|
+
export { assistant, agentApprovalResponsePart, createFileGenerateCache, createAgent, createAgentHandoff, createAgentApprovalMessage, createFileAgentMemoryStore, createFileAgentRunStore, createMcpToolRegistry, createMcpToolSet, createOtelAgentObserver, createOtelObserver, createOtelTelemetryMiddleware, createPostgresAgentMemoryStore, createPostgresAgentRunStore, createModelCatalog, createSqliteAgentMemoryStore, createSqliteAgentRunStore, createTextMessage, embed, embedMany, generateGroundedText, generateSpeech, generateObject, generateText, hostedTool, streamObject, streamAgent, streamLiveAgent, streamText, system, textPart, deserializeUIMessage, defaultModelCatalog, fromUIMessage, fromUIMessages, createCachedGenerateMiddleware, createCircuitBreakerMiddleware, createInMemoryGenerateCache, createTelemetryMiddleware, createToolRegistry, createInMemoryAgentMemoryStore, createInMemoryAgentRunStore, createUIMessageJsonResponse, createUIMessageLinesResponse, parseUIMessageRequest, serializeUIMessage, toSSEStream, toSSEResponse, toTextReadableStream, toTextStreamResponse, toToolSet, toUIAgentStreamResponse, toUIMessage, toUIMessageStream, toUIMessageStreamResponse, toUIMessages, wrapLanguageModel, ToolRegistry, OTelObserver, OTelSpanHandle, tool, transcribeAudio, getAgentApprovalRequestFromPart, resumeAgent, runAgent, runAgentHandoff, getAgentApprovalRequests, getAgentCapabilities, getAgentSupportTier, getHostedToolClass, user } from "@zhivex-ai/core";
|
|
3
2
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,
|
|
1
|
+
{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EACL,SAAS,EACT,yBAAyB,EACzB,uBAAuB,EACvB,WAAW,EACX,kBAAkB,EAClB,0BAA0B,EAC1B,0BAA0B,EAC1B,uBAAuB,EACvB,qBAAqB,EACrB,gBAAgB,EAChB,uBAAuB,EACvB,kBAAkB,EAClB,6BAA6B,EAC7B,8BAA8B,EAC9B,2BAA2B,EAC3B,kBAAkB,EAClB,4BAA4B,EAC5B,yBAAyB,EACzB,iBAAiB,EACjB,KAAK,EACL,SAAS,EACT,oBAAoB,EACpB,cAAc,EACd,cAAc,EACd,YAAY,EACZ,UAAU,EACV,YAAY,EACZ,WAAW,EACX,eAAe,EACf,UAAU,EACV,MAAM,EACN,QAAQ,EACR,oBAAoB,EACpB,mBAAmB,EACnB,aAAa,EACb,cAAc,EACd,8BAA8B,EAC9B,8BAA8B,EAC9B,2BAA2B,EAC3B,yBAAyB,EACzB,kBAAkB,EAClB,8BAA8B,EAC9B,2BAA2B,EAC3B,2BAA2B,EAC3B,4BAA4B,EAC5B,qBAAqB,EACrB,kBAAkB,EAClB,WAAW,EACX,aAAa,EACb,oBAAoB,EACpB,oBAAoB,EACpB,SAAS,EACT,uBAAuB,EACvB,WAAW,EACX,iBAAiB,EACjB,yBAAyB,EACzB,YAAY,EACZ,iBAAiB,EACjB,YAAY,EACZ,YAAY,EACZ,cAAc,EACd,IAAI,EACJ,eAAe,EACf,+BAA+B,EAC/B,WAAW,EACX,QAAQ,EACR,eAAe,EACf,wBAAwB,EACxB,oBAAoB,EACpB,mBAAmB,EACnB,kBAAkB,EAClB,IAAI,EACL,MAAM,iBAAiB,CAAC"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@zhivex-ai/sdk",
|
|
3
|
-
"version": "0.4.0
|
|
3
|
+
"version": "0.4.0",
|
|
4
4
|
"description": "Unified high-level SDK for multi-provider AI workflows.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -41,7 +41,6 @@
|
|
|
41
41
|
"access": "public"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@zhivex-ai/
|
|
45
|
-
"@zhivex-ai/core": "^0.5.0-next.0"
|
|
44
|
+
"@zhivex-ai/core": "^0.5.0"
|
|
46
45
|
}
|
|
47
46
|
}
|