@yushaw/sanqian-sdk 0.3.8 → 0.3.9

package/dist/index.d.mts

@@ -468,6 +468,17 @@ interface EmbeddingConfigResult {
     /** Embedding dimensions */
     dimensions?: number;
 }
+/** Rerank configuration returned from Sanqian */
+interface RerankConfigResult {
+    /** Whether rerank is configured in Sanqian */
+    available: boolean;
+    /** API URL for rerank service */
+    apiUrl?: string;
+    /** API key (decrypted) */
+    apiKey?: string;
+    /** Model name */
+    modelName?: string;
+}
 /** Capability type */
 type CapabilityType = "tool" | "skill" | "agent" | "context";
 /** Tool capability info */
@@ -533,6 +544,16 @@ interface AgentCapability {
     sourceId?: string;
     /** Agent icon/emoji */
     icon?: string;
+    /** Display name (localized) */
+    display?: {
+        zh?: string;
+        en?: string;
+    };
+    /** Short description (localized) */
+    shortDesc?: {
+        zh?: string;
+        en?: string;
+    };
 }
 /** Context capability info */
 interface ContextCapability {
@@ -975,6 +996,23 @@ declare class SanqianSDK {
      * @returns Embedding configuration or { available: false } if not configured
      */
     getEmbeddingConfig(): Promise<EmbeddingConfigResult>;
+    /**
+     * Get rerank configuration from Sanqian
+     *
+     * Returns the current rerank model configuration including API URL, key, and model name.
+     * This allows external apps to use the same rerank service configured in Sanqian.
+     *
+     * @example
+     * ```typescript
+     * const config = await sdk.getRerankConfig()
+     * if (config.available) {
+     *   // Use config.apiUrl, config.apiKey, config.modelName
+     * }
+     * ```
+     *
+     * @returns Rerank configuration or { available: false } if not configured
+     */
+    getRerankConfig(): Promise<RerankConfigResult>;
     /**
      * Push a session resource to Sanqian
      *
@@ -1329,4 +1367,4 @@ declare class SanqianSDKError extends Error {
  */
 declare function createSDKError(code: SDKErrorCode, details?: string): SanqianSDKError;
 
-export { type AgentCapability, type AgentConfig, type AgentInfo, type AgentUpdateConfig, type Capability, type CapabilitySearchResult, type CapabilityType, type ChatMessage, type ChatRequest, type ChatResponse, type ChatStreamEvent, type ConnectionInfo, type ConnectionState, type ContextCapability, type ContextData, type ContextListItem, type ContextProvider, Conversation, type ConversationDetail, type ConversationHistoryResult, type ConversationInfo, type ConversationMessage, DiscoveryManager, type EmbeddingConfigResult, ErrorMessages, type HitlInterruptPayload, type HitlInterruptType, type HitlResponse, type HitlRiskLevel, type JSONSchema, type JSONSchemaProperty, type ListCapabilitiesOptions, type RemoteToolDefinition, type ResourceListOptions, type ResourceListResult, type ResourceType, SANQIAN_WEBSITE, type SDKConfig, SDKErrorCode, type SDKEventName, type SDKEvents, type SDKExtendedMethods, SanqianSDK, SanqianSDKError, type SearchCapabilitiesOptions, type SessionResource, type SkillCapability, type StoredSessionResource, type ToolCall, type ToolCapability, type ToolDefinition, createSDKError };
+export { type AgentCapability, type AgentConfig, type AgentInfo, type AgentUpdateConfig, type Capability, type CapabilitySearchResult, type CapabilityType, type ChatMessage, type ChatRequest, type ChatResponse, type ChatStreamEvent, type ConnectionInfo, type ConnectionState, type ContextCapability, type ContextData, type ContextListItem, type ContextProvider, Conversation, type ConversationDetail, type ConversationHistoryResult, type ConversationInfo, type ConversationMessage, DiscoveryManager, type EmbeddingConfigResult, ErrorMessages, type HitlInterruptPayload, type HitlInterruptType, type HitlResponse, type HitlRiskLevel, type JSONSchema, type JSONSchemaProperty, type ListCapabilitiesOptions, type RemoteToolDefinition, type RerankConfigResult, type ResourceListOptions, type ResourceListResult, type ResourceType, SANQIAN_WEBSITE, type SDKConfig, SDKErrorCode, type SDKEventName, type SDKEvents, type SDKExtendedMethods, SanqianSDK, SanqianSDKError, type SearchCapabilitiesOptions, type SessionResource, type SkillCapability, type StoredSessionResource, type ToolCall, type ToolCapability, type ToolDefinition, createSDKError };

package/dist/index.d.ts

@@ -468,6 +468,17 @@ interface EmbeddingConfigResult {
     /** Embedding dimensions */
     dimensions?: number;
 }
+/** Rerank configuration returned from Sanqian */
+interface RerankConfigResult {
+    /** Whether rerank is configured in Sanqian */
+    available: boolean;
+    /** API URL for rerank service */
+    apiUrl?: string;
+    /** API key (decrypted) */
+    apiKey?: string;
+    /** Model name */
+    modelName?: string;
+}
 /** Capability type */
 type CapabilityType = "tool" | "skill" | "agent" | "context";
 /** Tool capability info */
@@ -533,6 +544,16 @@ interface AgentCapability {
     sourceId?: string;
     /** Agent icon/emoji */
     icon?: string;
+    /** Display name (localized) */
+    display?: {
+        zh?: string;
+        en?: string;
+    };
+    /** Short description (localized) */
+    shortDesc?: {
+        zh?: string;
+        en?: string;
+    };
 }
 /** Context capability info */
 interface ContextCapability {
@@ -975,6 +996,23 @@ declare class SanqianSDK {
      * @returns Embedding configuration or { available: false } if not configured
      */
     getEmbeddingConfig(): Promise<EmbeddingConfigResult>;
+    /**
+     * Get rerank configuration from Sanqian
+     *
+     * Returns the current rerank model configuration including API URL, key, and model name.
+     * This allows external apps to use the same rerank service configured in Sanqian.
+     *
+     * @example
+     * ```typescript
+     * const config = await sdk.getRerankConfig()
+     * if (config.available) {
+     *   // Use config.apiUrl, config.apiKey, config.modelName
+     * }
+     * ```
+     *
+     * @returns Rerank configuration or { available: false } if not configured
+     */
+    getRerankConfig(): Promise<RerankConfigResult>;
     /**
      * Push a session resource to Sanqian
      *
@@ -1329,4 +1367,4 @@ declare class SanqianSDKError extends Error {
  */
 declare function createSDKError(code: SDKErrorCode, details?: string): SanqianSDKError;
 
-export { type AgentCapability, type AgentConfig, type AgentInfo, type AgentUpdateConfig, type Capability, type CapabilitySearchResult, type CapabilityType, type ChatMessage, type ChatRequest, type ChatResponse, type ChatStreamEvent, type ConnectionInfo, type ConnectionState, type ContextCapability, type ContextData, type ContextListItem, type ContextProvider, Conversation, type ConversationDetail, type ConversationHistoryResult, type ConversationInfo, type ConversationMessage, DiscoveryManager, type EmbeddingConfigResult, ErrorMessages, type HitlInterruptPayload, type HitlInterruptType, type HitlResponse, type HitlRiskLevel, type JSONSchema, type JSONSchemaProperty, type ListCapabilitiesOptions, type RemoteToolDefinition, type ResourceListOptions, type ResourceListResult, type ResourceType, SANQIAN_WEBSITE, type SDKConfig, SDKErrorCode, type SDKEventName, type SDKEvents, type SDKExtendedMethods, SanqianSDK, SanqianSDKError, type SearchCapabilitiesOptions, type SessionResource, type SkillCapability, type StoredSessionResource, type ToolCall, type ToolCapability, type ToolDefinition, createSDKError };
+export { type AgentCapability, type AgentConfig, type AgentInfo, type AgentUpdateConfig, type Capability, type CapabilitySearchResult, type CapabilityType, type ChatMessage, type ChatRequest, type ChatResponse, type ChatStreamEvent, type ConnectionInfo, type ConnectionState, type ContextCapability, type ContextData, type ContextListItem, type ContextProvider, Conversation, type ConversationDetail, type ConversationHistoryResult, type ConversationInfo, type ConversationMessage, DiscoveryManager, type EmbeddingConfigResult, ErrorMessages, type HitlInterruptPayload, type HitlInterruptType, type HitlResponse, type HitlRiskLevel, type JSONSchema, type JSONSchemaProperty, type ListCapabilitiesOptions, type RemoteToolDefinition, type RerankConfigResult, type ResourceListOptions, type ResourceListResult, type ResourceType, SANQIAN_WEBSITE, type SDKConfig, SDKErrorCode, type SDKEventName, type SDKEvents, type SDKExtendedMethods, SanqianSDK, SanqianSDKError, type SearchCapabilitiesOptions, type SessionResource, type SkillCapability, type StoredSessionResource, type ToolCall, type ToolCapability, type ToolDefinition, createSDKError };

package/dist/index.js

@@ -1770,6 +1770,39 @@ var SanqianSDK = class _SanqianSDK {
     return response.config || { available: false };
   }
   // ============================================
+  // Rerank Config API
+  // ============================================
+  /**
+   * Get rerank configuration from Sanqian
+   *
+   * Returns the current rerank model configuration including API URL, key, and model name.
+   * This allows external apps to use the same rerank service configured in Sanqian.
+   *
+   * @example
+   * ```typescript
+   * const config = await sdk.getRerankConfig()
+   * if (config.available) {
+   *   // Use config.apiUrl, config.apiKey, config.modelName
+   * }
+   * ```
+   *
+   * @returns Rerank configuration or { available: false } if not configured
+   */
+  async getRerankConfig() {
+    await this.ensureReady();
+    const msgId = this.generateId();
+    const message = {
+      id: msgId,
+      type: "get_rerank_config"
+    };
+    const response = await this.sendAndWait(message, msgId, 1e4);
+    if (!response.success) {
+      this.log(`getRerankConfig failed: ${response.error}`);
+      return { available: false };
+    }
+    return response.config || { available: false };
+  }
+  // ============================================
   // Session Resources API
   // ============================================
   /**