@alien_intelligence/data-api-client 1.4.15 → 1.16.2

package/src/src/models/DerivedPageReport.ts

@@ -0,0 +1,137 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.16.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * One source unit the producer had to split, and how far it overshot.
+ * @export
+ * @interface DerivedPageReport
+ */
+export interface DerivedPageReport {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {string}
+     * @memberof DerivedPageReport
+     */
+    reason?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DerivedPageReport
+     */
+    budgetPositions?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DerivedPageReport
+     */
+    sourceIndex?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DerivedPageReport
+     */
+    sourcePositions?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DerivedPageReport
+     */
+    firstPage?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DerivedPageReport
+     */
+    lastPage?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof DerivedPageReport
+     */
+    pageCount?: number | null;
+    /**
+     * Every rule the split actually needed, so a unit that fell back to 'fixed' says so instead of quietly claiming a clean paragraph split.
+     * @type {Array<string>}
+     * @memberof DerivedPageReport
+     */
+    rules?: Array<DerivedPageReportRulesEnum>;
+}
+
+
+/**
+ * @export
+ */
+export const DerivedPageReportRulesEnum = {
+    Paragraph: 'paragraph',
+    TableRow: 'table_row',
+    Line: 'line',
+    Fixed: 'fixed'
+} as const;
+export type DerivedPageReportRulesEnum = typeof DerivedPageReportRulesEnum[keyof typeof DerivedPageReportRulesEnum];
+
+
+/**
+ * Check if a given object implements the DerivedPageReport interface.
+ */
+export function instanceOfDerivedPageReport(value: object): value is DerivedPageReport {
+    return true;
+}
+
+export function DerivedPageReportFromJSON(json: any): DerivedPageReport {
+    return DerivedPageReportFromJSONTyped(json, false);
+}
+
+export function DerivedPageReportFromJSONTyped(json: any, ignoreDiscriminator: boolean): DerivedPageReport {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'reason': json['reason'] == null ? undefined : json['reason'],
+        'budgetPositions': json['budget_positions'] == null ? undefined : json['budget_positions'],
+        'sourceIndex': json['source_index'] == null ? undefined : json['source_index'],
+        'sourcePositions': json['source_positions'] == null ? undefined : json['source_positions'],
+        'firstPage': json['first_page'] == null ? undefined : json['first_page'],
+        'lastPage': json['last_page'] == null ? undefined : json['last_page'],
+        'pageCount': json['page_count'] == null ? undefined : json['page_count'],
+        'rules': json['rules'] == null ? undefined : json['rules'],
+    };
+}
+
+export function DerivedPageReportToJSON(json: any): DerivedPageReport {
+    return DerivedPageReportToJSONTyped(json, false);
+}
+
+export function DerivedPageReportToJSONTyped(value?: DerivedPageReport | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'reason': value['reason'],
+        'budget_positions': value['budgetPositions'],
+        'source_index': value['sourceIndex'],
+        'source_positions': value['sourcePositions'],
+        'first_page': value['firstPage'],
+        'last_page': value['lastPage'],
+        'page_count': value['pageCount'],
+        'rules': value['rules'],
+    };
+}
+

package/src/src/models/EmbeddingProvider.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EmbeddingResponse.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/Entry.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EntryContentResponse.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EntryCreateRequest.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EntryCreateResponse.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EntryManifest.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EntrySearchResponse.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EntrySearchResult.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EntryStatus.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/EntryUpdateRequest.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -57,6 +57,12 @@ export interface EntryUpdateRequest {
      * @memberof EntryUpdateRequest
      */
     errorMessage?: string | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof EntryUpdateRequest
+     */
+    ifVersion?: number | null;
 }
 
 
@@ -83,6 +89,7 @@ export function EntryUpdateRequestFromJSONTyped(json: any, ignoreDiscriminator:
         'status': json['status'] == null ? undefined : EntryStatusFromJSON(json['status']),
         'metadata': json['metadata'] == null ? undefined : json['metadata'],
         'errorMessage': json['error_message'] == null ? undefined : json['error_message'],
+        'ifVersion': json['if_version'] == null ? undefined : json['if_version'],
     };
 }
 
@@ -102,6 +109,7 @@ export function EntryUpdateRequestToJSONTyped(value?: EntryUpdateRequest | null,
         'status': EntryStatusToJSON(value['status']),
         'metadata': value['metadata'],
         'error_message': value['errorMessage'],
+        'if_version': value['ifVersion'],
     };
 }
 

package/src/src/models/EntryWithContent.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/FigureImage.ts

@@ -0,0 +1,126 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.16.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * One figure crop: its id, where it sat on the page, and optionally its bytes.
+ * 
+ * Typed rather than ``dict[str, Any]`` because every part of this shape is a contract
+ * somebody already depends on and nothing was checking: the figure linker resolves
+ * ``id`` with ``img-\d+\.\w+``
+ * (``data-pipelines/alienargo/processors/figure_linker/main.py``), and the bbox is
+ * what makes the crop locatable on the page it came from.
+ * 
+ * **Divergence 1 of the three listed in the module docstring.** The producer
+ * constrains ``id`` only to be non-empty and documents the shape in prose.
+ * An id the linker's regex cannot resolve therefore reaches the linker and is
+ * dropped there, silently, with the figure's markdown reference left dangling - the
+ * failure the global ``img-{N}.{ext}`` renumbering exists to prevent. Refusing it at
+ * the write boundary turns that into a 422 naming the id.
+ * 
+ * The pattern is the consumer's regex, anchored - not a tightened version of it.
+ * Narrowing it further (to ``[A-Za-z0-9]+``, say) would reject ids the linker would
+ * have resolved perfectly well, which trades one silent failure for a loud wrong one.
+ * @export
+ * @interface FigureImage
+ */
+export interface FigureImage {
+    [key: string]: any | any;
+    /**
+     * Figure id, `img-{N}.{ext}` and globally sequential across the document. The figure linker matches on exactly that shape and breaks silently otherwise.
+     * @type {string}
+     * @memberof FigureImage
+     */
+    id: string;
+    /**
+     * 
+     * @type {number}
+     * @memberof FigureImage
+     */
+    topLeftX?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof FigureImage
+     */
+    topLeftY?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof FigureImage
+     */
+    bottomRightX?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof FigureImage
+     */
+    bottomRightY?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof FigureImage
+     */
+    imageBase64?: string | null;
+}
+
+/**
+ * Check if a given object implements the FigureImage interface.
+ */
+export function instanceOfFigureImage(value: object): value is FigureImage {
+    if (!('id' in value) || value['id'] === undefined) return false;
+    return true;
+}
+
+export function FigureImageFromJSON(json: any): FigureImage {
+    return FigureImageFromJSONTyped(json, false);
+}
+
+export function FigureImageFromJSONTyped(json: any, ignoreDiscriminator: boolean): FigureImage {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        'id': json['id'],
+        'topLeftX': json['top_left_x'] == null ? undefined : json['top_left_x'],
+        'topLeftY': json['top_left_y'] == null ? undefined : json['top_left_y'],
+        'bottomRightX': json['bottom_right_x'] == null ? undefined : json['bottom_right_x'],
+        'bottomRightY': json['bottom_right_y'] == null ? undefined : json['bottom_right_y'],
+        'imageBase64': json['image_base64'] == null ? undefined : json['image_base64'],
+    };
+}
+
+export function FigureImageToJSON(json: any): FigureImage {
+    return FigureImageToJSONTyped(json, false);
+}
+
+export function FigureImageToJSONTyped(value?: FigureImage | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'id': value['id'],
+        'top_left_x': value['topLeftX'],
+        'top_left_y': value['topLeftY'],
+        'bottom_right_x': value['bottomRightX'],
+        'bottom_right_y': value['bottomRightY'],
+        'image_base64': value['imageBase64'],
+    };
+}
+

package/src/src/models/FileMetadata.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/GenerateEmbeddingsRequest.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/HTTPValidationError.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/HealthResponse.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/IngestContractUsageResponse.ts

@@ -0,0 +1,96 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.16.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+import type { IngestContractUsageRow } from './IngestContractUsageRow';
+import {
+    IngestContractUsageRowFromJSON,
+    IngestContractUsageRowFromJSONTyped,
+    IngestContractUsageRowToJSON,
+    IngestContractUsageRowToJSONTyped,
+} from './IngestContractUsageRow';
+
+/**
+ * Which ingest shapes this cluster's producers actually use.
+ * 
+ * Read before setting a date for refusing the legacy shape. The tenant is the cluster
+ * itself, so the same query run across clusters gives the per-tenant picture and this
+ * one gives the per-dataset detail within a tenant.
+ * @export
+ * @interface IngestContractUsageResponse
+ */
+export interface IngestContractUsageResponse {
+    /**
+     * The tenant this cluster serves.
+     * @type {string}
+     * @memberof IngestContractUsageResponse
+     */
+    tenantId: string;
+    /**
+     * The tenant's slug.
+     * @type {string}
+     * @memberof IngestContractUsageResponse
+     */
+    tenantSlug: string;
+    /**
+     * One row per dataset and shape. A dataset absent from this list has had no processed content posted to it since counting began.
+     * @type {Array<IngestContractUsageRow>}
+     * @memberof IngestContractUsageResponse
+     */
+    usage: Array<IngestContractUsageRow>;
+}
+
+/**
+ * Check if a given object implements the IngestContractUsageResponse interface.
+ */
+export function instanceOfIngestContractUsageResponse(value: object): value is IngestContractUsageResponse {
+    if (!('tenantId' in value) || value['tenantId'] === undefined) return false;
+    if (!('tenantSlug' in value) || value['tenantSlug'] === undefined) return false;
+    if (!('usage' in value) || value['usage'] === undefined) return false;
+    return true;
+}
+
+export function IngestContractUsageResponseFromJSON(json: any): IngestContractUsageResponse {
+    return IngestContractUsageResponseFromJSONTyped(json, false);
+}
+
+export function IngestContractUsageResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): IngestContractUsageResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'tenantId': json['tenant_id'],
+        'tenantSlug': json['tenant_slug'],
+        'usage': ((json['usage'] as Array<any>).map(IngestContractUsageRowFromJSON)),
+    };
+}
+
+export function IngestContractUsageResponseToJSON(json: any): IngestContractUsageResponse {
+    return IngestContractUsageResponseToJSONTyped(json, false);
+}
+
+export function IngestContractUsageResponseToJSONTyped(value?: IngestContractUsageResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'tenant_id': value['tenantId'],
+        'tenant_slug': value['tenantSlug'],
+        'usage': ((value['usage'] as Array<any>).map(IngestContractUsageRowToJSON)),
+    };
+}
+

package/src/src/models/IngestContractUsageRow.ts

@@ -0,0 +1,102 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.16.2
+ * 
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+
+import { mapValues } from '../runtime';
+/**
+ * How often one dataset has been posted to in one ingest shape.
+ * @export
+ * @interface IngestContractUsageRow
+ */
+export interface IngestContractUsageRow {
+    /**
+     * Dataset the content was posted to.
+     * @type {number}
+     * @memberof IngestContractUsageRow
+     */
+    datasetId: number;
+    /**
+     * 'legacy_text' (no page structure sent), 'transcription' (pages) or 'producer_segments' (offsets).
+     * @type {string}
+     * @memberof IngestContractUsageRow
+     */
+    contentShape: string;
+    /**
+     * Posts counted in this shape.
+     * @type {number}
+     * @memberof IngestContractUsageRow
+     */
+    postCount: number;
+    /**
+     * First post counted in this shape.
+     * @type {Date}
+     * @memberof IngestContractUsageRow
+     */
+    firstSeenAt: Date;
+    /**
+     * Most recent post counted in this shape.
+     * @type {Date}
+     * @memberof IngestContractUsageRow
+     */
+    lastSeenAt: Date;
+}
+
+/**
+ * Check if a given object implements the IngestContractUsageRow interface.
+ */
+export function instanceOfIngestContractUsageRow(value: object): value is IngestContractUsageRow {
+    if (!('datasetId' in value) || value['datasetId'] === undefined) return false;
+    if (!('contentShape' in value) || value['contentShape'] === undefined) return false;
+    if (!('postCount' in value) || value['postCount'] === undefined) return false;
+    if (!('firstSeenAt' in value) || value['firstSeenAt'] === undefined) return false;
+    if (!('lastSeenAt' in value) || value['lastSeenAt'] === undefined) return false;
+    return true;
+}
+
+export function IngestContractUsageRowFromJSON(json: any): IngestContractUsageRow {
+    return IngestContractUsageRowFromJSONTyped(json, false);
+}
+
+export function IngestContractUsageRowFromJSONTyped(json: any, ignoreDiscriminator: boolean): IngestContractUsageRow {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'datasetId': json['dataset_id'],
+        'contentShape': json['content_shape'],
+        'postCount': json['post_count'],
+        'firstSeenAt': (new Date(json['first_seen_at'])),
+        'lastSeenAt': (new Date(json['last_seen_at'])),
+    };
+}
+
+export function IngestContractUsageRowToJSON(json: any): IngestContractUsageRow {
+    return IngestContractUsageRowToJSONTyped(json, false);
+}
+
+export function IngestContractUsageRowToJSONTyped(value?: IngestContractUsageRow | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'dataset_id': value['datasetId'],
+        'content_shape': value['contentShape'],
+        'post_count': value['postCount'],
+        'first_seen_at': ((value['firstSeenAt']).toISOString()),
+        'last_seen_at': ((value['lastSeenAt']).toISOString()),
+    };
+}
+

package/src/src/models/KeywordSearchHit.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 1.4.15
+ * The version of the OpenAPI document: 1.16.2
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).