@robota-sdk/agent-provider 3.0.0-beta.64

package/src/qwen/provider-definition.ts

@@ -0,0 +1,173 @@
+import type { IProviderDefinition } from '@robota-sdk/agent-core';
+import type { TUniversalValue } from '@robota-sdk/agent-core';
+import { probeOpenAICompatibleProfile } from '../shared/openai-compatible/index.js';
+import { QwenProvider } from './provider';
+import {
+  DEFAULT_QWEN_PROVIDER_API_KEY_REFERENCE,
+  DEFAULT_QWEN_PROVIDER_BASE_URL,
+  DEFAULT_QWEN_PROVIDER_MODEL,
+  QWEN_MODEL_LAST_VERIFIED_AT,
+  QWEN_MODEL_SOURCE_URL,
+} from './defaults';
+import type { IQwenBuiltInWebToolsOptions } from './types';
+import { refreshQwenModelCatalog } from './model-catalog-refresh';
+
+const QWEN_API_KEY_URL = 'https://modelstudio.console.alibabacloud.com/?tab=api#/api-key';
+const QWEN_SETUP_SOURCE_URL = 'https://www.alibabacloud.com/help/en/model-studio/get-api-key';
+const QWEN_SETUP_LAST_VERIFIED_AT = '2026-05-08';
+const QWEN_SETUP_HELP_LINKS: NonNullable<IProviderDefinition['setupHelpLinks']> = [
+  {
+    kind: 'api-key',
+    label: 'Alibaba Cloud Model Studio API keys',
+    url: QWEN_API_KEY_URL,
+    sourceUrl: QWEN_SETUP_SOURCE_URL,
+    lastVerifiedAt: QWEN_SETUP_LAST_VERIFIED_AT,
+  },
+];
+const QWEN_MODEL_CATALOG: NonNullable<IProviderDefinition['modelCatalog']> = {
+  status: 'fallback',
+  sourceUrl: QWEN_MODEL_SOURCE_URL,
+  lastVerifiedAt: QWEN_MODEL_LAST_VERIFIED_AT,
+  entries: [
+    {
+      id: DEFAULT_QWEN_PROVIDER_MODEL,
+      displayName: 'Qwen Plus',
+      capabilities: ['tools', 'reasoning', 'native_web', 'streaming'],
+      lifecycle: 'active',
+      sourceUrl: QWEN_MODEL_SOURCE_URL,
+      lastVerifiedAt: QWEN_MODEL_LAST_VERIFIED_AT,
+    },
+    {
+      id: 'qwen-max',
+      displayName: 'Qwen Max',
+      capabilities: ['tools', 'reasoning', 'native_web', 'streaming'],
+      lifecycle: 'active',
+      sourceUrl: QWEN_MODEL_SOURCE_URL,
+      lastVerifiedAt: QWEN_MODEL_LAST_VERIFIED_AT,
+    },
+    {
+      id: 'qwen-flash',
+      displayName: 'Qwen Flash',
+      capabilities: ['tools', 'native_web', 'streaming'],
+      lifecycle: 'active',
+      sourceUrl: QWEN_MODEL_SOURCE_URL,
+      lastVerifiedAt: QWEN_MODEL_LAST_VERIFIED_AT,
+    },
+  ],
+};
+
+export {
+  DEFAULT_QWEN_PROVIDER_API_KEY_ENV,
+  DEFAULT_QWEN_PROVIDER_API_KEY_REFERENCE,
+  DEFAULT_QWEN_PROVIDER_BASE_URL,
+  DEFAULT_QWEN_PROVIDER_MODEL,
+  DEFAULT_QWEN_PROVIDER_RESPONSES_BASE_URL,
+  QWEN_PROVIDER_BASE_URLS,
+  QWEN_PROVIDER_RESPONSES_BASE_URLS,
+} from './defaults';
+export type { TQwenProviderRegion, TQwenProviderResponsesRegion } from './defaults';
+
+export function createQwenProviderDefinition(): IProviderDefinition {
+  return {
+    type: 'qwen',
+    displayName: 'Qwen',
+    description: 'Alibaba Cloud Model Studio OpenAI-compatible endpoint',
+    defaults: {
+      model: DEFAULT_QWEN_PROVIDER_MODEL,
+      apiKey: DEFAULT_QWEN_PROVIDER_API_KEY_REFERENCE,
+      baseURL: DEFAULT_QWEN_PROVIDER_BASE_URL,
+    },
+    modelCatalog: QWEN_MODEL_CATALOG,
+    refreshModelCatalog: ({ profile }) => refreshQwenModelCatalog(profile),
+    modelCatalogCacheTtlSeconds: 86400,
+    setupHelpLinks: QWEN_SETUP_HELP_LINKS,
+    setupSteps: [
+      {
+        key: 'baseURL',
+        title: 'Qwen OpenAI-compatible base URL',
+        defaultValue: DEFAULT_QWEN_PROVIDER_BASE_URL,
+      },
+      {
+        key: 'model',
+        title: 'Qwen model',
+        defaultValue: DEFAULT_QWEN_PROVIDER_MODEL,
+      },
+      {
+        key: 'apiKey',
+        title: 'Qwen Model Studio API key',
+        defaultValue: DEFAULT_QWEN_PROVIDER_API_KEY_REFERENCE,
+        masked: true,
+      },
+    ],
+    requiresApiKey: true,
+    probeProfile: probeOpenAICompatibleProfile,
+    createProvider: (config) => {
+      const qwenOptions = parseQwenProviderOptions(config.options);
+      return new QwenProvider({
+        apiKey: requireApiKey(config.apiKey),
+        ...(config.baseURL !== undefined && { baseURL: config.baseURL }),
+        ...(qwenOptions.responsesBaseURL !== undefined && {
+          responsesBaseURL: qwenOptions.responsesBaseURL,
+        }),
+        ...(config.timeout !== undefined && { timeout: config.timeout }),
+        ...(qwenOptions.builtInWebTools !== undefined && {
+          builtInWebTools: qwenOptions.builtInWebTools,
+        }),
+        defaultModel: config.model,
+      });
+    },
+  };
+}
+
+function requireApiKey(apiKey: string | undefined): string {
+  if (!apiKey) {
+    throw new Error('Provider qwen requires apiKey');
+  }
+  return apiKey;
+}
+
+function parseQwenProviderOptions(options: Record<string, TUniversalValue> | undefined): {
+  responsesBaseURL?: string;
+  builtInWebTools?: IQwenBuiltInWebToolsOptions;
+} {
+  const builtInWebTools = parseBuiltInWebTools(asRecord(options?.['builtInWebTools']));
+  const responsesBaseURL = asString(options?.['responsesBaseURL']);
+  return {
+    ...(responsesBaseURL !== undefined && { responsesBaseURL }),
+    ...(builtInWebTools !== undefined && { builtInWebTools }),
+  };
+}
+
+function parseBuiltInWebTools(
+  options: Record<string, TUniversalValue> | undefined,
+): IQwenBuiltInWebToolsOptions | undefined {
+  if (options === undefined) {
+    return undefined;
+  }
+  return {
+    ...(asBoolean(options['webSearch']) !== undefined && {
+      webSearch: asBoolean(options['webSearch']),
+    }),
+    ...(asBoolean(options['webFetch']) !== undefined && {
+      webFetch: asBoolean(options['webFetch']),
+    }),
+    ...(asBoolean(options['enableThinking']) !== undefined && {
+      enableThinking: asBoolean(options['enableThinking']),
+    }),
+  };
+}
+
+function asRecord(value: TUniversalValue | undefined): Record<string, TUniversalValue> | undefined {
+  if (value === null || value === undefined || value instanceof Date || Array.isArray(value)) {
+    return undefined;
+  }
+  return typeof value === 'object' ? value : undefined;
+}
+
+function asBoolean(value: TUniversalValue | undefined): boolean | undefined {
+  return typeof value === 'boolean' ? value : undefined;
+}
+
+function asString(value: TUniversalValue | undefined): string | undefined {
+  return typeof value === 'string' && value.length > 0 ? value : undefined;
+}

package/src/qwen/provider-streaming-assembly.ts

@@ -0,0 +1,40 @@
+import OpenAI from 'openai';
+import type { IChatOptions, TUniversalMessage } from '@robota-sdk/agent-core';
+import {
+  assembleOpenAICompatibleStream,
+  observeProviderNativeRawPayloadStream,
+} from '../shared/openai-compatible/index.js';
+import type { IOpenAICompatibleError } from '../shared/openai-compatible/index.js';
+
+export async function qwenChatWithStreamingAssembly(
+  client: OpenAI,
+  requestParams: OpenAI.Chat.ChatCompletionCreateParamsStreaming,
+  options: IChatOptions,
+): Promise<TUniversalMessage> {
+  try {
+    options.onProviderNativeRawPayload?.({
+      provider: 'qwen',
+      apiSurface: 'chat-completions',
+      payloadKind: 'request',
+      payload: requestParams,
+    });
+    const stream = await client.chat.completions.create(
+      requestParams,
+      options.signal ? { signal: options.signal } : undefined,
+    );
+
+    return assembleOpenAICompatibleStream({
+      stream: observeProviderNativeRawPayloadStream(stream, {
+        provider: 'qwen',
+        apiSurface: 'chat-completions',
+        onProviderNativeRawPayload: options.onProviderNativeRawPayload,
+      }),
+      onTextDelta: options.onTextDelta,
+      signal: options.signal,
+    });
+  } catch (error) {
+    const qwenError = error as IOpenAICompatibleError;
+    const errorMessage = qwenError.message || 'Qwen streaming request failed';
+    throw new Error(`Qwen stream failed: ${errorMessage}`);
+  }
+}