Skip to content

_documents

DocumentFormat

Bases: StrEnum

Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
15
16
17
class DocumentFormat(StrEnum):
    html = "html"
    markdown = "markdown"

html class-attribute instance-attribute 

html = 'html'

markdown class-attribute instance-attribute 

markdown = 'markdown'

HordeDocument

Bases: HordeResponseBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
20
21
22
23
24
25
26
27
28
29
class HordeDocument(HordeResponseBaseModel):
    html: str | None = None
    """The HTML content of the document, if requested."""
    markdown: str | None = None
    """The markdown content of the document, if requested."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str:
        return "HordeDocument"

html class-attribute instance-attribute 

html: str | None = None

The HTML content of the document, if requested.

markdown class-attribute instance-attribute 

markdown: str | None = None

The markdown content of the document, if requested.

get_api_model_name classmethod 

get_api_model_name() -> str
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
26
27
28
29
@override
@classmethod
def get_api_model_name(cls) -> str:
    return "HordeDocument"

AIHordeDocumentRequestMixin

Bases: HordeAPIObjectBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
class AIHordeDocumentRequestMixin(HordeAPIObjectBaseModel):
    format: DocumentFormat | str = DocumentFormat.html

    """The format of the document to return. Default is markdown."""

    @field_validator("format")
    def validate_format(cls, value: DocumentFormat | str) -> DocumentFormat | str:
        if isinstance(value, DocumentFormat):
            return value

        try:
            DocumentFormat(value)
        except ValueError:
            logger.warning(f"Unknown document format: {value}. Is your SDK out of date or did the API change?")

        return value

format class-attribute instance-attribute 

format: DocumentFormat | str = html

The format of the document to return. Default is markdown.

validate_format 

validate_format(value: DocumentFormat | str) -> DocumentFormat | str
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
37
38
39
40
41
42
43
44
45
46
47
@field_validator("format")
def validate_format(cls, value: DocumentFormat | str) -> DocumentFormat | str:
    if isinstance(value, DocumentFormat):
        return value

    try:
        DocumentFormat(value)
    except ValueError:
        logger.warning(f"Unknown document format: {value}. Is your SDK out of date or did the API change?")

    return value

AIHordeGetPrivacyPolicyRequest

Bases: BaseAIHordeRequest, AIHordeDocumentRequestMixin

Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
class AIHordeGetPrivacyPolicyRequest(BaseAIHordeRequest, AIHordeDocumentRequestMixin):
    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_documents_privacy

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[HordeDocument]:
        return HordeDocument

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
51
52
53
54
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
56
57
58
59
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.GET

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
61
62
63
64
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_documents_privacy

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[HordeDocument]
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
66
67
68
69
@override
@classmethod
def get_default_success_response_type(cls) -> type[HordeDocument]:
    return HordeDocument

AIHordeGetSponsorsRequest

Bases: BaseAIHordeRequest, AIHordeDocumentRequestMixin

Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
class AIHordeGetSponsorsRequest(BaseAIHordeRequest, AIHordeDocumentRequestMixin):
    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_documents_sponsors

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[HordeDocument]:
        return HordeDocument

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
73
74
75
76
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
78
79
80
81
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.GET

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
83
84
85
86
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_documents_sponsors

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[HordeDocument]
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
88
89
90
91
@override
@classmethod
def get_default_success_response_type(cls) -> type[HordeDocument]:
    return HordeDocument

AIHordeGetTermsRequest

Bases: BaseAIHordeRequest, AIHordeDocumentRequestMixin

Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
class AIHordeGetTermsRequest(BaseAIHordeRequest, AIHordeDocumentRequestMixin):
    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return None

    @override
    @classmethod
    def get_http_method(cls) -> HTTPMethod:
        return HTTPMethod.GET

    @override
    @classmethod
    def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
        return AI_HORDE_API_ENDPOINT_SUBPATH.v2_documents_terms

    @override
    @classmethod
    def get_default_success_response_type(cls) -> type[HordeDocument]:
        return HordeDocument

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
95
96
97
98
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return None

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
100
101
102
103
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.GET

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
105
106
107
108
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_documents_terms

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[HordeDocument]
Source code in horde_sdk/ai_horde_api/apimodels/_documents.py 
110
111
112
113
@override
@classmethod
def get_default_success_response_type(cls) -> type[HordeDocument]:
    return HordeDocument