@meetkai/mka1 0.54.27 → 0.54.29

package/src/models/components/classifierconfig.ts

@@ -0,0 +1,110 @@
+/*
+ * 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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Stop the request or skip this classifier when evaluation fails
+ */
+export const OnError = {
+  FailClosed: "fail_closed",
+  FailOpen: "fail_open",
+} as const;
+/**
+ * Stop the request or skip this classifier when evaluation fails
+ */
+export type OnError = ClosedEnum<typeof OnError>;
+
+export type ClassifierConfig = {
+  /**
+   * Exact model ID available in the caller's organization registry
+   */
+  model: string;
+  /**
+   * Instructions defining when to block or allow content; content is supplied separately
+   */
+  prompt: string;
+  /**
+   * Stop the request or skip this classifier when evaluation fails
+   */
+  onError?: OnError | undefined;
+  /**
+   * Message returned when classification blocks content
+   */
+  rejectionMessage?: string | undefined;
+};
+
+/** @internal */
+export const OnError$inboundSchema: z.ZodNativeEnum<typeof OnError> = z
+  .nativeEnum(OnError);
+/** @internal */
+export const OnError$outboundSchema: z.ZodNativeEnum<typeof OnError> =
+  OnError$inboundSchema;
+
+/** @internal */
+export const ClassifierConfig$inboundSchema: z.ZodType<
+  ClassifierConfig,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.string(),
+  prompt: z.string(),
+  on_error: OnError$inboundSchema.default("fail_closed"),
+  rejection_message: z.string().default(
+    "This request is not allowed by your organization's content policy.",
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    "on_error": "onError",
+    "rejection_message": "rejectionMessage",
+  });
+});
+/** @internal */
+export type ClassifierConfig$Outbound = {
+  model: string;
+  prompt: string;
+  on_error: string;
+  rejection_message: string;
+};
+
+/** @internal */
+export const ClassifierConfig$outboundSchema: z.ZodType<
+  ClassifierConfig$Outbound,
+  z.ZodTypeDef,
+  ClassifierConfig
+> = z.object({
+  model: z.string(),
+  prompt: z.string(),
+  onError: OnError$outboundSchema.default("fail_closed"),
+  rejectionMessage: z.string().default(
+    "This request is not allowed by your organization's content policy.",
+  ),
+}).transform((v) => {
+  return remap$(v, {
+    onError: "on_error",
+    rejectionMessage: "rejection_message",
+  });
+});
+
+export function classifierConfigToJSON(
+  classifierConfig: ClassifierConfig,
+): string {
+  return JSON.stringify(
+    ClassifierConfig$outboundSchema.parse(classifierConfig),
+  );
+}
+export function classifierConfigFromJSON(
+  jsonString: string,
+): SafeParseResult<ClassifierConfig, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ClassifierConfig$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ClassifierConfig' from JSON`,
+  );
+}

package/src/models/components/classifierguardrail.ts

@@ -0,0 +1,84 @@
+/*
+ * 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 {
+  ClassifierConfig,
+  ClassifierConfig$inboundSchema,
+  ClassifierConfig$Outbound,
+  ClassifierConfig$outboundSchema,
+} from "./classifierconfig.js";
+
+export type ClassifierGuardrail = {
+  mode: "classifier";
+  /**
+   * Whether this guardrail is enabled
+   */
+  enabled?: boolean | undefined;
+  /**
+   * Also apply this guardrail to model output, not just the request
+   */
+  checkOutput?: boolean | undefined;
+  config: ClassifierConfig;
+};
+
+/** @internal */
+export const ClassifierGuardrail$inboundSchema: z.ZodType<
+  ClassifierGuardrail,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  mode: z.literal("classifier"),
+  enabled: z.boolean().default(true),
+  check_output: z.boolean().optional(),
+  config: ClassifierConfig$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "check_output": "checkOutput",
+  });
+});
+/** @internal */
+export type ClassifierGuardrail$Outbound = {
+  mode: "classifier";
+  enabled: boolean;
+  check_output?: boolean | undefined;
+  config: ClassifierConfig$Outbound;
+};
+
+/** @internal */
+export const ClassifierGuardrail$outboundSchema: z.ZodType<
+  ClassifierGuardrail$Outbound,
+  z.ZodTypeDef,
+  ClassifierGuardrail
+> = z.object({
+  mode: z.literal("classifier"),
+  enabled: z.boolean().default(true),
+  checkOutput: z.boolean().optional(),
+  config: ClassifierConfig$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    checkOutput: "check_output",
+  });
+});
+
+export function classifierGuardrailToJSON(
+  classifierGuardrail: ClassifierGuardrail,
+): string {
+  return JSON.stringify(
+    ClassifierGuardrail$outboundSchema.parse(classifierGuardrail),
+  );
+}
+export function classifierGuardrailFromJSON(
+  jsonString: string,
+): SafeParseResult<ClassifierGuardrail, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ClassifierGuardrail$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ClassifierGuardrail' from JSON`,
+  );
+}

package/src/models/components/getexportstatusresponse.ts

@@ -13,6 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Current status of the export job
  */
 export const GetExportStatusResponseStatus = {
+  Unknown: "UNKNOWN",
   NotFound: "NOT_FOUND",
   Running: "RUNNING",
   Completed: "COMPLETED",

package/src/models/components/guardrailconfig.ts

@@ -14,6 +14,12 @@ import {
   BanWordsGuardrail$Outbound,
   BanWordsGuardrail$outboundSchema,
 } from "./banwordsguardrail.js";
+import {
+  ClassifierGuardrail,
+  ClassifierGuardrail$inboundSchema,
+  ClassifierGuardrail$Outbound,
+  ClassifierGuardrail$outboundSchema,
+} from "./classifierguardrail.js";
 import {
   LeakageGuardrail,
   LeakageGuardrail$inboundSchema,
@@ -31,6 +37,7 @@ export type GuardrailConfig =
   | BanWordsGuardrail
   | PromptInjectionGuardrail
   | LeakageGuardrail
+  | ClassifierGuardrail
   | discriminatedUnionTypes.Unknown<"mode">;
 
 /** @internal */
@@ -42,12 +49,14 @@ export const GuardrailConfig$inboundSchema: z.ZodType<
   ban_words: BanWordsGuardrail$inboundSchema,
   prompt_injection: PromptInjectionGuardrail$inboundSchema,
   leakage: LeakageGuardrail$inboundSchema,
+  classifier: ClassifierGuardrail$inboundSchema,
 });
 /** @internal */
 export type GuardrailConfig$Outbound =
   | BanWordsGuardrail$Outbound
   | PromptInjectionGuardrail$Outbound
-  | LeakageGuardrail$Outbound;
+  | LeakageGuardrail$Outbound
+  | ClassifierGuardrail$Outbound;
 
 /** @internal */
 export const GuardrailConfig$outboundSchema: z.ZodType<
@@ -58,6 +67,7 @@ export const GuardrailConfig$outboundSchema: z.ZodType<
   BanWordsGuardrail$outboundSchema,
   PromptInjectionGuardrail$outboundSchema,
   LeakageGuardrail$outboundSchema,
+  ClassifierGuardrail$outboundSchema,
 ]);
 
 export function guardrailConfigToJSON(

package/src/models/components/guardrailmode.ts

@@ -9,6 +9,7 @@ export const GuardrailMode = {
   BanWords: "ban_words",
   PromptInjection: "prompt_injection",
   Leakage: "leakage",
+  Classifier: "classifier",
 } as const;
 export type GuardrailMode = ClosedEnum<typeof GuardrailMode>;
 

package/src/models/components/index.ts

@@ -53,6 +53,8 @@ export * from "./checkpointmetrics.js";
 export * from "./chunkingstrategy.js";
 export * from "./classificationrequest.js";
 export * from "./classificationresponse.js";
+export * from "./classifierconfig.js";
+export * from "./classifierguardrail.js";
 export * from "./classifygroupby.js";
 export * from "./clickaction.js";
 export * from "./clustercurrencyresponse.js";

package/src/models/components/startexportfeedbackresponse.ts

@@ -13,6 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  * Current status of the export job
  */
 export const StartExportFeedbackResponseStatus = {
+  Unknown: "UNKNOWN",
   NotFound: "NOT_FOUND",
   Running: "RUNNING",
   Completed: "COMPLETED",

package/src/react-query/guardrailsTestGuardrails.ts

@@ -49,7 +49,7 @@ export type GuardrailsTestGuardrailsMutationError =
  * Test content against guardrails
  *
  * @remarks
- * Test a piece of content against the caller's effective guardrails (org-wide policy plus team policy) without making an actual API call. Useful for debugging and validating guardrail configurations. Returns a report indicating whether the content passed and which guardrail was triggered if any.
+ * Test a piece of content against the caller's effective guardrails (org-wide policy plus team policy) without generating an answer. Classifier guardrails call their configured model and incur inference usage; API keys additionally require write:responses and must pass the spend budget gate. Useful for debugging and validating guardrail configurations. Returns a report indicating whether the content passed and which guardrail was triggered if any.
  */
 export function useGuardrailsTestGuardrailsMutation(
   options?: MutationHookOptions<

package/src/react-query/guardrailsUpdateGuardrails.ts

@@ -49,7 +49,7 @@ export type GuardrailsUpdateGuardrailsMutationError =
  * Update guardrails policy
  *
  * @remarks
- * Replace a guardrails policy. Omit team_id to set the org-wide policy (org admin only); provide team_id to set that team's additional policy (org admins may target any team in their org, other callers only their own team). The org-wide policy applies to every team; a team policy is enforced in addition to it — configuring a team policy never weakens the org-wide one.
+ * Replace a guardrails policy. Classifier models must be active and declare structured-output support; replace the example model ID with a suitable model from your organization. Omit team_id to set the org-wide policy (org admin only); provide team_id to set that team's additional policy (org admins may target any team in their org, other callers only their own team). The org-wide policy applies to every team; a team policy is enforced in addition to it — configuring a team policy never weakens the org-wide one.
  */
 export function useGuardrailsUpdateGuardrailsMutation(
   options?: MutationHookOptions<

package/src/sdk/guardrails.ts

@@ -34,7 +34,7 @@ export class Guardrails extends ClientSDK {
    * Update guardrails policy
    *
    * @remarks
-   * Replace a guardrails policy. Omit team_id to set the org-wide policy (org admin only); provide team_id to set that team's additional policy (org admins may target any team in their org, other callers only their own team). The org-wide policy applies to every team; a team policy is enforced in addition to it — configuring a team policy never weakens the org-wide one.
+   * Replace a guardrails policy. Classifier models must be active and declare structured-output support; replace the example model ID with a suitable model from your organization. Omit team_id to set the org-wide policy (org admin only); provide team_id to set that team's additional policy (org admins may target any team in their org, other callers only their own team). The org-wide policy applies to every team; a team policy is enforced in addition to it — configuring a team policy never weakens the org-wide one.
    */
   async updateGuardrails(
     request: operations.UpdateGuardrailsRequest,
@@ -85,7 +85,7 @@ export class Guardrails extends ClientSDK {
    * Test content against guardrails
    *
    * @remarks
-   * Test a piece of content against the caller's effective guardrails (org-wide policy plus team policy) without making an actual API call. Useful for debugging and validating guardrail configurations. Returns a report indicating whether the content passed and which guardrail was triggered if any.
+   * Test a piece of content against the caller's effective guardrails (org-wide policy plus team policy) without generating an answer. Classifier guardrails call their configured model and incur inference usage; API keys additionally require write:responses and must pass the spend budget gate. Useful for debugging and validating guardrail configurations. Returns a report indicating whether the content passed and which guardrail was triggered if any.
    */
   async testGuardrails(
     request: operations.TestGuardrailsRequest,