Skip to content

Commit

Permalink
Add readme for web
Browse files Browse the repository at this point in the history
  • Loading branch information
alexastrum committed Dec 12, 2023
1 parent 1a5409b commit bf04979
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions samples/web/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# Google Generative AI Sample for Web (Javascript)

This sample app demonstrates how to use state-of-the-art
generative AI models (like Gemini) to build AI-powered features and applications.

To try out this sample app, you'll need a modern web browser and a local http server.

## Requirements

Follow the instructions on Google AI Studio [setup page](https://makersuite.google.com/app/apikey) to obtain an API key.

It’s strongly recommended that you do not check an API key into your version control system. Instead, you should use a secrets store for your API key.

The Node.js http server provided alonside this app (`http-server.js`) assumes that you're providing an `API_KEY` environment variable.

## Features

This sample showcases the following API capablilites:

- `index.html` - demonstrates the Text and MultiModal feature from the SDK
- `chat.html` - demonstrates the Multi-turn Conversations feature from the SDK

## Documentation

- [Quickstart: Get started with the Gemini API in web apps](https://googledevai.google.com/tutorials/web_quickstart).

0 comments on commit bf04979

Please sign in to comment.