api.md

Agents

Types:

from giskard_hub.types import (
    Agent,
    AgentDetectStatefulness,
    AgentOutput,
    ChatMessage,
    Header,
)

Methods:

• client.agents.create(**params) -> Agent
• client.agents.retrieve(agent_id) -> Agent
• client.agents.update(agent_id, **params) -> Agent
• client.agents.list(**params) -> List[Agent]
• client.agents.delete(agent_id) -> None
• client.agents.bulk_delete(**params) -> None
• client.agents.generate_completion(agent_id, **params) -> AgentOutput
• client.agents.test_connection(**params) -> AgentOutput
• client.agents.generate_description(agent_id) -> str
• client.agents.detect_statefulness(agent_id) -> AgentDetectStatefulness

Audit

Types:

from giskard_hub.types import (
    Audit,
    AuditDisplay,
    APIPaginatedMetadata,
)

Methods:

• client.audit_logs.search(**params, include_metadata: bool = False) -> List[Audit] | Tuple[List[Audit], APIPaginatedMetadata]
• client.audit_logs.list_entities(entity_id, entity_type, **params, include_metadata: bool = False) -> List[AuditDisplay] | Tuple[List[AuditDisplay], APIPaginatedMetadata]

Checks

Types:

from giskard_hub.types import (
    Check,
    CheckResult,
    ConformityParams,
    CorrectnessParams,
    GroundednessParams,
    MetadataParams,
    SemanticSimilarityParams,
    StringMatchParams,
)

Methods:

• client.checks.create(**params) -> Check
• client.checks.retrieve(check_id) -> Check
• client.checks.update(check_id, **params) -> Check
• client.checks.list(**params) -> List[Check]
• client.checks.delete(check_id) -> None
• client.checks.bulk_delete(**params) -> None

Datasets

Types:

from giskard_hub.types import (
    Dataset,
    TestCase,
    TaskProgress,
    APIPaginatedMetadata,
)

Methods:

• client.datasets.create(**params) -> Dataset
• client.datasets.upload(**params) -> Dataset
• client.datasets.retrieve(dataset_id) -> Dataset
• client.datasets.update(dataset_id, **params) -> Dataset
• client.datasets.list(**params) -> List[Dataset]
• client.datasets.delete(dataset_id) -> None
• client.datasets.bulk_delete(**params) -> None
• client.datasets.generate_scenario_based(**params) -> Dataset
• client.datasets.generate_document_based(**params) -> Dataset
• client.datasets.list_tags(dataset_id) -> List[str]
• client.datasets.list_test_cases(dataset_id) -> List[TestCase]
• client.datasets.search_test_cases(dataset_id, **params, include_metadata: bool = False) -> List[TestCase] | Tuple[List[TestCase], APIPaginatedMetadata]

Evaluations

Types:

from giskard_hub.types import (
    Agent,
    AgentOutput,
    CheckResult,
    Dataset,
    DatasetSubset,
    DivergenceWarning,
    Evaluation,
    Metric,
    MinimalAgent,
    OutputAnnotation,
)

Methods:

• client.evaluations.create(**params) -> Evaluation
• client.evaluations.retrieve(evaluation_id, **params) -> Evaluation
• client.evaluations.update(evaluation_id, **params) -> Evaluation
• client.evaluations.list(**params) -> List[Evaluation]
• client.evaluations.delete(evaluation_id) -> None
• client.evaluations.bulk_delete(**params) -> None
• client.evaluations.create_local(**params) -> Evaluation
• client.evaluations.rerun_errored_results(evaluation_id) -> Evaluation
• client.evaluations.run_single(**params) -> List[CheckResult]

Helpers

The helpers resource exposes convenience methods for common workflows such as running evaluations and waiting for completion.

Types:

from giskard_hub.resources.helpers import (
    HelpersResource,
    AsyncHelpersResource,
)
from giskard_hub.types import (
    Evaluation,
    ChatMessage,
)

Methods:

• client.helpers.wait_for_completion(entity, *, poll_interval=5.0, max_retries=360, running_states={"running"}, error_states={"error"}, raise_on_error=True) -> TStateful Waits until a task-like entity (such as an evaluation) leaves a running state or reaches an error state.

• client.helpers.evaluate(agent, *, dataset, project=None, name=None, tags=None) -> Evaluation Run an evaluation for a given agent over a dataset. The agent can be:

  • a remote agent identifier (str or Agent), which creates a regular evaluation, or
  • a local Python callable with signature (messages: list[ChatMessage]) -> AgentReturn, which creates a local evaluation and submits outputs on your behalf.

• client.helpers.print_metrics(entity) -> None Print metrics for an evaluation or scan result to the console. For an evaluation, displays a table of metric names, success rates, and pass/fail/error/skipped counts. For a scan result, displays probe categories, names, severity, and issue/attack counts.

For asynchronous usage, use the corresponding methods on async_client.helpers (for example, await async_client.helpers.evaluate(...)).

Results

Types:

from giskard_hub.types.evaluation import (
    FailureCategory,
    TaskState,
    TestCaseEvaluation,
)
from giskard_hub.types import (
    TestCase,
    APIPaginatedMetadata,
)

Methods:

• client.evaluations.results.retrieve(result_id, *, evaluation_id, **params) -> TestCaseEvaluation
• client.evaluations.results.update(result_id, *, evaluation_id, **params) -> TestCaseEvaluation
• client.evaluations.results.list(evaluation_id, **params) -> List[TestCaseEvaluation]
• client.evaluations.results.rerun_test_case(result_id, *, evaluation_id) -> TestCaseEvaluation
• client.evaluations.results.submit_local_output(result_id, *, evaluation_id, **params) -> TestCaseEvaluation
• client.evaluations.results.search(evaluation_id, **params, include_metadata: bool = False) -> List[TestCaseEvaluation] | Tuple[List[TestCaseEvaluation], APIPaginatedMetadata]
• client.evaluations.results.update_visibility(result_id, *, evaluation_id, **params) -> TestCaseEvaluation

KnowledgeBases

Types:

from giskard_hub.types import (
    KnowledgeBase,
    KnowledgeBaseDocumentRow,
    KnowledgeBaseDocumentDetail,
    APIPaginatedMetadata,
)

Methods:

• client.knowledge_bases.create(**params) -> KnowledgeBase
• client.knowledge_bases.retrieve(knowledge_base_id) -> KnowledgeBase
• client.knowledge_bases.update(knowledge_base_id, **params) -> KnowledgeBase
• client.knowledge_bases.list(**params) -> List[KnowledgeBase]
• client.knowledge_bases.delete(knowledge_base_id) -> None
• client.knowledge_bases.bulk_delete(**params) -> None
• client.knowledge_bases.search_documents(knowledge_base_id, **params, include_metadata: bool = False) -> List[KnowledgeBaseDocumentRow] | Tuple[List[KnowledgeBaseDocumentRow], APIPaginatedMetadata]
• client.knowledge_bases.retrieve_document(knowledge_base_id, document_id) -> KnowledgeBaseDocumentDetail

Projects

Types:

from giskard_hub.types import (
    Project,
)

Methods:

• client.projects.create(**params) -> Project
• client.projects.retrieve(project_id) -> Project
• client.projects.update(project_id, **params) -> Project
• client.projects.list() -> List[Project]
• client.projects.delete(project_id) -> None
• client.projects.bulk_delete(**params) -> None

Scenarios

Types:

from giskard_hub.types import (
    Scenario,
    ScenarioPreview,
)

Methods:

• client.projects.scenarios.create(project_id, **params) -> Scenario
• client.projects.scenarios.retrieve(scenario_id, *, project_id) -> Scenario
• client.projects.scenarios.update(scenario_id, *, project_id, **params) -> Scenario
• client.projects.scenarios.list(project_id) -> List[Scenario]
• client.projects.scenarios.delete(scenario_id, *, project_id) -> None
• client.projects.scenarios.preview(project_id, **params) -> ScenarioPreview

Scans

Types:

from giskard_hub.types import (
    Agent,
    AgentReference,
    KnowledgeBase,
    Scan,
    ScanAvailableProbe,
    ScanCategory,
    ScanProbe,
)

Methods:

• client.scans.create(**params) -> Scan
• client.scans.retrieve(scan_id, **params) -> Scan
• client.scans.list(**params) -> List[Scan]
• client.scans.delete(scan_id) -> None
• client.scans.bulk_delete(**params) -> None
• client.scans.list_categories() -> List[ScanCategory]
• client.scans.list_probes(scan_id) -> List[ScanProbe]
• client.scans.list_available_probes() -> List[ScanAvailableProbe]

Probes

Types:

from giskard_hub.types.scan import (
    ScanProbe,
    ScanProbeAttempt,
)

Methods:

• client.scans.probes.retrieve(probe_id) -> ScanProbe
• client.scans.probes.list_attempts(probe_id) -> List[ScanProbeAttempt]

Attempts

Types:

from giskard_hub.types.scan import (
    ReviewStatus,
    ScanProbeAttempt,
    Severity,
)

Methods:

• client.scans.attempts.update(probe_attempt_id, **params) -> ScanProbeAttempt

ScheduledEvaluations

Types:

from giskard_hub.types import (
    Agent,
    Dataset,
    ScheduledEvaluation,
    Evaluation,
    ErrorExecutionStatus,
    FrequencyOption,
    SuccessExecutionStatus,
)

Methods:

• client.scheduled_evaluations.create(**params) -> ScheduledEvaluation
• client.scheduled_evaluations.retrieve(scheduled_evaluation_id, **params) -> ScheduledEvaluation
• client.scheduled_evaluations.update(scheduled_evaluation_id, **params) -> ScheduledEvaluation
• client.scheduled_evaluations.list(**params) -> List[ScheduledEvaluation]
• client.scheduled_evaluations.delete(scheduled_evaluation_id) -> None
• client.scheduled_evaluations.bulk_delete(**params) -> None
• client.scheduled_evaluations.list_evaluations(scheduled_evaluation_id, **params) -> List[Evaluation]

TestCases

Types:

from giskard_hub.types import (
    TestCase,
    TestCaseComment,
    TestCaseCheckConfig,
    ChatMessageWithMetadata,
)

Methods:

• client.test_cases.create(**params) -> TestCase
• client.test_cases.retrieve(test_case_id) -> TestCase
• client.test_cases.update(test_case_id, **params) -> TestCase
• client.test_cases.delete(test_case_id) -> None
• client.test_cases.bulk_delete(**params) -> None
• client.test_cases.bulk_update(**params) -> List[TestCase]
• client.test_cases.bulk_move(**params) -> None

Comments

Types:

from giskard_hub.types import (
    TestCaseComment,
)

Methods:

• client.test_cases.comments.delete(comment_id, *, test_case_id) -> None
• client.test_cases.comments.add(test_case_id, **params) -> TestCaseComment
• client.test_cases.comments.edit(comment_id, *, test_case_id, **params) -> TestCaseComment

Tasks

Types:

from giskard_hub.types import (
    Task,
    TaskStatus,
    TaskPriority,
)

Methods:

• client.tasks.create(**params) -> Task
• client.tasks.retrieve(task_id) -> Task
• client.tasks.update(task_id, **params) -> Task
• client.tasks.list(**params) -> List[Task]
• client.tasks.delete(task_id) -> None
• client.tasks.bulk_delete(**params) -> None

PlaygroundChats

Types:

from giskard_hub.types import (
    Agent,
    PlaygroundChat,
)

Methods:

• client.playground_chats.list(**params) -> List[PlaygroundChat]
• client.playground_chats.retrieve(chat_id, **params) -> PlaygroundChat
• client.playground_chats.delete(chat_id) -> None
• client.playground_chats.bulk_delete(**params) -> None