@read-frog/api-contract 0.12.5 → 0.12.6

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@read-frog/api-contract",
   "type": "module",
-  "version": "0.12.5",
+  "version": "0.12.6",
   "private": false,
   "repository": {
     "type": "git",

package/src/contracts/hosted-ai.ts

@@ -48,6 +48,64 @@ export const hostedAiContract = {
       .output(eventIterator(HostedAiStreamPartSchema))
       .errors(hostedAiStreamErrors),
   },
+  videoSubtitles: {
+    // Subtitle lines and the video summary share this route: both are short
+    // text and both bill against `videoSubtitles`.
+    streamText: oc
+      .route({
+        method: "POST",
+        path: "/hosted-ai/video-subtitles/stream-text",
+        summary: "Stream hosted subtitle translation or video summary text output",
+        tags: ["Hosted AI"],
+      })
+      .input(HostedAiStreamTextInputSchema)
+      .output(eventIterator(HostedAiStreamPartSchema))
+      .errors(hostedAiStreamErrors),
+    /**
+     * Segmentation shares the `videoSubtitles` feature but not its route,
+     * because `endpointMaxOutputTokens` sizes the credit reservation: emitting
+     * a WebVTT block needs several times a subtitle line's budget, and folding
+     * both into one route would make every line reserve — and, near the end of
+     * a credit window, fail to afford — what only segmentation needs.
+     */
+    streamSegmentation: oc
+      .route({
+        method: "POST",
+        path: "/hosted-ai/video-subtitles/stream-segmentation",
+        summary: "Stream hosted subtitle segmentation output",
+        tags: ["Hosted AI"],
+      })
+      .input(HostedAiStreamTextInputSchema)
+      .output(eventIterator(HostedAiStreamPartSchema))
+      .errors(hostedAiStreamErrors),
+  },
+  inputTranslation: {
+    streamText: oc
+      .route({
+        method: "POST",
+        path: "/hosted-ai/input-translation/stream-text",
+        summary: "Stream hosted input box translation text output",
+        tags: ["Hosted AI"],
+      })
+      .input(HostedAiStreamTextInputSchema)
+      .output(eventIterator(HostedAiStreamPartSchema))
+      .errors(hostedAiStreamErrors),
+  },
+  languageDetection: {
+    // Detection wants one short string back, not a stream, but the quota
+    // reserve/settle path is stream-shaped end to end. Reusing it keeps one
+    // metering implementation; the client collects the deltas.
+    streamText: oc
+      .route({
+        method: "POST",
+        path: "/hosted-ai/language-detection/stream-text",
+        summary: "Stream hosted language detection output",
+        tags: ["Hosted AI"],
+      })
+      .input(HostedAiStreamTextInputSchema)
+      .output(eventIterator(HostedAiStreamPartSchema))
+      .errors(hostedAiStreamErrors),
+  },
   customAction: {
     streamStructuredObject: oc
       .route({

package/src/schemas/hosted-ai.ts

@@ -9,14 +9,28 @@ export const HostedAiOutputFieldSchema = z.strictObject({
 
 const HostedAiInstructionsSchema = z.string().trim().min(1).max(16000)
 
-export const HostedAiModelTierSchema = z.enum(["normal", "ultra"])
+/**
+ * Which hosted model a request runs on. Deliberately NOT named after a billing
+ * plan: which plans may reach which tier is policy (see `access-policy.ts`),
+ * not identity, so a future plan can be sold with any tier without a rename.
+ */
+export const HostedAiModelTierSchema = z.enum(["normal", "advance"])
+/**
+ * The billing/access subject of a hosted request, not a route id. Sub-calls
+ * bill against the feature they serve: the page summary is `pageTranslation`,
+ * and the video summary and subtitle segmentation are `videoSubtitles`.
+ *
+ * Appended last on purpose: the db pgEnum mirrors this order, and appending
+ * keeps drizzle from emitting the ADD VALUE ... BEFORE variant.
+ */
 export const HostedAiFeatureSchema = z.enum([
   "pageTranslation",
   "customAction",
   "noteSuggestion",
-  // Appended last on purpose: the db pgEnum mirrors this order, and appending
-  // keeps drizzle from emitting the ADD VALUE ... BEFORE variant.
   "selectionTranslation",
+  "videoSubtitles",
+  "inputTranslation",
+  "languageDetection",
 ])
 export const HostedAiRequestIdSchema = z.uuid()
 
@@ -210,7 +224,7 @@ export const HostedAiTierStatusSchema = z.strictObject({
 
 export const HostedAiFeatureStatusSchema = z.strictObject({
   normal: HostedAiTierStatusSchema,
-  ultra: HostedAiTierStatusSchema,
+  advance: HostedAiTierStatusSchema,
 })
 
 export const HostedAiStatusOutputSchema = z.strictObject({
@@ -220,6 +234,9 @@ export const HostedAiStatusOutputSchema = z.strictObject({
     customAction: HostedAiFeatureStatusSchema,
     noteSuggestion: HostedAiFeatureStatusSchema,
     selectionTranslation: HostedAiFeatureStatusSchema,
+    videoSubtitles: HostedAiFeatureStatusSchema,
+    inputTranslation: HostedAiFeatureStatusSchema,
+    languageDetection: HostedAiFeatureStatusSchema,
   }),
 })