@meetkai/mka1 0.55.23 → 0.55.24

package/src/models/components/shelltoolrequest.ts

@@ -0,0 +1,219 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  MemoryStoreMount,
+  MemoryStoreMount$inboundSchema,
+  MemoryStoreMount$Outbound,
+  MemoryStoreMount$outboundSchema,
+} from "./memorystoremount.js";
+import {
+  ShellEnvironmentContainerAuto,
+  ShellEnvironmentContainerAuto$inboundSchema,
+  ShellEnvironmentContainerAuto$Outbound,
+  ShellEnvironmentContainerAuto$outboundSchema,
+} from "./shellenvironmentcontainerauto.js";
+import {
+  ShellNetworkPolicy,
+  ShellNetworkPolicy$inboundSchema,
+  ShellNetworkPolicy$Outbound,
+  ShellNetworkPolicy$outboundSchema,
+} from "./shellnetworkpolicy.js";
+import {
+  SkillEntry,
+  SkillEntry$inboundSchema,
+  SkillEntry$Outbound,
+  SkillEntry$outboundSchema,
+} from "./skillentry.js";
+
+export type Environment2 = {
+  type: "container_reference";
+  /**
+   * ID of an existing container to reuse.
+   */
+  containerId: string;
+  networkPolicy?: ShellNetworkPolicy | undefined;
+  /**
+   * Skills to inject into the container's /skills directory.
+   */
+  skills?: Array<SkillEntry> | undefined;
+  /**
+   * Memory stores to mount into the container under /mnt/memory.
+   */
+  memoryStores?: Array<MemoryStoreMount> | undefined;
+  /**
+   * Must be omitted when referencing an existing container.
+   */
+  sessionScope?: any | undefined;
+};
+
+/**
+ * Container environment configuration. Defaults to container_auto.
+ */
+export type Environment = ShellEnvironmentContainerAuto | Environment2;
+
+export type ShellToolRequest = {
+  type: "shell";
+  /**
+   * Container environment configuration. Defaults to container_auto.
+   */
+  environment?: ShellEnvironmentContainerAuto | Environment2 | undefined;
+};
+
+/** @internal */
+export const Environment2$inboundSchema: z.ZodType<
+  Environment2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("container_reference"),
+  container_id: z.string(),
+  network_policy: ShellNetworkPolicy$inboundSchema.optional(),
+  skills: z.array(SkillEntry$inboundSchema).optional(),
+  memory_stores: z.array(MemoryStoreMount$inboundSchema).optional(),
+  session_scope: z.any().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "container_id": "containerId",
+    "network_policy": "networkPolicy",
+    "memory_stores": "memoryStores",
+    "session_scope": "sessionScope",
+  });
+});
+/** @internal */
+export type Environment2$Outbound = {
+  type: "container_reference";
+  container_id: string;
+  network_policy?: ShellNetworkPolicy$Outbound | undefined;
+  skills?: Array<SkillEntry$Outbound> | undefined;
+  memory_stores?: Array<MemoryStoreMount$Outbound> | undefined;
+  session_scope?: any | undefined;
+};
+
+/** @internal */
+export const Environment2$outboundSchema: z.ZodType<
+  Environment2$Outbound,
+  z.ZodTypeDef,
+  Environment2
+> = z.object({
+  type: z.literal("container_reference"),
+  containerId: z.string(),
+  networkPolicy: ShellNetworkPolicy$outboundSchema.optional(),
+  skills: z.array(SkillEntry$outboundSchema).optional(),
+  memoryStores: z.array(MemoryStoreMount$outboundSchema).optional(),
+  sessionScope: z.any().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    containerId: "container_id",
+    networkPolicy: "network_policy",
+    memoryStores: "memory_stores",
+    sessionScope: "session_scope",
+  });
+});
+
+export function environment2ToJSON(environment2: Environment2): string {
+  return JSON.stringify(Environment2$outboundSchema.parse(environment2));
+}
+export function environment2FromJSON(
+  jsonString: string,
+): SafeParseResult<Environment2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Environment2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Environment2' from JSON`,
+  );
+}
+
+/** @internal */
+export const Environment$inboundSchema: z.ZodType<
+  Environment,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  ShellEnvironmentContainerAuto$inboundSchema,
+  z.lazy(() => Environment2$inboundSchema),
+]);
+/** @internal */
+export type Environment$Outbound =
+  | ShellEnvironmentContainerAuto$Outbound
+  | Environment2$Outbound;
+
+/** @internal */
+export const Environment$outboundSchema: z.ZodType<
+  Environment$Outbound,
+  z.ZodTypeDef,
+  Environment
+> = z.union([
+  ShellEnvironmentContainerAuto$outboundSchema,
+  z.lazy(() => Environment2$outboundSchema),
+]);
+
+export function environmentToJSON(environment: Environment): string {
+  return JSON.stringify(Environment$outboundSchema.parse(environment));
+}
+export function environmentFromJSON(
+  jsonString: string,
+): SafeParseResult<Environment, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Environment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Environment' from JSON`,
+  );
+}
+
+/** @internal */
+export const ShellToolRequest$inboundSchema: z.ZodType<
+  ShellToolRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  type: z.literal("shell"),
+  environment: z.union([
+    ShellEnvironmentContainerAuto$inboundSchema,
+    z.lazy(() => Environment2$inboundSchema),
+  ]).optional(),
+});
+/** @internal */
+export type ShellToolRequest$Outbound = {
+  type: "shell";
+  environment?:
+    | ShellEnvironmentContainerAuto$Outbound
+    | Environment2$Outbound
+    | undefined;
+};
+
+/** @internal */
+export const ShellToolRequest$outboundSchema: z.ZodType<
+  ShellToolRequest$Outbound,
+  z.ZodTypeDef,
+  ShellToolRequest
+> = z.object({
+  type: z.literal("shell"),
+  environment: z.union([
+    ShellEnvironmentContainerAuto$outboundSchema,
+    z.lazy(() => Environment2$outboundSchema),
+  ]).optional(),
+});
+
+export function shellToolRequestToJSON(
+  shellToolRequest: ShellToolRequest,
+): string {
+  return JSON.stringify(
+    ShellToolRequest$outboundSchema.parse(shellToolRequest),
+  );
+}
+export function shellToolRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<ShellToolRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ShellToolRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ShellToolRequest' from JSON`,
+  );
+}

package/src/models/components/tooldefinition.ts

@@ -10,6 +10,11 @@ import { discriminatedUnion } from "../../types/discriminatedUnion.js";
 import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  AgentsSandboxSessionScope,
+  AgentsSandboxSessionScope$inboundSchema,
+  AgentsSandboxSessionScope$outboundSchema,
+} from "./agentssandboxsessionscope.js";
 import {
   FileSearchComparisonFilter,
   FileSearchComparisonFilter$inboundSchema,
@@ -34,11 +39,6 @@ import {
   MCPToolFilter$Outbound,
   MCPToolFilter$outboundSchema,
 } from "./mcptoolfilter.js";
-import {
-  SandboxSessionScope,
-  SandboxSessionScope$inboundSchema,
-  SandboxSessionScope$outboundSchema,
-} from "./sandboxsessionscope.js";
 
 export const ToolDefinition10Type = {
   Shell: "shell",
@@ -61,7 +61,7 @@ export type EnvironmentMemoryStores = {
   instructions?: string | undefined;
 };
 
-export type Environment2 = {
+export type ToolDefinitionEnvironment2 = {
   type: "container_reference";
   containerId: string;
   /**
@@ -91,7 +91,7 @@ export type Environment1 = {
   /**
    * Workspace lifetime. conversation (default) keeps files within the same conversation or response chain. Delegated agents inherit their parent's workspace without its conversation history. request starts a fresh workspace for this response and its default-scoped delegated agents. Explicit child request scope or container IDs override inheritance. Independent top-level responses start fresh.
    */
-  sessionScope?: SandboxSessionScope | undefined;
+  sessionScope?: AgentsSandboxSessionScope | undefined;
   /**
    * Arbitrary JSON value.
    */
@@ -100,16 +100,16 @@ export type Environment1 = {
   memoryStores?: Array<MemoryStores> | undefined;
 };
 
-export type Environment =
+export type ToolDefinitionEnvironment =
   | Environment1
-  | Environment2
+  | ToolDefinitionEnvironment2
   | discriminatedUnionTypes.Unknown<"type">;
 
 export type Ten = {
   type: ToolDefinition10Type;
   environment?:
     | Environment1
-    | Environment2
+    | ToolDefinitionEnvironment2
     | discriminatedUnionTypes.Unknown<"type">
     | undefined;
 };
@@ -162,7 +162,7 @@ export type ToolDefinitionContainer2 = {
   /**
    * Workspace lifetime. conversation (default) keeps files within the same conversation or response chain. Delegated agents inherit their parent's workspace without its conversation history. request starts a fresh workspace for this response and its default-scoped delegated agents. Explicit child request scope or container IDs override inheritance. Independent top-level responses start fresh.
    */
-  sessionScope?: SandboxSessionScope | undefined;
+  sessionScope?: AgentsSandboxSessionScope | undefined;
   fileIds?: Array<string> | null | undefined;
   memoryLimit?: ToolDefinitionContainerMemoryLimit | null | undefined;
 };
@@ -446,8 +446,8 @@ export function environmentMemoryStoresFromJSON(
 }
 
 /** @internal */
-export const Environment2$inboundSchema: z.ZodType<
-  Environment2,
+export const ToolDefinitionEnvironment2$inboundSchema: z.ZodType<
+  ToolDefinitionEnvironment2,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -465,7 +465,7 @@ export const Environment2$inboundSchema: z.ZodType<
   });
 });
 /** @internal */
-export type Environment2$Outbound = {
+export type ToolDefinitionEnvironment2$Outbound = {
   type: "container_reference";
   container_id: string;
   network_policy?: any | undefined;
@@ -474,10 +474,10 @@ export type Environment2$Outbound = {
 };
 
 /** @internal */
-export const Environment2$outboundSchema: z.ZodType<
-  Environment2$Outbound,
+export const ToolDefinitionEnvironment2$outboundSchema: z.ZodType<
+  ToolDefinitionEnvironment2$Outbound,
   z.ZodTypeDef,
-  Environment2
+  ToolDefinitionEnvironment2
 > = z.object({
   type: z.literal("container_reference"),
   containerId: z.string(),
@@ -493,16 +493,20 @@ export const Environment2$outboundSchema: z.ZodType<
   });
 });
 
-export function environment2ToJSON(environment2: Environment2): string {
-  return JSON.stringify(Environment2$outboundSchema.parse(environment2));
+export function toolDefinitionEnvironment2ToJSON(
+  toolDefinitionEnvironment2: ToolDefinitionEnvironment2,
+): string {
+  return JSON.stringify(
+    ToolDefinitionEnvironment2$outboundSchema.parse(toolDefinitionEnvironment2),
+  );
 }
-export function environment2FromJSON(
+export function toolDefinitionEnvironment2FromJSON(
   jsonString: string,
-): SafeParseResult<Environment2, SDKValidationError> {
+): SafeParseResult<ToolDefinitionEnvironment2, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Environment2$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Environment2' from JSON`,
+    (x) => ToolDefinitionEnvironment2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolDefinitionEnvironment2' from JSON`,
   );
 }
 
@@ -577,7 +581,7 @@ export const Environment1$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   type: z.literal("container_auto"),
-  session_scope: SandboxSessionScope$inboundSchema.optional(),
+  session_scope: AgentsSandboxSessionScope$inboundSchema.optional(),
   network_policy: z.any().optional(),
   skills: z.array(z.any()).optional(),
   memory_stores: z.array(z.lazy(() => MemoryStores$inboundSchema)).optional(),
@@ -604,7 +608,7 @@ export const Environment1$outboundSchema: z.ZodType<
   Environment1
 > = z.object({
   type: z.literal("container_auto"),
-  sessionScope: SandboxSessionScope$outboundSchema.optional(),
+  sessionScope: AgentsSandboxSessionScope$outboundSchema.optional(),
   networkPolicy: z.any().optional(),
   skills: z.array(z.any()).optional(),
   memoryStores: z.array(z.lazy(() => MemoryStores$outboundSchema)).optional(),
@@ -630,39 +634,43 @@ export function environment1FromJSON(
 }
 
 /** @internal */
-export const Environment$inboundSchema: z.ZodType<
-  Environment,
+export const ToolDefinitionEnvironment$inboundSchema: z.ZodType<
+  ToolDefinitionEnvironment,
   z.ZodTypeDef,
   unknown
 > = discriminatedUnion("type", {
   container_auto: z.lazy(() => Environment1$inboundSchema),
-  container_reference: z.lazy(() => Environment2$inboundSchema),
+  container_reference: z.lazy(() => ToolDefinitionEnvironment2$inboundSchema),
 });
 /** @internal */
-export type Environment$Outbound =
+export type ToolDefinitionEnvironment$Outbound =
   | Environment1$Outbound
-  | Environment2$Outbound;
+  | ToolDefinitionEnvironment2$Outbound;
 
 /** @internal */
-export const Environment$outboundSchema: z.ZodType<
-  Environment$Outbound,
+export const ToolDefinitionEnvironment$outboundSchema: z.ZodType<
+  ToolDefinitionEnvironment$Outbound,
   z.ZodTypeDef,
-  Environment
+  ToolDefinitionEnvironment
 > = z.union([
   z.lazy(() => Environment1$outboundSchema),
-  z.lazy(() => Environment2$outboundSchema),
+  z.lazy(() => ToolDefinitionEnvironment2$outboundSchema),
 ]);
 
-export function environmentToJSON(environment: Environment): string {
-  return JSON.stringify(Environment$outboundSchema.parse(environment));
+export function toolDefinitionEnvironmentToJSON(
+  toolDefinitionEnvironment: ToolDefinitionEnvironment,
+): string {
+  return JSON.stringify(
+    ToolDefinitionEnvironment$outboundSchema.parse(toolDefinitionEnvironment),
+  );
 }
-export function environmentFromJSON(
+export function toolDefinitionEnvironmentFromJSON(
   jsonString: string,
-): SafeParseResult<Environment, SDKValidationError> {
+): SafeParseResult<ToolDefinitionEnvironment, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Environment$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Environment' from JSON`,
+    (x) => ToolDefinitionEnvironment$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ToolDefinitionEnvironment' from JSON`,
   );
 }
 
@@ -672,13 +680,18 @@ export const Ten$inboundSchema: z.ZodType<Ten, z.ZodTypeDef, unknown> = z
     type: ToolDefinition10Type$inboundSchema,
     environment: discriminatedUnion("type", {
       container_auto: z.lazy(() => Environment1$inboundSchema),
-      container_reference: z.lazy(() => Environment2$inboundSchema),
+      container_reference: z.lazy(() =>
+        ToolDefinitionEnvironment2$inboundSchema
+      ),
     }).optional(),
   });
 /** @internal */
 export type Ten$Outbound = {
   type: string;
-  environment?: Environment1$Outbound | Environment2$Outbound | undefined;
+  environment?:
+    | Environment1$Outbound
+    | ToolDefinitionEnvironment2$Outbound
+    | undefined;
 };
 
 /** @internal */
@@ -687,7 +700,7 @@ export const Ten$outboundSchema: z.ZodType<Ten$Outbound, z.ZodTypeDef, Ten> = z
     type: ToolDefinition10Type$outboundSchema,
     environment: z.union([
       z.lazy(() => Environment1$outboundSchema),
-      z.lazy(() => Environment2$outboundSchema),
+      z.lazy(() => ToolDefinitionEnvironment2$outboundSchema),
     ]).optional(),
   });
 
@@ -834,7 +847,7 @@ export const ToolDefinitionContainer2$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   type: ContainerType$inboundSchema,
-  session_scope: SandboxSessionScope$inboundSchema.optional(),
+  session_scope: AgentsSandboxSessionScope$inboundSchema.optional(),
   file_ids: z.nullable(z.array(z.string())).optional(),
   memory_limit: z.nullable(ToolDefinitionContainerMemoryLimit$inboundSchema)
     .optional(),
@@ -860,7 +873,7 @@ export const ToolDefinitionContainer2$outboundSchema: z.ZodType<
   ToolDefinitionContainer2
 > = z.object({
   type: ContainerType$outboundSchema,
-  sessionScope: SandboxSessionScope$outboundSchema.optional(),
+  sessionScope: AgentsSandboxSessionScope$outboundSchema.optional(),
   fileIds: z.nullable(z.array(z.string())).optional(),
   memoryLimit: z.nullable(ToolDefinitionContainerMemoryLimit$outboundSchema)
     .optional(),

package/src/react-query/llmModelsCheckCatalogHealth.ts

@@ -49,7 +49,7 @@ export type LlmModelsCheckCatalogHealthMutationError =
  * Check a BYO catalog model's health
  *
  * @remarks
- * Probes an available BYO definition whether or not it is active.
+ * Probes an available BYO definition whether or not it is active. A definition without a health check has nothing to probe and reports `status: unknown`.
  */
 export function useLlmModelsCheckCatalogHealthMutation(
   options?: MutationHookOptions<

package/src/sdk/models.ts

@@ -192,7 +192,7 @@ export class Models extends ClientSDK {
    * Check a BYO catalog model's health
    *
    * @remarks
-   * Probes an available BYO definition whether or not it is active.
+   * Probes an available BYO definition whether or not it is active. A definition without a health check has nothing to probe and reports `status: unknown`.
    */
   async checkCatalogHealth(
     request: operations.CheckModelCatalogHealthRequest,