sp-dev-fx-webparts/samples/react-dall-e-image-generation
Hugo Bernier 72bb01cafc Updated links to devprogram 2024-02-06 11:16:44 -05:00
..
.devcontainer Updated readme, sample.json and containers 2022-11-09 12:05:30 -05:00
assets Update sample.json 2022-11-24 17:07:53 +02:00
config DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
src DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
teams DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
.eslintrc.js DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
.gitignore DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
.npmignore DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
.yo-rc.json DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
README.md Updated links to devprogram 2024-02-06 11:16:44 -05:00
gulpfile.js DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
package-lock.json Bump follow-redirects in /samples/react-dall-e-image-generation 2024-01-10 08:17:38 +00:00
package.json DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00
tsconfig.json DALL-E Image generator webpart sample added. 2022-11-09 08:32:23 +01:00

README.md

Image generation using DALL-E API

Summary

This web part allows you to generate some images using the recently released API of DALL-E image generation. Once the image is generated, the web part allows you to save it to the Documents library of the current site collection.

./assets/react-dall-e-image-generation.gif

Note: The Images API is in beta. During this time the API and models will evolve based on your feedback. To ensure all users can prototype comfortably, the default rate limit is 10 images per minute, 25 per 5 minutes. In this sample, we are calling the API asking for Base64 images format, while the default is a URL. We are using the Base64 format, because DALL-E servers do not support CORS, so we cannot fetch the image content to save it to SharePoint. To achieve this feature, we use the Base64 format.

Compatibility

⚠️ Important
Every SPFx version is only compatible with specific version(s) of Node.js. In order to be able to build this sample, please ensure that the version of Node on your workstation matches one of the versions listed in this section. This sample will not work on a different version of Node.
Refer to https://aka.ms/spfx-matrix for more information on SPFx compatibility.

This sample is optimally compatible with the following environment configuration:

SPFx 1.15.2 Node.js v16 | v14 | v12 Compatible with SharePoint Online Does not work with SharePoint 2019 Does not work with SharePoint 2016 (Feature Pack 2) Local Workbench Unsupported Hosted Workbench Compatible Compatible with Remote Containers

For more information about SPFx compatibility, please refer to https://aka.ms/spfx-matrix

Applies to

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

Prerequisites

For being able to use the API, you first needs to register into the DALL-E 2 website, and then, you must generate an API Key

Contributors

Version history

Version Date Comments
1.0 November 08, 2022 Initial release

Minimal Path to Awesome

  • Clone this repository (or download this solution as a .ZIP file then unzip it)
  • From your command line, change your current directory to the directory containing this sample (react-dall-e-image-generation, located under samples)
  • Edit the file /src/webparts/dalleImageGenerator/Constants.ts and set your DALL-E API Key generated in the pre-requisites section
  • in the command line run:
    • npm install
    • gulp serve

This sample can also be opened with VS Code Remote Development. Visit https://aka.ms/spfx-devcontainer for further instructions.

Features

This extension illustrates the following concepts:

  • use of the DALL-E API
  • use of PnPJS

References

Help

We do not support samples, but this community is always willing to help, and we want to improve these samples. We use GitHub to track issues, which makes it easy for community members to volunteer their time and help resolve issues.

If you're having issues building the solution, please run spfx doctor from within the solution folder to diagnose incompatibility issues with your environment.

You can try looking at issues related to this sample to see if anybody else is having the same issues.

You can also try looking at discussions related to this sample and see what the community is saying.

If you encounter any issues using this sample, create a new issue.

For questions regarding this sample, create a new question.

Finally, if you have an idea for improvement, make a suggestion.

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.