Quickstart

import sys

import hiddenlayer
from hiddenlayer import HiddenLayer


def main() -> int:
    # The client reads HIDDENLAYER_CLIENT_ID and HIDDENLAYER_CLIENT_SECRET
    # from the environment. Use "prod-eu" if your API key is in the EU region.
    client = HiddenLayer(environment="prod-us")

    try:
        response = client.interactions.analyze(
            # Metadata describes where the interaction came from.
            metadata={
                "model": "gpt-4o",               # The LLM that produced the output
                "requester_id": "quickstart-user",  # Who sent the prompt
                "provider": "openai",            # Optional: the LLM provider
            },
            # The prompt sent to the LLM.
            input={
                "messages": [
                    {"role": "user", "content": "What is the largest moon of Jupiter?"}
                ]
            },
            # The LLM's reply.
            output={
                "messages": [
                    {"role": "assistant", "content": "The largest moon of Jupiter is Ganymede."}
                ]
            },
        )
    except hiddenlayer.AuthenticationError:
        print("Authentication failed (401). Check HIDDENLAYER_CLIENT_ID, "
              "HIDDENLAYER_CLIENT_SECRET, and that the environment matches your API key's region.")
        return 1
    except hiddenlayer.PermissionDeniedError:
        print("Permission denied (403). Make sure your API key has Interactions permissions.")
        return 1
    except hiddenlayer.APIConnectionError as e:
        print(f"Could not reach the HiddenLayer API: {e.__cause__!r}")
        return 1
    except hiddenlayer.APIStatusError as e:
        print(f"The API returned an error: HTTP {e.status_code}: {e.message}")
        return 1
    finally:
        client.close()

    # The overall verdict. It can be absent, so check before using it.
    if response.evaluation is not None:
        print(f"Action:       {response.evaluation.action}")
        print(f"Threat level: {response.evaluation.threat_level}")
        print(f"Detections:   {response.evaluation.has_detections}")

    # One entry per analysis (detector) that ran on the interaction.
    print("Analyses:")
    for analysis in response.analysis:
        print(f"  - {analysis.name} ({analysis.phase}): detected={analysis.detected}")

    return 0


if __name__ == "__main__":
    sys.exit(main())