Skip to content

Latest commit

 

History

History
96 lines (65 loc) · 2.2 KB

README.md

File metadata and controls

96 lines (65 loc) · 2.2 KB
Raw

Shiro Python Library

This is the official Shiro API Python library maintained by OpenShiro. The Shiro Python library provides convenient access to the Shiro API from applications written in the Python language.

Documentation

See the API docs and also this post on Getting Started with the Shiro API.

Installation

To install the package:

pip install shiro

Usage

The library needs to be configured with your account's api key which is available in your Shiro account under API Keys.

Initialize the client with your API key

from shiro import ShiroClient

client = ShiroClient("your_api_key_here")

Deployment Actions

List deployments

deployments = client.deployments.list()

Retrieve a single deployment

deployment = client.deployments.retrieve("dpmt_lWokJnPAwQCeV2ZWovjG7BNr")

Update a deployment

update_data = {"name": "Updated Deployment Name"}
updated_deployment = client.deployments.update("dpmt_lWokJnPAwQCeV2ZWovjG7BNr", update_data)

Prompt Actions

List prompts

prompts = client.prompts.list()

Retrieve a specific prompt

prompt = client.prompts.retrieve("prmt_9nORYX8zAYHGo2AVQ1a2w03p")

Generating Completions

Generate a completion for a deployment

completion_data = {
    "deployment_id": "dpmt_lWokJnPAwQCeV2ZWovjG7BNr",
    "prompt_id": "prmt_9nORYX8zAYHGo2AVQ1a2w03p",  # Optional
    "input_variables": {
        "review_text": "I loved the movie."
    }
}
completion = client.generate_completion.create(completion_data)

Support

New features and bug fixes are released on the latest major version of the Shiro Python library. If you are on an older major version, we recommend that you upgrade to the latest in order to use the new features and bug fixes including those for security vulnerabilities. Older major versions of the package will continue to be available for use, but will not be receiving any updates.

Development

Run all tests

python -m unittest discover tests