Skip to main content

aixplain.v2.issue

from aixplain import IssueReporter, IssueSeverity, IssueSeverityValue

Issue reporting helpers for the V2 SDK.

IssueSeverity Objects​

class IssueSeverity(str, Enum)

[view_source]

Supported issue severity levels.

IssueSeverityValue​

The string form of IssueSeverity, accepted anywhere the enum is.

IssueReporter Objects​

class IssueReporter()

[view_source]

submitting SDK issues to the backend.

__init__​

def __init__(context: "Aixplain") -> None

[view_source]

Initialize the issue reporter.

report​

def report(description: Optional[str],
*,
severity: Optional[Union[IssueSeverity, IssueSeverityValue]] = None,
**kwargs: Any) -> str

[view_source]

Submit an issue report and return its ID.

Arguments:

  • description - What went wrong. Required.
  • severity - IssueSeverity or its string value ("SEV1".."SEV4"). Named explicitly rather than left in **kwargs so a type checker can reject a typo against IssueSeverityValue.
  • **kwargs - title, tags, sdk_version, runtime_context and reporter_email.