@alien_intelligence/data-api-client 1.4.15 → 1.16.2

package/src/src/models/KeywordSearchRequest.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).
@@ -81,6 +81,16 @@ export interface KeywordSearchRequest {
      * @memberof KeywordSearchRequest
      */
     sort?: Array<string> | null;
+    /**
+     * Which index to search. 'entry' searches one document per entry, whose text_content Meilisearch caps at 65,535 positions - so a long document is only searchable near its start. 'segment' searches one document per citable segment, which is the whole text, and returns snippets carrying a page label and an offset into the entry's full content. Results are grouped back to one hit per entry either way, so the response shape is identical.
+     * 
+     * 'entry' is the default while segment backfills are still running: an entry whose segments have not been written yet is absent from the segments index, and defaulting to it would silently narrow the corpus a query can reach.
+     * 
+     * 'segment' is gated per tenant. On a tenant whose segments index is not live the request is answered by the entries index rather than by an empty one, and query_info reports granularity_fallback=true with a fallback_reason.
+     * @type {string}
+     * @memberof KeywordSearchRequest
+     */
+    granularity?: KeywordSearchRequestGranularityEnum;
     /**
      * Context extraction mode: 'smart' tries sentence→paragraph→section→crop
      * @type {string}
@@ -102,6 +112,15 @@ export interface KeywordSearchRequest {
 }
 
 
+/**
+ * @export
+ */
+export const KeywordSearchRequestGranularityEnum = {
+    Entry: 'entry',
+    Segment: 'segment'
+} as const;
+export type KeywordSearchRequestGranularityEnum = typeof KeywordSearchRequestGranularityEnum[keyof typeof KeywordSearchRequestGranularityEnum];
+
 /**
  * @export
  */
@@ -141,6 +160,7 @@ export function KeywordSearchRequestFromJSONTyped(json: any, ignoreDiscriminator
         'tags': json['tags'] == null ? undefined : json['tags'],
         'metadataFilters': json['metadata_filters'] == null ? undefined : (mapValues(json['metadata_filters'], KeywordSearchRequestMetadataFiltersValueFromJSON)),
         'sort': json['sort'] == null ? undefined : json['sort'],
+        'granularity': json['granularity'] == null ? undefined : json['granularity'],
         'contextMode': json['context_mode'] == null ? undefined : json['context_mode'],
         'maxSnippets': json['max_snippets'] == null ? undefined : json['max_snippets'],
         'maxCropLength': json['max_crop_length'] == null ? undefined : json['max_crop_length'],
@@ -167,6 +187,7 @@ export function KeywordSearchRequestToJSONTyped(value?: KeywordSearchRequest | n
         'tags': value['tags'],
         'metadata_filters': value['metadataFilters'] == null ? undefined : (mapValues(value['metadataFilters'], KeywordSearchRequestMetadataFiltersValueToJSON)),
         'sort': value['sort'],
+        'granularity': value['granularity'],
         'context_mode': value['contextMode'],
         'max_snippets': value['maxSnippets'],
         'max_crop_length': value['maxCropLength'],

package/src/src/models/KeywordSearchRequestMetadataFiltersValue.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/KeywordSearchResponse.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).
@@ -40,7 +40,11 @@ export interface KeywordSearchResponse {
      */
     total: number;
     /**
-     * Query metadata (query, filters applied, execution time, etc.)
+     * Query metadata (query, filters applied, execution time, etc.).
+     * 
+     * `granularity` always names the index that actually answered.
+     * 
+     * A request that asked for granularity='segment' additionally carries `granularity_requested`, `granularity_fallback` and `fallback_reason`. When `granularity_fallback` is true the results are entry-level, not segment-level: the tenant's segments index is not live, `granularity` reads 'entry', `fallback_reason` is one of 'segment_search_disabled', 'segments_index_empty' or 'segments_index_unavailable', and `fallback_detail` spells out what that means for the results.
      * @type {{ [key: string]: any; }}
      * @memberof KeywordSearchResponse
      */

package/src/src/models/MissingPageRange.ts

@@ -0,0 +1,100 @@
+/* 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';
+/**
+ * A run of source pages that did not come back, and why.
+ * @export
+ * @interface MissingPageRange
+ */
+export interface MissingPageRange {
+    [key: string]: any | any;
+    /**
+     * 
+     * @type {number}
+     * @memberof MissingPageRange
+     */
+    firstPage?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof MissingPageRange
+     */
+    lastPage?: number | null;
+    /**
+     * 
+     * @type {number}
+     * @memberof MissingPageRange
+     */
+    pageCount?: number | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MissingPageRange
+     */
+    code?: string | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof MissingPageRange
+     */
+    reason?: string | null;
+}
+
+/**
+ * Check if a given object implements the MissingPageRange interface.
+ */
+export function instanceOfMissingPageRange(value: object): value is MissingPageRange {
+    return true;
+}
+
+export function MissingPageRangeFromJSON(json: any): MissingPageRange {
+    return MissingPageRangeFromJSONTyped(json, false);
+}
+
+export function MissingPageRangeFromJSONTyped(json: any, ignoreDiscriminator: boolean): MissingPageRange {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+            ...json,
+        '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'],
+        'code': json['code'] == null ? undefined : json['code'],
+        'reason': json['reason'] == null ? undefined : json['reason'],
+    };
+}
+
+export function MissingPageRangeToJSON(json: any): MissingPageRange {
+    return MissingPageRangeToJSONTyped(json, false);
+}
+
+export function MissingPageRangeToJSONTyped(value?: MissingPageRange | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+            ...value,
+        'first_page': value['firstPage'],
+        'last_page': value['lastPage'],
+        'page_count': value['pageCount'],
+        'code': value['code'],
+        'reason': value['reason'],
+    };
+}
+

package/src/src/models/ModelInfo.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/MoveEntryRequest.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/MoveEntryResponse.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/OriginalManifest.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/PageDimensions.ts

@@ -0,0 +1,75 @@
+/* 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';
+/**
+ * Rendered page size in pixels, the space a figure bbox sits in.
+ * @export
+ * @interface PageDimensions
+ */
+export interface PageDimensions {
+    /**
+     * Rendered page width in pixels.
+     * @type {number}
+     * @memberof PageDimensions
+     */
+    width: number;
+    /**
+     * Rendered page height in pixels.
+     * @type {number}
+     * @memberof PageDimensions
+     */
+    height: number;
+}
+
+/**
+ * Check if a given object implements the PageDimensions interface.
+ */
+export function instanceOfPageDimensions(value: object): value is PageDimensions {
+    if (!('width' in value) || value['width'] === undefined) return false;
+    if (!('height' in value) || value['height'] === undefined) return false;
+    return true;
+}
+
+export function PageDimensionsFromJSON(json: any): PageDimensions {
+    return PageDimensionsFromJSONTyped(json, false);
+}
+
+export function PageDimensionsFromJSONTyped(json: any, ignoreDiscriminator: boolean): PageDimensions {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'width': json['width'],
+        'height': json['height'],
+    };
+}
+
+export function PageDimensionsToJSON(json: any): PageDimensions {
+    return PageDimensionsToJSONTyped(json, false);
+}
+
+export function PageDimensionsToJSONTyped(value?: PageDimensions | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'width': value['width'],
+        'height': value['height'],
+    };
+}
+

package/src/src/models/PipelineStepConfig.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/PresetListResponse.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/ProcessedManifest.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).
@@ -20,9 +20,20 @@ import {
     FileMetadataToJSON,
     FileMetadataToJSONTyped,
 } from './FileMetadata';
+import type { Segment } from './Segment';
+import {
+    SegmentFromJSON,
+    SegmentFromJSONTyped,
+    SegmentToJSON,
+    SegmentToJSONTyped,
+} from './Segment';
 
 /**
- * Processed content section of entry manifest
+ * Processed content section of entry manifest.
+ * 
+ * Carries the segment view of the processed text: where each citable unit begins
+ * and ends in ``content.json``'s ``text``. Offsets only - see ``schemas/segment.py``
+ * for why the text is not duplicated here.
  * @export
  * @interface ProcessedManifest
  */
@@ -40,11 +51,23 @@ export interface ProcessedManifest {
      */
     size?: number | null;
     /**
-     * Quick stats for UI (text_length, chunk_count, etc.)
+     * Quick stats for UI (text_length, chunk_count, figure_count, segment_count). segment_count is derived from segments and kept in step by this model.
      * @type {{ [key: string]: any; }}
      * @memberof ProcessedManifest
      */
     fieldsSummary?: { [key: string]: any; };
+    /**
+     * 
+     * @type {Array<Segment>}
+     * @memberof ProcessedManifest
+     */
+    segments?: Array<Segment> | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof ProcessedManifest
+     */
+    segmentsSource?: ProcessedManifestSegmentsSourceEnum | null;
     /**
      * 
      * @type {Date}
@@ -59,6 +82,18 @@ export interface ProcessedManifest {
     additionalFiles?: Array<FileMetadata> | null;
 }
 
+
+/**
+ * @export
+ */
+export const ProcessedManifestSegmentsSourceEnum = {
+    ProducerPages: 'producer_pages',
+    DerivedMarkdown: 'derived_markdown',
+    DerivedFixed: 'derived_fixed'
+} as const;
+export type ProcessedManifestSegmentsSourceEnum = typeof ProcessedManifestSegmentsSourceEnum[keyof typeof ProcessedManifestSegmentsSourceEnum];
+
+
 /**
  * Check if a given object implements the ProcessedManifest interface.
  */
@@ -79,6 +114,8 @@ export function ProcessedManifestFromJSONTyped(json: any, ignoreDiscriminator: b
         'contentKey': json['content_key'] == null ? undefined : json['content_key'],
         'size': json['size'] == null ? undefined : json['size'],
         'fieldsSummary': json['fields_summary'] == null ? undefined : json['fields_summary'],
+        'segments': json['segments'] == null ? undefined : ((json['segments'] as Array<any>).map(SegmentFromJSON)),
+        'segmentsSource': json['segments_source'] == null ? undefined : json['segments_source'],
         'completedAt': json['completed_at'] == null ? undefined : (new Date(json['completed_at'])),
         'additionalFiles': json['additional_files'] == null ? undefined : ((json['additional_files'] as Array<any>).map(FileMetadataFromJSON)),
     };
@@ -98,6 +135,8 @@ export function ProcessedManifestToJSONTyped(value?: ProcessedManifest | null, i
         'content_key': value['contentKey'],
         'size': value['size'],
         'fields_summary': value['fieldsSummary'],
+        'segments': value['segments'] == null ? undefined : ((value['segments'] as Array<any>).map(SegmentToJSON)),
+        'segments_source': value['segmentsSource'],
         'completed_at': value['completedAt'] == null ? undefined : ((value['completedAt'] as any).toISOString()),
         'additional_files': value['additionalFiles'] == null ? undefined : ((value['additionalFiles'] as Array<any>).map(FileMetadataToJSON)),
     };

package/src/src/models/ProcessingManifest.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/ReconcileSchemaFieldsResponse.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/RetryFailedWebhooksResponse.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/SaveProcessedContentRequest.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).
@@ -13,8 +13,42 @@
  */
 
 import { mapValues } from '../runtime';
+import type { Transcription } from './Transcription';
+import {
+    TranscriptionFromJSON,
+    TranscriptionFromJSONTyped,
+    TranscriptionToJSON,
+    TranscriptionToJSONTyped,
+} from './Transcription';
+import type { Segment } from './Segment';
+import {
+    SegmentFromJSON,
+    SegmentFromJSONTyped,
+    SegmentToJSON,
+    SegmentToJSONTyped,
+} from './Segment';
+
 /**
- * Request to save processed content
+ * Request to save processed content.
+ * 
+ * ``content`` is the payload stored in ``content.json`` and is deliberately still
+ * free-form: producers put their own fields there and always have. Its ``text`` key is
+ * the one part this service now reads, because it is the canonical text every segment
+ * offset is expressed against.
+ * 
+ * A producer may say where its pages are in either of two ways, and the difference
+ * matters:
+ * 
+ * - ``segments`` - offsets computed against ``content["text"]`` itself. **This is the
+ *   shape to send if anything rewrote the text after transcription.** The figure linker
+ *   does exactly that, and it shifts every offset past the first figure.
+ * - ``transcription`` - the pages themselves, from which offsets are read off the page
+ *   join. Only correct when ``content["text"]`` *is* that join; the write boundary
+ *   checks it and refuses the post otherwise rather than storing offsets into a string
+ *   that no longer exists.
+ * 
+ * Sending neither is the legacy shape. It is still accepted, the boundaries are derived
+ * from the markdown, and the response says so.
  * @export
  * @interface SaveProcessedContentRequest
  */
@@ -31,6 +65,18 @@ export interface SaveProcessedContentRequest {
      * @memberof SaveProcessedContentRequest
      */
     additionalFiles?: { [key: string]: string; } | null;
+    /**
+     * 
+     * @type {Transcription}
+     * @memberof SaveProcessedContentRequest
+     */
+    transcription?: Transcription | null;
+    /**
+     * 
+     * @type {Array<Segment>}
+     * @memberof SaveProcessedContentRequest
+     */
+    segments?: Array<Segment> | null;
 }
 
 /**
@@ -53,6 +99,8 @@ export function SaveProcessedContentRequestFromJSONTyped(json: any, ignoreDiscri
         
         'content': json['content'],
         'additionalFiles': json['additional_files'] == null ? undefined : json['additional_files'],
+        'transcription': json['transcription'] == null ? undefined : TranscriptionFromJSON(json['transcription']),
+        'segments': json['segments'] == null ? undefined : ((json['segments'] as Array<any>).map(SegmentFromJSON)),
     };
 }
 
@@ -69,6 +117,8 @@ export function SaveProcessedContentRequestToJSONTyped(value?: SaveProcessedCont
         
         'content': value['content'],
         'additional_files': value['additionalFiles'],
+        'transcription': TranscriptionToJSON(value['transcription']),
+        'segments': value['segments'] == null ? undefined : ((value['segments'] as Array<any>).map(SegmentToJSON)),
     };
 }
 

package/src/src/models/SaveProcessedContentResponse.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).
@@ -13,6 +13,13 @@
  */
 
 import { mapValues } from '../runtime';
+import type { DeprecationNotice } from './DeprecationNotice';
+import {
+    DeprecationNoticeFromJSON,
+    DeprecationNoticeFromJSONTyped,
+    DeprecationNoticeToJSON,
+    DeprecationNoticeToJSONTyped,
+} from './DeprecationNotice';
 import type { EntryManifest } from './EntryManifest';
 import {
     EntryManifestFromJSON,
@@ -45,8 +52,38 @@ export interface SaveProcessedContentResponse {
      * @memberof SaveProcessedContentResponse
      */
     success?: boolean;
+    /**
+     * 
+     * @type {string}
+     * @memberof SaveProcessedContentResponse
+     */
+    segmentsSource?: SaveProcessedContentResponseSegmentsSourceEnum | null;
+    /**
+     * Segments stored for this entry.
+     * @type {number}
+     * @memberof SaveProcessedContentResponse
+     */
+    segmentCount?: number;
+    /**
+     * 
+     * @type {DeprecationNotice}
+     * @memberof SaveProcessedContentResponse
+     */
+    deprecation?: DeprecationNotice | null;
 }
 
+
+/**
+ * @export
+ */
+export const SaveProcessedContentResponseSegmentsSourceEnum = {
+    ProducerPages: 'producer_pages',
+    DerivedMarkdown: 'derived_markdown',
+    DerivedFixed: 'derived_fixed'
+} as const;
+export type SaveProcessedContentResponseSegmentsSourceEnum = typeof SaveProcessedContentResponseSegmentsSourceEnum[keyof typeof SaveProcessedContentResponseSegmentsSourceEnum];
+
+
 /**
  * Check if a given object implements the SaveProcessedContentResponse interface.
  */
@@ -69,6 +106,9 @@ export function SaveProcessedContentResponseFromJSONTyped(json: any, ignoreDiscr
         'entryId': json['entry_id'],
         'manifest': EntryManifestFromJSON(json['manifest']),
         'success': json['success'] == null ? undefined : json['success'],
+        'segmentsSource': json['segments_source'] == null ? undefined : json['segments_source'],
+        'segmentCount': json['segment_count'] == null ? undefined : json['segment_count'],
+        'deprecation': json['deprecation'] == null ? undefined : DeprecationNoticeFromJSON(json['deprecation']),
     };
 }
 
@@ -86,6 +126,9 @@ export function SaveProcessedContentResponseToJSONTyped(value?: SaveProcessedCon
         'entry_id': value['entryId'],
         'manifest': EntryManifestToJSON(value['manifest']),
         'success': value['success'],
+        'segments_source': value['segmentsSource'],
+        'segment_count': value['segmentCount'],
+        'deprecation': DeprecationNoticeToJSON(value['deprecation']),
     };
 }
 

package/src/src/models/SearchSnippet.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).