ai chat protocol

微軟人工智慧聊天協議

Microsoft AI 聊天協定 SDK 是一個庫，用於透過遵循 AI 聊天協議 API 規範的服務輕鬆構建 AI 聊天接口，這兩個接口均位於此存儲庫中。

透過就標準 API 合約達成一致，無論使用何種模型、編排工具或設計模式，都可以在不同的服務中輕鬆、一致地執行 AI 後端消費和評估。

注意：我們目前處於公共預覽版。非常感謝您的回饋，我們已準備好全面上市！

透過人工智慧聊天協議，您將能夠：

• 使用 JavaScript/TypeScript 開發 AI 聊天介面、元件和應用程式（更多語言即將推出！）
• 同步或透過串流傳輸，輕鬆一致地使用和評估 AI 推理後端和中間層
• 輕鬆整合用於日誌記錄、驗證等的 HTTP 中間件。

請為該儲存庫加註星標以表示您對該專案的支持！

入門

我們的綜合入門指南即將推出！請務必查看範例和 API 規格以了解更多詳細資訊。

• 樣品
• API規格
• Azure 上的範例

要在本地查看，請透過 npm 安裝庫：

npm install @microsoft/ai-chat-protocol

建立客戶端物件：

 const client = new AIChatProtocolClient ( "/api/chat" ) ;

將完成情況串流傳輸到您的 UI：

 let sessionState = undefined ;

// add any logic to handle state here
function setSessionState ( value ) {
    sessionState = value ;
}

const message : AIChatMessage = {
    role : "user" ,
    content : "Hello World!" ,
} ;

const result = await client . getStreamedCompletion ( [ message ] , {
    sessionState : sessionState ,
} ) ;

for await ( const response of result ) {
    if ( response . sessionState ) {
        //do something with the session state returned
    }
    if ( response . delta . role ) {
        // do something with the information about the role
    }
    if ( response . delta . content ) { 
        // do something with the content of the message
    }
} 

Azure 上的範例

如果您對 Azure 上託管的範例感到好奇，以下範例在前端使用 AI 聊天協定 SDK：

• 使用 LangChain.js 與 RAG 進行無伺服器 AI 聊天
• 使用 Azure OpenAI (Python) 的聊天應用程式
• 具有 Microsoft Entra 驗證 (Python) 的 OpenAI 聊天應用程式 - 本地
• 具有 Microsoft Entra 驗證 (Python) 的 OpenAI 聊天應用程式 - 內建
• OpenAI 聊天應用程式前端 (Vanilla JS)
• 使用 Azure OpenAI (Python) 的聊天應用程式

此外，許多 Azure AI 範例專案在沒有 SDK 的情況下使用 AI 聊天協定 API 規範，要么是因為它們沒有前端，要么是因為它們是在庫發布之前製作的：

• ChatGPT + 企業資料以及 Azure OpenAI 和 Python 中的 AI 搜尋
• ChatGPT + 在 JavaScript 中使用 Azure OpenAI 和 Azure AI 搜尋的企業數據
• 與 GPT 模式聊天 - FastAPI 後端
• 評估 RAG 聊天應用程式

行為守則

該專案採用了微軟開源行為準則。有關詳細信息，請參閱行為準則常見問題解答或聯繫 [email protected] 提出任何其他問題或意見。

執照

版權所有 (c) Microsoft Corporation。版權所有。

根據 MIT 許可證獲得許可。