pip install honeyhiveimport honeyhive
from honeyhive.models import components, operations
s = honeyhive.HoneyHive(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
res = s.session.start_session(request=operations.StartSessionRequestBody(
session=components.SessionStartRequest(
project='Simple RAG Project',
session_name='Playground Session',
source='playground',
session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',
children_ids=[
'7f22137a-6911-4ed3-bc36-110f1dde6b66',
],
inputs={
'chat_history': [
{
'role': 'system',
'content': 'Answer the user\'s question only using provided context.\n' +
'\n' +
'Context: Hello world',
},
{
'role': 'user',
'content': 'What is in the context?',
},
],
'context': 'Hello world',
'question': 'What is in the context?',
},
outputs={
'content': 'Hello world',
'role': 'assistant',
},
error='<value>',
duration=824.8056,
user_properties={
'user': 'google-oauth2|111840237613341303366',
},
metrics={
},
feedback={
},
metadata={
},
start_time=1712025501605,
end_time=1712025499832,
),
))
if res.object is not None:
# handle response
pass
Handling errors in this SDK should largely match your expectations. All operations return a response object or raise an exception.
By default, an API error will raise a errors.SDKError exception, which has the following properties:
| Property | Type | Description |
|---|---|---|
.status_code |
int | The HTTP status code |
.message |
str | The error message |
.raw_response |
httpx.Response | The raw HTTP response |
.body |
str | The response content |
When custom error responses are specified for an operation, the SDK may also raise their associated exception. You can refer to respective Errors tables in SDK docs for more details on possible exception types for each operation. For example, the create_event_batch method may raise the following exceptions:
| Error Type | Status Code | Content Type |
|---|---|---|
| errors.CreateEventBatchResponseBody | 500 | application/json |
| errors.SDKError | 4XX, 5XX | */* |
import honeyhive
from honeyhive.models import components, errors, operations
s = honeyhive.HoneyHive(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
res = None
try:
res = s.events.create_event_batch(request=operations.CreateEventBatchRequestBody(
events=[
components.CreateEventRequest(
project='Simple RAG',
source='playground',
event_name='Model Completion',
event_type=components.CreateEventRequestEventType.MODEL,
config={
'model': 'gpt-3.5-turbo',
'version': 'v0.1',
'provider': 'openai',
'hyperparameters': {
'temperature': 0,
'top_p': 1,
'max_tokens': 1000,
'presence_penalty': 0,
'frequency_penalty': 0,
'stop': [
'<value>',
],
'n': 1,
},
'template': [
{
'role': 'system',
'content': 'Answer the user\'s question only using provided context.\n' +
'\n' +
'Context: {{ context }}',
},
{
'role': 'user',
'content': '{{question}}',
},
],
'type': 'chat',
},
inputs={
'context': 'Hello world',
'question': 'What is in the context?',
'chat_history': [
{
'role': 'system',
'content': 'Answer the user\'s question only using provided context.\n' +
'\n' +
'Context: Hello world',
},
{
'role': 'user',
'content': 'What is in the context?',
},
],
},
duration=999.8056,
event_id='7f22137a-6911-4ed3-bc36-110f1dde6b66',
session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',
parent_id='caf77ace-3417-4da4-944d-f4a0688f3c23',
children_ids=[
'<value>',
],
outputs={
'role': 'assistant',
'content': 'Hello world',
},
error='<value>',
start_time=1714978764301,
end_time=1714978765301,
metadata={
'cost': 0.00008,
'completion_tokens': 23,
'prompt_tokens': 35,
'total_tokens': 58,
},
feedback={
},
metrics={
'Answer Faithfulness': 5,
'Answer Faithfulness_explanation': 'The AI assistant\'s answer is a concise and accurate description of Ramp\'s API. It provides a clear explanation of what the API does and how developers can use it to integrate Ramp\'s financial services into their own applications. The answer is faithful to the provided context.',
'Number of words': 18,
},
user_properties={
'user': 'google-oauth2|111840237613341303366',
},
),
],
session_properties=operations.SessionProperties(
model_event=components.SessionPropertiesBatch(
session_name='Playground Session',
source='playground',
session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',
inputs={
'context': 'Hello world',
'question': 'What is in the context?',
'chat_history': [
{
'role': 'system',
'content': 'Answer the user\'s question only using provided context.\n' +
'\n' +
'Context: Hello world',
},
{
'role': 'user',
'content': 'What is in the context?',
},
],
},
outputs={
'role': 'assistant',
'content': 'Hello world',
},
error='<value>',
user_properties={
'user': 'google-oauth2|111840237613341303366',
},
metrics={
},
feedback={
},
metadata={
},
),
),
))
except errors.CreateEventBatchResponseBody as e:
# handle exception
raise(e)
except errors.SDKError as e:
# handle exception
raise(e)
if res.object is not None:
# handle response
pass
You can override the default server globally by passing a server index to the server_idx: int optional parameter when initializing the SDK client instance. The selected server will then be used as the default on the operations that use it. This table lists the indexes associated with the available servers:
| # | Server | Variables |
|---|---|---|
| 0 | https://api.honeyhive.ai |
None |
import honeyhive
from honeyhive.models import components, operations
s = honeyhive.HoneyHive(
server_idx=0,
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
res = s.session.start_session(request=operations.StartSessionRequestBody(
session=components.SessionStartRequest(
project='Simple RAG Project',
session_name='Playground Session',
source='playground',
session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',
children_ids=[
'7f22137a-6911-4ed3-bc36-110f1dde6b66',
],
inputs={
'chat_history': [
{
'role': 'system',
'content': 'Answer the user\'s question only using provided context.\n' +
'\n' +
'Context: Hello world',
},
{
'role': 'user',
'content': 'What is in the context?',
},
],
'context': 'Hello world',
'question': 'What is in the context?',
},
outputs={
'content': 'Hello world',
'role': 'assistant',
},
error='<value>',
duration=824.8056,
user_properties={
'user': 'google-oauth2|111840237613341303366',
},
metrics={
},
feedback={
},
metadata={
},
start_time=1712025501605,
end_time=1712025499832,
),
))
if res.object is not None:
# handle response
pass
The default server can also be overridden globally by passing a URL to the server_url: str optional parameter when initializing the SDK client instance. For example:
import honeyhive
from honeyhive.models import components, operations
s = honeyhive.HoneyHive(
server_url="https://api.honeyhive.ai",
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
res = s.session.start_session(request=operations.StartSessionRequestBody(
session=components.SessionStartRequest(
project='Simple RAG Project',
session_name='Playground Session',
source='playground',
session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',
children_ids=[
'7f22137a-6911-4ed3-bc36-110f1dde6b66',
],
inputs={
'chat_history': [
{
'role': 'system',
'content': 'Answer the user\'s question only using provided context.\n' +
'\n' +
'Context: Hello world',
},
{
'role': 'user',
'content': 'What is in the context?',
},
],
'context': 'Hello world',
'question': 'What is in the context?',
},
outputs={
'content': 'Hello world',
'role': 'assistant',
},
error='<value>',
duration=824.8056,
user_properties={
'user': 'google-oauth2|111840237613341303366',
},
metrics={
},
feedback={
},
metadata={
},
start_time=1712025501605,
end_time=1712025499832,
),
))
if res.object is not None:
# handle response
pass
The Python SDK makes API calls using the requests HTTP library. In order to provide a convenient way to configure timeouts, cookies, proxies, custom headers, and other low-level configuration, you can initialize the SDK client with a custom requests.Session object.
For example, you could specify a header for every request that this sdk makes as follows:
import honeyhive
import requests
http_client = requests.Session()
http_client.headers.update({'x-custom-header': 'someValue'})
s = honeyhive.HoneyHive(client=http_client)This SDK supports the following security scheme globally:
| Name | Type | Scheme |
|---|---|---|
bearer_auth |
http | HTTP Bearer |
To authenticate with the API the bearer_auth parameter must be set when initializing the SDK client instance. For example:
import honeyhive
from honeyhive.models import components, operations
s = honeyhive.HoneyHive(
bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)
res = s.session.start_session(request=operations.StartSessionRequestBody(
session=components.SessionStartRequest(
project='Simple RAG Project',
session_name='Playground Session',
source='playground',
session_id='caf77ace-3417-4da4-944d-f4a0688f3c23',
children_ids=[
'7f22137a-6911-4ed3-bc36-110f1dde6b66',
],
inputs={
'chat_history': [
{
'role': 'system',
'content': 'Answer the user\'s question only using provided context.\n' +
'\n' +
'Context: Hello world',
},
{
'role': 'user',
'content': 'What is in the context?',
},
],
'context': 'Hello world',
'question': 'What is in the context?',
},
outputs={
'content': 'Hello world',
'role': 'assistant',
},
error='<value>',
duration=824.8056,
user_properties={
'user': 'google-oauth2|111840237613341303366',
},
metrics={
},
feedback={
},
metadata={
},
start_time=1712025501605,
end_time=1712025499832,
),
))
if res.object is not None:
# handle response
pass
The SDK can be installed using the pip package manager, with dependencies and metadata stored in the setup.py file.
pip install HoneyHiveThis SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version.
While we value open-source contributions to this SDK, this library is generated programmatically. Feel free to open a PR or a Github issue as a proof of concept and we'll do our best to include it in a future release!