General Introduction
Prompt Smith is a prompt engineering solution designed to help users easily manage generative AI prompts. The platform offers a self-hosted option that gives users full control over their data. With Dockerized deployment, users can easily get the service up and running. Prompt Smith also provides a RESTful API and SDKs for Python and Node.js for easy integration and use.
Function List
- Self-hosted option: Users have full control over their data.
- Dockerized Deployment: Simplifies the process of starting and running services.
- RESTful API: User-friendly integration and access to alerts.
- SDK Support: Provides SDKs for Python and Node.js.
- API Key Management: API key management through a centralized UI.
- Cue Management: Prompt management through a centralized UI.
- version control: Version control at the database level.
Using Help
Installation process
- Local Startup Service::
- Using commands
docker-compose up --build
Start the service. - interviews
http://localhost:3000
Management.
- Using commands
- Default login credentials::
- Email:
admin@localhost.lan
- Password:
AwesomePromptsManagement
- Do not use the default credentials in a production environment.
- Email:
Function Operation
- Create a Tip::
- interviews
http://localhost:3000/prompt
Create a new prompt. - Enter the prompt and save.
- interviews
- Creating API Keys::
- interviews
http://localhost:3000/key
Create a new API key. - Use the generated API key for authentication.
- interviews
- Get tips::
- Get tips via RESTful API:
curl "http://localhost:3000/api/bff/api/sdk/prompt/{prompt-key}" \\cH -H 'Authorization: Bearer {api-key}' \\cH -H 'Content-Type: application/json; charset=utf-8'
- Get tips via the SDK:
- Python SDK::
from promptsmith_sdk import PromptSmith client = PromptSmith(api_key="your_api_key") prompt = client.get_prompt("prompt_key") print(prompt)
- Node.js SDK::
const PromptSmith = require('promptsmith-sdk'); const client = new PromptSmith('your_api_key'); client.getPrompt('prompt_key').then(prompt => console.log(prompt)).
- Python SDK::
- Get tips via RESTful API:
caveat
- data persistence: Note that the data in the Demo instance may not be retained and will be deleted on a scheduled basis.
- Contribution Guidelines: Users are welcome to submit feature requests or bug reports via issue or PR.