@alien_intelligence/data-api-client 2.3.2 → 2.5.0

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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -82,11 +82,13 @@ export interface 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.
+     * Which index answers the query. Results are one hit per entry whichever answers, 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.
+     * 'auto' (the default) uses the segment path when this tenant's segments index is live and covers its corpus, and the entries index otherwise. query_info.granularity names the one that answered and, when it is 'entry', query_info.granularity_reason says why. Neither is a fallback.
      * 
-     * '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.
+     * 'segment' searches one document per citable segment, which is the whole text, together with the entries index for metadata (an identifier, a court, an author), and returns snippets carrying a page label and an offset into the entry's full content. On a tenant whose segments index is not live it is answered by the entries index, and query_info reports granularity_fallback=true with a fallback_reason. With a sort and a query, the sort orders the 1,000 best-ranked matching entries, not every match; query_info.sort_window_complete says whether every match fitted.
+     * 
+     * '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.
      * @type {string}
      * @memberof KeywordSearchRequest
      */
@@ -116,6 +118,7 @@ export interface KeywordSearchRequest {
  * @export
  */
 export const KeywordSearchRequestGranularityEnum = {
+    Auto: 'auto',
     Entry: 'entry',
     Segment: 'segment'
 } as const;

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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * 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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -55,9 +55,14 @@ export interface KeywordSearchResponse {
     /**
      * Query metadata (query, filters applied, execution time, etc.).
      * 
-     * `granularity` always names the index that actually answered.
+     * `granularity` always names the index that actually answered: 'entry' or 'segment'.
      * 
-     * 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.
+     * A request that asked for granularity='segment' or 'auto' additionally carries `granularity_requested`, `granularity_fallback` and `fallback_reason`.
+     * 
+     * - 'segment': 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` names why and `fallback_detail` spells out what that means for the results.
+     * - 'auto': `granularity_fallback` is always false. When `granularity` reads 'entry', `granularity_reason` names why (a rollout reason such as 'segment_search_disabled', or 'empty_query', 'segments_index_not_ready', 'metadata_filter_too_broad') and `granularity_detail` explains it.
+     * 
+     * A segment-path answer also carries `total_is_exact` and `page_hits_by_source`. With a sort, `sort_scope` is 'best_matches' (the `sort_window` best-ranked matches were sorted; `sort_window_complete` says whether that was every match) or 'all_matches' (an empty query).
      * @type {{ [key: string]: any; }}
      * @memberof KeywordSearchResponse
      */

package/src/src/models/MissingPageRange.ts

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

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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * 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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * 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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * 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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/PageDimensions.ts

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

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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * 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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * 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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/ProcessingResetResponse.ts

@@ -4,7 +4,7 @@
  * Client Data API
  * Client Cluster Data API - Manifest-based storage service
  *
- * The version of the OpenAPI document: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
@@ -45,13 +45,13 @@ export interface ProcessingResetResponse {
      */
     status: EntryStatus;
     /**
-     * The entry's version after the reset. Bumped only when the manifest changed, so a reset of a clean entry leaves it where it was.
+     * The entry's version after the reset. Bumped whenever the reset deleted anything (a manifest section, an object or a vector point), so a reset of a clean entry leaves it where it was.
      * @type {number}
      * @memberof ProcessingResetResponse
      */
     version: number;
     /**
-     * Whether the entry row changed (a manifest section was cleared).
+     * Whether the reset deleted anything (a manifest section, an object or a vector point), and so bumped the version.
      * @type {boolean}
      * @memberof ProcessingResetResponse
      */

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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * 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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * 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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

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: 2.3.2
+ * The version of the OpenAPI document: 2.5.0
  * 
  *
  * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).

package/src/src/models/Segment.ts

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

package/src/src/models/SnippetContext.ts

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

package/src/src/models/Transcription.ts

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

package/src/src/models/TranscriptionDocumentInfo.ts

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

package/src/src/models/TranscriptionPage.ts

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

package/src/src/models/TranscriptionUsage.ts

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

package/src/src/models/TranscriptionWarnings.ts

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

package/src/src/models/UploadFileResponse.ts

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

package/src/src/models/ValidationError.ts

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

package/src/src/models/ValidationErrorLocInner.ts

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

package/src/src/models/VectorSearchRequest.ts

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

package/src/src/models/WebhookEndpointCreate.ts

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

package/src/src/models/WebhookEndpointResponse.ts

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

package/src/src/models/Weight.ts

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

package/src/src/models/WeightListResponse.ts

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

package/src/src/models/WeightResponse.ts

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

package/src/src/models/WeightType.ts

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

package/src/src/runtime.ts

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