api.md

EvaluatorCriteria

Types:

from patronus_api.types import (
    EvaluatorCriteria,
    EvaluatorCriterionCreateResponse,
    EvaluatorCriterionListResponse,
    EvaluatorCriterionAddRevisionResponse,
    EvaluatorCriterionArchiveResponse,
)

Methods:

• client.evaluator_criteria.create(**params) -> EvaluatorCriterionCreateResponse
• client.evaluator_criteria.list(**params) -> EvaluatorCriterionListResponse
• client.evaluator_criteria.add_revision(public_id, **params) -> EvaluatorCriterionAddRevisionResponse
• client.evaluator_criteria.archive(public_id) -> EvaluatorCriterionArchiveResponse

Experiments

Types:

from patronus_api.types import (
    Experiment,
    ExperimentCreateResponse,
    ExperimentRetrieveResponse,
    ExperimentUpdateResponse,
    ExperimentListResponse,
)

Methods:

• client.experiments.create(**params) -> ExperimentCreateResponse
• client.experiments.retrieve(id) -> ExperimentRetrieveResponse
• client.experiments.update(id, **params) -> ExperimentUpdateResponse
• client.experiments.list(**params) -> ExperimentListResponse
• client.experiments.delete(id) -> None

Projects

Types:

from patronus_api.types import Project, ProjectRetrieveResponse, ProjectListResponse

Methods:

• client.projects.create(**params) -> Project
• client.projects.retrieve(id) -> ProjectRetrieveResponse
• client.projects.list(**params) -> ProjectListResponse
• client.projects.delete(id) -> None

Evaluations

Types:

from patronus_api.types import (
    EvaluationRetrieveResponse,
    EvaluationBatchCreateResponse,
    EvaluationEvaluateResponse,
    EvaluationSearchResponse,
)

Methods:

• client.evaluations.retrieve(id) -> EvaluationRetrieveResponse
• client.evaluations.delete(id) -> None
• client.evaluations.batch_create(**params) -> EvaluationBatchCreateResponse
• client.evaluations.batch_delete(**params) -> object
• client.evaluations.evaluate(**params) -> EvaluationEvaluateResponse
• client.evaluations.search(**params) -> EvaluationSearchResponse

Otel

Logs

Types:

from patronus_api.types.otel import LogSearchResponse

Methods:

• client.otel.logs.search(**params) -> LogSearchResponse

Spans

Types:

from patronus_api.types.otel import SpanSearchResponse

Methods:

• client.otel.spans.delete(**params) -> None
• client.otel.spans.search(**params) -> SpanSearchResponse

TraceInsight

Types:

from patronus_api.types import (
    TraceInsightListResponse,
    TraceInsightCreateJobResponse,
    TraceInsightGetErrorAggregationsResponse,
    TraceInsightListJobsResponse,
    TraceInsightSearchSpanAnalysisResponse,
    TraceInsightSearchTraceInsightsResponse,
)

Methods:

• client.trace_insight.list(**params) -> TraceInsightListResponse
• client.trace_insight.create_job(**params) -> TraceInsightCreateJobResponse
• client.trace_insight.get_error_aggregations(**params) -> TraceInsightGetErrorAggregationsResponse
• client.trace_insight.list_jobs(**params) -> TraceInsightListJobsResponse
• client.trace_insight.search_span_analysis(**params) -> TraceInsightSearchSpanAnalysisResponse
• client.trace_insight.search_trace_insights(**params) -> TraceInsightSearchTraceInsightsResponse

Evaluators

Types:

from patronus_api.types import EvaluatorListResponse, EvaluatorListFamiliesResponse

Methods:

• client.evaluators.list(**params) -> EvaluatorListResponse
• client.evaluators.list_families() -> EvaluatorListFamiliesResponse

Whoami

Types:

from patronus_api.types import WhoamiRetrieveResponse

Methods:

• client.whoami.retrieve() -> WhoamiRetrieveResponse

Apps

Types:

from patronus_api.types import AppListResponse

Methods:

• client.apps.list(**params) -> AppListResponse

Prompts

Types:

from patronus_api.types import (
    PromptCreateRevisionResponse,
    PromptListDefinitionsResponse,
    PromptListRevisionsResponse,
    PromptUpdateDefinitionResponse,
)

Methods:

• client.prompts.create_revision(**params) -> PromptCreateRevisionResponse
• client.prompts.delete_definitions(**params) -> None
• client.prompts.list_definitions(**params) -> PromptListDefinitionsResponse
• client.prompts.list_revisions(**params) -> PromptListRevisionsResponse
• client.prompts.remove_labels(revision_id, **params) -> None
• client.prompts.set_labels(revision_id, **params) -> None
• client.prompts.update_definition(prompt_id, **params) -> PromptUpdateDefinitionResponse