# promptwiz
### Context
The PromptWiz API provides a way to execute prompt templates built in the UI. The API will populate the prompt variables with your inputs, query the model then return the results. The results for API requests will be stored in PromptWiz for the purpose of analysis.
### Pre-requisites
1. Create a prompt
2. Create a version of the prompt (and save it)
3. Activate the prompt version - the version's status should be ‘Active’
4. Set the API Key for the model service (e.g. OpenAI) used by the prompt in the [API keys](https://promptwiz.co.uk/api_keys/) page, or alternatively pass the model service API key on every query in an API request using the `modelApiKey` field
5. Read about the API spec in the [API docs](https://promptwiz.co.uk/docs/) page
This Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
- PromptWiz API version: 0.1
- Build package: org.openapitools.codegen.languages.PythonClientCodegen
## Requirements.
Python 3.7+
## Installation & Usage
### pip install
You can install directly using pip:
```sh
pip install promptwiz
```
(you may need to run `pip` with root permission: `sudo pip install promptwiz`)
Then import the package:
```python
import promptwiz
```
## Getting Started
Please follow the [installation procedure](#installation--usage) and then run the following:
```python
import promptwiz
from pprint import pprint
promptwiz.Api.api_key = os.environ["API_KEY"]
query_set = [
promptwiz.Query(prompt_id=7, variables=dict(EXAMPLE_VARIABLE_1="VARIABLE 1 Value 1"), results_size=2),
promptwiz.Query(prompt_id=8, variables=dict(EXAMPLE_VARIABLE_1="VARIABLE 1 Value 2", EXAMPLE_VARIABLE_2="VARIABLE 2 Value 2")),
]
results, errors, status_code = promptwiz.Api.evaluate(query_set=query_set)
print("The response of Api->evaluate:\n")
pprint(results)
```
## Documentation for API Endpoints
All URIs are relative to *https://app.promptwiz.co.uk/api/v0.1*
Class | Method | HTTP request | Description
------------ | ------------- | ------------- | -------------
*Api* | evaluate | **POST** /evaluate/ |
Authentication schemes defined for the API:
<a id="apiKey"></a>
### apiKey
- **Type**: API key
- **API key parameter name**: apiKey
- **Location**: HTTP header
## Author
contact@promptwiz.co.uk
Raw data
{
"_id": null,
"home_page": null,
"name": "promptwiz",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "PromptWiz, PromptWiz API",
"author": "PromptWiz",
"author_email": "contact@promptwiz.co.uk",
"download_url": "https://files.pythonhosted.org/packages/4b/9b/438a343c21a259868ba152e7f3de8a13d85ec7523fcfb2753ac964a648d9/promptwiz-0.0.5.tar.gz",
"platform": null,
"description": "# promptwiz\n\n### Context\nThe PromptWiz API provides a way to execute prompt templates built in the UI. The API will populate the prompt variables with your inputs, query the model then return the results. The results for API requests will be stored in PromptWiz for the purpose of analysis.\n\n### Pre-requisites\n1. Create a prompt\n2. Create a version of the prompt (and save it)\n3. Activate the prompt version - the version's status should be \u2018Active\u2019\n4. Set the API Key for the model service (e.g. OpenAI) used by the prompt in the [API keys](https://promptwiz.co.uk/api_keys/) page, or alternatively pass the model service API key on every query in an API request using the `modelApiKey` field\n5. Read about the API spec in the [API docs](https://promptwiz.co.uk/docs/) page \n\nThis Python package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:\n\n- PromptWiz API version: 0.1\n- Build package: org.openapitools.codegen.languages.PythonClientCodegen\n\n## Requirements.\n\nPython 3.7+\n\n## Installation & Usage\n### pip install\n\nYou can install directly using pip:\n\n```sh\npip install promptwiz\n```\n(you may need to run `pip` with root permission: `sudo pip install promptwiz`)\n\nThen import the package:\n```python\nimport promptwiz\n```\n\n## Getting Started\n\nPlease follow the [installation procedure](#installation--usage) and then run the following:\n\n```python\nimport promptwiz\nfrom pprint import pprint\n\n\npromptwiz.Api.api_key = os.environ[\"API_KEY\"]\n\nquery_set = [\n promptwiz.Query(prompt_id=7, variables=dict(EXAMPLE_VARIABLE_1=\"VARIABLE 1 Value 1\"), results_size=2),\n promptwiz.Query(prompt_id=8, variables=dict(EXAMPLE_VARIABLE_1=\"VARIABLE 1 Value 2\", EXAMPLE_VARIABLE_2=\"VARIABLE 2 Value 2\")),\n]\nresults, errors, status_code = promptwiz.Api.evaluate(query_set=query_set)\n\nprint(\"The response of Api->evaluate:\\n\")\npprint(results)\n\n```\n\n## Documentation for API Endpoints\n\nAll URIs are relative to *https://app.promptwiz.co.uk/api/v0.1*\n\nClass | Method | HTTP request | Description\n------------ | ------------- | ------------- | -------------\n*Api* | evaluate | **POST** /evaluate/ | \n\n\nAuthentication schemes defined for the API:\n<a id=\"apiKey\"></a>\n### apiKey\n\n- **Type**: API key\n- **API key parameter name**: apiKey\n- **Location**: HTTP header\n\n\n## Author\n\ncontact@promptwiz.co.uk\n\n\n",
"bugtrack_url": null,
"license": "Apache 2.0",
"summary": "PromptWiz API",
"version": "0.0.5",
"project_urls": null,
"split_keywords": [
"promptwiz",
" promptwiz api"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ea8608bf86a31d3427ac95b6d95ee0d06d18477a016a004e39ec8ab7bbe06a07",
"md5": "c621916800a652eb2fec93099539919c",
"sha256": "2321c11255257720e7e3af246ca814fbd41b56fd124d186f32e7fffc28ba0b7d"
},
"downloads": -1,
"filename": "promptwiz-0.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c621916800a652eb2fec93099539919c",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 4963,
"upload_time": "2024-05-07T20:45:30",
"upload_time_iso_8601": "2024-05-07T20:45:30.668165Z",
"url": "https://files.pythonhosted.org/packages/ea/86/08bf86a31d3427ac95b6d95ee0d06d18477a016a004e39ec8ab7bbe06a07/promptwiz-0.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4b9b438a343c21a259868ba152e7f3de8a13d85ec7523fcfb2753ac964a648d9",
"md5": "27e84e56c77f8d79f7ad80a2db912a5a",
"sha256": "643664490653dccbfe329051a9a5a78e01a426d930a0a3f3068bf063a3126f01"
},
"downloads": -1,
"filename": "promptwiz-0.0.5.tar.gz",
"has_sig": false,
"md5_digest": "27e84e56c77f8d79f7ad80a2db912a5a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4473,
"upload_time": "2024-05-07T20:45:32",
"upload_time_iso_8601": "2024-05-07T20:45:32.003747Z",
"url": "https://files.pythonhosted.org/packages/4b/9b/438a343c21a259868ba152e7f3de8a13d85ec7523fcfb2753ac964a648d9/promptwiz-0.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-07 20:45:32",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "promptwiz"
}
JSON