@mistralai/mistralai 2.0.0-alpha.1 → 2.1.0

package/src/models/components/agentscompletionrequest.ts

@@ -11,6 +11,31 @@ import {
   AssistantMessage$Outbound,
   AssistantMessage$outboundSchema,
 } from "./assistantmessage.js";
+import {
+  CodeInterpreterTool,
+  CodeInterpreterTool$Outbound,
+  CodeInterpreterTool$outboundSchema,
+} from "./codeinterpretertool.js";
+import {
+  CustomConnector,
+  CustomConnector$Outbound,
+  CustomConnector$outboundSchema,
+} from "./customconnector.js";
+import {
+  DocumentLibraryTool,
+  DocumentLibraryTool$Outbound,
+  DocumentLibraryTool$outboundSchema,
+} from "./documentlibrarytool.js";
+import {
+  GuardrailConfig,
+  GuardrailConfig$Outbound,
+  GuardrailConfig$outboundSchema,
+} from "./guardrailconfig.js";
+import {
+  ImageGenerationTool,
+  ImageGenerationTool$Outbound,
+  ImageGenerationTool$outboundSchema,
+} from "./imagegenerationtool.js";
 import {
   MistralPromptMode,
   MistralPromptMode$outboundSchema,
@@ -20,6 +45,10 @@ import {
   Prediction$Outbound,
   Prediction$outboundSchema,
 } from "./prediction.js";
+import {
+  ReasoningEffort,
+  ReasoningEffort$outboundSchema,
+} from "./reasoningeffort.js";
 import {
   ResponseFormat,
   ResponseFormat$Outbound,
@@ -50,6 +79,16 @@ import {
   UserMessage$Outbound,
   UserMessage$outboundSchema,
 } from "./usermessage.js";
+import {
+  WebSearchPremiumTool,
+  WebSearchPremiumTool$Outbound,
+  WebSearchPremiumTool$outboundSchema,
+} from "./websearchpremiumtool.js";
+import {
+  WebSearchTool,
+  WebSearchTool$Outbound,
+  WebSearchTool$outboundSchema,
+} from "./websearchtool.js";
 
 /**
  * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
@@ -62,6 +101,27 @@ export type AgentsCompletionRequestMessage =
   | ToolMessage
   | UserMessage;
 
+export type AgentsCompletionRequestTools1 =
+  | DocumentLibraryTool
+  | CustomConnector
+  | Tool
+  | WebSearchTool
+  | WebSearchPremiumTool
+  | CodeInterpreterTool
+  | ImageGenerationTool;
+
+export type AgentsCompletionRequestTools2 =
+  | Array<
+    | DocumentLibraryTool
+    | CustomConnector
+    | Tool
+    | WebSearchTool
+    | WebSearchPremiumTool
+    | CodeInterpreterTool
+    | ImageGenerationTool
+  >
+  | Array<string>;
+
 export type AgentsCompletionRequestToolChoice = ToolChoice | ToolChoiceEnum;
 
 export type AgentsCompletionRequest = {
@@ -95,7 +155,19 @@ export type AgentsCompletionRequest = {
    * Specify the format that the model must output. By default it will use `{ "type": "text" }`. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to `{ "type": "json_schema" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.
    */
   responseFormat?: ResponseFormat | undefined;
-  tools?: Array<Tool> | null | undefined;
+  tools?:
+    | Array<
+      | DocumentLibraryTool
+      | CustomConnector
+      | Tool
+      | WebSearchTool
+      | WebSearchPremiumTool
+      | CodeInterpreterTool
+      | ImageGenerationTool
+    >
+    | Array<string>
+    | null
+    | undefined;
   toolChoice?: ToolChoice | ToolChoiceEnum | undefined;
   /**
    * The `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
@@ -114,14 +186,17 @@ export type AgentsCompletionRequest = {
    */
   prediction?: Prediction | undefined;
   parallelToolCalls?: boolean | undefined;
+  reasoningEffort?: ReasoningEffort | null | undefined;
   /**
    * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used.
    */
   promptMode?: MistralPromptMode | null | undefined;
+  guardrails?: Array<GuardrailConfig> | null | undefined;
   /**
    * The ID of the agent to use for this completion.
    */
   agentId: string;
+  [additionalProperties: string]: unknown;
 };
 
 /** @internal */
@@ -173,6 +248,82 @@ export function agentsCompletionRequestMessageToJSON(
   );
 }
 
+/** @internal */
+export type AgentsCompletionRequestTools1$Outbound =
+  | DocumentLibraryTool$Outbound
+  | CustomConnector$Outbound
+  | Tool$Outbound
+  | WebSearchTool$Outbound
+  | WebSearchPremiumTool$Outbound
+  | CodeInterpreterTool$Outbound
+  | ImageGenerationTool$Outbound;
+
+/** @internal */
+export const AgentsCompletionRequestTools1$outboundSchema: z.ZodType<
+  AgentsCompletionRequestTools1$Outbound,
+  AgentsCompletionRequestTools1
+> = smartUnion([
+  DocumentLibraryTool$outboundSchema,
+  CustomConnector$outboundSchema,
+  Tool$outboundSchema,
+  WebSearchTool$outboundSchema,
+  WebSearchPremiumTool$outboundSchema,
+  CodeInterpreterTool$outboundSchema,
+  ImageGenerationTool$outboundSchema,
+]);
+
+export function agentsCompletionRequestTools1ToJSON(
+  agentsCompletionRequestTools1: AgentsCompletionRequestTools1,
+): string {
+  return JSON.stringify(
+    AgentsCompletionRequestTools1$outboundSchema.parse(
+      agentsCompletionRequestTools1,
+    ),
+  );
+}
+
+/** @internal */
+export type AgentsCompletionRequestTools2$Outbound =
+  | Array<
+    | DocumentLibraryTool$Outbound
+    | CustomConnector$Outbound
+    | Tool$Outbound
+    | WebSearchTool$Outbound
+    | WebSearchPremiumTool$Outbound
+    | CodeInterpreterTool$Outbound
+    | ImageGenerationTool$Outbound
+  >
+  | Array<string>;
+
+/** @internal */
+export const AgentsCompletionRequestTools2$outboundSchema: z.ZodType<
+  AgentsCompletionRequestTools2$Outbound,
+  AgentsCompletionRequestTools2
+> = smartUnion([
+  z.array(
+    smartUnion([
+      DocumentLibraryTool$outboundSchema,
+      CustomConnector$outboundSchema,
+      Tool$outboundSchema,
+      WebSearchTool$outboundSchema,
+      WebSearchPremiumTool$outboundSchema,
+      CodeInterpreterTool$outboundSchema,
+      ImageGenerationTool$outboundSchema,
+    ]),
+  ),
+  z.array(z.string()),
+]);
+
+export function agentsCompletionRequestTools2ToJSON(
+  agentsCompletionRequestTools2: AgentsCompletionRequestTools2,
+): string {
+  return JSON.stringify(
+    AgentsCompletionRequestTools2$outboundSchema.parse(
+      agentsCompletionRequestTools2,
+    ),
+  );
+}
+
 /** @internal */
 export type AgentsCompletionRequestToolChoice$Outbound =
   | ToolChoice$Outbound
@@ -208,15 +359,30 @@ export type AgentsCompletionRequest$Outbound = {
     | UserMessage$Outbound
   >;
   response_format?: ResponseFormat$Outbound | undefined;
-  tools?: Array<Tool$Outbound> | null | undefined;
+  tools?:
+    | Array<
+      | DocumentLibraryTool$Outbound
+      | CustomConnector$Outbound
+      | Tool$Outbound
+      | WebSearchTool$Outbound
+      | WebSearchPremiumTool$Outbound
+      | CodeInterpreterTool$Outbound
+      | ImageGenerationTool$Outbound
+    >
+    | Array<string>
+    | null
+    | undefined;
   tool_choice?: ToolChoice$Outbound | string | undefined;
   presence_penalty?: number | undefined;
   frequency_penalty?: number | undefined;
   n?: number | null | undefined;
   prediction?: Prediction$Outbound | undefined;
   parallel_tool_calls?: boolean | undefined;
+  reasoning_effort?: string | null | undefined;
   prompt_mode?: string | null | undefined;
+  guardrails?: Array<GuardrailConfig$Outbound> | null | undefined;
   agent_id: string;
+  [additionalProperties: string]: unknown;
 };
 
 /** @internal */
@@ -240,7 +406,22 @@ export const AgentsCompletionRequest$outboundSchema: z.ZodType<
     ]),
   ),
   responseFormat: ResponseFormat$outboundSchema.optional(),
-  tools: z.nullable(z.array(Tool$outboundSchema)).optional(),
+  tools: z.nullable(
+    smartUnion([
+      z.array(
+        smartUnion([
+          DocumentLibraryTool$outboundSchema,
+          CustomConnector$outboundSchema,
+          Tool$outboundSchema,
+          WebSearchTool$outboundSchema,
+          WebSearchPremiumTool$outboundSchema,
+          CodeInterpreterTool$outboundSchema,
+          ImageGenerationTool$outboundSchema,
+        ]),
+      ),
+      z.array(z.string()),
+    ]),
+  ).optional(),
   toolChoice: smartUnion([
     ToolChoice$outboundSchema,
     ToolChoiceEnum$outboundSchema,
@@ -250,20 +431,25 @@ export const AgentsCompletionRequest$outboundSchema: z.ZodType<
   n: z.nullable(z.int()).optional(),
   prediction: Prediction$outboundSchema.optional(),
   parallelToolCalls: z.boolean().optional(),
+  reasoningEffort: z.nullable(ReasoningEffort$outboundSchema).optional(),
   promptMode: z.nullable(MistralPromptMode$outboundSchema).optional(),
+  guardrails: z.nullable(z.array(GuardrailConfig$outboundSchema)).optional(),
   agentId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    maxTokens: "max_tokens",
-    randomSeed: "random_seed",
-    responseFormat: "response_format",
-    toolChoice: "tool_choice",
-    presencePenalty: "presence_penalty",
-    frequencyPenalty: "frequency_penalty",
-    parallelToolCalls: "parallel_tool_calls",
-    promptMode: "prompt_mode",
-    agentId: "agent_id",
-  });
+}).catchall(z.any()).transform((v) => {
+  return {
+    ...remap$(v, {
+      maxTokens: "max_tokens",
+      randomSeed: "random_seed",
+      responseFormat: "response_format",
+      toolChoice: "tool_choice",
+      presencePenalty: "presence_penalty",
+      frequencyPenalty: "frequency_penalty",
+      parallelToolCalls: "parallel_tool_calls",
+      reasoningEffort: "reasoning_effort",
+      promptMode: "prompt_mode",
+      agentId: "agent_id",
+    }),
+  };
 });
 
 export function agentsCompletionRequestToJSON(

package/src/models/components/agentscompletionstreamrequest.ts

@@ -11,6 +11,31 @@ import {
   AssistantMessage$Outbound,
   AssistantMessage$outboundSchema,
 } from "./assistantmessage.js";
+import {
+  CodeInterpreterTool,
+  CodeInterpreterTool$Outbound,
+  CodeInterpreterTool$outboundSchema,
+} from "./codeinterpretertool.js";
+import {
+  CustomConnector,
+  CustomConnector$Outbound,
+  CustomConnector$outboundSchema,
+} from "./customconnector.js";
+import {
+  DocumentLibraryTool,
+  DocumentLibraryTool$Outbound,
+  DocumentLibraryTool$outboundSchema,
+} from "./documentlibrarytool.js";
+import {
+  GuardrailConfig,
+  GuardrailConfig$Outbound,
+  GuardrailConfig$outboundSchema,
+} from "./guardrailconfig.js";
+import {
+  ImageGenerationTool,
+  ImageGenerationTool$Outbound,
+  ImageGenerationTool$outboundSchema,
+} from "./imagegenerationtool.js";
 import {
   MistralPromptMode,
   MistralPromptMode$outboundSchema,
@@ -20,6 +45,10 @@ import {
   Prediction$Outbound,
   Prediction$outboundSchema,
 } from "./prediction.js";
+import {
+  ReasoningEffort,
+  ReasoningEffort$outboundSchema,
+} from "./reasoningeffort.js";
 import {
   ResponseFormat,
   ResponseFormat$Outbound,
@@ -50,6 +79,16 @@ import {
   UserMessage$Outbound,
   UserMessage$outboundSchema,
 } from "./usermessage.js";
+import {
+  WebSearchPremiumTool,
+  WebSearchPremiumTool$Outbound,
+  WebSearchPremiumTool$outboundSchema,
+} from "./websearchpremiumtool.js";
+import {
+  WebSearchTool,
+  WebSearchTool$Outbound,
+  WebSearchTool$outboundSchema,
+} from "./websearchtool.js";
 
 /**
  * Stop generation if this token is detected. Or if one of these tokens is detected when providing an array
@@ -62,6 +101,27 @@ export type AgentsCompletionStreamRequestMessage =
   | ToolMessage
   | UserMessage;
 
+export type AgentsCompletionStreamRequestTools1 =
+  | DocumentLibraryTool
+  | CustomConnector
+  | Tool
+  | WebSearchTool
+  | WebSearchPremiumTool
+  | CodeInterpreterTool
+  | ImageGenerationTool;
+
+export type AgentsCompletionStreamRequestTools2 =
+  | Array<
+    | DocumentLibraryTool
+    | CustomConnector
+    | Tool
+    | WebSearchTool
+    | WebSearchPremiumTool
+    | CodeInterpreterTool
+    | ImageGenerationTool
+  >
+  | Array<string>;
+
 export type AgentsCompletionStreamRequestToolChoice =
   | ToolChoice
   | ToolChoiceEnum;
@@ -94,7 +154,19 @@ export type AgentsCompletionStreamRequest = {
    * Specify the format that the model must output. By default it will use `{ "type": "text" }`. Setting to `{ "type": "json_object" }` enables JSON mode, which guarantees the message the model generates is in JSON. When using JSON mode you MUST also instruct the model to produce JSON yourself with a system or a user message. Setting to `{ "type": "json_schema" }` enables JSON schema mode, which guarantees the message the model generates is in JSON and follows the schema you provide.
    */
   responseFormat?: ResponseFormat | undefined;
-  tools?: Array<Tool> | null | undefined;
+  tools?:
+    | Array<
+      | DocumentLibraryTool
+      | CustomConnector
+      | Tool
+      | WebSearchTool
+      | WebSearchPremiumTool
+      | CodeInterpreterTool
+      | ImageGenerationTool
+    >
+    | Array<string>
+    | null
+    | undefined;
   toolChoice?: ToolChoice | ToolChoiceEnum | undefined;
   /**
    * The `presence_penalty` determines how much the model penalizes the repetition of words or phrases. A higher presence penalty encourages the model to use a wider variety of words and phrases, making the output more diverse and creative.
@@ -113,14 +185,17 @@ export type AgentsCompletionStreamRequest = {
    */
   prediction?: Prediction | undefined;
   parallelToolCalls?: boolean | undefined;
+  reasoningEffort?: ReasoningEffort | null | undefined;
   /**
    * Allows toggling between the reasoning mode and no system prompt. When set to `reasoning` the system prompt for reasoning models will be used.
    */
   promptMode?: MistralPromptMode | null | undefined;
+  guardrails?: Array<GuardrailConfig> | null | undefined;
   /**
    * The ID of the agent to use for this completion.
    */
   agentId: string;
+  [additionalProperties: string]: unknown;
 };
 
 /** @internal */
@@ -172,6 +247,82 @@ export function agentsCompletionStreamRequestMessageToJSON(
   );
 }
 
+/** @internal */
+export type AgentsCompletionStreamRequestTools1$Outbound =
+  | DocumentLibraryTool$Outbound
+  | CustomConnector$Outbound
+  | Tool$Outbound
+  | WebSearchTool$Outbound
+  | WebSearchPremiumTool$Outbound
+  | CodeInterpreterTool$Outbound
+  | ImageGenerationTool$Outbound;
+
+/** @internal */
+export const AgentsCompletionStreamRequestTools1$outboundSchema: z.ZodType<
+  AgentsCompletionStreamRequestTools1$Outbound,
+  AgentsCompletionStreamRequestTools1
+> = smartUnion([
+  DocumentLibraryTool$outboundSchema,
+  CustomConnector$outboundSchema,
+  Tool$outboundSchema,
+  WebSearchTool$outboundSchema,
+  WebSearchPremiumTool$outboundSchema,
+  CodeInterpreterTool$outboundSchema,
+  ImageGenerationTool$outboundSchema,
+]);
+
+export function agentsCompletionStreamRequestTools1ToJSON(
+  agentsCompletionStreamRequestTools1: AgentsCompletionStreamRequestTools1,
+): string {
+  return JSON.stringify(
+    AgentsCompletionStreamRequestTools1$outboundSchema.parse(
+      agentsCompletionStreamRequestTools1,
+    ),
+  );
+}
+
+/** @internal */
+export type AgentsCompletionStreamRequestTools2$Outbound =
+  | Array<
+    | DocumentLibraryTool$Outbound
+    | CustomConnector$Outbound
+    | Tool$Outbound
+    | WebSearchTool$Outbound
+    | WebSearchPremiumTool$Outbound
+    | CodeInterpreterTool$Outbound
+    | ImageGenerationTool$Outbound
+  >
+  | Array<string>;
+
+/** @internal */
+export const AgentsCompletionStreamRequestTools2$outboundSchema: z.ZodType<
+  AgentsCompletionStreamRequestTools2$Outbound,
+  AgentsCompletionStreamRequestTools2
+> = smartUnion([
+  z.array(
+    smartUnion([
+      DocumentLibraryTool$outboundSchema,
+      CustomConnector$outboundSchema,
+      Tool$outboundSchema,
+      WebSearchTool$outboundSchema,
+      WebSearchPremiumTool$outboundSchema,
+      CodeInterpreterTool$outboundSchema,
+      ImageGenerationTool$outboundSchema,
+    ]),
+  ),
+  z.array(z.string()),
+]);
+
+export function agentsCompletionStreamRequestTools2ToJSON(
+  agentsCompletionStreamRequestTools2: AgentsCompletionStreamRequestTools2,
+): string {
+  return JSON.stringify(
+    AgentsCompletionStreamRequestTools2$outboundSchema.parse(
+      agentsCompletionStreamRequestTools2,
+    ),
+  );
+}
+
 /** @internal */
 export type AgentsCompletionStreamRequestToolChoice$Outbound =
   | ToolChoice$Outbound
@@ -208,15 +359,30 @@ export type AgentsCompletionStreamRequest$Outbound = {
     | UserMessage$Outbound
   >;
   response_format?: ResponseFormat$Outbound | undefined;
-  tools?: Array<Tool$Outbound> | null | undefined;
+  tools?:
+    | Array<
+      | DocumentLibraryTool$Outbound
+      | CustomConnector$Outbound
+      | Tool$Outbound
+      | WebSearchTool$Outbound
+      | WebSearchPremiumTool$Outbound
+      | CodeInterpreterTool$Outbound
+      | ImageGenerationTool$Outbound
+    >
+    | Array<string>
+    | null
+    | undefined;
   tool_choice?: ToolChoice$Outbound | string | undefined;
   presence_penalty?: number | undefined;
   frequency_penalty?: number | undefined;
   n?: number | null | undefined;
   prediction?: Prediction$Outbound | undefined;
   parallel_tool_calls?: boolean | undefined;
+  reasoning_effort?: string | null | undefined;
   prompt_mode?: string | null | undefined;
+  guardrails?: Array<GuardrailConfig$Outbound> | null | undefined;
   agent_id: string;
+  [additionalProperties: string]: unknown;
 };
 
 /** @internal */
@@ -240,7 +406,22 @@ export const AgentsCompletionStreamRequest$outboundSchema: z.ZodType<
     ]),
   ),
   responseFormat: ResponseFormat$outboundSchema.optional(),
-  tools: z.nullable(z.array(Tool$outboundSchema)).optional(),
+  tools: z.nullable(
+    smartUnion([
+      z.array(
+        smartUnion([
+          DocumentLibraryTool$outboundSchema,
+          CustomConnector$outboundSchema,
+          Tool$outboundSchema,
+          WebSearchTool$outboundSchema,
+          WebSearchPremiumTool$outboundSchema,
+          CodeInterpreterTool$outboundSchema,
+          ImageGenerationTool$outboundSchema,
+        ]),
+      ),
+      z.array(z.string()),
+    ]),
+  ).optional(),
   toolChoice: smartUnion([
     ToolChoice$outboundSchema,
     ToolChoiceEnum$outboundSchema,
@@ -250,20 +431,25 @@ export const AgentsCompletionStreamRequest$outboundSchema: z.ZodType<
   n: z.nullable(z.int()).optional(),
   prediction: Prediction$outboundSchema.optional(),
   parallelToolCalls: z.boolean().optional(),
+  reasoningEffort: z.nullable(ReasoningEffort$outboundSchema).optional(),
   promptMode: z.nullable(MistralPromptMode$outboundSchema).optional(),
+  guardrails: z.nullable(z.array(GuardrailConfig$outboundSchema)).optional(),
   agentId: z.string(),
-}).transform((v) => {
-  return remap$(v, {
-    maxTokens: "max_tokens",
-    randomSeed: "random_seed",
-    responseFormat: "response_format",
-    toolChoice: "tool_choice",
-    presencePenalty: "presence_penalty",
-    frequencyPenalty: "frequency_penalty",
-    parallelToolCalls: "parallel_tool_calls",
-    promptMode: "prompt_mode",
-    agentId: "agent_id",
-  });
+}).catchall(z.any()).transform((v) => {
+  return {
+    ...remap$(v, {
+      maxTokens: "max_tokens",
+      randomSeed: "random_seed",
+      responseFormat: "response_format",
+      toolChoice: "tool_choice",
+      presencePenalty: "presence_penalty",
+      frequencyPenalty: "frequency_penalty",
+      parallelToolCalls: "parallel_tool_calls",
+      reasoningEffort: "reasoning_effort",
+      promptMode: "prompt_mode",
+      agentId: "agent_id",
+    }),
+  };
 });
 
 export function agentsCompletionStreamRequestToJSON(

package/src/models/components/authurlresponse.ts

@@ -0,0 +1,38 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ * @generated-id: 2438b56452ed
+ */
+
+import * as z from "zod/v4";
+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";
+
+export type AuthUrlResponse = {
+  authUrl: string;
+  ttl: number;
+};
+
+/** @internal */
+export const AuthUrlResponse$inboundSchema: z.ZodType<
+  AuthUrlResponse,
+  unknown
+> = z.object({
+  auth_url: z.string(),
+  ttl: z.int(),
+}).transform((v) => {
+  return remap$(v, {
+    "auth_url": "authUrl",
+  });
+});
+
+export function authUrlResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<AuthUrlResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => AuthUrlResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'AuthUrlResponse' from JSON`,
+  );
+}

package/src/models/components/basefielddefinition.ts

@@ -11,7 +11,7 @@ import { OpenEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const TypeEnum = {
+export const BaseFieldDefinitionType = {
   Enum: "ENUM",
   Text: "TEXT",
   Int: "INT",
@@ -20,7 +20,7 @@ export const TypeEnum = {
   Timestamp: "TIMESTAMP",
   Array: "ARRAY",
 } as const;
-export type TypeEnum = OpenEnum<typeof TypeEnum>;
+export type BaseFieldDefinitionType = OpenEnum<typeof BaseFieldDefinitionType>;
 
 export const SupportedOperator = {
   Lt: "lt",
@@ -48,14 +48,16 @@ export type SupportedOperator = OpenEnum<typeof SupportedOperator>;
 export type BaseFieldDefinition = {
   name: string;
   label: string;
-  type: TypeEnum;
+  type: BaseFieldDefinitionType;
   group?: string | null | undefined;
   supportedOperators: Array<SupportedOperator>;
 };
 
 /** @internal */
-export const TypeEnum$inboundSchema: z.ZodType<TypeEnum, unknown> = openEnums
-  .inboundSchema(TypeEnum);
+export const BaseFieldDefinitionType$inboundSchema: z.ZodType<
+  BaseFieldDefinitionType,
+  unknown
+> = openEnums.inboundSchema(BaseFieldDefinitionType);
 
 /** @internal */
 export const SupportedOperator$inboundSchema: z.ZodType<
@@ -70,7 +72,7 @@ export const BaseFieldDefinition$inboundSchema: z.ZodType<
 > = z.object({
   name: z.string(),
   label: z.string(),
-  type: TypeEnum$inboundSchema,
+  type: BaseFieldDefinitionType$inboundSchema,
   group: z.nullable(z.string()).optional(),
   supported_operators: z.array(SupportedOperator$inboundSchema),
 }).transform((v) => {

package/src/models/components/basemodelcard.ts

@@ -18,6 +18,12 @@ export type BaseModelCard = {
   object: string;
   created?: number | undefined;
   ownedBy: string;
+  /**
+   * This is populated by Harmattan, but some fields have a name
+   *
+   * @remarks
+   * that we don't want to expose in the API.
+   */
   capabilities: ModelCapabilities;
   name?: string | null | undefined;
   description?: string | null | undefined;