sarvamai 1.1.12 → 1.1.13

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/dist/cjs/BaseClient.js +2 -2
  2. package/dist/cjs/api/resources/docAi/client/Client.d.ts +78 -8
  3. package/dist/cjs/api/resources/docAi/client/Client.js +233 -12
  4. package/dist/cjs/api/resources/docAi/client/requests/DocAiClassifyRequest.d.ts +17 -0
  5. package/dist/cjs/api/resources/docAi/client/requests/DocAiExtractRequest.d.ts +1 -1
  6. package/dist/cjs/api/resources/docAi/client/requests/DocAiGetResultsRequest.d.ts +8 -0
  7. package/dist/cjs/api/resources/docAi/client/requests/{DocAiDigitiseRequest.d.ts → DocAiParseRequest.d.ts} +4 -4
  8. package/dist/cjs/api/resources/docAi/client/requests/{DocAiDigitiseRequest.js → DocAiParseRequest.js} +5 -5
  9. package/dist/cjs/api/resources/docAi/client/requests/DocAiSplitRequest.d.ts +17 -0
  10. package/dist/cjs/api/resources/docAi/client/requests/DocAiSplitRequest.js +3 -0
  11. package/dist/cjs/api/resources/docAi/client/requests/index.d.ts +3 -1
  12. package/dist/cjs/api/resources/docAi/client/requests/index.js +3 -3
  13. package/dist/cjs/api/resources/docAi/types/DocAiGetResultsResponse.d.ts +9 -3
  14. package/dist/cjs/api/resources/documentTranslation/client/requests/CreateDocumentJobRequest.d.ts +1 -1
  15. package/dist/cjs/api/resources/documentTranslation/client/requests/DocumentTranslationTriggerExportRequest.d.ts +1 -0
  16. package/dist/cjs/api/types/ChunkMetrics.d.ts +6 -0
  17. package/dist/cjs/api/types/ChunkMetrics.js +3 -0
  18. package/dist/cjs/api/types/ConfigureConnection.d.ts +3 -3
  19. package/dist/cjs/api/types/ConfigureConnection.js +3 -3
  20. package/dist/cjs/api/types/DocAiBatchDocument.d.ts +10 -0
  21. package/dist/cjs/api/types/DocAiBatchDocument.js +3 -0
  22. package/dist/cjs/api/types/DocAiCapabilitiesResponse.d.ts +23 -0
  23. package/dist/cjs/api/types/DocAiCapabilitiesResponse.js +3 -0
  24. package/dist/cjs/api/types/DocAiCapabilityLimits.d.ts +12 -0
  25. package/dist/cjs/api/types/DocAiCapabilityLimits.js +3 -0
  26. package/dist/cjs/api/types/DocAiClassifyCategory.d.ts +9 -0
  27. package/dist/cjs/api/types/DocAiClassifyCategory.js +3 -0
  28. package/dist/cjs/api/types/DocAiClassifyConfig.d.ts +33 -0
  29. package/dist/cjs/api/types/DocAiClassifyConfig.js +17 -0
  30. package/dist/cjs/api/types/DocAiClassifyDecision.d.ts +24 -0
  31. package/dist/cjs/api/types/DocAiClassifyDecision.js +3 -0
  32. package/dist/cjs/api/types/DocAiClassifyInspection.d.ts +27 -0
  33. package/dist/cjs/api/types/DocAiClassifyInspection.js +15 -0
  34. package/dist/cjs/api/types/DocAiClassifyJobRequest.d.ts +24 -0
  35. package/dist/cjs/api/types/DocAiClassifyJobRequest.js +12 -0
  36. package/dist/cjs/api/types/DocAiClassifyOutput.d.ts +4 -0
  37. package/dist/cjs/api/types/DocAiClassifyOutput.js +3 -0
  38. package/dist/cjs/api/types/DocAiClassifyResult.d.ts +35 -0
  39. package/dist/cjs/api/types/DocAiClassifyResult.js +11 -0
  40. package/dist/cjs/api/types/DocAiClassifyResults.d.ts +14 -0
  41. package/dist/cjs/api/types/DocAiClassifyResults.js +3 -0
  42. package/dist/cjs/api/types/DocAiEvidence.d.ts +9 -0
  43. package/dist/cjs/api/types/DocAiEvidence.js +3 -0
  44. package/dist/cjs/api/types/DocAiJobAcceptedResponse.d.ts +23 -0
  45. package/dist/cjs/api/types/DocAiJobAcceptedResponse.js +3 -0
  46. package/dist/cjs/api/types/DocAiJobError.d.ts +23 -0
  47. package/dist/cjs/api/types/DocAiJobError.js +3 -0
  48. package/dist/cjs/api/types/DocAiJobStatusResponse.d.ts +16 -2
  49. package/dist/cjs/api/types/DocAiJobUsage.d.ts +6 -0
  50. package/dist/cjs/api/types/DocAiJobUsage.js +3 -0
  51. package/dist/cjs/api/types/DocAiPageRange.d.ts +7 -0
  52. package/dist/cjs/api/types/DocAiPageRange.js +3 -0
  53. package/dist/cjs/api/types/{DocAiDigitiseResults.d.ts → DocAiParseResults.d.ts} +4 -4
  54. package/dist/cjs/api/types/DocAiParseResults.js +3 -0
  55. package/dist/cjs/api/types/DocAiPresignUploadResponse.d.ts +1 -1
  56. package/dist/cjs/api/types/DocAiSplitConfig.d.ts +34 -0
  57. package/dist/cjs/api/types/DocAiSplitConfig.js +18 -0
  58. package/dist/cjs/api/types/DocAiSplitJobRequest.d.ts +21 -0
  59. package/dist/cjs/api/types/DocAiSplitJobRequest.js +11 -0
  60. package/dist/cjs/api/types/DocAiSplitResult.d.ts +21 -0
  61. package/dist/cjs/api/types/DocAiSplitResult.js +3 -0
  62. package/dist/cjs/api/types/DocAiSplitResults.d.ts +12 -0
  63. package/dist/cjs/api/types/DocAiSplitResults.js +3 -0
  64. package/dist/cjs/api/types/DocAiSplitSegment.d.ts +28 -0
  65. package/dist/cjs/api/types/DocAiSplitSegment.js +3 -0
  66. package/dist/cjs/api/types/DocAiSplitTrigger.d.ts +59 -0
  67. package/dist/cjs/api/types/DocAiSplitTrigger.js +42 -0
  68. package/dist/cjs/api/types/DocAiSplitTriggerMatch.d.ts +8 -0
  69. package/dist/cjs/api/types/DocAiSplitTriggerMatch.js +3 -0
  70. package/dist/cjs/api/types/DocAiSuggestedType.d.ts +8 -0
  71. package/dist/cjs/api/types/DocAiSuggestedType.js +3 -0
  72. package/dist/cjs/api/types/DocAiUsage.d.ts +6 -0
  73. package/dist/cjs/api/types/ExportFormat.d.ts +2 -1
  74. package/dist/cjs/api/types/ExportFormat.js +2 -1
  75. package/dist/cjs/api/types/JobLiveStatusResponse.d.ts +2 -0
  76. package/dist/cjs/api/types/StartJobResponse.d.ts +2 -0
  77. package/dist/cjs/api/types/TextToSpeechSpeaker.d.ts +3 -3
  78. package/dist/cjs/api/types/TextToSpeechSpeaker.js +3 -3
  79. package/dist/cjs/api/types/TranslationStatusItem.d.ts +4 -0
  80. package/dist/cjs/api/types/index.d.ts +26 -1
  81. package/dist/cjs/api/types/index.js +26 -1
  82. package/dist/cjs/version.d.ts +1 -1
  83. package/dist/cjs/version.js +1 -1
  84. package/dist/esm/BaseClient.mjs +2 -2
  85. package/dist/esm/api/resources/docAi/client/Client.d.mts +78 -8
  86. package/dist/esm/api/resources/docAi/client/Client.mjs +233 -12
  87. package/dist/esm/api/resources/docAi/client/requests/DocAiClassifyRequest.d.mts +17 -0
  88. package/dist/esm/api/resources/docAi/client/requests/DocAiExtractRequest.d.mts +1 -1
  89. package/dist/esm/api/resources/docAi/client/requests/DocAiGetResultsRequest.d.mts +8 -0
  90. package/dist/esm/api/resources/docAi/client/requests/{DocAiDigitiseRequest.d.mts → DocAiParseRequest.d.mts} +4 -4
  91. package/dist/esm/api/resources/docAi/client/requests/{DocAiDigitiseRequest.mjs → DocAiParseRequest.mjs} +4 -4
  92. package/dist/esm/api/resources/docAi/client/requests/DocAiSplitRequest.d.mts +17 -0
  93. package/dist/esm/api/resources/docAi/client/requests/DocAiSplitRequest.mjs +2 -0
  94. package/dist/esm/api/resources/docAi/client/requests/index.d.mts +3 -1
  95. package/dist/esm/api/resources/docAi/client/requests/index.mjs +1 -1
  96. package/dist/esm/api/resources/docAi/types/DocAiGetResultsResponse.d.mts +9 -3
  97. package/dist/esm/api/resources/documentTranslation/client/requests/CreateDocumentJobRequest.d.mts +1 -1
  98. package/dist/esm/api/resources/documentTranslation/client/requests/DocumentTranslationTriggerExportRequest.d.mts +1 -0
  99. package/dist/esm/api/types/ChunkMetrics.d.mts +6 -0
  100. package/dist/esm/api/types/ChunkMetrics.mjs +2 -0
  101. package/dist/esm/api/types/ConfigureConnection.d.mts +3 -3
  102. package/dist/esm/api/types/ConfigureConnection.mjs +3 -3
  103. package/dist/esm/api/types/DocAiBatchDocument.d.mts +10 -0
  104. package/dist/esm/api/types/DocAiBatchDocument.mjs +2 -0
  105. package/dist/esm/api/types/DocAiCapabilitiesResponse.d.mts +23 -0
  106. package/dist/esm/api/types/DocAiCapabilitiesResponse.mjs +2 -0
  107. package/dist/esm/api/types/DocAiCapabilityLimits.d.mts +12 -0
  108. package/dist/esm/api/types/DocAiCapabilityLimits.mjs +2 -0
  109. package/dist/esm/api/types/DocAiClassifyCategory.d.mts +9 -0
  110. package/dist/esm/api/types/DocAiClassifyCategory.mjs +2 -0
  111. package/dist/esm/api/types/DocAiClassifyConfig.d.mts +33 -0
  112. package/dist/esm/api/types/DocAiClassifyConfig.mjs +14 -0
  113. package/dist/esm/api/types/DocAiClassifyDecision.d.mts +24 -0
  114. package/dist/esm/api/types/DocAiClassifyDecision.mjs +2 -0
  115. package/dist/esm/api/types/DocAiClassifyInspection.d.mts +27 -0
  116. package/dist/esm/api/types/DocAiClassifyInspection.mjs +12 -0
  117. package/dist/esm/api/types/DocAiClassifyJobRequest.d.mts +24 -0
  118. package/dist/esm/api/types/DocAiClassifyJobRequest.mjs +9 -0
  119. package/dist/esm/api/types/DocAiClassifyOutput.d.mts +4 -0
  120. package/dist/esm/api/types/DocAiClassifyOutput.mjs +2 -0
  121. package/dist/esm/api/types/DocAiClassifyResult.d.mts +35 -0
  122. package/dist/esm/api/types/DocAiClassifyResult.mjs +8 -0
  123. package/dist/esm/api/types/DocAiClassifyResults.d.mts +14 -0
  124. package/dist/esm/api/types/DocAiClassifyResults.mjs +2 -0
  125. package/dist/esm/api/types/DocAiEvidence.d.mts +9 -0
  126. package/dist/esm/api/types/DocAiEvidence.mjs +2 -0
  127. package/dist/esm/api/types/DocAiJobAcceptedResponse.d.mts +23 -0
  128. package/dist/esm/api/types/DocAiJobAcceptedResponse.mjs +2 -0
  129. package/dist/esm/api/types/DocAiJobError.d.mts +23 -0
  130. package/dist/esm/api/types/DocAiJobError.mjs +2 -0
  131. package/dist/esm/api/types/DocAiJobStatusResponse.d.mts +16 -2
  132. package/dist/esm/api/types/DocAiJobUsage.d.mts +6 -0
  133. package/dist/esm/api/types/DocAiJobUsage.mjs +2 -0
  134. package/dist/esm/api/types/DocAiPageRange.d.mts +7 -0
  135. package/dist/esm/api/types/DocAiPageRange.mjs +2 -0
  136. package/dist/esm/api/types/{DocAiDigitiseResults.d.mts → DocAiParseResults.d.mts} +4 -4
  137. package/dist/esm/api/types/DocAiParseResults.mjs +2 -0
  138. package/dist/esm/api/types/DocAiPresignUploadResponse.d.mts +1 -1
  139. package/dist/esm/api/types/DocAiSplitConfig.d.mts +34 -0
  140. package/dist/esm/api/types/DocAiSplitConfig.mjs +15 -0
  141. package/dist/esm/api/types/DocAiSplitJobRequest.d.mts +21 -0
  142. package/dist/esm/api/types/DocAiSplitJobRequest.mjs +8 -0
  143. package/dist/esm/api/types/DocAiSplitResult.d.mts +21 -0
  144. package/dist/esm/api/types/DocAiSplitResult.mjs +2 -0
  145. package/dist/esm/api/types/DocAiSplitResults.d.mts +12 -0
  146. package/dist/esm/api/types/DocAiSplitResults.mjs +2 -0
  147. package/dist/esm/api/types/DocAiSplitSegment.d.mts +28 -0
  148. package/dist/esm/api/types/DocAiSplitSegment.mjs +2 -0
  149. package/dist/esm/api/types/DocAiSplitTrigger.d.mts +59 -0
  150. package/dist/esm/api/types/DocAiSplitTrigger.mjs +39 -0
  151. package/dist/esm/api/types/DocAiSplitTriggerMatch.d.mts +8 -0
  152. package/dist/esm/api/types/DocAiSplitTriggerMatch.mjs +2 -0
  153. package/dist/esm/api/types/DocAiSuggestedType.d.mts +8 -0
  154. package/dist/esm/api/types/DocAiSuggestedType.mjs +2 -0
  155. package/dist/esm/api/types/DocAiUsage.d.mts +6 -0
  156. package/dist/esm/api/types/ExportFormat.d.mts +2 -1
  157. package/dist/esm/api/types/ExportFormat.mjs +2 -1
  158. package/dist/esm/api/types/JobLiveStatusResponse.d.mts +2 -0
  159. package/dist/esm/api/types/StartJobResponse.d.mts +2 -0
  160. package/dist/esm/api/types/TextToSpeechSpeaker.d.mts +3 -3
  161. package/dist/esm/api/types/TextToSpeechSpeaker.mjs +3 -3
  162. package/dist/esm/api/types/TranslationStatusItem.d.mts +4 -0
  163. package/dist/esm/api/types/index.d.mts +26 -1
  164. package/dist/esm/api/types/index.mjs +26 -1
  165. package/dist/esm/version.d.mts +1 -1
  166. package/dist/esm/version.mjs +1 -1
  167. package/package.json +1 -1
  168. package/reference.md +205 -8
  169. /package/dist/cjs/api/{types/DocAiDigitiseResults.js → resources/docAi/client/requests/DocAiClassifyRequest.js} +0 -0
  170. /package/dist/esm/api/{types/DocAiDigitiseResults.mjs → resources/docAi/client/requests/DocAiClassifyRequest.mjs} +0 -0
@@ -15,7 +15,7 @@ export interface CreateDocumentJobRequest {
15
15
  job_name?: string;
16
16
  /** Source language (BCP-47). */
17
17
  source_language_code: SarvamAI.DocumentLanguage;
18
- /** Original filename with extension. Supported: `.pdf`, `.doc`, `.docx`, `.odt`, `.xls`, `.xlsx`, `.ods`, `.ppt`, `.pptx`, `.odp`, `.html`, `.xhtml`, `.mhtml`. */
18
+ /** Original filename with extension. Supported: `.pdf`, `.doc`, `.docx`, `.odt`, `.xls`, `.xlsx`, `.ods`, `.ppt`, `.pptx`, `.odp`, `.html`, `.xhtml`, `.mhtml`, `.md`, `.markdown`, `.txt`. */
19
19
  original_filename: string;
20
20
  /** Genre enum name (e.g. `NON_FICTION`). Use the enum constant name, not the human-readable label. */
21
21
  genre?: SarvamAI.DocumentGenre;
@@ -13,6 +13,7 @@ export interface DocumentTranslationTriggerExportRequest {
13
13
  *
14
14
  * - **PDF uploads:** may be set to `pdf` (default), `docx`, `html`, `txt`, or `epub`.
15
15
  * - **Microsoft Office uploads** (`.doc`, `.docx`, `.xls`, `.xlsx`, `.ppt`, `.pptx`, and related formats): always export in the original format only; other values are rejected.
16
+ * - **Markdown / plain-text uploads** (`.md`, `.markdown`, `.txt`): export in the original format only — `md` (`markdown` is accepted as an alias) or `txt`.
16
17
  */
17
18
  format?: SarvamAI.ExportFormat;
18
19
  /** When true, the export may reduce line spacing to fit translated text within the original layout. PDF/DOCX only. */
@@ -0,0 +1,6 @@
1
+ export interface ChunkMetrics {
2
+ total_chunks: number;
3
+ chunks_processed: number;
4
+ chunks_succeeded: number;
5
+ chunks_failed: number;
6
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -201,7 +201,7 @@ export declare namespace ConfigureConnection {
201
201
  readonly Rehan: "rehan";
202
202
  readonly Soham: "soham";
203
203
  readonly Rupali: "rupali";
204
- readonly BappaBnConversation: "bappa_bn_conversation";
204
+ readonly ArnabBnConversation: "arnab_bn_conversation";
205
205
  readonly RoopaBnConversational: "roopa_bn_conversational";
206
206
  readonly BimalBnSuspense: "bimal_bn_suspense";
207
207
  readonly AditiEnStories: "aditi_en_stories";
@@ -416,8 +416,8 @@ export declare namespace ConfigureConnection {
416
416
  readonly HarpreetPaNarration: "harpreet_pa_narration";
417
417
  readonly JaspalPaBanking: "jaspal_pa_banking";
418
418
  readonly GokulTaNarration: "gokul_ta_narration";
419
- readonly VetriTaAds: "vetri_ta_ads";
420
- readonly VetriTaSuspense: "vetri_ta_suspense";
419
+ readonly AravindTaAds: "aravind_ta_ads";
420
+ readonly AravindTaSuspense: "aravind_ta_suspense";
421
421
  readonly VijayTaNarration: "vijay_ta_narration";
422
422
  readonly KavithaTeConversation: "kavitha_te_conversation";
423
423
  readonly KavithaTeNarration: "kavitha_te_narration";
@@ -92,7 +92,7 @@ var ConfigureConnection;
92
92
  Rehan: "rehan",
93
93
  Soham: "soham",
94
94
  Rupali: "rupali",
95
- BappaBnConversation: "bappa_bn_conversation",
95
+ ArnabBnConversation: "arnab_bn_conversation",
96
96
  RoopaBnConversational: "roopa_bn_conversational",
97
97
  BimalBnSuspense: "bimal_bn_suspense",
98
98
  AditiEnStories: "aditi_en_stories",
@@ -307,8 +307,8 @@ var ConfigureConnection;
307
307
  HarpreetPaNarration: "harpreet_pa_narration",
308
308
  JaspalPaBanking: "jaspal_pa_banking",
309
309
  GokulTaNarration: "gokul_ta_narration",
310
- VetriTaAds: "vetri_ta_ads",
311
- VetriTaSuspense: "vetri_ta_suspense",
310
+ AravindTaAds: "aravind_ta_ads",
311
+ AravindTaSuspense: "aravind_ta_suspense",
312
312
  VijayTaNarration: "vijay_ta_narration",
313
313
  KavithaTeConversation: "kavitha_te_conversation",
314
314
  KavithaTeNarration: "kavitha_te_narration",
@@ -0,0 +1,10 @@
1
+ export interface DocAiBatchDocument {
2
+ /** Position of the document in the submission, starting at 1. */
3
+ index?: number | undefined;
4
+ filename?: string | undefined;
5
+ /** Job for this document. */
6
+ job_id?: string | undefined;
7
+ status?: string | undefined;
8
+ status_url?: string | undefined;
9
+ results_url?: string | undefined;
10
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,23 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ /**
3
+ * Classify and Split capabilities of this deployment.
4
+ */
5
+ export interface DocAiCapabilitiesResponse {
6
+ /** Contract version, `v1`. */
7
+ api_contract?: string | undefined;
8
+ /** Enabled operations, e.g. `split` and `classify`. */
9
+ operations?: string[] | undefined;
10
+ /** Accepted media types. */
11
+ input_formats?: string[] | undefined;
12
+ /** Classify inspection policies. */
13
+ inspection_policies?: string[] | undefined;
14
+ /** Enabled `reasoning_input` values, e.g. `auto` and `text_only`. */
15
+ reasoning_input_modes?: string[] | undefined;
16
+ split_methods?: string[] | undefined;
17
+ /** Feature flags, e.g. `split_triggers` and `split_trigger_photo`. */
18
+ features?: Record<string, boolean> | undefined;
19
+ limits?: SarvamAI.DocAiCapabilityLimits | undefined;
20
+ /** How long jobs and results are kept. */
21
+ retention_seconds?: number | undefined;
22
+ review_timeout_hours_max?: number | undefined;
23
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,12 @@
1
+ export interface DocAiCapabilityLimits {
2
+ /** Maximum pages in one source document. */
3
+ max_source_pages?: number | undefined;
4
+ /** Maximum size of one source document in bytes. */
5
+ max_source_bytes?: number | undefined;
6
+ /** Maximum categories in one request. */
7
+ max_categories?: number | undefined;
8
+ /** Maximum segments a Split can return. */
9
+ max_segments?: number | undefined;
10
+ /** Largest result returned inline. */
11
+ max_inline_result_bytes?: number | undefined;
12
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ /**
2
+ * A category to label documents with. Names are yours to choose and must be unique, ignoring case and surrounding spaces.
3
+ */
4
+ export interface DocAiClassifyCategory {
5
+ /** Category name returned as the result `type`. Must be unique. */
6
+ type: string;
7
+ /** What belongs in this category. Clear descriptions improve accuracy. */
8
+ description: string;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,33 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ /**
3
+ * Classify options. Use at most one page selector from `max_pages`, `target_pages` and `inspection`.
4
+ */
5
+ export interface DocAiClassifyConfig {
6
+ /** `document` returns one decision for the file. `page` returns one decision per page in `decisions`. */
7
+ scope?: DocAiClassifyConfig.Scope | undefined;
8
+ /** Categories to choose from. Omit them to let the API suggest a document type. */
9
+ categories?: SarvamAI.DocAiClassifyCategory[] | undefined;
10
+ /** What to do when no category matches. `suggest_type` returns a `suggested_type`; `other` returns `type: "other"` without a suggestion. */
11
+ unmatched_behavior?: DocAiClassifyConfig.UnmatchedBehavior | undefined;
12
+ /** Your own instruction text. */
13
+ prompt?: string | undefined;
14
+ /** Inspect only the first N pages. */
15
+ max_pages?: number | undefined;
16
+ /** Inspect only these 1-based pages, e.g. `[1, 6, 8]`. */
17
+ target_pages?: number[] | undefined;
18
+ inspection?: SarvamAI.DocAiClassifyInspection | undefined;
19
+ }
20
+ export declare namespace DocAiClassifyConfig {
21
+ /** `document` returns one decision for the file. `page` returns one decision per page in `decisions`. */
22
+ const Scope: {
23
+ readonly Document: "document";
24
+ readonly Page: "page";
25
+ };
26
+ type Scope = (typeof Scope)[keyof typeof Scope];
27
+ /** What to do when no category matches. `suggest_type` returns a `suggested_type`; `other` returns `type: "other"` without a suggestion. */
28
+ const UnmatchedBehavior: {
29
+ readonly SuggestType: "suggest_type";
30
+ readonly Other: "other";
31
+ };
32
+ type UnmatchedBehavior = (typeof UnmatchedBehavior)[keyof typeof UnmatchedBehavior];
33
+ }
@@ -0,0 +1,17 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.DocAiClassifyConfig = void 0;
5
+ var DocAiClassifyConfig;
6
+ (function (DocAiClassifyConfig) {
7
+ /** `document` returns one decision for the file. `page` returns one decision per page in `decisions`. */
8
+ DocAiClassifyConfig.Scope = {
9
+ Document: "document",
10
+ Page: "page",
11
+ };
12
+ /** What to do when no category matches. `suggest_type` returns a `suggested_type`; `other` returns `type: "other"` without a suggestion. */
13
+ DocAiClassifyConfig.UnmatchedBehavior = {
14
+ SuggestType: "suggest_type",
15
+ Other: "other",
16
+ };
17
+ })(DocAiClassifyConfig || (exports.DocAiClassifyConfig = DocAiClassifyConfig = {}));
@@ -0,0 +1,24 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ /**
3
+ * One Classify decision, for a whole document or a single page.
4
+ */
5
+ export interface DocAiClassifyDecision {
6
+ /** Page number, on per-page decisions. */
7
+ input_page?: number | undefined;
8
+ /** The matched category. `null` when `classification_status` is `unknown` or `mixed`; `other` when nothing matched and `unmatched_behavior` is `other`. */
9
+ type?: string | undefined;
10
+ /** Why the status is `unknown`: `no_matching_type`, or `insufficient_evidence` when the pages were not enough to tell. */
11
+ reason_code?: string | undefined;
12
+ reasoning?: string | undefined;
13
+ /** A token-based score from 0 to 1, or `null`. Not a measured probability of being correct. */
14
+ confidence?: number | undefined;
15
+ /** Whether a person should check the answer. */
16
+ review_required?: boolean | undefined;
17
+ /** E.g. `NO_MATCHING_TYPE`, `MODEL_SCORE_UNAVAILABLE`, `MULTIPLE_DOCUMENTS_DETECTED`. */
18
+ review_reasons?: string[] | undefined;
19
+ suggested_type?: SarvamAI.DocAiSuggestedType | undefined;
20
+ /** Present on per-page decisions when `output.include_evidence` is `true`. */
21
+ evidence?: SarvamAI.DocAiEvidence[] | undefined;
22
+ /** `matched` (a category fits), `unknown` (none fits) or `mixed` (the file holds several documents). */
23
+ classification_status?: string | undefined;
24
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,27 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ /**
3
+ * Which pages Classify reads. `first` and `last` take `count`; `head_tail` takes `head_pages` and `tail_pages`; `explicit` takes `ranges`; `adaptive` takes `initial` (a `first`, `last`, `head_tail` or `explicit` policy) and `max_pages`; `all` takes nothing.
4
+ */
5
+ export interface DocAiClassifyInspection {
6
+ policy: DocAiClassifyInspection.Policy;
7
+ /** Pages to read, for `first` and `last`. */
8
+ count?: number | undefined;
9
+ head_pages?: number | undefined;
10
+ tail_pages?: number | undefined;
11
+ ranges?: SarvamAI.DocAiPageRange[] | undefined;
12
+ /** Starting selection for `adaptive`. */
13
+ initial?: Record<string, unknown> | undefined;
14
+ /** Upper bound for `adaptive`. Must cover the initial selection. */
15
+ max_pages?: number | undefined;
16
+ }
17
+ export declare namespace DocAiClassifyInspection {
18
+ const Policy: {
19
+ readonly First: "first";
20
+ readonly Last: "last";
21
+ readonly HeadTail: "head_tail";
22
+ readonly Explicit: "explicit";
23
+ readonly All: "all";
24
+ readonly Adaptive: "adaptive";
25
+ };
26
+ type Policy = (typeof Policy)[keyof typeof Policy];
27
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.DocAiClassifyInspection = void 0;
5
+ var DocAiClassifyInspection;
6
+ (function (DocAiClassifyInspection) {
7
+ DocAiClassifyInspection.Policy = {
8
+ First: "first",
9
+ Last: "last",
10
+ HeadTail: "head_tail",
11
+ Explicit: "explicit",
12
+ All: "all",
13
+ Adaptive: "adaptive",
14
+ };
15
+ })(DocAiClassifyInspection || (exports.DocAiClassifyInspection = DocAiClassifyInspection = {}));
@@ -0,0 +1,24 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ /**
3
+ * The JSON `request` part of a Classify submission.
4
+ */
5
+ export interface DocAiClassifyJobRequest {
6
+ config?: SarvamAI.DocAiClassifyConfig | undefined;
7
+ /** Language of the document in BCP-47 format, e.g. `en-IN`. When omitted, the Indic OCR default is used. */
8
+ language?: string | undefined;
9
+ /** How the model reads pages. Image modes (`images_for_scans`, `vision`) are available only when listed by `GET /doc-ai/v1/capabilities`. */
10
+ reasoning_input?: DocAiClassifyJobRequest.ReasoningInput | undefined;
11
+ /** Set `auto` to wait briefly for a single document and receive the finished result with HTTP 200; otherwise the job is returned to poll. Not supported for multi-document submissions. */
12
+ execution?: "auto" | undefined;
13
+ /** Restrict the job to these page ranges. */
14
+ pages?: SarvamAI.DocAiPageRange[] | undefined;
15
+ output?: SarvamAI.DocAiClassifyOutput | undefined;
16
+ }
17
+ export declare namespace DocAiClassifyJobRequest {
18
+ /** How the model reads pages. Image modes (`images_for_scans`, `vision`) are available only when listed by `GET /doc-ai/v1/capabilities`. */
19
+ const ReasoningInput: {
20
+ readonly Auto: "auto";
21
+ readonly TextOnly: "text_only";
22
+ };
23
+ type ReasoningInput = (typeof ReasoningInput)[keyof typeof ReasoningInput];
24
+ }
@@ -0,0 +1,12 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.DocAiClassifyJobRequest = void 0;
5
+ var DocAiClassifyJobRequest;
6
+ (function (DocAiClassifyJobRequest) {
7
+ /** How the model reads pages. Image modes (`images_for_scans`, `vision`) are available only when listed by `GET /doc-ai/v1/capabilities`. */
8
+ DocAiClassifyJobRequest.ReasoningInput = {
9
+ Auto: "auto",
10
+ TextOnly: "text_only",
11
+ };
12
+ })(DocAiClassifyJobRequest || (exports.DocAiClassifyJobRequest = DocAiClassifyJobRequest = {}));
@@ -0,0 +1,4 @@
1
+ export interface DocAiClassifyOutput {
2
+ /** Include supporting evidence (pages, blocks and a region) for each decision. */
3
+ include_evidence?: boolean | undefined;
4
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,35 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ export interface DocAiClassifyResult {
3
+ scope?: DocAiClassifyResult.Scope | undefined;
4
+ /** Reference to the input document. */
5
+ input_document_ref?: string | undefined;
6
+ /** With `scope: page`, one decision per page. */
7
+ decisions?: SarvamAI.DocAiClassifyDecision[] | undefined;
8
+ /** The pages that were read, e.g. `{"complete": true, "selected_pages": [1, 2]}`. */
9
+ inspection?: Record<string, unknown> | undefined;
10
+ /** Supporting evidence, when `output.include_evidence` is `true`. */
11
+ evidence?: SarvamAI.DocAiEvidence[] | undefined;
12
+ /** Page number, on per-page decisions. */
13
+ input_page?: number | undefined;
14
+ /** The matched category. `null` when `classification_status` is `unknown` or `mixed`; `other` when nothing matched and `unmatched_behavior` is `other`. */
15
+ type?: string | undefined;
16
+ /** Why the status is `unknown`: `no_matching_type`, or `insufficient_evidence` when the pages were not enough to tell. */
17
+ reason_code?: string | undefined;
18
+ reasoning?: string | undefined;
19
+ /** A token-based score from 0 to 1, or `null`. Not a measured probability of being correct. */
20
+ confidence?: number | undefined;
21
+ /** Whether a person should check the answer. */
22
+ review_required?: boolean | undefined;
23
+ /** E.g. `NO_MATCHING_TYPE`, `MODEL_SCORE_UNAVAILABLE`, `MULTIPLE_DOCUMENTS_DETECTED`. */
24
+ review_reasons?: string[] | undefined;
25
+ suggested_type?: SarvamAI.DocAiSuggestedType | undefined;
26
+ /** `matched` (a category fits), `unknown` (none fits) or `mixed` (the file holds several documents). */
27
+ classification_status?: string | undefined;
28
+ }
29
+ export declare namespace DocAiClassifyResult {
30
+ const Scope: {
31
+ readonly Document: "document";
32
+ readonly Page: "page";
33
+ };
34
+ type Scope = (typeof Scope)[keyof typeof Scope];
35
+ }
@@ -0,0 +1,11 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.DocAiClassifyResult = void 0;
5
+ var DocAiClassifyResult;
6
+ (function (DocAiClassifyResult) {
7
+ DocAiClassifyResult.Scope = {
8
+ Document: "document",
9
+ Page: "page",
10
+ };
11
+ })(DocAiClassifyResult || (exports.DocAiClassifyResult = DocAiClassifyResult = {}));
@@ -0,0 +1,14 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ /**
3
+ * Job results for the `classify` pipeline.
4
+ */
5
+ export interface DocAiClassifyResults {
6
+ job_id: string;
7
+ status: string;
8
+ result_revision?: number | undefined;
9
+ usage?: SarvamAI.DocAiJobUsage | undefined;
10
+ result: SarvamAI.DocAiClassifyResult;
11
+ pagination?: Record<string, unknown> | undefined;
12
+ /** Returned with `include=details`. */
13
+ provenance?: Record<string, unknown> | undefined;
14
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,9 @@
1
+ export interface DocAiEvidence {
2
+ input_page?: number | undefined;
3
+ source_page?: number | undefined;
4
+ block_ids?: string[] | undefined;
5
+ /** Where the text came from, e.g. `pdf_text`. */
6
+ source?: string | undefined;
7
+ /** Normalised box `{x, y, width, height, coordinate_space}`. */
8
+ region?: Record<string, unknown> | undefined;
9
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,23 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ /**
3
+ * Returned when a Classify or Split job is created.
4
+ */
5
+ export interface DocAiJobAcceptedResponse {
6
+ /** The unique identifier of the job. For a batch, the parent job. */
7
+ job_id: string;
8
+ /** The unique identifier of the job run. */
9
+ run_id?: string | undefined;
10
+ /** Initial status, `accepted`. */
11
+ status: string;
12
+ /** Path to poll for status. */
13
+ status_url: string;
14
+ /** Path to fetch results from once the job is `completed`. */
15
+ results_url: string;
16
+ /** `true` when the response replays an earlier request with the same `Idempotency-Key`. */
17
+ idempotency_replayed?: boolean | undefined;
18
+ /** Limits applied to the job, such as `deadline_at` and `max_model_calls`. */
19
+ resolved_budget?: Record<string, unknown> | undefined;
20
+ resolved_limits?: SarvamAI.DocAiCapabilityLimits | undefined;
21
+ /** Batch submissions only: one entry per document, each with its own job. */
22
+ documents?: SarvamAI.DocAiBatchDocument[] | undefined;
23
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,23 @@
1
+ /**
2
+ * Error returned by the Classify, Split and job endpoints. Retry only when `retryable` is `true`, using the same `Idempotency-Key`. Include `request_id` when reporting an issue.
3
+ */
4
+ export interface DocAiJobError {
5
+ /** Machine-readable error code, e.g. `INVALID_REQUEST`, `UNAUTHORIZED`, `NOT_FOUND`, `RESULTS_NOT_READY`, `IDEMPOTENCY_CONFLICT`, `PAGE_RANGE_INVALID`, `UNSUPPORTED_CAPABILITY`, `UNSUPPORTED_INPUT` or `TOO_MANY_DOCUMENTS`. */
6
+ code: string;
7
+ /** Human-readable summary. */
8
+ message: string;
9
+ /** Explanation specific to this occurrence. */
10
+ detail?: string | undefined;
11
+ /** JSON pointer to the offending field, e.g. `/config/scope`. */
12
+ pointer?: string | undefined;
13
+ /** Whether retrying the same request can succeed. */
14
+ retryable: boolean;
15
+ /** Request identifier to quote when reporting an issue. */
16
+ request_id?: string | undefined;
17
+ /** HTTP status code. */
18
+ status?: number | undefined;
19
+ /** Short title of the HTTP status. */
20
+ title?: string | undefined;
21
+ /** Present on `RESULTS_NOT_READY`, the current status of the job. */
22
+ job_status?: string | undefined;
23
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -4,11 +4,25 @@ export interface DocAiJobStatusResponse {
4
4
  job_id: string;
5
5
  /** Current status of the job. Terminal statuses: `completed`, `partially_completed`, `failed`, `rejected`. */
6
6
  status: string;
7
- /** Job pipeline: `digitise` or `extract`. */
8
- pipeline: string;
7
+ /** Job pipeline: `parse` or `extract`. Classify and Split jobs report `type` instead. */
8
+ pipeline?: string | undefined;
9
9
  usage: SarvamAI.DocAiUsage;
10
10
  /** Job creation timestamp. */
11
11
  created_at: string;
12
12
  /** Timestamp of the last job update. */
13
13
  updated_at: string;
14
+ /** Job type. Present for Classify and Split jobs: `classify` or `split`. */
15
+ type?: string | undefined;
16
+ /** Processing phase of a Classify or Split job, e.g. `commit` when finished. */
17
+ phase?: string | undefined;
18
+ /** Progress counters for a Classify or Split job, such as `pages_read`, `pages_analyzed` and `pages_total_selected`. */
19
+ progress?: Record<string, unknown> | undefined;
20
+ /** Revision of the result. Present for Classify and Split jobs. */
21
+ result_revision?: number | undefined;
22
+ /** The unique identifier of the job run. */
23
+ run_id?: string | undefined;
24
+ /** Path to fetch the results from. */
25
+ results_url?: string | undefined;
26
+ /** For a batch, one entry per submitted document with its own `job_id`, `status` and URLs. */
27
+ documents?: Record<string, unknown>[] | undefined;
14
28
  }
@@ -0,0 +1,6 @@
1
+ export interface DocAiJobUsage {
2
+ /** Pages processed so far. */
3
+ pages_processed?: number | undefined;
4
+ /** Pages in the source document. */
5
+ pages_source?: number | undefined;
6
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,7 @@
1
+ /**
2
+ * An inclusive, 1-based page range.
3
+ */
4
+ export interface DocAiPageRange {
5
+ start: number;
6
+ end: number;
7
+ }
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,17 +1,17 @@
1
1
  import type * as SarvamAI from "../index.js";
2
2
  /**
3
- * Job results for the `digitise` pipeline.
3
+ * Job results for the `parse` pipeline.
4
4
  */
5
- export interface DocAiDigitiseResults {
5
+ export interface DocAiParseResults {
6
6
  /** The unique identifier of the job. */
7
7
  job_id: string;
8
8
  /** Terminal status of the job: `completed`, `partially_completed`, `failed`, or `rejected`. */
9
9
  status: string;
10
10
  usage: SarvamAI.DocAiUsage;
11
11
  /** One entry per input document, each holding per-page content. */
12
- documents: DocAiDigitiseResults.Documents.Item[];
12
+ documents: DocAiParseResults.Documents.Item[];
13
13
  }
14
- export declare namespace DocAiDigitiseResults {
14
+ export declare namespace DocAiParseResults {
15
15
  type Documents = Documents.Item[];
16
16
  namespace Documents {
17
17
  interface Item {
@@ -0,0 +1,3 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -1,5 +1,5 @@
1
1
  export interface DocAiPresignUploadResponse {
2
- /** Handle for the uploaded file. Pass it through `upload_ids` on a later digitise or extract job request. */
2
+ /** Handle for the uploaded file. Pass it through `upload_ids` on a later parse or extract job request. */
3
3
  upload_id: string;
4
4
  /** HTTP method to use for the upload (e.g. `PUT`). */
5
5
  method: string;
@@ -0,0 +1,34 @@
1
+ import type * as SarvamAI from "../index.js";
2
+ /**
3
+ * Split options. `fixed_pages` needs `pages_per_segment`, `page_ranges` needs `segment_ranges` and `triggers` needs `split_on`.
4
+ */
5
+ export interface DocAiSplitConfig {
6
+ method?: DocAiSplitConfig.Method | undefined;
7
+ /** Label each child document. Supply `categories` when `true`; omit them when `false`. */
8
+ classify_segments?: boolean | undefined;
9
+ /** Categories to label each child document with, each with a `type` and a `description`. Required when `classify_segments` is `true`. */
10
+ categories?: SarvamAI.DocAiClassifyCategory[] | undefined;
11
+ /** Pages in each document, for `fixed_pages`. */
12
+ pages_per_segment?: number | undefined;
13
+ /** For `fixed_pages`. `keep` keeps the final smaller group; `error` rejects the request when pages do not divide evenly. */
14
+ remainder?: DocAiSplitConfig.Remainder | undefined;
15
+ /** For `page_ranges`. Ranges must cover the selected pages exactly once, in order. */
16
+ segment_ranges?: SarvamAI.DocAiPageRange[] | undefined;
17
+ /** Markers, for `triggers`. */
18
+ split_on?: SarvamAI.DocAiSplitTrigger[] | undefined;
19
+ }
20
+ export declare namespace DocAiSplitConfig {
21
+ const Method: {
22
+ readonly Semantic: "semantic";
23
+ readonly FixedPages: "fixed_pages";
24
+ readonly PageRanges: "page_ranges";
25
+ readonly Triggers: "triggers";
26
+ };
27
+ type Method = (typeof Method)[keyof typeof Method];
28
+ /** For `fixed_pages`. `keep` keeps the final smaller group; `error` rejects the request when pages do not divide evenly. */
29
+ const Remainder: {
30
+ readonly Keep: "keep";
31
+ readonly Error: "error";
32
+ };
33
+ type Remainder = (typeof Remainder)[keyof typeof Remainder];
34
+ }
@@ -0,0 +1,18 @@
1
+ "use strict";
2
+ // This file was auto-generated by Fern from our API Definition.
3
+ Object.defineProperty(exports, "__esModule", { value: true });
4
+ exports.DocAiSplitConfig = void 0;
5
+ var DocAiSplitConfig;
6
+ (function (DocAiSplitConfig) {
7
+ DocAiSplitConfig.Method = {
8
+ Semantic: "semantic",
9
+ FixedPages: "fixed_pages",
10
+ PageRanges: "page_ranges",
11
+ Triggers: "triggers",
12
+ };
13
+ /** For `fixed_pages`. `keep` keeps the final smaller group; `error` rejects the request when pages do not divide evenly. */
14
+ DocAiSplitConfig.Remainder = {
15
+ Keep: "keep",
16
+ Error: "error",
17
+ };
18
+ })(DocAiSplitConfig || (exports.DocAiSplitConfig = DocAiSplitConfig = {}));