Configurations

In Python, you can use the enrich_session function to set on the trace level.

To pass to HoneyHive, pass it to the param in the enrich_session function. This function is used to enrich the session with additional information. Remember that enrich_session will update, not overwrite, the existing object on the trace.

Read more about the enrich_session function in the Python SDK reference.

Here’s an example of how to set on the trace level in Python:

from honeyhive import HoneyHiveTracer, enrich_session

HoneyHiveTracer.init(
  api_key="my-api-key",
  project="my-project",
)

# ...

enrich_session(config={
  "template": prompt_template["template"],
  "prompt": prompt_template["prompt"],
  "hyperparams": {
      "temperature": 0.5,
      "max_tokens": 100,
      "top_p": 0.9,
      "top_k": 50,
  }
  # optionally adding any arbitrary fields as you need
})

In TypeScript, you can use the tracer.enrichSession function to set on the trace level.

To pass to HoneyHive, pass it to the param in the tracer.enrichSession function. This function is used to enrich the session with additional information. Remember that tracer.enrichSession will update, not overwrite, the existing object linked to the trace.

Read more about the tracer.enrichSession function in the TypeScript SDK reference.

Here’s an example of how to set on the trace level in TypeScript:

import { HoneyHiveTracer } from "honeyhive";

const tracer = await HoneyHiveTracer.init({
  apiKey: "my-api-key",
  project: "my-project",
});

// ...

tracer.enrichSession({
  config: {
    "template": prompt_template["template"],
    "prompt": prompt_template["prompt"],
    "hyperparams": {
        "temperature": 0.5,
        "max_tokens": 100,
        "top_p": 0.9,
        "top_k": 50,
    }
  }
})

In Python, you can use the enrich_span function to set on the span level.

To pass to HoneyHive, pass it to the param in the enrich_span function. This function is used to enrich the span with additional information. Remember that enrich_span will update, not overwrite, the existing object linked to the span.

Read more about the enrich_span function in the Python SDK reference.

Here’s an example of how to set on the span level in Python:

from honeyhive import HoneyHiveTracer, trace, enrich_span

HoneyHiveTracer.init(
  api_key="my-api-key",
  project="my-project",
)

# ...

@trace()
def my_function(input, prompt_template):
    # ...

    enrich_span(config={
        "template": prompt_template["template"],
        "prompt": prompt_template["prompt"],
        "hyperparams": {
            "temperature": 0.5,
            "max_tokens": 100,
            "top_p": 0.9,
            "top_k": 50,
        }
    })

    # ...

    return response

# ...

Alternatively, you can also enrich the field on the decorator in addition to using the enrich_span function.

You can find the complete documentation for this in the Python SDK reference.

In TypeScript, you can use the tracer.enrichSpan function to set on the span level.

To pass to HoneyHive, pass it to the param in the tracer.enrichSpan function. This function is used to enrich the span with additional information. Remember that tracer.enrichSpan will update, not overwrite, the existing object linked to the span.

Read more about the tracer.enrichSpan function in the TypeScript SDK reference.

Here’s an example of how to set on the span level in TypeScript:

import { HoneyHiveTracer } from "honeyhive";

const tracer = await HoneyHiveTracer.init({
  apiKey: "my-api-key",
  project: "my-project",
});

// ...

const myTracedFunction = tracer.traceFunction()(function (param1, param2, prompt_template) {

    // span enrichment
    tracer.enrichSpan({
      config: {
        "template": prompt_template["template"],
        "prompt": prompt_template["prompt"],
        "hyperparams": {
            "temperature": 0.5,
            "max_tokens": 100,
            "top_p": 0.9,
            "top_k": 50,
        }
      }
    });

    // Your function code here
    return `Result with ${param1} and ${param2}`;
});

// ...

Alternatively, you can also enrich the field on the decorator in addition to using the enrichSpan function.

You can find the complete documentation for this in the TypeScript SDK reference.