1. 登錄控制臺:注冊完成后,進入控制臺頁面,點擊“在線調試”。

控制臺

  1. 創建新應用:點擊“創建新應用”按鈕,在彈出的窗口中填寫應用信息。

創建應用

  1. 獲取密鑰:進入應用的服務詳情頁,訪問接口文檔并獲取 API 密鑰。

服務詳情

API Key 的可用性測試

在獲取 API Key 后,測試其可用性是確保其正常工作的關鍵步驟。以下是使用 Python 進行快速測試的步驟。

安裝和配置

步驟一:在 Python 環境中安裝 PyPI 包。

pip install --upgrade spark_ai_python

步驟二:執行以下 Python 代碼進行測試。

from sparkai.llm.llm import ChatSparkLLM, ChunkPrintHandler
from sparkai.core.messages import ChatMessage

SPARKAI_URL = 'wss://spark-api.xf-yun.com/v3.5/chat'
SPARKAI_APP_ID = ''
SPARKAI_API_SECRET = ''
SPARKAI_API_KEY = ''
SPARKAI_DOMAIN = 'generalv3.5'

if __name__ == '__main__':
    spark = ChatSparkLLM(
        spark_api_url=SPARKAI_URL,
        spark_app_id=SPARKAI_APP_ID,
        spark_api_key=SPARKAI_API_KEY,
        spark_api_secret=SPARKAI_API_SECRET,
        spark_llm_domain=SPARKAI_DOMAIN,
        streaming=False,
    )
    messages = [ChatMessage(
        role="user",
        content='你好呀'
    )]
    handler = ChunkPrintHandler()
    a = spark.generate([messages], callbacks=[handler])
    print(a)

使用 API 搭建應用的關鍵考慮因素

在使用星火語音大模型 API 開發應用時,除了獲取和測試 API Key,還需考慮以下因素:

接口說明

訊飛星火 API 提供多個版本的接口,每個版本的功能和計費策略可能不同。在使用前,請詳細閱讀 產品頁面 的說明。

請求地址

星火大模型 API 支持多種版本,包括 Lite、Pro、Max 等。每個版本有獨立的 tokens 計量方式。

請求版本 請求地址
Spark4.0 Ultra wss://spark-api.xf-yun.com/v4.0/chat
Spark Max-32K wss://spark-api.xf-yun.com/chat/max-32k
Spark Max wss://spark-api.xf-yun.com/v3.5/chat

接口鑒權

通過 URL 鑒權來保護 Web 應用的敏感資源,確保 API 的安全訪問。有關鑒權的詳細信息,請參考 通用URL鑒權文檔

接口請求

接口請求由 header、parameter 和 payload 三部分組成。以下是請求參數示例:

{
    "header": {  
        "app_id": "12345",  
        "uid": "12345"  
    },  
    "parameter": {  
        "chat": {  
            "domain": "generalv3.5",  
            "temperature": 0.5,  
            "max_tokens": 1024  
        }  
    },  
    "payload": {  
        "message": {  
            "text": [  
                {"role":"system","content":"你現在扮演李白..."}, 
                {"role": "user", "content": "你是誰"}, 
                {"role": "assistant", "content": "....."}, 
                {"role": "user", "content": "你會做什么"}  
            ]  
        }  
    }
}

訊飛星火 API 進階指引

Function Call 說明

Function Call 是星火大模型能力擴展的核心功能,支持識別并調度外部接口。此功能目前僅支持 Spark Max/4.0 Ultra 版本。以下是功能調用的請求示例:

{
    "header": {  
        "app_id": appid,  
        "uid": "1234"  
    },  
    "parameter": {  
        "chat": {  
            "domain": domain,  
            "random_threshold": 0.5,  
            "max_tokens": 2048,  
            "auditing": "default"  
        }  
    },  
    "payload": {  
        "message": {  
            "text": [  
                {"role": "user", "content": ""}  
            ]  
        },  
        "functions": {  
            "text": [  
                {  
                    "name": "天氣查詢",  
                    "description": "天氣插件可以提供天氣相關信息。",  
                    "parameters": {  
                        "type": "object",  
                        "properties": {  
                            "location": {  
                                "type": "string",  
                                "description": "地點,比如北京。"  
                            },  
                            "date": {  
                                "type": "string",  
                                "description": "日期。"  
                            }  
                        },  
                        "required": [  
                            "location"  
                        ]  
                    }  
                }  
            ]  
        }  
    }
}

價格說明

星火語音大模型的價格根據不同版本和功能有所不同。詳細價格信息請參閱價格說明

常見問題

FAQ

  1. 問:如何找到訊飛星火 API?

  2. 問:訊飛星火 API 的替代品有哪些?

  3. 問:如何進行 API 的可用性測試?

總結

通過本文,您了解了如何獲取訊飛星火大模型 API Key,并通過詳細的步驟和示例進行了可用性測試。希望本文能夠幫助開發者輕松集成星火語音大模型的強大功能。

上一篇:

訊飛星火文生圖的應用與實現

下一篇:

使用 Polly API 實現高效文本轉語音服務
#你可能也喜歡這些API文章!

我們有何不同?

API服務商零注冊

多API并行試用

數據驅動選型,提升決策效率

查看全部API→
??

熱門場景實測,選對API

#AI文本生成大模型API

對比大模型API的內容創意新穎性、情感共鳴力、商業轉化潛力

25個渠道
一鍵對比試用API 限時免費

#AI深度推理大模型API

對比大模型API的邏輯推理準確性、分析深度、可視化建議合理性

10個渠道
一鍵對比試用API 限時免費