@alien_intelligence/data-api-client 1.2.5

package/src/models/KeywordSearchHit.ts

@@ -0,0 +1,166 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * 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 { EntryPreview } from './EntryPreview';
+import {
+    EntryPreviewFromJSON,
+    EntryPreviewFromJSONTyped,
+    EntryPreviewToJSON,
+    EntryPreviewToJSONTyped,
+} from './EntryPreview';
+import type { SearchSnippet } from './SearchSnippet';
+import {
+    SearchSnippetFromJSON,
+    SearchSnippetFromJSONTyped,
+    SearchSnippetToJSON,
+    SearchSnippetToJSONTyped,
+} from './SearchSnippet';
+
+/**
+ * Single keyword search result with contextual snippets.
+ * @export
+ * @interface KeywordSearchHit
+ */
+export interface KeywordSearchHit {
+    /**
+     * Entry ID
+     * @type {number}
+     * @memberof KeywordSearchHit
+     */
+    entryId: number;
+    /**
+     * Dataset ID
+     * @type {number}
+     * @memberof KeywordSearchHit
+     */
+    datasetId: number;
+    /**
+     * Entry name
+     * @type {string}
+     * @memberof KeywordSearchHit
+     */
+    name: string;
+    /**
+     * Document title
+     * @type {string}
+     * @memberof KeywordSearchHit
+     */
+    title: string;
+    /**
+     * Document description
+     * @type {string}
+     * @memberof KeywordSearchHit
+     */
+    description: string;
+    /**
+     * MeiliSearch ranking score (0.0-1.0)
+     * @type {number}
+     * @memberof KeywordSearchHit
+     */
+    score: number;
+    /**
+     * Contextual snippets around matches
+     * @type {Array<SearchSnippet>}
+     * @memberof KeywordSearchHit
+     */
+    snippets?: Array<SearchSnippet>;
+    /**
+     * Total number of matches in document
+     * @type {number}
+     * @memberof KeywordSearchHit
+     */
+    matchCount?: number;
+    /**
+     * True if more matches exist beyond max_snippets
+     * @type {boolean}
+     * @memberof KeywordSearchHit
+     */
+    hasMore?: boolean;
+    /**
+     * Lightweight entry metadata preview
+     * @type {EntryPreview}
+     * @memberof KeywordSearchHit
+     */
+    preview?: EntryPreview;
+    /**
+     * Additional metadata (mime_type, status, tags, created_at, etc.)
+     * @type {{ [key: string]: any; }}
+     * @memberof KeywordSearchHit
+     */
+    metadata?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the KeywordSearchHit interface.
+ */
+export function instanceOfKeywordSearchHit(value: object): value is KeywordSearchHit {
+    if (!('entryId' in value) || value['entryId'] === undefined) return false;
+    if (!('datasetId' in value) || value['datasetId'] === undefined) return false;
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('title' in value) || value['title'] === undefined) return false;
+    if (!('description' in value) || value['description'] === undefined) return false;
+    if (!('score' in value) || value['score'] === undefined) return false;
+    return true;
+}
+
+export function KeywordSearchHitFromJSON(json: any): KeywordSearchHit {
+    return KeywordSearchHitFromJSONTyped(json, false);
+}
+
+export function KeywordSearchHitFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeywordSearchHit {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'entryId': json['entry_id'],
+        'datasetId': json['dataset_id'],
+        'name': json['name'],
+        'title': json['title'],
+        'description': json['description'],
+        'score': json['score'],
+        'snippets': json['snippets'] == null ? undefined : ((json['snippets'] as Array<any>).map(SearchSnippetFromJSON)),
+        'matchCount': json['match_count'] == null ? undefined : json['match_count'],
+        'hasMore': json['has_more'] == null ? undefined : json['has_more'],
+        'preview': json['preview'] == null ? undefined : EntryPreviewFromJSON(json['preview']),
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+
+export function KeywordSearchHitToJSON(json: any): KeywordSearchHit {
+    return KeywordSearchHitToJSONTyped(json, false);
+}
+
+export function KeywordSearchHitToJSONTyped(value?: KeywordSearchHit | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'entry_id': value['entryId'],
+        'dataset_id': value['datasetId'],
+        'name': value['name'],
+        'title': value['title'],
+        'description': value['description'],
+        'score': value['score'],
+        'snippets': value['snippets'] == null ? undefined : ((value['snippets'] as Array<any>).map(SearchSnippetToJSON)),
+        'match_count': value['matchCount'],
+        'has_more': value['hasMore'],
+        'preview': EntryPreviewToJSON(value['preview']),
+        'metadata': value['metadata'],
+    };
+}
+

package/src/models/KeywordSearchRequest.ts

@@ -0,0 +1,159 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * 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';
+/**
+ * Request schema for keyword/faceted search using Meilisearch.
+ * @export
+ * @interface KeywordSearchRequest
+ */
+export interface KeywordSearchRequest {
+    /**
+     * Search query string (can be empty for filtering only)
+     * @type {string}
+     * @memberof KeywordSearchRequest
+     */
+    query: string;
+    /**
+     * Maximum number of results to return
+     * @type {number}
+     * @memberof KeywordSearchRequest
+     */
+    limit?: number;
+    /**
+     * Number of results to skip (for pagination)
+     * @type {number}
+     * @memberof KeywordSearchRequest
+     */
+    offset?: number;
+    /**
+     * 
+     * @type {Array<number>}
+     * @memberof KeywordSearchRequest
+     */
+    datasetIds?: Array<number> | null;
+    /**
+     * 
+     * @type {string}
+     * @memberof KeywordSearchRequest
+     */
+    status?: string | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof KeywordSearchRequest
+     */
+    mimeTypes?: Array<string> | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof KeywordSearchRequest
+     */
+    tags?: Array<string> | null;
+    /**
+     * 
+     * @type {Array<string>}
+     * @memberof KeywordSearchRequest
+     */
+    sort?: Array<string> | null;
+    /**
+     * Context extraction mode: 'smart' tries sentence→paragraph→section→crop
+     * @type {string}
+     * @memberof KeywordSearchRequest
+     */
+    contextMode?: KeywordSearchRequestContextModeEnum;
+    /**
+     * Maximum number of snippets to return per result
+     * @type {number}
+     * @memberof KeywordSearchRequest
+     */
+    maxSnippets?: number;
+    /**
+     * Maximum length in characters for cropped snippets (if section/paragraph too long)
+     * @type {number}
+     * @memberof KeywordSearchRequest
+     */
+    maxCropLength?: number;
+}
+
+
+/**
+ * @export
+ */
+export const KeywordSearchRequestContextModeEnum = {
+    Sentence: 'sentence',
+    Paragraph: 'paragraph',
+    Section: 'section',
+    Smart: 'smart'
+} as const;
+export type KeywordSearchRequestContextModeEnum = typeof KeywordSearchRequestContextModeEnum[keyof typeof KeywordSearchRequestContextModeEnum];
+
+
+/**
+ * Check if a given object implements the KeywordSearchRequest interface.
+ */
+export function instanceOfKeywordSearchRequest(value: object): value is KeywordSearchRequest {
+    if (!('query' in value) || value['query'] === undefined) return false;
+    return true;
+}
+
+export function KeywordSearchRequestFromJSON(json: any): KeywordSearchRequest {
+    return KeywordSearchRequestFromJSONTyped(json, false);
+}
+
+export function KeywordSearchRequestFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeywordSearchRequest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'query': json['query'],
+        'limit': json['limit'] == null ? undefined : json['limit'],
+        'offset': json['offset'] == null ? undefined : json['offset'],
+        'datasetIds': json['dataset_ids'] == null ? undefined : json['dataset_ids'],
+        'status': json['status'] == null ? undefined : json['status'],
+        'mimeTypes': json['mime_types'] == null ? undefined : json['mime_types'],
+        'tags': json['tags'] == null ? undefined : json['tags'],
+        'sort': json['sort'] == null ? undefined : json['sort'],
+        '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'],
+    };
+}
+
+export function KeywordSearchRequestToJSON(json: any): KeywordSearchRequest {
+    return KeywordSearchRequestToJSONTyped(json, false);
+}
+
+export function KeywordSearchRequestToJSONTyped(value?: KeywordSearchRequest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'query': value['query'],
+        'limit': value['limit'],
+        'offset': value['offset'],
+        'dataset_ids': value['datasetIds'],
+        'status': value['status'],
+        'mime_types': value['mimeTypes'],
+        'tags': value['tags'],
+        'sort': value['sort'],
+        'context_mode': value['contextMode'],
+        'max_snippets': value['maxSnippets'],
+        'max_crop_length': value['maxCropLength'],
+    };
+}
+

package/src/models/KeywordSearchResponse.ts

@@ -0,0 +1,91 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * 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 { KeywordSearchHit } from './KeywordSearchHit';
+import {
+    KeywordSearchHitFromJSON,
+    KeywordSearchHitFromJSONTyped,
+    KeywordSearchHitToJSON,
+    KeywordSearchHitToJSONTyped,
+} from './KeywordSearchHit';
+
+/**
+ * Response schema for keyword/faceted search.
+ * @export
+ * @interface KeywordSearchResponse
+ */
+export interface KeywordSearchResponse {
+    /**
+     * List of matching documents
+     * @type {Array<KeywordSearchHit>}
+     * @memberof KeywordSearchResponse
+     */
+    results: Array<KeywordSearchHit>;
+    /**
+     * Estimated total number of matching documents
+     * @type {number}
+     * @memberof KeywordSearchResponse
+     */
+    total: number;
+    /**
+     * Query metadata (query, filters applied, execution time, etc.)
+     * @type {{ [key: string]: any; }}
+     * @memberof KeywordSearchResponse
+     */
+    queryInfo?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the KeywordSearchResponse interface.
+ */
+export function instanceOfKeywordSearchResponse(value: object): value is KeywordSearchResponse {
+    if (!('results' in value) || value['results'] === undefined) return false;
+    if (!('total' in value) || value['total'] === undefined) return false;
+    return true;
+}
+
+export function KeywordSearchResponseFromJSON(json: any): KeywordSearchResponse {
+    return KeywordSearchResponseFromJSONTyped(json, false);
+}
+
+export function KeywordSearchResponseFromJSONTyped(json: any, ignoreDiscriminator: boolean): KeywordSearchResponse {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'results': ((json['results'] as Array<any>).map(KeywordSearchHitFromJSON)),
+        'total': json['total'],
+        'queryInfo': json['query_info'] == null ? undefined : json['query_info'],
+    };
+}
+
+export function KeywordSearchResponseToJSON(json: any): KeywordSearchResponse {
+    return KeywordSearchResponseToJSONTyped(json, false);
+}
+
+export function KeywordSearchResponseToJSONTyped(value?: KeywordSearchResponse | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'results': ((value['results'] as Array<any>).map(KeywordSearchHitToJSON)),
+        'total': value['total'],
+        'query_info': value['queryInfo'],
+    };
+}
+

package/src/models/ModelInfo.ts

@@ -0,0 +1,103 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * 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 { EmbeddingProvider } from './EmbeddingProvider';
+import {
+    EmbeddingProviderFromJSON,
+    EmbeddingProviderFromJSONTyped,
+    EmbeddingProviderToJSON,
+    EmbeddingProviderToJSONTyped,
+} from './EmbeddingProvider';
+
+/**
+ * Information about an embedding model
+ * @export
+ * @interface ModelInfo
+ */
+export interface ModelInfo {
+    /**
+     * Model name
+     * @type {string}
+     * @memberof ModelInfo
+     */
+    name: string;
+    /**
+     * Provider
+     * @type {EmbeddingProvider}
+     * @memberof ModelInfo
+     */
+    provider: EmbeddingProvider;
+    /**
+     * Vector dimensions
+     * @type {number}
+     * @memberof ModelInfo
+     */
+    dimensions: number;
+    /**
+     * Maximum input tokens
+     * @type {number}
+     * @memberof ModelInfo
+     */
+    maxTokens: number;
+}
+
+
+
+/**
+ * Check if a given object implements the ModelInfo interface.
+ */
+export function instanceOfModelInfo(value: object): value is ModelInfo {
+    if (!('name' in value) || value['name'] === undefined) return false;
+    if (!('provider' in value) || value['provider'] === undefined) return false;
+    if (!('dimensions' in value) || value['dimensions'] === undefined) return false;
+    if (!('maxTokens' in value) || value['maxTokens'] === undefined) return false;
+    return true;
+}
+
+export function ModelInfoFromJSON(json: any): ModelInfo {
+    return ModelInfoFromJSONTyped(json, false);
+}
+
+export function ModelInfoFromJSONTyped(json: any, ignoreDiscriminator: boolean): ModelInfo {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'name': json['name'],
+        'provider': EmbeddingProviderFromJSON(json['provider']),
+        'dimensions': json['dimensions'],
+        'maxTokens': json['max_tokens'],
+    };
+}
+
+export function ModelInfoToJSON(json: any): ModelInfo {
+    return ModelInfoToJSONTyped(json, false);
+}
+
+export function ModelInfoToJSONTyped(value?: ModelInfo | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'name': value['name'],
+        'provider': EmbeddingProviderToJSON(value['provider']),
+        'dimensions': value['dimensions'],
+        'max_tokens': value['maxTokens'],
+    };
+}
+

package/src/models/OriginalManifest.ts

@@ -0,0 +1,81 @@
+/* tslint:disable */
+/* eslint-disable */
+/**
+ * Client Data API
+ * Client Cluster Data API - Manifest-based storage service
+ *
+ * The version of the OpenAPI document: 1.0.0
+ * 
+ *
+ * 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 { FileMetadata } from './FileMetadata';
+import {
+    FileMetadataFromJSON,
+    FileMetadataFromJSONTyped,
+    FileMetadataToJSON,
+    FileMetadataToJSONTyped,
+} from './FileMetadata';
+
+/**
+ * Original files section of entry manifest
+ * @export
+ * @interface OriginalManifest
+ */
+export interface OriginalManifest {
+    /**
+     * List of original files
+     * @type {Array<FileMetadata>}
+     * @memberof OriginalManifest
+     */
+    files?: Array<FileMetadata>;
+    /**
+     * Original metadata (title, author, etc.)
+     * @type {{ [key: string]: any; }}
+     * @memberof OriginalManifest
+     */
+    metadata?: { [key: string]: any; };
+}
+
+/**
+ * Check if a given object implements the OriginalManifest interface.
+ */
+export function instanceOfOriginalManifest(value: object): value is OriginalManifest {
+    return true;
+}
+
+export function OriginalManifestFromJSON(json: any): OriginalManifest {
+    return OriginalManifestFromJSONTyped(json, false);
+}
+
+export function OriginalManifestFromJSONTyped(json: any, ignoreDiscriminator: boolean): OriginalManifest {
+    if (json == null) {
+        return json;
+    }
+    return {
+        
+        'files': json['files'] == null ? undefined : ((json['files'] as Array<any>).map(FileMetadataFromJSON)),
+        'metadata': json['metadata'] == null ? undefined : json['metadata'],
+    };
+}
+
+export function OriginalManifestToJSON(json: any): OriginalManifest {
+    return OriginalManifestToJSONTyped(json, false);
+}
+
+export function OriginalManifestToJSONTyped(value?: OriginalManifest | null, ignoreDiscriminator: boolean = false): any {
+    if (value == null) {
+        return value;
+    }
+
+    return {
+        
+        'files': value['files'] == null ? undefined : ((value['files'] as Array<any>).map(FileMetadataToJSON)),
+        'metadata': value['metadata'],
+    };
+}
+