Getting Started
Connect your application to HoneyHive and start optimizing your prompts and models.
Our APIs and SDKs are designed to be easy to use and integrate with your existing infrastructure and the larger LLMOps ecosystem (Langchain, LlamaIndex, etc.).
Everything you can do via the platform can be done programmatically via the SDK.
Create a new project
- Login to the HoneyHive platform via Google SSO.
- Create a new project by clicking on the New Project button.
- Give your project a name (optionally type and description as well) and click Create Project.
It is best to organize each project within your workspace as a separate task for which you’re using large language models. For example, a SQL code generate will be concidered a seperate Project vs a SQL code interpreter. This allows you to standardize data structures and schema for each individual project but allows the flexibility to store multiple prompt variants within each Project space.
Add your first prompt
- You can access the Playground within the Prompts tab in the left sidebar.
- Add a version name for your prompt (e.g.
v1
,davinci-basic
, etc.). We typically recommend using a serialized format such as v1.x.x to better organize your prompts. - Type in your prompt with
{{
and}}
around the variable you want to dynamically insert. You’ll be using these variable names when sending requests to HoneyHive. - Click Save to save your changes.
Evaluate your prompt
- Click on the Evaluation tab in the left sidebar.
- Click
Add Dataset
to upload a dataset to evaluate your prompt. Alternatively, you also have the option to generate a synthetic evaluation dataset. - Click
Add Metrics
to add a metric to evaluate your prompt. We provide a few out-of-the-box metrics and allow users to add their own custom metrics in Python via an in-built code editor within the platform. - Click
Run Comparison
to run your evaluation. - Wait for the evaluation to complete and view the results.
- Rate the results to begin collecting labelled data.
Deploy your prompt
- Click on the Prompts tab in the left sidebar.
- Select the prompt you want to deploy.
- Click on the Deploy button.
- Copy the deployment code snippet (which contains your API keys) and paste it into your codebase.
Integrate the SDK/API
- Install the SDK via
pip install honeyhive -q
or connect via your favorite web client. - Replace your model provider requests with our Generations endpoint. More details on this can be found in the API documentation.
- Instrument your application to collect user feedback using our feedback API. More details on this can be found in the API documentation.
Python Quickstart
How to quickly get started with our Python SDK
Javascript Quickstart
How to quickly get started with Javascript
Monitor your prompt
- Watch your prompt’s performance in real-time on HoneyHive.
- Slice and dice your data using
where
andgroup by
filters. - Use the Generations page or API to view the generated text, feedback and any custom metadata.