hiddenlayer-sdk 2.0.9__py3-none-any.whl → 3.0.0__py3-none-any.whl

hiddenlayer/types/interaction_analyze_response.py

@@ -0,0 +1,199 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import TYPE_CHECKING, Dict, List, Optional
+from datetime import datetime
+
+from pydantic import Field as FieldInfo
+
+from .._models import BaseModel
+
+__all__ = [
+    "InteractionAnalyzeResponse",
+    "Analysis",
+    "AnalysisFindings",
+    "AnalysisFindingsFramework",
+    "AnalyzedData",
+    "AnalyzedDataInput",
+    "AnalyzedDataInputMessage",
+    "AnalyzedDataOutput",
+    "AnalyzedDataOutputMessage",
+    "Metadata",
+    "MetadataProject",
+    "ModifiedData",
+    "ModifiedDataInput",
+    "ModifiedDataInputMessage",
+    "ModifiedDataOutput",
+    "ModifiedDataOutputMessage",
+]
+
+
+class AnalysisFindingsFramework(BaseModel):
+    label: str
+    """Unique identifier for the framework taxonomy item."""
+
+    name: str
+    """Name of the framework taxonomy item."""
+
+
+class AnalysisFindings(BaseModel):
+    frameworks: Dict[str, List[AnalysisFindingsFramework]]
+    """The taxonomies for the detections."""
+
+    __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+    if TYPE_CHECKING:
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+
+
+class Analysis(BaseModel):
+    id: str
+    """The unique identifier for the analyzer."""
+
+    configuration: Dict[str, object]
+    """The configuration settings used for the analyzer."""
+
+    detected: bool
+    """Indicates the analysis resulted in a detection."""
+
+    findings: AnalysisFindings
+    """The frameworks and associated findings for the analysis."""
+
+    name: str
+    """The name of the analysis performed."""
+
+    phase: str
+    """The phase of the analysis (i.e. input or output)."""
+
+    processing_time_ms: float
+    """The time taken to perform this specific analysis."""
+
+    version: str
+    """The version of the analysis performed."""
+
+
+class AnalyzedDataInputMessage(BaseModel):
+    content: str
+    """The textual content of the message."""
+
+    role: Optional[str] = None
+    """The role of the message sender (e.g., user, assistant, system)."""
+
+
+class AnalyzedDataInput(BaseModel):
+    messages: Optional[List[AnalyzedDataInputMessage]] = None
+    """The list of messages as input to a language model."""
+
+    __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+    if TYPE_CHECKING:
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+
+
+class AnalyzedDataOutputMessage(BaseModel):
+    content: str
+    """The textual content of the message."""
+
+    role: Optional[str] = None
+    """The role of the message sender (e.g., user, assistant, system)."""
+
+
+class AnalyzedDataOutput(BaseModel):
+    messages: Optional[List[AnalyzedDataOutputMessage]] = None
+    """The list of messages as output from a language model."""
+
+
+class AnalyzedData(BaseModel):
+    input: AnalyzedDataInput
+
+    output: Optional[AnalyzedDataOutput] = None
+
+
+class MetadataProject(BaseModel):
+    project_alias: Optional[str] = None
+    """A custom alias for the Project."""
+
+    project_id: Optional[str] = None
+    """The unique identifier for the Project."""
+
+    ruleset_id: Optional[str] = None
+    """The unique identifier for the Ruleset associated with the Project."""
+
+
+class Metadata(BaseModel):
+    model: str
+    """The language model from the request."""
+
+    processing_time_ms: float
+    """The total time taken to perform the analysis."""
+
+    project: MetadataProject
+
+    provider: str
+    """The provider of the language model from the request."""
+
+    requester_id: str
+    """The identifier for the entity from the request."""
+
+    analyzed_at: Optional[datetime] = None
+    """The timestamp when the analysis was performed."""
+
+    event_id: Optional[str] = None
+    """The unique identifier for the analysis event."""
+
+
+class ModifiedDataInputMessage(BaseModel):
+    content: str
+    """The textual content of the message."""
+
+    role: Optional[str] = None
+    """The role of the message sender (e.g., user, assistant, system)."""
+
+
+class ModifiedDataInput(BaseModel):
+    messages: Optional[List[ModifiedDataInputMessage]] = None
+    """The list of messages as input to a language model."""
+
+    __pydantic_extra__: Dict[str, object] = FieldInfo(init=False)  # pyright: ignore[reportIncompatibleVariableOverride]
+    if TYPE_CHECKING:
+        # Stub to indicate that arbitrary properties are accepted.
+        # To access properties that are not valid identifiers you can use `getattr`, e.g.
+        # `getattr(obj, '$type')`
+        def __getattr__(self, attr: str) -> object: ...
+
+
+class ModifiedDataOutputMessage(BaseModel):
+    content: str
+    """The textual content of the message."""
+
+    role: Optional[str] = None
+    """The role of the message sender (e.g., user, assistant, system)."""
+
+
+class ModifiedDataOutput(BaseModel):
+    messages: Optional[List[ModifiedDataOutputMessage]] = None
+    """The list of messages as output from a language model."""
+
+
+class ModifiedData(BaseModel):
+    input: ModifiedDataInput
+
+    output: ModifiedDataOutput
+
+
+class InteractionAnalyzeResponse(BaseModel):
+    analysis: List[Analysis]
+
+    analyzed_data: AnalyzedData
+    """The language model input and/or output that was analyzed."""
+
+    metadata: Metadata
+
+    modified_data: ModifiedData
+    """
+    The potentially modified language model input and output after applying any
+    redactions or modifications based on the analysis.
+    """

hiddenlayer/types/model_retrieve_response.py

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, List, Optional
+
+from .._compat import PYDANTIC_V1, ConfigDict
+from .._models import BaseModel
+
+__all__ = ["ModelRetrieveResponse", "Version", "VersionDeployment"]
+
+
+class VersionDeployment(BaseModel):
+    active: Optional[bool] = None
+
+    path: Optional[str] = None
+
+
+class Version(BaseModel):
+    version: str
+
+    deployments: Optional[List[VersionDeployment]] = None
+
+    locations: Optional[Dict[str, object]] = None
+
+    model_version_id: Optional[str] = None
+
+    multi_file: Optional[bool] = None
+
+    retrievable: Optional[bool] = None
+
+    tags: Optional[Dict[str, object]] = None
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())
+
+
+class ModelRetrieveResponse(BaseModel):
+    name: str
+
+    source: str
+
+    model_id: Optional[str] = None
+
+    tenant_id: Optional[str] = None
+
+    versions: Optional[List[Version]] = None
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())

hiddenlayer/types/models/__init__.py

@@ -0,0 +1,6 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from .card_list_params import CardListParams as CardListParams
+from .card_list_response import CardListResponse as CardListResponse

hiddenlayer/types/models/card_list_params.py

@@ -0,0 +1,65 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing import List, Union
+from datetime import datetime
+from typing_extensions import Literal, Annotated, TypedDict
+
+from ..._utils import PropertyInfo
+
+__all__ = ["CardListParams", "ModelCreated", "ModelName", "Source"]
+
+
+class CardListParams(TypedDict, total=False):
+    aidr_severity: List[Literal["SAFE", "UNSAFE", "SUSPICIOUS"]]
+
+    aidr_status: Literal["ENABLED", "DISABLED", "ANY"]
+    """filter by aidr enabled"""
+
+    limit: int
+    """Limit the number of items returned"""
+
+    model_created: ModelCreated
+    """match on models created between dates"""
+
+    model_name: ModelName
+    """substring match on model name"""
+
+    modscan_severity: List[Literal["SAFE", "UNSAFE", "SUSPICIOUS", "UNKNOWN", "ERROR"]]
+
+    modscan_status: Literal["ENABLED", "DISABLED", "ANY"]
+
+    offset: int
+    """Begin returning the results from this offset"""
+
+    provider: List[Literal["AZURE", "ADHOC"]]
+
+    sort: str
+    """
+    allow sorting by model name or created at timestamp, ascending (+) or the
+    default descending (-)
+    """
+
+    source: Source
+    """substring and full match on model source"""
+
+    x_correlation_id: Annotated[str, PropertyInfo(alias="X-Correlation-Id")]
+
+
+class ModelCreated(TypedDict, total=False):
+    gte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+
+    lte: Annotated[Union[str, datetime], PropertyInfo(format="iso8601")]
+
+
+class ModelName(TypedDict, total=False):
+    contains: str
+
+    eq: str
+
+
+class Source(TypedDict, total=False):
+    contains: str
+
+    eq: str

hiddenlayer/types/models/card_list_response.py

@@ -0,0 +1,50 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from typing import Dict, Optional
+from typing_extensions import Literal
+
+from ..._compat import PYDANTIC_V1, ConfigDict
+from ..._models import BaseModel
+
+__all__ = ["CardListResponse", "SecurityPosture"]
+
+
+class SecurityPosture(BaseModel):
+    attack_monitoring: Optional[bool] = None
+
+    model_scan: Optional[bool] = None
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())
+
+
+class CardListResponse(BaseModel):
+    active_version_count: int
+
+    attack_monitoring_threat_level: Literal["safe", "unsafe", "suspicious", "not available"]
+
+    created_at: int
+    """Unix Nano Epoch Timestamp"""
+
+    has_genealogy: bool
+    """
+    A value of `true` indicates that one or more versions of this model have
+    associated model genealogy information.
+    """
+
+    model_id: str
+
+    model_scan_threat_level: Literal["safe", "unsafe", "suspicious", "not available"]
+
+    plaintext_name: str
+
+    source: str
+
+    security_posture: Optional[SecurityPosture] = None
+
+    tags: Optional[Dict[str, object]] = None
+
+    if not PYDANTIC_V1:
+        # allow fields with a `model_` prefix
+        model_config = ConfigDict(protected_namespaces=tuple())

hiddenlayer/types/prompt_analyzer_create_params.py

@@ -0,0 +1,23 @@
+# File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+from __future__ import annotations
+
+from typing_extensions import Required, Annotated, TypedDict
+
+from .._utils import PropertyInfo
+
+__all__ = ["PromptAnalyzerCreateParams"]
+
+
+class PromptAnalyzerCreateParams(TypedDict, total=False):
+    prompt: Required[str]
+
+    model: str
+
+    output: str
+
+    hl_project_id: Annotated[str, PropertyInfo(alias="HL-Project-Id")]
+
+    x_correlation_id: Annotated[str, PropertyInfo(alias="X-Correlation-Id")]
+
+    x_requester_id: Annotated[str, PropertyInfo(alias="X-Requester-Id")]