dtx-models 0.18.2__py3-none-any.whl

dtx_models/target.py

@@ -0,0 +1,255 @@
+from typing import Dict, List, Optional, Union
+
+from pydantic import AnyUrl, BaseModel, Field, HttpUrl
+
+
+class BaseTarget(BaseModel):
+    """
+    Base class for all AI providers in dtx.
+
+    Attributes:
+        id (str): Unique identifier for the provider.
+        config (Optional[Dict[str, Union[str, int, float, List[str]]]]):
+            Configuration options such as API keys, temperature, max tokens, etc.
+    """
+
+    id: str = Field(
+        description="Unique provider identifier (e.g., 'openai:gpt-4o-mini')"
+    )
+    config: Optional[Dict[str, Union[str, int, float, List[str]]]] = Field(
+        default_factory=dict,
+        description="Optional configuration settings for the provider.",
+    )
+
+
+class OpenAITarget(BaseTarget):
+    """
+    OpenAI provider for GPT-based models.
+
+    Example:
+    ```yaml
+    providers:
+      - id: openai:gpt-4o-mini
+        config:
+          temperature: 0.7
+          max_tokens: 150
+    ```
+    """
+
+    id: str = Field(default="openai:gpt-4o-mini", description="OpenAI model identifier")
+    config: Dict[str, Union[str, int, float, List[str]]] = Field(
+        default_factory=lambda: {"temperature": 0.7, "max_tokens": 150}
+    )
+
+
+class AnthropicTarget(BaseTarget):
+    """
+    Anthropic provider for Claude models.
+
+    Example:
+    ```yaml
+    providers:
+      - id: anthropic:messages:claude-3-7-sonnet
+        config:
+          max_tokens: 1000
+    ```
+    """
+
+    id: str = Field(
+        default="anthropic:messages:claude-3-7-sonnet",
+        description="Anthropic model identifier",
+    )
+    config: Dict[str, Union[str, int]] = Field(
+        default_factory=lambda: {"max_tokens": 1000}
+    )
+
+
+class HTTPTarget(BaseTarget):
+    """
+    Generic HTTP provider for API-based integrations.
+
+    Example:
+    ```yaml
+    providers:
+      - id: https://api.example.com/v1/chat/completions
+        config:
+          headers:
+            Authorization: "Bearer your_api_key"
+    ```
+    """
+
+    id: HttpUrl = Field(description="API endpoint URL")
+    config: Dict[str, Union[str, Dict[str, str]]] = Field(
+        default_factory=lambda: {"headers": {"Authorization": "Bearer your_api_key"}}
+    )
+
+
+class LocalPythonTarget(BaseTarget):
+    """
+    Custom Python-based provider.
+
+    Example:
+    ```yaml
+    providers:
+      - id: file://path/to/custom_provider.py
+    ```
+    """
+
+    id: str = Field(
+        description="Path to the custom Python script (e.g., file://path/to/custom_provider.py)"
+    )
+
+
+class ShellCommandTarget(BaseTarget):
+    """
+    Target for executing shell commands.
+
+    Example:
+    ```yaml
+    providers:
+      - id: "exec: python chain.py"
+    ```
+    """
+
+    id: str = Field(
+        description="Shell command to execute (e.g., 'exec: python chain.py')"
+    )
+
+
+class WebSocketTarget(BaseModel):
+    """
+    WebSocket provider for real-time AI model interactions.
+
+    Example:
+    ```yaml
+    providers:
+      - id: ws://example.com/ws
+        config:
+          messageTemplate: '{"prompt": "{{prompt}}"}'
+    ```
+    """
+
+    id: AnyUrl = Field(description="WebSocket URL (supports ws:// and wss://)")
+    config: Optional[Dict[str, str]] = Field(
+        default_factory=lambda: {"messageTemplate": '{"prompt": "{{prompt}}"}'}
+    )
+
+
+class CustomJSTarget(BaseTarget):
+    """
+    JavaScript-based custom provider.
+
+    Example:
+    ```yaml
+    providers:
+      - id: file://path/to/custom_provider.js
+    ```
+    """
+
+    id: str = Field(
+        description="Path to the JavaScript file (e.g., file://path/to/custom_provider.js)"
+    )
+
+
+class OpenRouterTarget(BaseTarget):
+    """
+    OpenRouter provider for accessing multiple AI models via a unified API.
+
+    Example:
+    ```yaml
+    providers:
+      - id: openrouter:mistral/7b-instruct
+    ```
+    """
+
+    id: str = Field(
+        default="openrouter:mistral/7b-instruct",
+        description="OpenRouter model identifier",
+    )
+
+
+class GoogleVertexAITarget(BaseTarget):
+    """
+    Google Vertex AI provider for Gemini models.
+
+    Example:
+    ```yaml
+    providers:
+      - id: vertex:gemini-pro
+    ```
+    """
+
+    id: str = Field(
+        default="vertex:gemini-pro", description="Google Vertex AI model identifier"
+    )
+
+
+class AWSBedrockTarget(BaseTarget):
+    """
+    AWS Bedrock provider for various hosted models.
+
+    Example:
+    ```yaml
+    providers:
+      - id: bedrock:us.meta.llama3-2-90b-instruct-v1:0
+    ```
+    """
+
+    id: str = Field(
+        default="bedrock:us.meta.llama3-2-90b-instruct-v1:0",
+        description="AWS Bedrock model identifier",
+    )
+
+
+class HuggingFaceTarget(BaseTarget):
+    """
+    Hugging Face provider for model inference.
+
+    Example:
+    ```yaml
+    providers:
+      - id: huggingface:text-generation:gpt2
+    ```
+    """
+
+    id: str = Field(
+        default="huggingface:text-generation:gpt2",
+        description="Hugging Face model identifier",
+    )
+
+
+class ManualInputTarget(BaseTarget):
+    """
+    Manual input provider for CLI-based interaction.
+
+    Example:
+    ```yaml
+    providers:
+      - id: dtx:manual-input
+    ```
+    """
+
+    id: str = Field(
+        default="dtx:manual-input", description="Manual input provider identifier"
+    )
+
+
+if __name__ == "__main__":
+    # Example usage
+    def example_usage():
+        providers = [
+            OpenAITarget(),
+            AnthropicTarget(),
+            HTTPTarget(id="https://api.example.com/v1/chat/completions"),
+            LocalPythonTarget(id="file://path/to/custom_provider.py"),
+            WebSocketTarget(id="ws://example.com/ws"),
+            CustomJSTarget(id="file://path/to/custom_provider.js"),
+            AWSBedrockTarget(),
+            HuggingFaceTarget(),
+            ManualInputTarget(),
+        ]
+
+        for provider in providers:
+            print(provider.model_dump_json())
+
+    example_usage()

dtx_models/template/prompts/base.py

@@ -0,0 +1,49 @@
+from abc import ABC, abstractmethod
+from enum import Enum
+from typing import List, Optional, Union
+
+from pydantic import BaseModel, Field
+
+from ...prompts import BaseMultiTurnConversation
+
+
+class PromptsRepoType(str, Enum):
+    LANGHUB = "langhub"
+
+    def __str__(self):
+        return self.value  # Ensures correct YAML serialization
+
+    @classmethod
+    def values(cls):
+        return [member.value for member in cls]
+
+
+class BasePrompTemplateParam(BaseModel):
+    """
+    Represents a parameter to be used in a request to a Gradio API.
+    """
+
+    name: str = Field(..., description="The name of the parameter.")
+    value: Optional[Union[str, int, bool, float, list, tuple, dict]] = Field(
+        None, description="The value of the parameter to be sent in the API request."
+    )
+
+
+class BasePromptTemplateConversation(BaseModel):
+    conversation: BaseMultiTurnConversation
+    input_variables: List[str]
+
+
+# Base abstract repository
+class BasePromptTemplateRepo(BaseModel, ABC):
+    id: str = Field(..., description="Prompt ID")
+
+    @abstractmethod
+    def get_template(self) -> BasePromptTemplateConversation:
+        """Retrieve the base prompt template."""
+        pass
+
+    @abstractmethod
+    def get_params(self) -> Optional[List[BasePrompTemplateParam]]:
+        """Retrieve the list of parameters for the prompt template."""
+        pass

dtx_models/template/prompts/langhub.py

@@ -0,0 +1,79 @@
+import re
+from typing import List, Literal, Optional
+
+from pydantic import BaseModel, Field
+
+from .base import (
+    BasePrompTemplateParam,
+    BasePromptTemplateConversation,
+    BasePromptTemplateRepo,
+)
+
+
+class LangchainHubPromptMetadata(BaseModel):
+    id: str
+    name: str
+    owner: Optional[str] = None
+    description: Optional[str] = None
+    readme: Optional[str] = None
+    tags: List[str] = []
+    last_commit_hash: Optional[str] = None
+    full_name: str
+
+
+class LangchainHubPromptParam(BasePrompTemplateParam):
+    pass
+
+
+class LangchainHubPrompt(BasePromptTemplateConversation):
+    metadata: LangchainHubPromptMetadata
+
+
+class LanghubPromptTemplateConfig(BaseModel):
+    full_name: str = Field(description="Repo Full Name")
+    prompt: Optional[LangchainHubPrompt] = Field(
+        default=None, description="Template Details"
+    )
+    params: Optional[List[LangchainHubPromptParam]] = Field(
+        None,
+        description="Optional list of parameters that can be replaced with values.",
+    )
+
+    @classmethod
+    def from_full_path(cls, full_path: str) -> "LanghubPromptTemplateConfig":
+        """
+        Factory method to extract full_name from full_path URL or path.
+        Example input:
+            - 'https://smith.langchain.com/hub/rlm/rag-prompt'
+            - '/rlm/rag-prompt'
+            - 'rlm/rag-prompt'
+        """
+        pattern = r"(?:https?://smith\.langchain\.com/hub)?/?(.+/.+)"
+        match = re.search(pattern, full_path.strip())
+        if not match:
+            raise ValueError(
+                "Invalid full path format.\n"
+                "Example: 'https://smith.langchain.com/hub/rlm/rag-prompt' or '/rlm/rag-prompt'"
+            )
+        full_name = match.group(1).strip("/")
+        return cls(full_name=full_name)
+
+
+# Concrete implementation for Langhub
+class LangHubPromptTemplate(BasePromptTemplateRepo):
+    provider: Literal["langhub"] = Field(
+        "langhub", description="Prompt ID, always set to 'langhub'."
+    )
+    config: LanghubPromptTemplateConfig
+
+    def get_template(self) -> BasePromptTemplateConversation:
+        if not self.config.prompt:
+            raise ValueError("Prompt template is not configured.")
+        return self.config.prompt
+
+    def get_params(self) -> Optional[List[LangchainHubPromptParam]]:
+        return self.config.params
+
+
+class LangHubPromptTemplates(BaseModel):
+    prompts: List[LangHubPromptTemplate]

dtx_models/utils/urls.py

@@ -0,0 +1,26 @@
+from urllib.parse import urlparse
+
+
+def url_2_name(url: str, level: int = 3) -> str:
+    """
+    Converts a URL into a name of format scheme:host:port:/limited/path.
+
+    Args:
+        url (str): The input URL.
+        level (int): Maximum number of path segments to include.
+
+    Returns:
+        str: A formatted name string.
+    """
+    parsed = urlparse(url)
+    scheme = parsed.scheme or "https"
+    netloc = parsed.netloc or parsed.path.split('/')[0]
+    path_parts = parsed.path.strip("/").split("/") if parsed.netloc else parsed.path.split("/")[1:]
+
+    trimmed_path = "/" + "/".join(path_parts[:level]) if path_parts else "/"
+
+    host = parsed.hostname or netloc
+    port = parsed.port or (443 if scheme == "https" else 80)
+
+    hostport = f"{host}:{port}"
+    return f"{scheme}:{hostport}:{trimmed_path}"

dtx_models-0.18.2.dist-info/METADATA

@@ -0,0 +1,57 @@
+Metadata-Version: 2.3
+Name: dtx-models
+Version: 0.18.2
+Summary: Shared model schemas and YAML-based configurations for the DTX framework.
+Author: JC
+Author-email: jitendra@detoxio.ai
+Requires-Python: >=3.10,<4.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: pydantic (>=2.11.5,<3.0.0)
+Requires-Dist: pydantic-yaml (>=1.5.1,<2.0.0)
+Requires-Dist: pyyaml (>=6.0.2,<7.0.0)
+Project-URL: Homepage, https://docs.detoxio.ai
+Description-Content-Type: text/markdown
+
+# dtx-models
+
+**dtx-models** provides shared model schemas, configuration structures, and YAML-based assets used across the [DTX AI Red Teaming Framework](https://docs.detoxio.ai).
+
+This package helps standardize model definitions and integrates seamlessly with components in the `dtx` ecosystem.
+
+## Features
+
+- Pydantic-based schema definitions
+- YAML-driven model and plugin configuration
+- Clean separation of model assets from core logic
+
+## Installation
+
+```bash
+pip install dtx-models
+````
+
+Or, if developing locally:
+
+```bash
+poetry install
+```
+
+## Requirements
+
+* Python >= 3.11
+* [Pydantic](https://docs.pydantic.dev/) v2
+* [PyYAML](https://pyyaml.org/)
+
+## Documentation
+
+Full documentation available at [docs.detoxio.ai](https://docs.detoxio.ai)
+
+---
+
+© Detoxio.ai – All rights reserved.
+
+

dtx_models-0.18.2.dist-info/RECORD

@@ -0,0 +1,29 @@
+dtx_models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtx_models/analysis.py,sha256=hrCy24jwS9uCXz7h6fTcAxgw5u_Stz9zsSZywCdQYCs,11539
+dtx_models/base.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtx_models/evaluator.py,sha256=h1XDCrvbVoqkexNBfc4fiUkXNAlq8DhpMoybVmAgjYU,10026
+dtx_models/exceptions.py,sha256=gxzdkoiZwsjfWKIT2m3hHM1FNO1l3gDj979rDUhKt_g,41
+dtx_models/prompts.py,sha256=tXCvdkuukjs_3j4lS1R_MSq_WOconmiWtFzLYdULocY,15164
+dtx_models/providers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtx_models/providers/base.py,sha256=KYEhVF61INjsGxO5tKOENv1c1xGGb1kX6Jevpewf5UI,418
+dtx_models/providers/gradio.py,sha256=2edCLtTAILvJkiMQkYl4FYKixMPjHrRUB0OFK9SeuIU,5261
+dtx_models/providers/groq.py,sha256=FoFtJrSzWEAcNJBM3irWtdYNgWZE72zOLVAjztrhdUI,694
+dtx_models/providers/hf.py,sha256=HKesR5iCcmjqtJqRowNav9YV7YYYIzkGy-Nl6VZTP9Q,5324
+dtx_models/providers/http.py,sha256=a2ZleqfEiqMfzEVoy55DUoUl3knxJLctppFgGdD4xAo,5294
+dtx_models/providers/litellm.py,sha256=VD7CNzeSO8ht96cRSrfi4opF_rtqKmdARDJD10nzkN4,550
+dtx_models/providers/models_spec.py,sha256=pc8yCITiaErZSp8H9f49fSBZEeEp2zPYfFN4QhgszQ4,7813
+dtx_models/providers/ollama.py,sha256=VfCAOO9YTPMLUbcsiKXDQgG_SYSGVUsCfS7iwfhCogk,3207
+dtx_models/providers/openai.py,sha256=psxmTeOdK5g2sOyLTBRTsxtgtBudXAWLCvzH8CeTNnw,3671
+dtx_models/results.py,sha256=sah7v1jOXAd8Vz_ghlamgTSaYxjvI8GdBzpLq0O2OJU,4323
+dtx_models/scope.py,sha256=PwmoOS6i4FLTKxklUH8Ueb633RH_l3_6x3ppA4hUmfk,7071
+dtx_models/tactic.py,sha256=GFSqgRmf00P6qJKKuLo14h3Tg-TRkl9nKk7oLvzDMdI,1395
+dtx_models/target.py,sha256=EETY2MzhWTuS4Xc8DmAQqrnesSuCttPaYTkzzt2Wn8M,5803
+dtx_models/template/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtx_models/template/prompts/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtx_models/template/prompts/base.py,sha256=E1ygnImn7RBY1puRhnyz3Ftz77PgahipqG2YtjXIlAU,1359
+dtx_models/template/prompts/langhub.py,sha256=90qvLl94hxg4mRRfhanoDICfS1YQyy3ply1ZYre7l6I,2414
+dtx_models/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+dtx_models/utils/urls.py,sha256=1uuarlhCBi-BVTPvtvCz7l7kM-b7rVCmPI_9ktHrKYw,816
+dtx_models-0.18.2.dist-info/METADATA,sha256=qMlSzJrB_Z_nfMPDWgo2y3uoajrCvGFJAhjwBOdU6kw,1484
+dtx_models-0.18.2.dist-info/WHEEL,sha256=b4K_helf-jlQoXBBETfwnf4B04YC67LOev0jo4fX5m8,88
+dtx_models-0.18.2.dist-info/RECORD,,

dtx_models-0.18.2.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: poetry-core 2.1.3
+Root-Is-Purelib: true
+Tag: py3-none-any