codemie-sdk 0.1.80 → 0.1.82

package/README.md

@@ -230,8 +230,84 @@ const params: AssistantChatParams = {
 };
 const response = await client.assistants.chat("assistant-id", params);
 ```
+7. **Utilize structured outputs with Assistant
+Uzing zod objects
+```typescript
+
+const ResponseFormat = z.object({
+  answer: z.string().describe("The answer to the user's question"),
+  followup_question: z
+    .string()
+    .describe("A followup question the user could ask"),
+});
+
+const params: AssistantChatParams  = {
+  text: "Your message here",
+  history: [],  // Previous conversation messages as ChatMessage[] or string
+  // Optional parameters
+  stream: false,  // Set to true for streaming response
+  conversation_id: "optional-conversation-id",
+  llm_model: "gpt-4o",
+  system_prompt: "Override default system prompt",
+  background_task: false,
+  content_raw: "", // Raw content if needed
+  file_name: "", // For file processing
+  top_k: 1,
+  metadata: {}, // Additional metadata
+  output_schema: ResponseFormat
+};
+
+  const response = await client.assistants.chat(
+    "b797be81-5ddb-4649-a445-96bbdde14809",
+    params
+  );
+  // response.generated is object
+
+```
+Using JSON Schema in object format
+```typescript
+const schema = {
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.com/product.schema.json",
+  "title": "ResponseFormatter",
+  "type": "object",
+  "properties": {
+    "answer": {
+      "description": "The answer to the user's question",
+      "type": "string"
+    },
+    "followup_question": {
+      "description": "A followup question the user could ask",
+      "type": "string"
+    }
+  },
+  "required": ["answer", "followup_question"]
+}
+
+const params: AssistantChatParams  = {
+  text: "Your message here",
+  history: [],  // Previous conversation messages as ChatMessage[] or string
+  // Optional parameters
+  stream: false,  // Set to true for streaming response
+  conversation_id: "optional-conversation-id",
+  llm_model: "gpt-4o",
+  system_prompt: "Override default system prompt",
+  background_task: false,
+  content_raw: "", // Raw content if needed
+  file_name: "", // For file processing
+  top_k: 1,
+  metadata: {}, // Additional metadata
+  output_schema: schema
+};
+
+  const response = await client.assistants.chat(
+    "b797be81-5ddb-4649-a445-96bbdde14809",
+    params
+  );
+  // response.generated is object
+```
 
-7. **Work with Prebuilt Assistants**
+8. **Work with Prebuilt Assistants**
 ```typescript
 // List prebuilt assistants
 const prebuilt = await client.assistants.getPrebuilt();
@@ -240,7 +316,7 @@ const prebuilt = await client.assistants.getPrebuilt();
 const prebuiltAssistant = await client.assistants.getPrebuiltBySlug("assistant-slug");
 ```
 
-8. **Get Available Tools**
+9. **Get Available Tools**
 ```typescript
 const tools = await client.assistants.getTools();
 ```

package/dist/index.cjs

@@ -134,6 +134,10 @@ var AssistantMapper = class {
   }
 };
 
+// src/services/assistant.ts
+var import_zod2 = require("zod");
+var import_zod_to_json_schema = require("zod-to-json-schema");
+
 // src/schemas/assistant.ts
 var import_zod = require("zod");
 var AssistantListParamsSchema = import_zod.z.object({
@@ -223,7 +227,11 @@ var AssistantChatParamsSchema = import_zod.z.object({
   top_k: import_zod.z.number().optional(),
   system_prompt: import_zod.z.string().optional(),
   background_task: import_zod.z.boolean().optional(),
-  metadata: import_zod.z.record(import_zod.z.unknown()).optional()
+  metadata: import_zod.z.record(import_zod.z.unknown()).optional(),
+  output_schema: import_zod.z.union([
+    import_zod.z.custom((val) => val instanceof import_zod.z.ZodType),
+    import_zod.z.record(import_zod.z.unknown())
+  ]).optional()
 }).readonly();
 
 // src/utils/http.ts
@@ -400,7 +408,15 @@ var AssistantService = class {
    * Send a chat request to an assistant.
    */
   async chat(assistantId, _params) {
-    const params = AssistantChatParamsSchema.parse(_params);
+    let zodSchema = void 0;
+    let params = { ..._params };
+    if (params.output_schema && params.output_schema instanceof import_zod2.z.ZodType) {
+      zodSchema = params.output_schema;
+      params.output_schema = (0, import_zod_to_json_schema.zodToJsonSchema)(zodSchema, {
+        definitions: {}
+      });
+    }
+    params = AssistantChatParamsSchema.parse(params);
     const response = await this.api.post(
       `/v1/assistants/${assistantId}/model`,
       params,
@@ -408,7 +424,11 @@ var AssistantService = class {
         responseType: params.stream ? "stream" : void 0
       }
     );
-    return AssistantMapper.mapBaseModelApiResponse(response);
+    const mapped = AssistantMapper.mapBaseModelApiResponse(response);
+    if (!params.stream && zodSchema && mapped.generated) {
+      mapped.generated = zodSchema.parse(mapped.generated);
+    }
+    return mapped;
   }
 };
 
@@ -733,35 +753,35 @@ var IntegrationType = {
 };
 
 // src/schemas/integration.ts
-var import_zod2 = require("zod");
-var IntegrationListParamsSchema = import_zod2.z.object({
-  setting_type: import_zod2.z.enum([IntegrationType.USER, IntegrationType.PROJECT]).default(IntegrationType.USER),
-  page: import_zod2.z.number().default(0),
-  per_page: import_zod2.z.number().default(10),
-  filters: import_zod2.z.record(import_zod2.z.unknown()).optional()
+var import_zod3 = require("zod");
+var IntegrationListParamsSchema = import_zod3.z.object({
+  setting_type: import_zod3.z.enum([IntegrationType.USER, IntegrationType.PROJECT]).default(IntegrationType.USER),
+  page: import_zod3.z.number().default(0),
+  per_page: import_zod3.z.number().default(10),
+  filters: import_zod3.z.record(import_zod3.z.unknown()).optional()
 }).readonly();
-var IntegrationGetParamsSchema = import_zod2.z.object({
-  integration_id: import_zod2.z.string(),
-  setting_type: import_zod2.z.enum([IntegrationType.USER, IntegrationType.PROJECT]).default(IntegrationType.USER)
+var IntegrationGetParamsSchema = import_zod3.z.object({
+  integration_id: import_zod3.z.string(),
+  setting_type: import_zod3.z.enum([IntegrationType.USER, IntegrationType.PROJECT]).default(IntegrationType.USER)
 }).readonly();
-var IntegrationGetByAliasParamsSchema = import_zod2.z.object({
-  alias: import_zod2.z.string(),
-  setting_type: import_zod2.z.enum([IntegrationType.USER, IntegrationType.PROJECT]).default(IntegrationType.USER)
+var IntegrationGetByAliasParamsSchema = import_zod3.z.object({
+  alias: import_zod3.z.string(),
+  setting_type: import_zod3.z.enum([IntegrationType.USER, IntegrationType.PROJECT]).default(IntegrationType.USER)
 }).readonly();
-var CredentialValueSchema = import_zod2.z.object({
-  key: import_zod2.z.string(),
-  value: import_zod2.z.unknown()
+var CredentialValueSchema = import_zod3.z.object({
+  key: import_zod3.z.string(),
+  value: import_zod3.z.unknown()
 });
-var IntegrationCreateParamsSchema = import_zod2.z.object({
-  credential_type: import_zod2.z.enum(Object.values(CredentialTypes)),
-  credential_values: import_zod2.z.array(CredentialValueSchema),
-  project_name: import_zod2.z.string(),
-  setting_type: import_zod2.z.enum([IntegrationType.USER, IntegrationType.PROJECT]).default(IntegrationType.USER),
-  alias: import_zod2.z.string().optional(),
-  default: import_zod2.z.boolean().optional().default(false),
-  project: import_zod2.z.string().optional(),
-  enabled: import_zod2.z.boolean().optional().default(true),
-  external_id: import_zod2.z.string().optional()
+var IntegrationCreateParamsSchema = import_zod3.z.object({
+  credential_type: import_zod3.z.enum(Object.values(CredentialTypes)),
+  credential_values: import_zod3.z.array(CredentialValueSchema),
+  project_name: import_zod3.z.string(),
+  setting_type: import_zod3.z.enum([IntegrationType.USER, IntegrationType.PROJECT]).default(IntegrationType.USER),
+  alias: import_zod3.z.string().optional(),
+  default: import_zod3.z.boolean().optional().default(false),
+  project: import_zod3.z.string().optional(),
+  enabled: import_zod3.z.boolean().optional().default(true),
+  external_id: import_zod3.z.string().optional()
 }).readonly();
 var IntegrationUpdateParamsSchema = IntegrationCreateParamsSchema;
 
@@ -960,7 +980,7 @@ var WorkflowMapper = class {
 };
 
 // src/schemas/workflow.ts
-var import_zod3 = require("zod");
+var import_zod4 = require("zod");
 
 // src/models/workflow.ts
 var WorkflowMode = {
@@ -977,39 +997,39 @@ var ExecutionStatus = {
 };
 
 // src/schemas/workflow.ts
-var WorkflowListParamsSchema = import_zod3.z.object({
-  page: import_zod3.z.number().default(0),
-  per_page: import_zod3.z.number().default(10),
-  projects: import_zod3.z.array(import_zod3.z.string()).optional()
+var WorkflowListParamsSchema = import_zod4.z.object({
+  page: import_zod4.z.number().default(0),
+  per_page: import_zod4.z.number().default(10),
+  projects: import_zod4.z.array(import_zod4.z.string()).optional()
 }).readonly();
-var WorkflowCreateParamsSchema = import_zod3.z.object({
-  project: import_zod3.z.string(),
-  name: import_zod3.z.string(),
-  description: import_zod3.z.string().optional(),
-  yaml_config: import_zod3.z.string(),
-  mode: import_zod3.z.enum([WorkflowMode.SEQUENTIAL, WorkflowMode.AUTONOMOUS]),
-  shared: import_zod3.z.boolean(),
-  icon_url: import_zod3.z.string().optional()
+var WorkflowCreateParamsSchema = import_zod4.z.object({
+  project: import_zod4.z.string(),
+  name: import_zod4.z.string(),
+  description: import_zod4.z.string().optional(),
+  yaml_config: import_zod4.z.string(),
+  mode: import_zod4.z.enum([WorkflowMode.SEQUENTIAL, WorkflowMode.AUTONOMOUS]),
+  shared: import_zod4.z.boolean(),
+  icon_url: import_zod4.z.string().optional()
 }).readonly();
-var WorkflowUpdateParamsSchema = import_zod3.z.object({
-  project: import_zod3.z.string(),
-  name: import_zod3.z.string(),
-  description: import_zod3.z.string().optional(),
-  yaml_config: import_zod3.z.string(),
-  mode: import_zod3.z.enum([WorkflowMode.SEQUENTIAL, WorkflowMode.AUTONOMOUS]).optional(),
-  shared: import_zod3.z.boolean().optional(),
-  icon_url: import_zod3.z.string().optional()
+var WorkflowUpdateParamsSchema = import_zod4.z.object({
+  project: import_zod4.z.string(),
+  name: import_zod4.z.string(),
+  description: import_zod4.z.string().optional(),
+  yaml_config: import_zod4.z.string(),
+  mode: import_zod4.z.enum([WorkflowMode.SEQUENTIAL, WorkflowMode.AUTONOMOUS]).optional(),
+  shared: import_zod4.z.boolean().optional(),
+  icon_url: import_zod4.z.string().optional()
 }).readonly();
-var WorkflowExecutionListParamsSchema = import_zod3.z.object({
-  page: import_zod3.z.number().default(0),
-  per_page: import_zod3.z.number().default(10)
+var WorkflowExecutionListParamsSchema = import_zod4.z.object({
+  page: import_zod4.z.number().default(0),
+  per_page: import_zod4.z.number().default(10)
 }).readonly();
-var WorkflowExecutionCreateParamsSchema = import_zod3.z.object({
-  user_input: import_zod3.z.string().default("")
+var WorkflowExecutionCreateParamsSchema = import_zod4.z.object({
+  user_input: import_zod4.z.string().default("")
 }).readonly();
-var WorkflowExecutionStateListParamsSchema = import_zod3.z.object({
-  page: import_zod3.z.number().default(0),
-  per_page: import_zod3.z.number().default(10)
+var WorkflowExecutionStateListParamsSchema = import_zod4.z.object({
+  page: import_zod4.z.number().default(0),
+  per_page: import_zod4.z.number().default(10)
 }).readonly();
 
 // src/services/workflow_execution_state.ts