@openloaf-saas/sdk 0.1.34 → 0.1.37

package/dist/index.d.ts

@@ -741,11 +741,13 @@ declare class SaaSContract {
             variant: string;
             inputs?: Record<string, unknown> | undefined;
             params?: Record<string, unknown> | undefined;
+            stream?: boolean | undefined;
         }, {
             success: true;
             data: {
                 text: string;
                 creditsConsumed?: number | undefined;
+                taskId?: string | undefined;
             };
         }>;
         readonly v3Generate: Endpoint<{
@@ -755,6 +757,7 @@ declare class SaaSContract {
             inputs?: Record<string, unknown> | undefined;
             params?: Record<string, unknown> | undefined;
             count?: number | undefined;
+            stream?: boolean | undefined;
         }, {
             success: true;
             data: {
@@ -1275,6 +1278,8 @@ type BaseSaaSClientOptions<TContract> = {
     fetcher?: typeof fetch;
     headers?: HeaderInput;
     contract: TContract;
+    /** Default locale for APIs that support i18n (e.g. "zh-CN", "en-US"). */
+    locale?: string;
 };
 declare class BaseSaaSClient<TContract> {
     /** Contract definitions used by the client. */
@@ -1287,6 +1292,8 @@ declare class BaseSaaSClient<TContract> {
     private readonly fetcher;
     /** Static headers injected into every request. */
     private readonly headers?;
+    /** Default locale for i18n-aware APIs. */
+    private locale?;
     /** Create a base client instance. */
     constructor(options: BaseSaaSClientOptions<TContract>);
     /** Send a typed request to the SaaS server. */
@@ -1299,6 +1306,10 @@ declare class BaseSaaSClient<TContract> {
     buildAuthHeader(): Promise<Record<string, string>>;
     /** Return the configured base URL. */
     getBaseUrl(): string;
+    /** Return the configured default locale. */
+    getLocale(): string | undefined;
+    /** Update the default locale at runtime. */
+    setLocale(locale: string | undefined): void;
 }
 
 /** Request function signature shared by SDK clients. */
@@ -1317,6 +1328,8 @@ type SdkHost<TContract> = {
     getBaseUrl: () => string;
     /** Build Authorization header for authenticated calls. */
     buildAuthHeader: () => Promise<Record<string, string>>;
+    /** Resolve the configured default locale (e.g. "zh-CN"). */
+    getLocale: () => string | undefined;
 };
 
 declare const aiEndpoints: {
@@ -2020,17 +2033,19 @@ declare const aiEndpoints: {
             updatedAt?: string | undefined;
         };
     }>;
-    /** Submit a v3 text generate request (sync, for translate/OCR/caption). */
+    /** Submit a v3 text generate request (sync JSON or streaming SSE). */
     readonly v3TextGenerate: Endpoint<{
         feature: string;
         variant: string;
         inputs?: Record<string, unknown> | undefined;
         params?: Record<string, unknown> | undefined;
+        stream?: boolean | undefined;
     }, {
         success: true;
         data: {
             text: string;
             creditsConsumed?: number | undefined;
+            taskId?: string | undefined;
         };
     }>;
     /** Submit a v3 generate request. */
@@ -2041,6 +2056,7 @@ declare const aiEndpoints: {
         inputs?: Record<string, unknown> | undefined;
         params?: Record<string, unknown> | undefined;
         count?: number | undefined;
+        stream?: boolean | undefined;
     }, {
         success: true;
         data: {
@@ -3705,6 +3721,7 @@ declare const v3GenerateRequestSchema: z.ZodObject<{
     inputs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     count: z.ZodOptional<z.ZodNumber>;
+    stream: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 /** v3 text generate request body. */
 declare const v3TextGenerateRequestSchema: z.ZodObject<{
@@ -3712,6 +3729,7 @@ declare const v3TextGenerateRequestSchema: z.ZodObject<{
     variant: z.ZodString;
     inputs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
     params: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodUnknown>>;
+    stream: z.ZodOptional<z.ZodBoolean>;
 }, z.core.$strip>;
 /** v3 text generate response. */
 declare const v3TextGenerateResponseSchema: z.ZodObject<{
@@ -3719,6 +3737,7 @@ declare const v3TextGenerateResponseSchema: z.ZodObject<{
     data: z.ZodObject<{
         text: z.ZodString;
         creditsConsumed: z.ZodOptional<z.ZodNumber>;
+        taskId: z.ZodOptional<z.ZodString>;
     }, z.core.$strip>;
 }, z.core.$strip>;
 /** Individual task item within a v3 response. */
@@ -4651,8 +4670,15 @@ declare class AiClient {
             updatedAt?: string | undefined;
         };
     }>;
-    /** Submit a v3 text generate request (sync, for translate/OCR/caption). */
+    /** Submit a v3 text generate request (sync mode, returns parsed JSON). */
     v3TextGenerate(payload: V3TextGenerateRequest): Promise<V3TextGenerateResponse>;
+    /**
+     * Submit a v3 text generate request in streaming mode.
+     * 返回原始 Response，调用方通过 response.body (ReadableStream) 消费 SSE 事件。
+     * 每个 SSE event 的 data 字段是 OpenAI chat completions chunk 格式。
+     * taskId 通过响应头 x-task-id 返回。
+     */
+    v3TextGenerateStream(payload: Omit<V3TextGenerateRequest, "stream">): Promise<Response>;
     /** Submit a v3 generate request (unified for all media types). */
     v3Generate(payload: V3GenerateRequest): Promise<{
         success: true;
@@ -4663,6 +4689,13 @@ declare class AiClient {
             taskIds: string[];
         };
     }>;
+    /**
+     * Submit a v3 generate request in streaming mode.
+     * 返回原始 Response，调用方通过 response.body (ReadableStream) 消费 SSE 事件。
+     * 每个 SSE event 的 data 字段是 OpenAI chat completions chunk 格式。
+     * taskId 通过响应头 x-task-id 返回。
+     */
+    v3GenerateStream(payload: Omit<V3GenerateRequest, "stream" | "count">): Promise<Response>;
     /** Get v3 task details by ID. */
     v3Task(taskId: string): Promise<{
         success: true;
@@ -5178,6 +5211,21 @@ declare const MEDIA_FEATURES: {
             readonly ja: "画像内のテキストを認識";
         };
     };
+    readonly audioRecognize: {
+        readonly id: "audioRecognize";
+        readonly label: {
+            readonly zh: "音频识别";
+            readonly "zh-TW": "音訊辨識";
+            readonly en: "Audio Recognition";
+            readonly ja: "音声認識";
+        };
+        readonly description: {
+            readonly zh: "识别音频中的语音内容并转录为文字";
+            readonly "zh-TW": "辨識音訊中的語音內容並轉錄為文字";
+            readonly en: "Recognize speech in audio and transcribe to text";
+            readonly ja: "音声の内容を認識してテキストに書き起こす";
+        };
+    };
     readonly imageCaption: {
         readonly id: "imageCaption";
         readonly label: {
@@ -5193,6 +5241,21 @@ declare const MEDIA_FEATURES: {
             readonly ja: "画像のテキスト説明を自動生成";
         };
     };
+    readonly videoCaption: {
+        readonly id: "videoCaption";
+        readonly label: {
+            readonly zh: "视频描述";
+            readonly "zh-TW": "影片描述";
+            readonly en: "Video Caption";
+            readonly ja: "動画キャプション";
+        };
+        readonly description: {
+            readonly zh: "自动生成视频的文字描述";
+            readonly "zh-TW": "自動生成影片的文字描述";
+            readonly en: "Automatically generate text descriptions for videos";
+            readonly ja: "動画のテキスト説明を自動生成";
+        };
+    };
     readonly musicGenerate: {
         readonly id: "musicGenerate";
         readonly label: {
@@ -7070,6 +7133,8 @@ declare class SkillMarketClient {
     constructor(sdk: SkillMarketSdkHost);
     /** Build URL query string from params (skip undefined/null values). */
     private buildQuery;
+    /** Resolve effective lang: explicit param > global locale > undefined (server default). */
+    private resolveLang;
     /**
      * List marketplace skills with optional filters.
      * @remarks Public endpoint — no authentication required.