honeymoose/sp-dev-fx-webparts
1
0
Fork 0
mirror of https://github.com/pnp/sp-dev-fx-webparts.git synced 2025-02-22 21:25:55 +00:00
Code Issues Packages Projects Releases Wiki Activity
sp-dev-fx-webparts/samples/react-azure-openai-api-stream
History

README.md

Calling Azure OpenAI API in Stream mode

Summary

This webpart shows how you can call Azure OpenAI API in Streaming mode, so the webpart shows the data coming from the API in chunks, giving a much better user experience, so you are not waiting for the entire response. It also shows how you can cancel the streaming response at any point, which is useful to safe some tokens (hence money), if the generating response does not look good to you (like when getting AI hallucinations).

./assets/react-azure-openai-api-stream.gif

Used SharePoint Framework Version

version

Applies to

Get your own free development tenant by subscribing to Microsoft 365 developer program

Prerequisites

  • Your Azure Subscription has the Azure OpenAI service available. You will see this message if you try to add Azure OpenAI service in your Subscription (follow the link in the Azure portal to request access).

Azure OpenAI Service is currently available to customers via an application form. The selected subscription has not been enabled for use of the service and does not have quota for any pricing tiers. Click here to request access to Azure OpenAI service.

  • You have created an Azure OpenAI service in your subscription
  • Create a Deployment Model (use GPT-3.5-turbo or GPT-4)
  • Grab the Azure OpenAI Key, Endpoint and the deployment model created in previous step (go to your Azure OpenAI service -> Keys and Endpoint)

Solution

Solution Author(s)
react-azure-openai-api-stream Luis Mañez

Version history

Version Date Comments
1.0 January 2, 2024 Initial release

Disclaimer

THIS CODE IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.

Minimal Path to Awesome

  • Install the MS Graph Toolkit for SPFx package. Follow this
  • Clone this repository
  • Ensure that you are at the solution folder
  • in the command-line run:
    • npm install
    • gulp serve
  • Add the web part in the SharePoint workbench or any SharePoint page (appending ?debug=true&noredir=true&debugManifestsFile=https://localhost:4321/temp/manifests.js to the page URL)
  • Edit the webpart with your Azure OpenAI API values (see prerequisites section)

Features

This sample illustrates the following concepts:

  • Calling Azure OpenAI chat/completions endpoint in streaming mode
  • Keeping chat history during the chat session
  • How to cancel an streaming request
  • Using MS Graph toolkit with the Person component
  • Multiple FluentUI components

Notice that better pictures and documentation will increase the sample usage and the value you are providing for others. Thanks for your submissions advance.

Share your web part with others through Microsoft 365 Patterns and Practices program to get visibility and exposure. More details on the community, open-source projects and other activities from http://aka.ms/m365pnp.

References