@agentor/dashscope 0.0.0 → 0.0.1

package/README.md

@@ -10,6 +10,8 @@
 
 - **Chat Completions API** - Standard `/chat/completions` with function calling, streaming, and reasoning
 - **Responses API** - `/responses` endpoint with built-in tools support
+- **Embedding** - Text vectorization via OpenAI-compatible `/embeddings` endpoint
+- **Reranking** - Document reranking via `/reranks` endpoint
 - **Built-in Tools** - Web search, code interpreter, web extractor, file search, image search, MCP integration
 - **Thinking Mode** - Enable reasoning/thinking with configurable budget
 - **Multi-region** - Beijing, Singapore, US, Germany regions
@@ -245,16 +247,87 @@ const first = await generateText({
 });
 ```
 
+## Embedding
+
+```typescript
+import { embed, embedMany } from "ai";
+
+// Single text embedding
+const { embedding, usage } = await embed({
+  model: dashscope.embeddingModel("text-embedding-v4"),
+  value: "The clothes quality is excellent",
+});
+
+console.log(embedding.length); // 1024 (default dimensions)
+
+// Batch embedding
+const { embeddings } = await embedMany({
+  model: dashscope.embeddingModel("text-embedding-v4"),
+  values: ["Hello world", "Machine learning is fascinating"],
+});
+```
+
+### Custom Dimensions
+
+```typescript
+const { embedding } = await embed({
+  model: dashscope.embeddingModel("text-embedding-v4"),
+  value: "Custom dimension embedding",
+  providerOptions: {
+    openaiCompatible: {
+      dimensions: 256,
+    },
+  },
+});
+
+console.log(embedding.length); // 256
+```
+
+## Reranking
+
+```typescript
+import { rerank } from "ai";
+
+const { ranking } = await rerank({
+  model: dashscope.rerankingModel("qwen3-rerank"),
+  query: "What is a reranking model?",
+  documents: [
+    "Reranking models sort candidate texts by relevance",
+    "Quantum computing is a frontier field",
+    "Pre-trained models brought advances to reranking",
+  ],
+});
+
+for (const item of ranking) {
+  console.log(`Index: ${item.originalIndex}, Score: ${item.score}`);
+}
+```
+
+### Top N Results
+
+```typescript
+const { ranking } = await rerank({
+  model: dashscope.rerankingModel("qwen3-rerank"),
+  query: "How to reset password?",
+  documents: [
+    "Go to Settings > Security > Change Password",
+    "Forgot your password?",
+    "Two-factor authentication is supported",
+  ],
+  topN: 2,
+});
+```
+
 ## Provider Configuration
 
 ```typescript
 import { createDashScope } from "@agentor/dashscope";
 
 const dashscope = createDashScope({
-  apiKey: "sk-xxx",                       // or set DASHSCOPE_API_KEY env var
-  region: "beijing",                       // beijing | singapore | us | germany
-  workspaceId: "ws-xxx",                   // required for germany region
-  baseURL: "https://custom-endpoint.com",  // override default base URL
+  apiKey: "sk-xxx", // or set DASHSCOPE_API_KEY env var
+  region: "beijing", // beijing | singapore | us | germany
+  workspaceId: "ws-xxx", // required for germany region
+  baseURL: "https://custom-endpoint.com", // override default base URL
   headers: { "X-Custom-Header": "value" }, // custom headers
 });
 ```

package/dist/index.d.mts

@@ -1,6 +1,7 @@
+import { OpenAICompatibleEmbeddingModel } from "@ai-sdk/openai-compatible";
 import * as _$_ai_sdk_provider_utils0 from "@ai-sdk/provider-utils";
 import { FetchFunction } from "@ai-sdk/provider-utils";
-import { LanguageModelV3 } from "@ai-sdk/provider";
+import { EmbeddingModelV3, LanguageModelV3, RerankingModelV3, RerankingModelV3CallOptions, SharedV3Warning } from "@ai-sdk/provider";
 
 //#region src/tools.d.ts
 declare const webSearchToolFactory: _$_ai_sdk_provider_utils0.ProviderToolFactoryWithOutputSchema<Record<string, never>, {
@@ -164,13 +165,6 @@ interface DashScopeChatOptions {
   /** Enable code interpreter (requires enableThinking). */
   enableCodeInterpreter?: boolean;
 }
-interface DashScopeChatConfig {
-  provider: string;
-  baseURL: string;
-  headers: () => Record<string, string>;
-  fetch?: FetchFunction;
-  includeUsage?: boolean;
-}
 interface DashScopeResponsesOptions {
   enableThinking?: boolean;
   reasoning?: {
@@ -188,6 +182,8 @@ interface DashScopeResponsesNamespace {
 interface DashScopeProvider {
   (modelId: string): LanguageModelV3;
   languageModel(modelId: string): LanguageModelV3;
+  embeddingModel(modelId: string): EmbeddingModelV3;
+  rerankingModel(modelId: string): RerankingModelV3;
   chatOptions: (options: DashScopeChatOptions) => {
     providerOptions: {
       dashscope: DashScopeChatOptions;
@@ -201,10 +197,53 @@ interface DashScopeProvider {
   responses: DashScopeResponsesNamespace;
 }
 //#endregion
+//#region src/utils.d.ts
+interface DashScopeConfig {
+  provider: string;
+  baseURL: string;
+  headers: () => Record<string, string>;
+  fetch?: FetchFunction;
+  includeUsage?: boolean;
+}
+//#endregion
+//#region src/embedding.d.ts
+interface DashScopeEmbeddingOptions {
+  /** Output embedding dimensions. Supported by text-embedding-v4, text-embedding-v3, etc. */
+  dimensions?: number;
+}
+declare class DashScopeEmbeddingModel extends OpenAICompatibleEmbeddingModel {
+  constructor(modelId: string, config: DashScopeConfig);
+}
+//#endregion
+//#region src/rerank.d.ts
+interface DashScopeRerankOptions {
+  /** English instruction to guide the reranking strategy. */
+  instruct?: string;
+}
+declare class DashScopeRerankingModel implements RerankingModelV3 {
+  readonly specificationVersion: "v3";
+  readonly modelId: string;
+  private readonly config;
+  constructor(modelId: string, config: DashScopeConfig);
+  get provider(): string;
+  doRerank(options: RerankingModelV3CallOptions): Promise<{
+    ranking: {
+      index: number;
+      relevanceScore: number;
+    }[];
+    warnings: SharedV3Warning[];
+    response: {
+      id: string | undefined;
+      modelId: string | undefined;
+      headers: Record<string, string> | undefined;
+    };
+  }>;
+}
+//#endregion
 //#region src/provider.d.ts
 declare function createDashScope(options?: DashScopeProviderSettings): DashScopeProvider;
 //#endregion
 //#region src/index.d.ts
 declare const dashscope: DashScopeProvider;
 //#endregion
-export { DASHSCOPE_REGION_BASE_URLS, DashScopeChatConfig, DashScopeChatOptions, DashScopeProvider, DashScopeProviderSettings, DashScopeRegion, DashScopeResponsesNamespace, DashScopeResponsesOptions, DashScopeResponsesTools, createDashScope, dashscope, responsesTools };
+export { DASHSCOPE_REGION_BASE_URLS, DashScopeChatOptions, DashScopeEmbeddingModel, DashScopeEmbeddingOptions, DashScopeProvider, DashScopeProviderSettings, DashScopeRegion, DashScopeRerankOptions, DashScopeRerankingModel, DashScopeResponsesNamespace, DashScopeResponsesOptions, DashScopeResponsesTools, createDashScope, dashscope, responsesTools };

package/dist/index.mjs

@@ -1,23 +1,106 @@
-import { z } from "zod/v4";
+import { OpenAICompatibleEmbeddingModel } from "@ai-sdk/openai-compatible";
 import { combineHeaders, convertToBase64, createEventSourceResponseHandler, createJsonErrorResponseHandler, createJsonResponseHandler, createProviderToolFactoryWithOutputSchema, generateId, isParsableJson, lazySchema, parseProviderOptions, postJsonToApi, zodSchema } from "@ai-sdk/provider-utils";
-import { mapOpenAICompatibleFinishReason, prepareTools } from "@ai-sdk/openai-compatible/internal";
-//#region src/types.ts
-const DASHSCOPE_REGION_BASE_URLS = {
-	beijing: {
-		baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1",
-		videoBaseURL: "https://dashscope.aliyuncs.com"
-	},
-	singapore: {
-		baseURL: "https://dashscope-intl.aliyuncs.com/compatible-mode/v1",
-		videoBaseURL: "https://dashscope-intl.aliyuncs.com"
-	},
-	us: {
-		baseURL: "https://dashscope-us.aliyuncs.com/compatible-mode/v1",
-		videoBaseURL: "https://dashscope-us.aliyuncs.com"
-	},
-	germany: {
-		baseURL: "https://{workspaceId}.eu-central-1.maas.aliyuncs.com/compatible-mode/v1",
-		videoBaseURL: "https://{workspaceId}.eu-central-1.maas.aliyuncs.com"
+import { z } from "zod/v4";
+import { convertOpenAICompatibleChatUsage, getResponseMetadata, mapOpenAICompatibleFinishReason, prepareTools } from "@ai-sdk/openai-compatible/internal";
+//#region src/embedding.ts
+var DashScopeEmbeddingModel = class extends OpenAICompatibleEmbeddingModel {
+	constructor(modelId, config) {
+		super(modelId, {
+			provider: config.provider,
+			url: () => `${config.baseURL}/embeddings`,
+			headers: config.headers,
+			fetch: config.fetch
+		});
+	}
+};
+const failedResponseHandler = createJsonErrorResponseHandler({
+	errorSchema: zodSchema(z.object({ error: z.object({
+		message: z.string(),
+		code: z.string().nullish(),
+		type: z.string().nullish()
+	}) })),
+	errorToMessage: (data) => data.error.message
+});
+function convertResponsesUsage(usage) {
+	if (!usage) return {
+		inputTokens: {
+			total: 0,
+			noCache: void 0,
+			cacheRead: void 0,
+			cacheWrite: void 0
+		},
+		outputTokens: {
+			total: 0,
+			text: void 0,
+			reasoning: void 0
+		}
+	};
+	return {
+		inputTokens: {
+			total: usage.input_tokens ?? 0,
+			noCache: void 0,
+			cacheRead: usage.input_tokens_details?.cached_tokens ?? void 0,
+			cacheWrite: void 0
+		},
+		outputTokens: {
+			total: usage.output_tokens ?? 0,
+			text: void 0,
+			reasoning: usage.output_tokens_details?.reasoning_tokens ?? void 0
+		},
+		raw: usage
+	};
+}
+//#endregion
+//#region src/rerank.ts
+const rerankResponseSchema = zodSchema(z.object({
+	id: z.string().optional(),
+	model: z.string().optional(),
+	results: z.array(z.object({
+		index: z.number(),
+		relevance_score: z.number()
+	})).optional()
+}));
+var DashScopeRerankingModel = class {
+	specificationVersion = "v3";
+	modelId;
+	config;
+	constructor(modelId, config) {
+		this.modelId = modelId;
+		this.config = config;
+	}
+	get provider() {
+		return this.config.provider;
+	}
+	async doRerank(options) {
+		const warnings = [];
+		const documents = options.documents.type === "text" ? options.documents.values : options.documents.values.map((d) => JSON.stringify(d));
+		const body = {
+			model: this.modelId,
+			query: options.query,
+			documents,
+			...options.topN != null && { top_n: options.topN }
+		};
+		const { responseHeaders, value: response } = await postJsonToApi({
+			url: `${this.config.baseURL.replace("/compatible-mode/", "/compatible-api/")}/reranks`,
+			headers: combineHeaders(this.config.headers(), options.headers),
+			body,
+			failedResponseHandler,
+			successfulResponseHandler: createJsonResponseHandler(rerankResponseSchema),
+			abortSignal: options.abortSignal,
+			fetch: this.config.fetch
+		});
+		return {
+			ranking: (response.results ?? []).map((r) => ({
+				index: r.index,
+				relevanceScore: r.relevance_score
+			})),
+			warnings,
+			response: {
+				id: response.id ?? void 0,
+				modelId: response.model ?? void 0,
+				headers: responseHeaders
+			}
+		};
 	}
 };
 //#endregion
@@ -95,6 +178,26 @@ const responsesTools = {
 	mcp: (args) => mcpToolFactory(args)
 };
 //#endregion
+//#region src/types.ts
+const DASHSCOPE_REGION_BASE_URLS = {
+	beijing: {
+		baseURL: "https://dashscope.aliyuncs.com/compatible-mode/v1",
+		videoBaseURL: "https://dashscope.aliyuncs.com"
+	},
+	singapore: {
+		baseURL: "https://dashscope-intl.aliyuncs.com/compatible-mode/v1",
+		videoBaseURL: "https://dashscope-intl.aliyuncs.com"
+	},
+	us: {
+		baseURL: "https://dashscope-us.aliyuncs.com/compatible-mode/v1",
+		videoBaseURL: "https://dashscope-us.aliyuncs.com"
+	},
+	germany: {
+		baseURL: "https://{workspaceId}.eu-central-1.maas.aliyuncs.com/compatible-mode/v1",
+		videoBaseURL: "https://{workspaceId}.eu-central-1.maas.aliyuncs.com"
+	}
+};
+//#endregion
 //#region src/chat.ts
 const chatOptionsSchema = z.object({
 	enableThinking: z.boolean().optional(),
@@ -165,45 +268,6 @@ const chatChunkSchema = z.object({
 	})),
 	usage: usageSchema.nullish()
 });
-const failedResponseHandler$1 = createJsonErrorResponseHandler({
-	errorSchema: z.object({ error: z.object({
-		message: z.string(),
-		code: z.string().nullish(),
-		type: z.string().nullish()
-	}) }),
-	errorToMessage: (data) => data.error.message
-});
-function convertUsage$1(usage) {
-	if (!usage) return {
-		inputTokens: {
-			total: 0,
-			noCache: void 0,
-			cacheRead: void 0,
-			cacheWrite: void 0
-		},
-		outputTokens: {
-			total: 0,
-			text: void 0,
-			reasoning: void 0
-		}
-	};
-	const cacheRead = usage.prompt_tokens_details?.cached_tokens ?? void 0;
-	const cacheWrite = usage.prompt_tokens_details?.cache_creation_input_tokens ?? void 0;
-	const noCache = cacheRead != null || cacheWrite != null ? (usage.prompt_tokens ?? 0) - (cacheRead ?? 0) - (cacheWrite ?? 0) : void 0;
-	return {
-		inputTokens: {
-			total: usage.prompt_tokens ?? 0,
-			noCache,
-			cacheRead,
-			cacheWrite
-		},
-		outputTokens: {
-			total: usage.completion_tokens ?? 0,
-			text: void 0,
-			reasoning: usage.completion_tokens_details?.reasoning_tokens ?? void 0
-		}
-	};
-}
 function convertMessages(prompt) {
 	const messages = [];
 	for (const { role, content } of prompt) switch (role) {
@@ -361,7 +425,7 @@ var DashScopeChatLanguageModel = class {
 			url: `${this.config.baseURL}/chat/completions`,
 			headers: combineHeaders(this.config.headers(), options.headers),
 			body: args,
-			failedResponseHandler: failedResponseHandler$1,
+			failedResponseHandler,
 			successfulResponseHandler: createJsonResponseHandler(chatResponseSchema),
 			abortSignal: options.abortSignal,
 			fetch: this.config.fetch
@@ -388,12 +452,10 @@ var DashScopeChatLanguageModel = class {
 				unified: mapOpenAICompatibleFinishReason(choice.finish_reason),
 				raw: choice.finish_reason ?? void 0
 			},
-			usage: convertUsage$1(response.usage),
+			usage: convertOpenAICompatibleChatUsage(response.usage),
 			request: { body: JSON.stringify(args) },
 			response: {
-				id: response.id ?? void 0,
-				modelId: response.model ?? void 0,
-				timestamp: response.created ? /* @__PURE__ */ new Date(response.created * 1e3) : void 0,
+				...getResponseMetadata(response),
 				headers: responseHeaders
 			},
 			warnings
@@ -409,7 +471,7 @@ var DashScopeChatLanguageModel = class {
 			url: `${this.config.baseURL}/chat/completions`,
 			headers: combineHeaders(this.config.headers(), options.headers),
 			body,
-			failedResponseHandler: failedResponseHandler$1,
+			failedResponseHandler,
 			successfulResponseHandler: createEventSourceResponseHandler(chatChunkSchema),
 			abortSignal: options.abortSignal,
 			fetch: this.config.fetch
@@ -448,9 +510,7 @@ var DashScopeChatLanguageModel = class {
 						isFirstChunk = false;
 						controller.enqueue({
 							type: "response-metadata",
-							id: value.id ?? void 0,
-							modelId: value.model ?? void 0,
-							timestamp: value.created ? /* @__PURE__ */ new Date(value.created * 1e3) : void 0
+							...getResponseMetadata(value)
 						});
 					}
 					if (value.usage != null) usage = value.usage;
@@ -594,7 +654,7 @@ var DashScopeChatLanguageModel = class {
 					controller.enqueue({
 						type: "finish",
 						finishReason,
-						usage: convertUsage$1(usage)
+						usage: convertOpenAICompatibleChatUsage(usage)
 					});
 				}
 			})),
@@ -619,11 +679,6 @@ const responsesOptionsSchema = zodSchema(z.object({
 	instructions: z.string().optional(),
 	includeUsage: z.boolean().optional()
 }));
-const errorSchema = zodSchema(z.object({ error: z.object({
-	message: z.string(),
-	type: z.string().optional(),
-	code: z.string().optional()
-}) }));
 const responseSchema = zodSchema(z.object({
 	id: z.string(),
 	created_at: z.number().optional(),
@@ -641,41 +696,6 @@ const responseSchema = zodSchema(z.object({
 	error: z.object({ message: z.string() }).nullable().optional()
 }).loose());
 const streamChunkSchema = zodSchema(z.object({ type: z.string() }).loose());
-const failedResponseHandler = createJsonErrorResponseHandler({
-	errorSchema,
-	errorToMessage: (data) => data.error.message
-});
-function convertUsage(usage) {
-	if (!usage) return {
-		inputTokens: {
-			total: 0,
-			noCache: void 0,
-			cacheRead: void 0,
-			cacheWrite: void 0
-		},
-		outputTokens: {
-			total: 0,
-			text: void 0,
-			reasoning: void 0
-		}
-	};
-	const details = usage.output_tokens_details;
-	const inputDetails = usage.input_tokens_details;
-	return {
-		inputTokens: {
-			total: usage.input_tokens ?? 0,
-			noCache: void 0,
-			cacheRead: inputDetails?.cached_tokens ?? void 0,
-			cacheWrite: void 0
-		},
-		outputTokens: {
-			total: usage.output_tokens ?? 0,
-			text: void 0,
-			reasoning: details?.reasoning_tokens ?? void 0
-		},
-		raw: usage
-	};
-}
 function mapFinishReason(status) {
 	switch (status) {
 		case "completed": return {
@@ -1066,7 +1086,7 @@ var DashScopeResponsesLanguageModel = class {
 		return {
 			content,
 			finishReason,
-			usage: convertUsage(response.usage),
+			usage: convertResponsesUsage(response.usage),
 			request: { body },
 			response: {
 				id: response.id ?? void 0,
@@ -1151,7 +1171,7 @@ var DashScopeResponsesLanguageModel = class {
 						case "response.completed": {
 							const resp = val.response;
 							finishReason = mapFinishReason(resp?.status);
-							if (resp?.usage) usage = convertUsage(resp.usage);
+							if (resp?.usage) usage = convertResponsesUsage(resp.usage);
 							if (resp?.id) controller.enqueue({
 								type: "response-metadata",
 								id: resp.id,
@@ -1211,6 +1231,13 @@ function createDashScope(options = {}) {
 		includeUsage
 	};
 	const createChatModel = (modelId) => new DashScopeChatLanguageModel(modelId, chatConfig);
+	const createEmbeddingModel = (modelId) => new DashScopeEmbeddingModel(modelId, chatConfig);
+	const createRerankingModel = (modelId) => new DashScopeRerankingModel(modelId, {
+		provider: "dashscope.rerank",
+		baseURL,
+		headers: getHeaders,
+		fetch: rest.fetch
+	});
 	const createResponsesModel = (modelId) => new DashScopeResponsesLanguageModel(modelId, {
 		provider: "dashscope.responses",
 		baseURL,
@@ -1220,6 +1247,8 @@ function createDashScope(options = {}) {
 	const responses = Object.assign(createResponsesModel, { tools: responsesTools });
 	return Object.assign(createChatModel, {
 		languageModel: createChatModel,
+		embeddingModel: createEmbeddingModel,
+		rerankingModel: createRerankingModel,
 		chatOptions: (chatOpts) => ({ providerOptions: { dashscope: chatOpts } }),
 		responsesOptions: (responsesOpts) => ({ providerOptions: { dashscope: responsesOpts } }),
 		responses
@@ -1229,4 +1258,4 @@ function createDashScope(options = {}) {
 //#region src/index.ts
 const dashscope = createDashScope();
 //#endregion
-export { DASHSCOPE_REGION_BASE_URLS, createDashScope, dashscope, responsesTools };
+export { DASHSCOPE_REGION_BASE_URLS, DashScopeEmbeddingModel, DashScopeRerankingModel, createDashScope, dashscope, responsesTools };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@agentor/dashscope",
-  "version": "0.0.0",
+  "version": "0.0.1",
   "description": "AI SDK provider for Alibaba Cloud DashScope (Bailian) API",
   "keywords": [
     "ai",