@vepler/sdk 6.1.0 → 6.36.0

package/src/sdk/models/shared/chatcompletionrequest.ts

@@ -0,0 +1,318 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../../lib/primitives.js";
+
+export type Messages = {
+  content?: any | undefined;
+  role: string;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/**
+ * Output format: `json_object`, or `json_schema` with `name` set to the model's `output_schema_name` and `schema` either omitted or equal to its `output_schema`. The result is the same JSON object either way.
+ */
+export type ResponseFormat = {
+  type: string;
+  additionalProperties?: { [k: string]: any } | undefined;
+};
+
+/**
+ * Accepted and ignored.
+ */
+export type Stop = string | Array<string>;
+
+/**
+ * With `include_usage: true`, a final chunk carries `usage`.
+ */
+export type StreamOptions = {
+  includeUsage?: boolean | undefined;
+};
+
+export type ChatCompletionRequest = {
+  /**
+   * Accepted and ignored.
+   */
+  frequencyPenalty?: number | null | undefined;
+  /**
+   * Not supported. Any value other than `none` is refused.
+   */
+  functionCall?: any | undefined;
+  /**
+   * Not supported. A non-empty list is refused.
+   */
+  functions?: Array<any> | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  logitBias?: { [k: string]: number } | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  logprobs?: boolean | null | undefined;
+  /**
+   * Accepted and ignored. Each model has a fixed output limit.
+   */
+  maxCompletionTokens?: number | null | undefined;
+  /**
+   * Accepted and ignored. Each model has a fixed output limit.
+   */
+  maxTokens?: number | null | undefined;
+  /**
+   * Exactly one message with role `user`, whose content is one `image_url` part: an `https` URL on a public host name, or a base64 `data:` URL with a raster image type. The image can be up to 20 MiB. System messages and text parts are refused because the model's instructions are fixed.
+   */
+  messages: Array<Messages>;
+  /**
+   * Accepted and ignored.
+   */
+  metadata?: { [k: string]: string } | null | undefined;
+  /**
+   * Id of the model to run, from `GET /models`.
+   */
+  model: string;
+  /**
+   * Number of results. Only 1 is supported.
+   */
+  n?: number | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  parallelToolCalls?: boolean | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  presencePenalty?: number | null | undefined;
+  /**
+   * Output format: `json_object`, or `json_schema` with `name` set to the model's `output_schema_name` and `schema` either omitted or equal to its `output_schema`. The result is the same JSON object either way.
+   */
+  responseFormat?: ResponseFormat | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  seed?: number | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  serviceTier?: string | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  stop?: string | Array<string> | null | undefined;
+  /**
+   * Accepted and ignored. A completed result is kept for 15 minutes, only to answer an identical repeat from the same account without a charge.
+   */
+  store?: boolean | null | undefined;
+  /**
+   * When true, the result arrives as server-sent events in one chunk.
+   */
+  stream?: boolean | null | undefined;
+  /**
+   * With `include_usage: true`, a final chunk carries `usage`.
+   */
+  streamOptions?: StreamOptions | null | undefined;
+  /**
+   * Accepted and ignored. The model always runs at temperature 0.
+   */
+  temperature?: number | null | undefined;
+  /**
+   * Not supported. Any value other than `none` is refused.
+   */
+  toolChoice?: any | undefined;
+  /**
+   * Not supported. A non-empty list is refused.
+   */
+  tools?: Array<any> | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  topLogprobs?: number | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  topP?: number | null | undefined;
+  /**
+   * Accepted and ignored.
+   */
+  user?: string | null | undefined;
+};
+
+/** @internal */
+export type Messages$Outbound = {
+  content?: any | undefined;
+  role: string;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const Messages$outboundSchema: z.ZodType<
+  Messages$Outbound,
+  z.ZodTypeDef,
+  Messages
+> = z.object({
+  additionalProperties: z.record(z.any()).optional(),
+  content: z.any().optional(),
+  role: z.string(),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
+
+export function messagesToJSON(messages: Messages): string {
+  return JSON.stringify(Messages$outboundSchema.parse(messages));
+}
+
+/** @internal */
+export type ResponseFormat$Outbound = {
+  type: string;
+  [additionalProperties: string]: unknown;
+};
+
+/** @internal */
+export const ResponseFormat$outboundSchema: z.ZodType<
+  ResponseFormat$Outbound,
+  z.ZodTypeDef,
+  ResponseFormat
+> = z.object({
+  additionalProperties: z.record(z.any()).optional(),
+  type: z.string(),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
+
+export function responseFormatToJSON(responseFormat: ResponseFormat): string {
+  return JSON.stringify(ResponseFormat$outboundSchema.parse(responseFormat));
+}
+
+/** @internal */
+export type Stop$Outbound = string | Array<string>;
+
+/** @internal */
+export const Stop$outboundSchema: z.ZodType<Stop$Outbound, z.ZodTypeDef, Stop> =
+  z.union([z.string(), z.array(z.string())]);
+
+export function stopToJSON(stop: Stop): string {
+  return JSON.stringify(Stop$outboundSchema.parse(stop));
+}
+
+/** @internal */
+export type StreamOptions$Outbound = {
+  include_usage?: boolean | undefined;
+};
+
+/** @internal */
+export const StreamOptions$outboundSchema: z.ZodType<
+  StreamOptions$Outbound,
+  z.ZodTypeDef,
+  StreamOptions
+> = z.object({
+  includeUsage: z.boolean().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    includeUsage: "include_usage",
+  });
+});
+
+export function streamOptionsToJSON(streamOptions: StreamOptions): string {
+  return JSON.stringify(StreamOptions$outboundSchema.parse(streamOptions));
+}
+
+/** @internal */
+export type ChatCompletionRequest$Outbound = {
+  frequency_penalty?: number | null | undefined;
+  function_call?: any | undefined;
+  functions?: Array<any> | null | undefined;
+  logit_bias?: { [k: string]: number } | null | undefined;
+  logprobs?: boolean | null | undefined;
+  max_completion_tokens?: number | null | undefined;
+  max_tokens?: number | null | undefined;
+  messages: Array<Messages$Outbound>;
+  metadata?: { [k: string]: string } | null | undefined;
+  model: string;
+  n?: number | null | undefined;
+  parallel_tool_calls?: boolean | null | undefined;
+  presence_penalty?: number | null | undefined;
+  response_format?: ResponseFormat$Outbound | null | undefined;
+  seed?: number | null | undefined;
+  service_tier?: string | null | undefined;
+  stop?: string | Array<string> | null | undefined;
+  store?: boolean | null | undefined;
+  stream?: boolean | null | undefined;
+  stream_options?: StreamOptions$Outbound | null | undefined;
+  temperature?: number | null | undefined;
+  tool_choice?: any | undefined;
+  tools?: Array<any> | null | undefined;
+  top_logprobs?: number | null | undefined;
+  top_p?: number | null | undefined;
+  user?: string | null | undefined;
+};
+
+/** @internal */
+export const ChatCompletionRequest$outboundSchema: z.ZodType<
+  ChatCompletionRequest$Outbound,
+  z.ZodTypeDef,
+  ChatCompletionRequest
+> = z.object({
+  frequencyPenalty: z.nullable(z.number()).optional(),
+  functionCall: z.any().optional(),
+  functions: z.nullable(z.array(z.any())).optional(),
+  logitBias: z.nullable(z.record(z.number())).optional(),
+  logprobs: z.nullable(z.boolean()).optional(),
+  maxCompletionTokens: z.nullable(z.number().int()).optional(),
+  maxTokens: z.nullable(z.number().int()).optional(),
+  messages: z.array(z.lazy(() => Messages$outboundSchema)),
+  metadata: z.nullable(z.record(z.string())).optional(),
+  model: z.string(),
+  n: z.nullable(z.number().int()).optional(),
+  parallelToolCalls: z.nullable(z.boolean()).optional(),
+  presencePenalty: z.nullable(z.number()).optional(),
+  responseFormat: z.nullable(z.lazy(() => ResponseFormat$outboundSchema))
+    .optional(),
+  seed: z.nullable(z.number().int()).optional(),
+  serviceTier: z.nullable(z.string()).optional(),
+  stop: z.nullable(z.union([z.string(), z.array(z.string())])).optional(),
+  store: z.nullable(z.boolean()).optional(),
+  stream: z.nullable(z.boolean()).optional(),
+  streamOptions: z.nullable(z.lazy(() => StreamOptions$outboundSchema))
+    .optional(),
+  temperature: z.nullable(z.number()).optional(),
+  toolChoice: z.any().optional(),
+  tools: z.nullable(z.array(z.any())).optional(),
+  topLogprobs: z.nullable(z.number().int()).optional(),
+  topP: z.nullable(z.number()).optional(),
+  user: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    frequencyPenalty: "frequency_penalty",
+    functionCall: "function_call",
+    logitBias: "logit_bias",
+    maxCompletionTokens: "max_completion_tokens",
+    maxTokens: "max_tokens",
+    parallelToolCalls: "parallel_tool_calls",
+    presencePenalty: "presence_penalty",
+    responseFormat: "response_format",
+    serviceTier: "service_tier",
+    streamOptions: "stream_options",
+    toolChoice: "tool_choice",
+    topLogprobs: "top_logprobs",
+    topP: "top_p",
+  });
+});
+
+export function chatCompletionRequestToJSON(
+  chatCompletionRequest: ChatCompletionRequest,
+): string {
+  return JSON.stringify(
+    ChatCompletionRequest$outboundSchema.parse(chatCompletionRequest),
+  );
+}

package/src/sdk/models/shared/epcqueryresponse.ts

@@ -1409,7 +1409,7 @@ export type EPCQueryResponseFabric = {
 };
 
 /**
- * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries — so Scottish certificates and DECs are `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
+ * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries. Scottish certificates and DECs are therefore `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
  */
 export const EPCQueryResponseMeesCompliance = {
   Compliant: "compliant",
@@ -1420,7 +1420,7 @@ export const EPCQueryResponseMeesCompliance = {
   Unknown: "unknown",
 } as const;
 /**
- * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries — so Scottish certificates and DECs are `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
+ * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries. Scottish certificates and DECs are therefore `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
  */
 export type EPCQueryResponseMeesCompliance = OpenEnum<
   typeof EPCQueryResponseMeesCompliance
@@ -2383,7 +2383,7 @@ export type Data = {
    */
   lodgementDate: string;
   /**
-   * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries — so Scottish certificates and DECs are `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
+   * Whether the building meets the Minimum Energy Efficiency Standard, worked out from the current rating band, the certificate type and the nation. `compliant` covers bands A to D, `non_compliant` bands F and G, and `at_risk` marks band E as lettable today with no headroom under the expected tightening to C. The standard is SI 2015/962, which covers both domestic and non-domestic private rented property in England and Wales but does not extend to Scotland, and which is assessed on an asset rating rather than the operational rating a Display Energy Certificate carries. Scottish certificates and DECs are therefore `not_applicable`. `exempt` means a registered PRS exemption and appears only on legacy rows; it is never derived from certificate data. `unknown` means there is not enough data to decide.
    */
   meesCompliance: EPCQueryResponseMeesCompliance;
   /**

package/src/sdk/models/shared/geographyarea.ts

@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GeographyArea = {
   /**
-   * The layer as its publisher names it — `lsoa`, `sct_dz`, `nir_dz`. Never carries a vintage.
+   * The layer as its publisher names it, such as `lsoa`, `sct_dz` or `nir_dz`. Never carries a vintage.
    */
   areaType: string;
   /**
@@ -17,7 +17,7 @@ export type GeographyArea = {
    */
   code: string;
   /**
-   * Publisher name. Null where none is published — ONS issues no names for Output Areas — and never unique, so never key on it.
+   * Publisher name. Null where none is published (ONS issues no names for Output Areas). Names are not unique, so never key on one.
    */
   name: string | null;
   /**

package/src/sdk/models/shared/geographyrelatedarea.ts

@@ -9,7 +9,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type GeographyRelatedArea = {
   /**
-   * The layer as its publisher names it — `lsoa`, `sct_dz`, `nir_dz`. Never carries a vintage.
+   * The layer as its publisher names it, such as `lsoa`, `sct_dz` or `nir_dz`. Never carries a vintage.
    */
   areaType: string;
   /**
@@ -25,7 +25,7 @@ export type GeographyRelatedArea = {
    */
   minFit: string;
   /**
-   * Publisher name. Null where none is published — ONS issues no names for Output Areas — and never unique, so never key on it.
+   * Publisher name. Null where none is published (ONS issues no names for Output Areas). Names are not unique, so never key on one.
    */
   name: string | null;
   /**

package/src/sdk/models/shared/historicalvaluation.ts

@@ -8,7 +8,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Bounds either side of `estimatedPrice`.
+ * Lower and upper bounds for the value at that date, in pounds. A wider range means less certainty in the valuation for that date.
  */
 export type ConfidenceInterval = {
   lower: number;
@@ -24,11 +24,11 @@ export type HistoricalValuation = {
    */
   comparablesCount: number;
   /**
-   * How much confidence to place in this valuation, from 0 to 1.
+   * How much confidence to place in this valuation, from 0 to 1, where 1 is the most confident.
    */
   confidence: number;
   /**
-   * Bounds either side of `estimatedPrice`.
+   * Lower and upper bounds for the value at that date, in pounds. A wider range means less certainty in the valuation for that date.
    */
   confidenceInterval: ConfidenceInterval;
   /**

package/src/sdk/models/shared/imagecondition.ts

@@ -0,0 +1,28 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * The state of repair the photographs suggest.
+ */
+export const ImageCondition = {
+  MoveInReady: "move_in_ready",
+  CosmeticallyDated: "cosmetically_dated",
+  RenovationNeeded: "renovation_needed",
+  Derelict: "derelict",
+} as const;
+/**
+ * The state of repair the photographs suggest.
+ */
+export type ImageCondition = OpenEnum<typeof ImageCondition>;
+
+/** @internal */
+export const ImageCondition$inboundSchema: z.ZodType<
+  ImageCondition,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ImageCondition);

package/src/sdk/models/shared/imagedocumentclass.ts

@@ -0,0 +1,32 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * What the image is, rather than what it shows. A `photo` is a photograph of the property or its surroundings; the other values are documents published alongside the photographs.
+ */
+export const ImageDocumentClass = {
+  Photo: "photo",
+  FloorPlan: "floor_plan",
+  EpcChart: "epc_chart",
+  BrochurePage: "brochure_page",
+  SitePlan: "site_plan",
+  Map: "map",
+  AgentBranding: "agent_branding",
+  Other: "other",
+} as const;
+/**
+ * What the image is, rather than what it shows. A `photo` is a photograph of the property or its surroundings; the other values are documents published alongside the photographs.
+ */
+export type ImageDocumentClass = OpenEnum<typeof ImageDocumentClass>;
+
+/** @internal */
+export const ImageDocumentClass$inboundSchema: z.ZodType<
+  ImageDocumentClass,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ImageDocumentClass);

package/src/sdk/models/shared/imagequality.ts

@@ -0,0 +1,22 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+export const ImageQuality = {
+  WatermarkPresent: "watermark_present",
+  VirtuallyStaged: "virtually_staged",
+  EmptyRoom: "empty_room",
+  Furnished: "furnished",
+} as const;
+export type ImageQuality = OpenEnum<typeof ImageQuality>;
+
+/** @internal */
+export const ImageQuality$inboundSchema: z.ZodType<
+  ImageQuality,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ImageQuality);

package/src/sdk/models/shared/imagescene.ts

@@ -0,0 +1,72 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import * as openEnums from "../../types/enums.js";
+import { OpenEnum } from "../../types/enums.js";
+
+/**
+ * The space shown, as a hierarchical key such as `interior.bathroom.ensuite`.
+ */
+export const ImageScene = {
+  Interior: "interior",
+  Exterior: "exterior",
+  OutdoorSpace: "outdoor_space",
+  Communal: "communal",
+  NonProperty: "non_property",
+  InteriorKitchen: "interior.kitchen",
+  InteriorBathroom: "interior.bathroom",
+  InteriorBathroomEnsuite: "interior.bathroom.ensuite",
+  InteriorBathroomShowerRoom: "interior.bathroom.shower_room",
+  InteriorBathroomCloakroom: "interior.bathroom.cloakroom",
+  InteriorBedroom: "interior.bedroom",
+  InteriorLivingRoom: "interior.living_room",
+  InteriorDiningRoom: "interior.dining_room",
+  InteriorKitchenDiner: "interior.kitchen_diner",
+  InteriorKitchenLiving: "interior.kitchen_living",
+  InteriorHallway: "interior.hallway",
+  InteriorLanding: "interior.landing",
+  InteriorStairs: "interior.stairs",
+  InteriorUtilityRoom: "interior.utility_room",
+  InteriorStudy: "interior.study",
+  InteriorConservatory: "interior.conservatory",
+  InteriorPorch: "interior.porch",
+  InteriorBasement: "interior.basement",
+  InteriorAttic: "interior.attic",
+  InteriorDressingRoom: "interior.dressing_room",
+  InteriorStorage: "interior.storage",
+  InteriorGarageInterior: "interior.garage_interior",
+  InteriorGym: "interior.gym",
+  InteriorGamesRoom: "interior.games_room",
+  InteriorLibrary: "interior.library",
+  InteriorWineCellar: "interior.wine_cellar",
+  InteriorWorkshop: "interior.workshop",
+  InteriorSauna: "interior.sauna",
+  InteriorPoolRoom: "interior.pool_room",
+  ExteriorFrontElevation: "exterior.front_elevation",
+  ExteriorRearElevation: "exterior.rear_elevation",
+  ExteriorAerial: "exterior.aerial",
+  ExteriorStreet: "exterior.street",
+  OutdoorSpaceGarden: "outdoor_space.garden",
+  OutdoorSpacePatio: "outdoor_space.patio",
+  OutdoorSpaceTerrace: "outdoor_space.terrace",
+  OutdoorSpaceBalcony: "outdoor_space.balcony",
+  OutdoorSpaceDriveway: "outdoor_space.driveway",
+  OutdoorSpacePool: "outdoor_space.pool",
+  OutdoorSpaceOutbuilding: "outdoor_space.outbuilding",
+  CommunalLobby: "communal.lobby",
+  CommunalCorridor: "communal.corridor",
+  CommunalGarden: "communal.garden",
+} as const;
+/**
+ * The space shown, as a hierarchical key such as `interior.bathroom.ensuite`.
+ */
+export type ImageScene = OpenEnum<typeof ImageScene>;
+
+/** @internal */
+export const ImageScene$inboundSchema: z.ZodType<
+  ImageScene,
+  z.ZodTypeDef,
+  unknown
+> = openEnums.inboundSchema(ImageScene);

package/src/sdk/models/shared/imagescenelabel.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import { ImageScene, ImageScene$inboundSchema } from "./imagescene.js";
+
+export type ImageSceneLabel = {
+  /**
+   * How strongly the image supports this key, from 0 to 1.
+   */
+  confidence?: number | undefined;
+  /**
+   * The space shown, as a hierarchical key such as `interior.bathroom.ensuite`.
+   */
+  key?: ImageScene | undefined;
+};
+
+/** @internal */
+export const ImageSceneLabel$inboundSchema: z.ZodType<
+  ImageSceneLabel,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  confidence: z.number().optional(),
+  key: ImageScene$inboundSchema.optional(),
+});
+
+export function imageSceneLabelFromJSON(
+  jsonString: string,
+): SafeParseResult<ImageSceneLabel, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ImageSceneLabel$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ImageSceneLabel' from JSON`,
+  );
+}