Skip to content
This repository has been archived by the owner on Jan 9, 2024. It is now read-only.

Commit

Permalink
chore: update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
omartinma committed Dec 13, 2023
1 parent 7692037 commit 32f1a10
Showing 1 changed file with 16 additions and 4 deletions.
20 changes: 16 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
## Overview

To set up the LLM Search backend for the demo, you'll need the following:

- A Datastore with the website you want to index
- An App to access that data
- A Cloud Function to act as an API wrapper
Expand All @@ -22,23 +23,34 @@ Note that it might take up to 4 hours to fully index your website.
2. For type select Search and enter a name for your app and company
3. For data select the Datastore that you created already

Once your website has been indexed you should be able to search it directly from the Console. Select your App from the list of Apps and enter a question to try it out.
Once your website has been indexed you should be able to search it directly from the Console. Select your App from the list of Apps and enter a question to try it out.

If the data is ready to be searched you should see a natural language answer along with a list of citations from your own website. If you get a generic negative response like "I don't know what you mean" make sure that your site has been fully indexed and it's a question which is answered somewhere on it.
If the data is ready to be searched you should see a natural language answer along with a list of citations from your own website. If you get a generic negative response like "I don't know what you mean" make sure that your site has been fully indexed and it's a question which is answered somewhere on it.

## Build a Cloud Function API wrapper

1. In the Cloud Console search Cloud Functions
2. Select Create Function and enter a name
3. Python 3.11 as the runtime and paste the **insert link to function code here** into the source text editor

Your Search backend is now ready to go! To validate it's working correctly, on the Function page select Testing and enter a JSON object with format:
Your Search backend is now ready to go! To validate it's working correctly, on the Function page select Testing and enter a JSON object with format:

```JSON
{
"search_term": "{your question here}"
}
```

If everything is set up correctly you'll see the response in the Output box, which includes a natural language summary, citations, and short summaries of all the pages it references. If there are any problems check the logs on the same page to troubleshoot.
If everything is set up correctly you'll see the response in the Output box, which includes a natural language summary, citations, and short summaries of all the pages it references. If there are any problems check the logs on the same page to troubleshoot.

To control access to your API you can set up authentication using Cloud IAM, but that is beyond the scope of this tutorial.

## Testing Flutter frontend

Follow these questions to try the demo and see how the API responds! The live API will not be hit at this time.

1. What is flutter?
2. What platforms does flutter support today?
3. What language do you use to write flutter apps?
4. How does hot reload work in flutter?
5. Do you like cupcakes?

0 comments on commit 32f1a10

Please sign in to comment.