-
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'dev' of https://github.com/PromptSail/prompt_sail into dev
- Loading branch information
Showing
25 changed files
with
1,088 additions
and
456 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -168,3 +168,4 @@ backend/poetry.lock | |
**/.env | ||
private_examples/* | ||
docker-compose-wk.yml | ||
examples/poetry.lock |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
--- | ||
title: "Supported Generative AI Model" | ||
permalink: /docs/supported-gen-ai-models | ||
excerpt: "Supported Generative AI Models and Providers" | ||
last_modified_at: 2024-07-02T18:18:15+01:00 | ||
redirect_from: | ||
- /theme-setup/ | ||
toc: false | ||
toc_sticky: true | ||
--- | ||
|
||
|
||
|
||
|
||
## Supported Providers and Models | ||
|
||
<br><br> | ||
|
||
| Provider | Model | Type | Support | | ||
|-----------------|------------------------------------------------------------|------------------|----------------------------------------| | ||
| OpenAI | babbage-002 | completion |<input type="checkbox" checked disabled>| | ||
| OpenAI | davinci-002 | completion |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-3.5-turbo (gpt-3.5-turbo-0125) | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-3.5-turbo-0301 | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-3.5-turbo-0613 | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-3.5-turbo-1106 | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-3.5-turbo-16k (gpt-3.5-turbo-16k-0613) | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-3.5-turbo-instruct | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-3.5-turbo-instruct-0914 | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-4 (gpt-4-0613) | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-4-1106-preview | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-4-vision-preview (gpt-4-1106-vision-preview) | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-4-turbo (gpt-4-turbo-2024-04-09) | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-4-turbo-preview (gpt-4-0125-preview) | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | gpt-4o (gpt-4o-2024-05-13) | chat |<input type="checkbox" checked disabled>| | ||
| OpenAI | text-embedding-3-small | embedding |<input type="checkbox" checked disabled>| | ||
| OpenAI | text-embedding-3-large | embedding |<input type="checkbox" checked disabled>| | ||
| OpenAI | text-embedding-ada-002 | embedding |<input type="checkbox" checked disabled>| | ||
| OpenAI | dall-e-2 | image generation |<input type="checkbox" checked disabled>| | ||
| OpenAI | dall-e-3 | image generation |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | babbage-002 | completion |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | davinci-002 | completion |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-3.5-turbo-0125 | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-3.5-turbo-0301 | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-3.5-turbo-0613 | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-3.5-turbo-1106 | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-3.5-turbo-16k-0613 | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-3.5-turbo-instruct (gpt-3.5-turbo-instruct-0914) | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-4 (gpt-4-0613) | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-4-turbo (gpt-4-1106-preview) | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-4-turbo-vision (gpt-4-vision-preview) | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-4-turbo (gpt-4-0125-preview) | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | gpt-4o-2024-05-13 | chat |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | text-embedding-3-small | embedding |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | text-embedding-3-large | embedding |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | text-embedding-ada-002 | embedding |<input type="checkbox" checked disabled>| | ||
| Azure OpenAI | dall-e-2 | image generation | in progress | | ||
| Azure OpenAI | dall-e-3 | image generation | in progress | | ||
| Google Vertex AI| gemini-1.0-pro-001 | chat |<input type="checkbox" checked disabled>| | ||
| Google Vertex AI| gemini-1.0-pro-002 | chat |<input type="checkbox" checked disabled>| | ||
| Google Vertex AI| gemini-1.0-pro-vision-001 | chat |<input type="checkbox" checked disabled>| | ||
| Google Vertex AI| gemini-1.5-flash-001 | chat |<input type="checkbox" checked disabled>| | ||
| Google Vertex AI| gemini-1.5-flash-preview-0514 | chat |<input type="checkbox" checked disabled>| | ||
| Google Vertex AI| gemini-1.5-pro-001 | chat |<input type="checkbox" checked disabled>| | ||
| Google Vertex AI| gemini-1.5-pro-preview-0514 | chat |<input type="checkbox" checked disabled>| | ||
| Anthropic | claude-2.0 | chat |<input type="checkbox" checked disabled>| | ||
| Anthropic | claude-2.1 | chat |<input type="checkbox" checked disabled>| | ||
| Anthropic | claude-3-haiku | chat |<input type="checkbox" checked disabled>| | ||
| Anthropic | claude-3-opus | chat |<input type="checkbox" checked disabled>| | ||
| Anthropic | claude-3-sonnet | chat |<input type="checkbox" checked disabled>| | ||
| Anthropic | claude-3.5-sonnet | chat |<input type="checkbox" checked disabled>| | ||
| Anthropic | claude-instant-1.2 | chat |<input type="checkbox" checked disabled>| | ||
| Groq | gemma-7b-it | chat |<input type="checkbox" checked disabled>| | ||
| Groq | llama3-8b | chat |<input type="checkbox" checked disabled>| | ||
| Groq | llama3-70b | chat |<input type="checkbox" checked disabled>| | ||
| Groq | mixtral-8x7b | chat |<input type="checkbox" checked disabled>| | ||
| Ollama | | | in progress | | ||
| Huggingface | | | in progress | | ||
|
||
|
||
|
||
|
||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
title: "Rest API" | ||
permalink: /docs/backend-rest-api | ||
excerpt: "The Rest API documentation provides detailed information about the backend API endpoints and their functionalities." | ||
last_modified_at: 2024-07-01T18:18:15+01:00 | ||
redirect_from: | ||
- /theme-setup/ | ||
toc: false | ||
toc_sticky: true | ||
--- | ||
|
||
|
||
# Overview | ||
|
||
|
||
We provide a RESTful API to interact with the PromptSail backend. The API allows you to perform various operations such as creating and managing projects (CRUD), viewing and interactinng with stored transactions, and accessing AI models and providers. | ||
This allows you to integrate and automate project creation, AI providers configuration, and transaction management with your existing systems and tools. | ||
|
||
|
||
When you [deploy the PromptSail backend](https://promptsail.com/docs/deploy-promptsail-cookbook), the swagger documentation is available at `http://localhost:8000/docs`. | ||
|
||
|
||
![PromptSail REST API Swagger Documentation]({{ site.url }}{{ site.baseurl }}assets/images/promptsail_rest_api_swagger.png){: .align-center} | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,16 +1,29 @@ | ||
--- | ||
title: "Login Page" | ||
permalink: /docs/login-page/ | ||
permalink: /docs/login-page | ||
excerpt: "The Login Page allows users to authenticate and access their accounts within the application" | ||
last_modified_at: 2024-05-20T10:11:00+01:00 | ||
redirect_from: | ||
- /theme-setup/ | ||
toc: true | ||
--- | ||
|
||
The Login Page allows users to authenticate and access their accounts within the application. This documentation provides an overview of the login process and details the functionality available on the Login Page. | ||
This page is available at `localhost:80`. You will be redirected to the `/signin` subpage if the application does not find or recognise the **access token** in the browser's storage. | ||
Login page may operate in one of two mode, which you can set in `docker-compose`: | ||
|
||
- `SSO_AUTH: "False"` - this mode is set by default, no need to login anywhere just press **Click to continue** | ||
- `SSO_AUTH: "True"` - this mode requires you to select one of the available SSO login options and log in correctly. For more information, see [SSO Configuration](/docs/sso-configuration/) | ||
## Overview | ||
|
||
The Login Page allows users to authenticate and access their accounts within the application. | ||
|
||
|
||
Prompt Sail login page for annomous access is shown below: | ||
![PromptSail Login page - annomous access]({{ site.url }}{{ site.baseurl }}assets/images/promptsail_ui_login_page.png){: .align-center} | ||
|
||
Promp Sail login page for SSO authentication enabled is shown below: | ||
|
||
![PromptSail Login page - SSO enabled]({{ site.url }}{{ site.baseurl }}assets/images/promptsail_ui_login_page_sso.png){: .align-center} | ||
|
||
By default, the application will redirect you to the login page if it does not find or recognize the access token in the browser's storage. The login functionality can operate in one of two modes, which you can set in the `docker-compose` file: | ||
|
||
* allow annomous access to the application by setting env variable `SSO_AUTH: "False"` - this mode is set by default, no need to login anywhere just press **Click to continue** | ||
* allow only authenticated users to access the application via SSO, to configure this just follow the steps described in [SSO Configuration](/docs/sso-configuration/) | ||
|
||
You can customize the organization name by setting the `ORGANIZATION_NAME` environment variable in the `docker-compose` file. See the [Environment Variables](/docs/env-variables) documentation for more information. |
Oops, something went wrong.