@mistralai/mistralai 1.9.17 → 1.9.19

package/packages/mistralai-azure/src/models/components/ocrimageobject.ts

@@ -0,0 +1,126 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 OCRImageObject = {
+  /**
+   * Image ID for extracted image in a page
+   */
+  id: string;
+  /**
+   * X coordinate of top-left corner of the extracted image
+   */
+  topLeftX: number | null;
+  /**
+   * Y coordinate of top-left corner of the extracted image
+   */
+  topLeftY: number | null;
+  /**
+   * X coordinate of bottom-right corner of the extracted image
+   */
+  bottomRightX: number | null;
+  /**
+   * Y coordinate of bottom-right corner of the extracted image
+   */
+  bottomRightY: number | null;
+  /**
+   * Base64 string of the extracted image
+   */
+  imageBase64?: string | null | undefined;
+  /**
+   * Annotation of the extracted image in json str
+   */
+  imageAnnotation?: string | null | undefined;
+};
+
+/** @internal */
+export const OCRImageObject$inboundSchema: z.ZodType<
+  OCRImageObject,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  top_left_x: z.nullable(z.number().int()),
+  top_left_y: z.nullable(z.number().int()),
+  bottom_right_x: z.nullable(z.number().int()),
+  bottom_right_y: z.nullable(z.number().int()),
+  image_base64: z.nullable(z.string()).optional(),
+  image_annotation: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "top_left_x": "topLeftX",
+    "top_left_y": "topLeftY",
+    "bottom_right_x": "bottomRightX",
+    "bottom_right_y": "bottomRightY",
+    "image_base64": "imageBase64",
+    "image_annotation": "imageAnnotation",
+  });
+});
+
+/** @internal */
+export type OCRImageObject$Outbound = {
+  id: string;
+  top_left_x: number | null;
+  top_left_y: number | null;
+  bottom_right_x: number | null;
+  bottom_right_y: number | null;
+  image_base64?: string | null | undefined;
+  image_annotation?: string | null | undefined;
+};
+
+/** @internal */
+export const OCRImageObject$outboundSchema: z.ZodType<
+  OCRImageObject$Outbound,
+  z.ZodTypeDef,
+  OCRImageObject
+> = z.object({
+  id: z.string(),
+  topLeftX: z.nullable(z.number().int()),
+  topLeftY: z.nullable(z.number().int()),
+  bottomRightX: z.nullable(z.number().int()),
+  bottomRightY: z.nullable(z.number().int()),
+  imageBase64: z.nullable(z.string()).optional(),
+  imageAnnotation: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    topLeftX: "top_left_x",
+    topLeftY: "top_left_y",
+    bottomRightX: "bottom_right_x",
+    bottomRightY: "bottom_right_y",
+    imageBase64: "image_base64",
+    imageAnnotation: "image_annotation",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OCRImageObject$ {
+  /** @deprecated use `OCRImageObject$inboundSchema` instead. */
+  export const inboundSchema = OCRImageObject$inboundSchema;
+  /** @deprecated use `OCRImageObject$outboundSchema` instead. */
+  export const outboundSchema = OCRImageObject$outboundSchema;
+  /** @deprecated use `OCRImageObject$Outbound` instead. */
+  export type Outbound = OCRImageObject$Outbound;
+}
+
+export function ocrImageObjectToJSON(ocrImageObject: OCRImageObject): string {
+  return JSON.stringify(OCRImageObject$outboundSchema.parse(ocrImageObject));
+}
+
+export function ocrImageObjectFromJSON(
+  jsonString: string,
+): SafeParseResult<OCRImageObject, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OCRImageObject$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OCRImageObject' from JSON`,
+  );
+}

package/packages/mistralai-azure/src/models/components/ocrpagedimensions.ts

@@ -0,0 +1,83 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type OCRPageDimensions = {
+  /**
+   * Dots per inch of the page-image
+   */
+  dpi: number;
+  /**
+   * Height of the image in pixels
+   */
+  height: number;
+  /**
+   * Width of the image in pixels
+   */
+  width: number;
+};
+
+/** @internal */
+export const OCRPageDimensions$inboundSchema: z.ZodType<
+  OCRPageDimensions,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dpi: z.number().int(),
+  height: z.number().int(),
+  width: z.number().int(),
+});
+
+/** @internal */
+export type OCRPageDimensions$Outbound = {
+  dpi: number;
+  height: number;
+  width: number;
+};
+
+/** @internal */
+export const OCRPageDimensions$outboundSchema: z.ZodType<
+  OCRPageDimensions$Outbound,
+  z.ZodTypeDef,
+  OCRPageDimensions
+> = z.object({
+  dpi: z.number().int(),
+  height: z.number().int(),
+  width: z.number().int(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OCRPageDimensions$ {
+  /** @deprecated use `OCRPageDimensions$inboundSchema` instead. */
+  export const inboundSchema = OCRPageDimensions$inboundSchema;
+  /** @deprecated use `OCRPageDimensions$outboundSchema` instead. */
+  export const outboundSchema = OCRPageDimensions$outboundSchema;
+  /** @deprecated use `OCRPageDimensions$Outbound` instead. */
+  export type Outbound = OCRPageDimensions$Outbound;
+}
+
+export function ocrPageDimensionsToJSON(
+  ocrPageDimensions: OCRPageDimensions,
+): string {
+  return JSON.stringify(
+    OCRPageDimensions$outboundSchema.parse(ocrPageDimensions),
+  );
+}
+
+export function ocrPageDimensionsFromJSON(
+  jsonString: string,
+): SafeParseResult<OCRPageDimensions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OCRPageDimensions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OCRPageDimensions' from JSON`,
+  );
+}

package/packages/mistralai-azure/src/models/components/ocrpageobject.ts

@@ -0,0 +1,98 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  OCRImageObject,
+  OCRImageObject$inboundSchema,
+  OCRImageObject$Outbound,
+  OCRImageObject$outboundSchema,
+} from "./ocrimageobject.js";
+import {
+  OCRPageDimensions,
+  OCRPageDimensions$inboundSchema,
+  OCRPageDimensions$Outbound,
+  OCRPageDimensions$outboundSchema,
+} from "./ocrpagedimensions.js";
+
+export type OCRPageObject = {
+  /**
+   * The page index in a pdf document starting from 0
+   */
+  index: number;
+  /**
+   * The markdown string response of the page
+   */
+  markdown: string;
+  /**
+   * List of all extracted images in the page
+   */
+  images: Array<OCRImageObject>;
+  /**
+   * The dimensions of the PDF Page's screenshot image
+   */
+  dimensions: OCRPageDimensions | null;
+};
+
+/** @internal */
+export const OCRPageObject$inboundSchema: z.ZodType<
+  OCRPageObject,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  index: z.number().int(),
+  markdown: z.string(),
+  images: z.array(OCRImageObject$inboundSchema),
+  dimensions: z.nullable(OCRPageDimensions$inboundSchema),
+});
+
+/** @internal */
+export type OCRPageObject$Outbound = {
+  index: number;
+  markdown: string;
+  images: Array<OCRImageObject$Outbound>;
+  dimensions: OCRPageDimensions$Outbound | null;
+};
+
+/** @internal */
+export const OCRPageObject$outboundSchema: z.ZodType<
+  OCRPageObject$Outbound,
+  z.ZodTypeDef,
+  OCRPageObject
+> = z.object({
+  index: z.number().int(),
+  markdown: z.string(),
+  images: z.array(OCRImageObject$outboundSchema),
+  dimensions: z.nullable(OCRPageDimensions$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OCRPageObject$ {
+  /** @deprecated use `OCRPageObject$inboundSchema` instead. */
+  export const inboundSchema = OCRPageObject$inboundSchema;
+  /** @deprecated use `OCRPageObject$outboundSchema` instead. */
+  export const outboundSchema = OCRPageObject$outboundSchema;
+  /** @deprecated use `OCRPageObject$Outbound` instead. */
+  export type Outbound = OCRPageObject$Outbound;
+}
+
+export function ocrPageObjectToJSON(ocrPageObject: OCRPageObject): string {
+  return JSON.stringify(OCRPageObject$outboundSchema.parse(ocrPageObject));
+}
+
+export function ocrPageObjectFromJSON(
+  jsonString: string,
+): SafeParseResult<OCRPageObject, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OCRPageObject$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OCRPageObject' from JSON`,
+  );
+}

package/packages/mistralai-azure/src/models/components/ocrrequest.ts

@@ -0,0 +1,229 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  DocumentURLChunk,
+  DocumentURLChunk$inboundSchema,
+  DocumentURLChunk$Outbound,
+  DocumentURLChunk$outboundSchema,
+} from "./documenturlchunk.js";
+import {
+  FileChunk,
+  FileChunk$inboundSchema,
+  FileChunk$Outbound,
+  FileChunk$outboundSchema,
+} from "./filechunk.js";
+import {
+  ImageURLChunk,
+  ImageURLChunk$inboundSchema,
+  ImageURLChunk$Outbound,
+  ImageURLChunk$outboundSchema,
+} from "./imageurlchunk.js";
+import {
+  ResponseFormat,
+  ResponseFormat$inboundSchema,
+  ResponseFormat$Outbound,
+  ResponseFormat$outboundSchema,
+} from "./responseformat.js";
+
+/**
+ * Document to run OCR on
+ */
+export type Document = FileChunk | ImageURLChunk | DocumentURLChunk;
+
+export type OCRRequest = {
+  model: string | null;
+  id?: string | undefined;
+  /**
+   * Document to run OCR on
+   */
+  document: FileChunk | ImageURLChunk | DocumentURLChunk;
+  /**
+   * Specific pages user wants to process in various formats: single number, range, or list of both. Starts from 0
+   */
+  pages?: Array<number> | null | undefined;
+  /**
+   * Include image URLs in response
+   */
+  includeImageBase64?: boolean | null | undefined;
+  /**
+   * Max images to extract
+   */
+  imageLimit?: number | null | undefined;
+  /**
+   * Minimum height and width of image to extract
+   */
+  imageMinSize?: number | null | undefined;
+  /**
+   * Structured output class for extracting useful information from each extracted bounding box / image from document. Only json_schema is valid for this field
+   */
+  bboxAnnotationFormat?: ResponseFormat | null | undefined;
+  /**
+   * Structured output class for extracting useful information from the entire document. Only json_schema is valid for this field
+   */
+  documentAnnotationFormat?: ResponseFormat | null | undefined;
+};
+
+/** @internal */
+export const Document$inboundSchema: z.ZodType<
+  Document,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  FileChunk$inboundSchema,
+  ImageURLChunk$inboundSchema,
+  DocumentURLChunk$inboundSchema,
+]);
+
+/** @internal */
+export type Document$Outbound =
+  | FileChunk$Outbound
+  | ImageURLChunk$Outbound
+  | DocumentURLChunk$Outbound;
+
+/** @internal */
+export const Document$outboundSchema: z.ZodType<
+  Document$Outbound,
+  z.ZodTypeDef,
+  Document
+> = z.union([
+  FileChunk$outboundSchema,
+  ImageURLChunk$outboundSchema,
+  DocumentURLChunk$outboundSchema,
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Document$ {
+  /** @deprecated use `Document$inboundSchema` instead. */
+  export const inboundSchema = Document$inboundSchema;
+  /** @deprecated use `Document$outboundSchema` instead. */
+  export const outboundSchema = Document$outboundSchema;
+  /** @deprecated use `Document$Outbound` instead. */
+  export type Outbound = Document$Outbound;
+}
+
+export function documentToJSON(document: Document): string {
+  return JSON.stringify(Document$outboundSchema.parse(document));
+}
+
+export function documentFromJSON(
+  jsonString: string,
+): SafeParseResult<Document, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Document$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Document' from JSON`,
+  );
+}
+
+/** @internal */
+export const OCRRequest$inboundSchema: z.ZodType<
+  OCRRequest,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  model: z.nullable(z.string()),
+  id: z.string().optional(),
+  document: z.union([
+    FileChunk$inboundSchema,
+    ImageURLChunk$inboundSchema,
+    DocumentURLChunk$inboundSchema,
+  ]),
+  pages: z.nullable(z.array(z.number().int())).optional(),
+  include_image_base64: z.nullable(z.boolean()).optional(),
+  image_limit: z.nullable(z.number().int()).optional(),
+  image_min_size: z.nullable(z.number().int()).optional(),
+  bbox_annotation_format: z.nullable(ResponseFormat$inboundSchema).optional(),
+  document_annotation_format: z.nullable(ResponseFormat$inboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "include_image_base64": "includeImageBase64",
+    "image_limit": "imageLimit",
+    "image_min_size": "imageMinSize",
+    "bbox_annotation_format": "bboxAnnotationFormat",
+    "document_annotation_format": "documentAnnotationFormat",
+  });
+});
+
+/** @internal */
+export type OCRRequest$Outbound = {
+  model: string | null;
+  id?: string | undefined;
+  document:
+    | FileChunk$Outbound
+    | ImageURLChunk$Outbound
+    | DocumentURLChunk$Outbound;
+  pages?: Array<number> | null | undefined;
+  include_image_base64?: boolean | null | undefined;
+  image_limit?: number | null | undefined;
+  image_min_size?: number | null | undefined;
+  bbox_annotation_format?: ResponseFormat$Outbound | null | undefined;
+  document_annotation_format?: ResponseFormat$Outbound | null | undefined;
+};
+
+/** @internal */
+export const OCRRequest$outboundSchema: z.ZodType<
+  OCRRequest$Outbound,
+  z.ZodTypeDef,
+  OCRRequest
+> = z.object({
+  model: z.nullable(z.string()),
+  id: z.string().optional(),
+  document: z.union([
+    FileChunk$outboundSchema,
+    ImageURLChunk$outboundSchema,
+    DocumentURLChunk$outboundSchema,
+  ]),
+  pages: z.nullable(z.array(z.number().int())).optional(),
+  includeImageBase64: z.nullable(z.boolean()).optional(),
+  imageLimit: z.nullable(z.number().int()).optional(),
+  imageMinSize: z.nullable(z.number().int()).optional(),
+  bboxAnnotationFormat: z.nullable(ResponseFormat$outboundSchema).optional(),
+  documentAnnotationFormat: z.nullable(ResponseFormat$outboundSchema)
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    includeImageBase64: "include_image_base64",
+    imageLimit: "image_limit",
+    imageMinSize: "image_min_size",
+    bboxAnnotationFormat: "bbox_annotation_format",
+    documentAnnotationFormat: "document_annotation_format",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OCRRequest$ {
+  /** @deprecated use `OCRRequest$inboundSchema` instead. */
+  export const inboundSchema = OCRRequest$inboundSchema;
+  /** @deprecated use `OCRRequest$outboundSchema` instead. */
+  export const outboundSchema = OCRRequest$outboundSchema;
+  /** @deprecated use `OCRRequest$Outbound` instead. */
+  export type Outbound = OCRRequest$Outbound;
+}
+
+export function ocrRequestToJSON(ocrRequest: OCRRequest): string {
+  return JSON.stringify(OCRRequest$outboundSchema.parse(ocrRequest));
+}
+
+export function ocrRequestFromJSON(
+  jsonString: string,
+): SafeParseResult<OCRRequest, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OCRRequest$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OCRRequest' from JSON`,
+  );
+}

package/packages/mistralai-azure/src/models/components/ocrresponse.ts

@@ -0,0 +1,106 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  OCRPageObject,
+  OCRPageObject$inboundSchema,
+  OCRPageObject$Outbound,
+  OCRPageObject$outboundSchema,
+} from "./ocrpageobject.js";
+import {
+  OCRUsageInfo,
+  OCRUsageInfo$inboundSchema,
+  OCRUsageInfo$Outbound,
+  OCRUsageInfo$outboundSchema,
+} from "./ocrusageinfo.js";
+
+export type OCRResponse = {
+  /**
+   * List of OCR info for pages.
+   */
+  pages: Array<OCRPageObject>;
+  /**
+   * The model used to generate the OCR.
+   */
+  model: string;
+  /**
+   * Formatted response in the request_format if provided in json str
+   */
+  documentAnnotation?: string | null | undefined;
+  usageInfo: OCRUsageInfo;
+};
+
+/** @internal */
+export const OCRResponse$inboundSchema: z.ZodType<
+  OCRResponse,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  pages: z.array(OCRPageObject$inboundSchema),
+  model: z.string(),
+  document_annotation: z.nullable(z.string()).optional(),
+  usage_info: OCRUsageInfo$inboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    "document_annotation": "documentAnnotation",
+    "usage_info": "usageInfo",
+  });
+});
+
+/** @internal */
+export type OCRResponse$Outbound = {
+  pages: Array<OCRPageObject$Outbound>;
+  model: string;
+  document_annotation?: string | null | undefined;
+  usage_info: OCRUsageInfo$Outbound;
+};
+
+/** @internal */
+export const OCRResponse$outboundSchema: z.ZodType<
+  OCRResponse$Outbound,
+  z.ZodTypeDef,
+  OCRResponse
+> = z.object({
+  pages: z.array(OCRPageObject$outboundSchema),
+  model: z.string(),
+  documentAnnotation: z.nullable(z.string()).optional(),
+  usageInfo: OCRUsageInfo$outboundSchema,
+}).transform((v) => {
+  return remap$(v, {
+    documentAnnotation: "document_annotation",
+    usageInfo: "usage_info",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace OCRResponse$ {
+  /** @deprecated use `OCRResponse$inboundSchema` instead. */
+  export const inboundSchema = OCRResponse$inboundSchema;
+  /** @deprecated use `OCRResponse$outboundSchema` instead. */
+  export const outboundSchema = OCRResponse$outboundSchema;
+  /** @deprecated use `OCRResponse$Outbound` instead. */
+  export type Outbound = OCRResponse$Outbound;
+}
+
+export function ocrResponseToJSON(ocrResponse: OCRResponse): string {
+  return JSON.stringify(OCRResponse$outboundSchema.parse(ocrResponse));
+}
+
+export function ocrResponseFromJSON(
+  jsonString: string,
+): SafeParseResult<OCRResponse, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => OCRResponse$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'OCRResponse' from JSON`,
+  );
+}