Skip to content

_async

TextGenerateAsyncResponse

Bases: HordeResponseBaseModel, JobResponseMixin, ResponseRequiringFollowUpMixin, ContainsMessageResponseMixin

Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
class TextGenerateAsyncResponse(
    HordeResponseBaseModel,
    JobResponseMixin,
    ResponseRequiringFollowUpMixin,
    ContainsMessageResponseMixin,
):
    kudos: float | None = Field(
        default=None,
    )
    """The expected kudos consumption for this request."""
    warnings: list[SingleWarningEntry] | None = None
    """Any warnings that were generated by the server or a serving worker."""

    @model_validator(mode="after")
    def validate_warnings(self) -> TextGenerateAsyncResponse:
        if self.warnings is None:
            return self

        for warning in self.warnings:
            logger.warning(f"Warning from server ({warning.code}): {warning.message}")

        return self

    @override
    def get_follow_up_returned_params(self, *, as_python_field_name: bool = False) -> list[dict[str, object]]:
        if as_python_field_name:
            return [{"id_": self.id_}]
        return [{"id": self.id_}]

    @classmethod
    def get_follow_up_default_request_type(cls) -> type[TextGenerateStatusRequest]:
        return TextGenerateStatusRequest

    @override
    @classmethod
    def get_follow_up_request_types(  # type: ignore[override]
        cls,
    ) -> list[type[TextGenerateStatusRequest]]:
        return [TextGenerateStatusRequest]

    @override
    @classmethod
    def get_follow_up_failure_cleanup_request_type(cls) -> type[DeleteTextGenerateRequest]:
        return DeleteTextGenerateRequest

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "RequestAsync"

    def __hash__(self) -> int:
        return hash(TextGenerateAsyncResponse.__name__) + hash(self.id_)

    def __eq__(self, __value: object) -> bool:
        return isinstance(__value, TextGenerateAsyncResponse) and self.id_ == __value.id_

kudos class-attribute instance-attribute 

kudos: float | None = Field(default=None)

The expected kudos consumption for this request.

warnings class-attribute instance-attribute 

warnings: list[SingleWarningEntry] | None = None

Any warnings that were generated by the server or a serving worker.

validate_warnings 

validate_warnings() -> TextGenerateAsyncResponse
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
41
42
43
44
45
46
47
48
49
@model_validator(mode="after")
def validate_warnings(self) -> TextGenerateAsyncResponse:
    if self.warnings is None:
        return self

    for warning in self.warnings:
        logger.warning(f"Warning from server ({warning.code}): {warning.message}")

    return self

get_follow_up_returned_params 

get_follow_up_returned_params(*, as_python_field_name: bool = False) -> list[dict[str, object]]
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
51
52
53
54
55
@override
def get_follow_up_returned_params(self, *, as_python_field_name: bool = False) -> list[dict[str, object]]:
    if as_python_field_name:
        return [{"id_": self.id_}]
    return [{"id": self.id_}]

get_follow_up_default_request_type classmethod 

get_follow_up_default_request_type() -> type[TextGenerateStatusRequest]
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
57
58
59
@classmethod
def get_follow_up_default_request_type(cls) -> type[TextGenerateStatusRequest]:
    return TextGenerateStatusRequest

get_follow_up_request_types classmethod 

get_follow_up_request_types() -> list[type[TextGenerateStatusRequest]]
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
61
62
63
64
65
66
@override
@classmethod
def get_follow_up_request_types(  # type: ignore[override]
    cls,
) -> list[type[TextGenerateStatusRequest]]:
    return [TextGenerateStatusRequest]

get_follow_up_failure_cleanup_request_type classmethod 

get_follow_up_failure_cleanup_request_type() -> type[DeleteTextGenerateRequest]
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
68
69
70
71
@override
@classmethod
def get_follow_up_failure_cleanup_request_type(cls) -> type[DeleteTextGenerateRequest]:
    return DeleteTextGenerateRequest

get_api_model_name classmethod 

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

__hash__ 

__hash__() -> int
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
78
79
def __hash__(self) -> int:
    return hash(TextGenerateAsyncResponse.__name__) + hash(self.id_)

__eq__ 

__eq__(__value: object) -> bool
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
81
82
def __eq__(self, __value: object) -> bool:
    return isinstance(__value, TextGenerateAsyncResponse) and self.id_ == __value.id_

ModelPayloadRootKobold

Bases: HordeAPIData

Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
@Unhashable
class ModelPayloadRootKobold(HordeAPIData):
    dynatemp_exponent: float | None = Field(1, ge=0.0, le=5.0)
    """Dynamic temperature exponent value."""
    dynatemp_range: float | None = Field(0, ge=0.0, le=5.0)
    """Dynamic temperature range value."""
    frmtadsnsp: bool | None = Field(
        default=None,
        description=(
            "Input formatting option. When enabled, adds a leading space to your input if there is no trailing"
            " whitespace at the end of the previous action."
        ),
        examples=[
            False,
        ],
    )
    """Input formatting option. When enabled, adds a leading space to your input if there is no trailing whitespace at
    the end of the previous action."""
    frmtrmblln: bool | None = Field(
        default=None,
        description=(
            "Output formatting option. When enabled, replaces all occurrences of two or more consecutive newlines in"
            " the output with one newline."
        ),
        examples=[
            False,
        ],
    )
    """Output formatting option. When enabled, replaces all occurrences of two or more consecutive newlines in the
    output with one newline."""
    frmtrmspch: bool | None = Field(
        default=None,
        examples=[
            False,
        ],
    )
    """Output formatting option. When enabled, removes #/@%}{+=~|\\^<> from the output."""
    frmttriminc: bool | None = Field(
        default=None,
        description=(
            "Output formatting option. When enabled, removes some characters from the end of the output such that the"
            " output doesn't end in the middle of a sentence. If the output is less than one sentence long, does"
            " nothing."
        ),
        examples=[
            False,
        ],
    )
    """Output formatting option. When enabled, removes some characters from the end of the output such that the output
    doesn't end in the middle of a sentence. If the output is less than one sentence long, does nothing."""
    max_context_length: int | None = Field(
        default=1024,
        ge=80,
        le=32000,
    )
    """Maximum number of tokens to send to the model."""
    max_length: int | None = Field(80, ge=16, le=1024)
    """Number of tokens to generate."""
    min_p: float | None = Field(0, ge=0.0, le=1.0)
    """Min-p sampling value."""
    n: int | None = Field(default=None, examples=[1], ge=1, le=20)
    """The number of generations to produce."""
    rep_pen: float | None = Field(default=None, ge=1.0, le=3.0)
    """Base repetition penalty value."""
    rep_pen_range: int | None = Field(default=None, ge=0, le=4096)
    """Repetition penalty range."""
    rep_pen_slope: float | None = Field(default=None, ge=0.0, le=10.0)
    """Repetition penalty slope."""
    sampler_order: list[int] | None = None
    """The sampler order to use for the generation."""
    singleline: bool | None = Field(
        default=None,
        description=(
            "Output formatting option. When enabled, removes everything after the first line of the output, including"
            " the newline."
        ),
        examples=[
            False,
        ],
    )
    """Output formatting option. When enabled, removes everything after the first line of the output, including the
    newline."""
    smoothing_factor: float | None = Field(0, ge=0.0, le=10.0)
    """Quadratic sampling value."""
    stop_sequence: list[str] | None = None
    """The stop sequences to use for the generation."""
    temperature: float | None = Field(default=None, ge=0.0, le=5.0)
    """Temperature value."""
    tfs: float | None = Field(default=None, ge=0.0, le=1.0)
    """Tail free sampling value."""
    top_a: float | None = Field(default=None, ge=0.0, le=1.0)
    """Top-a sampling value."""
    top_k: int | None = Field(default=None, ge=0, le=100)
    """Top-k sampling value."""
    top_p: float | None = Field(default=None, ge=0.001, le=1.0)
    """Top-p sampling value."""
    typical: float | None = Field(default=None, ge=0.0, le=1.0)
    """Typical sampling value."""
    use_default_badwordsids: bool | None = None
    """When True, uses the default KoboldAI bad word IDs."""

dynatemp_exponent class-attribute instance-attribute 

dynatemp_exponent: float | None = Field(1, ge=0.0, le=5.0)

Dynamic temperature exponent value.

dynatemp_range class-attribute instance-attribute 

dynatemp_range: float | None = Field(0, ge=0.0, le=5.0)

Dynamic temperature range value.

frmtadsnsp class-attribute instance-attribute 

frmtadsnsp: bool | None = Field(default=None, description='Input formatting option. When enabled, adds a leading space to your input if there is no trailing whitespace at the end of the previous action.', examples=[False])

Input formatting option. When enabled, adds a leading space to your input if there is no trailing whitespace at the end of the previous action.

frmtrmblln class-attribute instance-attribute 

frmtrmblln: bool | None = Field(default=None, description='Output formatting option. When enabled, replaces all occurrences of two or more consecutive newlines in the output with one newline.', examples=[False])

Output formatting option. When enabled, replaces all occurrences of two or more consecutive newlines in the output with one newline.

frmtrmspch class-attribute instance-attribute 

frmtrmspch: bool | None = Field(default=None, examples=[False])

Output formatting option. When enabled, removes #/@%}{+=~|\^<> from the output.

frmttriminc class-attribute instance-attribute 

frmttriminc: bool | None = Field(default=None, description="Output formatting option. When enabled, removes some characters from the end of the output such that the output doesn't end in the middle of a sentence. If the output is less than one sentence long, does nothing.", examples=[False])

Output formatting option. When enabled, removes some characters from the end of the output such that the output doesn't end in the middle of a sentence. If the output is less than one sentence long, does nothing.

max_context_length class-attribute instance-attribute 

max_context_length: int | None = Field(default=1024, ge=80, le=32000)

Maximum number of tokens to send to the model.

max_length class-attribute instance-attribute 

max_length: int | None = Field(80, ge=16, le=1024)

Number of tokens to generate.

min_p class-attribute instance-attribute 

min_p: float | None = Field(0, ge=0.0, le=1.0)

Min-p sampling value.

n class-attribute instance-attribute 

n: int | None = Field(default=None, examples=[1], ge=1, le=20)

The number of generations to produce.

rep_pen class-attribute instance-attribute 

rep_pen: float | None = Field(default=None, ge=1.0, le=3.0)

Base repetition penalty value.

rep_pen_range class-attribute instance-attribute 

rep_pen_range: int | None = Field(default=None, ge=0, le=4096)

Repetition penalty range.

rep_pen_slope class-attribute instance-attribute 

rep_pen_slope: float | None = Field(default=None, ge=0.0, le=10.0)

Repetition penalty slope.

sampler_order class-attribute instance-attribute 

sampler_order: list[int] | None = None

The sampler order to use for the generation.

singleline class-attribute instance-attribute 

singleline: bool | None = Field(default=None, description='Output formatting option. When enabled, removes everything after the first line of the output, including the newline.', examples=[False])

Output formatting option. When enabled, removes everything after the first line of the output, including the newline.

smoothing_factor class-attribute instance-attribute 

smoothing_factor: float | None = Field(0, ge=0.0, le=10.0)

Quadratic sampling value.

stop_sequence class-attribute instance-attribute 

stop_sequence: list[str] | None = None

The stop sequences to use for the generation.

temperature class-attribute instance-attribute 

temperature: float | None = Field(default=None, ge=0.0, le=5.0)

Temperature value.

tfs class-attribute instance-attribute 

tfs: float | None = Field(default=None, ge=0.0, le=1.0)

Tail free sampling value.

top_a class-attribute instance-attribute 

top_a: float | None = Field(default=None, ge=0.0, le=1.0)

Top-a sampling value.

top_k class-attribute instance-attribute 

top_k: int | None = Field(default=None, ge=0, le=100)

Top-k sampling value.

top_p class-attribute instance-attribute 

top_p: float | None = Field(default=None, ge=0.001, le=1.0)

Top-p sampling value.

typical class-attribute instance-attribute 

typical: float | None = Field(default=None, ge=0.0, le=1.0)

Typical sampling value.

use_default_badwordsids class-attribute instance-attribute 

use_default_badwordsids: bool | None = None

When True, uses the default KoboldAI bad word IDs.

ModelGenerationInputKobold

Bases: ModelPayloadRootKobold

Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
187
188
189
@Unhashable
class ModelGenerationInputKobold(ModelPayloadRootKobold):
    pass

TextGenerateAsyncDryRunResponse

Bases: HordeResponseBaseModel

Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
192
193
194
195
196
197
198
199
class TextGenerateAsyncDryRunResponse(HordeResponseBaseModel):
    kudos: float
    """The expected kudos consumption for this request."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return _ANONYMOUS_MODEL

kudos instance-attribute 

kudos: float

The expected kudos consumption for this request.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
196
197
198
199
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return _ANONYMOUS_MODEL

TextGenerateAsyncRequest

Bases: BaseAIHordeRequest, APIKeyAllowedInRequestMixin, RequestUsesWorkerMixin

Represents the data needed to make a request to the /v2/generate/async endpoint.

v2 API Model: GenerationInputKobold

Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
@Unhashable
class TextGenerateAsyncRequest(
    BaseAIHordeRequest,
    APIKeyAllowedInRequestMixin,
    RequestUsesWorkerMixin,
):
    """Represents the data needed to make a request to the `/v2/generate/async` endpoint.

    v2 API Model: `GenerationInputKobold`
    """

    params: ModelGenerationInputKobold | None = None
    """The parameters to use for the generation."""
    prompt: str | None = None
    """The prompt which will be sent to KoboldAI to generate text."""

    allow_downgrade: bool | None = Field(False)
    """When true and the request requires upfront kudos and the account does not have enough The request will be
    downgraded in max context and max tokens so that it does not need upfront kudos."""
    disable_batching: bool | None = Field(False)
    """When true, This request will not use batching. This will allow you to retrieve accurate seeds.
    Feature is restricted to Trusted users and Patreons."""
    extra_source_images: list[ExtraSourceImageEntry] | None = None
    """Any extra source images that should be used for this request; e.g., for multi-modal models."""
    proxied_account: str | None = Field(default=None)
    """If using a service account as a proxy, provide this value to identify the actual account from which this
    request is coming from."""
    softprompt: str | None = Field(
        default=None,
        min_length=1,
    )
    """Specify which softprompt needs to be used to service this request."""
    webhook: str | None = Field(default=None)
    """Provide a URL where the AI Horde will send a POST call after each delivered generation.
    The request will include the details of the job as well as the request ID."""

    @override
    @classmethod
    def get_api_model_name(cls) -> str | None:
        return "GenerationInputKobold"

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

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

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

    @override
    @classmethod
    def get_success_status_response_pairs(cls) -> dict[HTTPStatusCode, type[HordeResponseTypes]]:
        return {
            HTTPStatusCode.OK: TextGenerateAsyncDryRunResponse,
            HTTPStatusCode.ACCEPTED: cls.get_default_success_response_type(),
        }

    @override
    def get_extra_fields_to_exclude_from_log(self) -> set[str]:
        return {"extra_source_images"}

params class-attribute instance-attribute 

params: ModelGenerationInputKobold | None = None

The parameters to use for the generation.

prompt class-attribute instance-attribute 

prompt: str | None = None

The prompt which will be sent to KoboldAI to generate text.

allow_downgrade class-attribute instance-attribute 

allow_downgrade: bool | None = Field(False)

When true and the request requires upfront kudos and the account does not have enough The request will be downgraded in max context and max tokens so that it does not need upfront kudos.

disable_batching class-attribute instance-attribute 

disable_batching: bool | None = Field(False)

When true, This request will not use batching. This will allow you to retrieve accurate seeds. Feature is restricted to Trusted users and Patreons.

extra_source_images class-attribute instance-attribute 

extra_source_images: list[ExtraSourceImageEntry] | None = None

Any extra source images that should be used for this request; e.g., for multi-modal models.

proxied_account class-attribute instance-attribute 

proxied_account: str | None = Field(default=None)

If using a service account as a proxy, provide this value to identify the actual account from which this request is coming from.

softprompt class-attribute instance-attribute 

softprompt: str | None = Field(default=None, min_length=1)

Specify which softprompt needs to be used to service this request.

webhook class-attribute instance-attribute 

webhook: str | None = Field(default=None)

Provide a URL where the AI Horde will send a POST call after each delivered generation. The request will include the details of the job as well as the request ID.

get_api_model_name classmethod 

get_api_model_name() -> str | None
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
238
239
240
241
@override
@classmethod
def get_api_model_name(cls) -> str | None:
    return "GenerationInputKobold"

get_http_method classmethod 

get_http_method() -> HTTPMethod
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
243
244
245
246
@override
@classmethod
def get_http_method(cls) -> HTTPMethod:
    return HTTPMethod.POST

get_api_endpoint_subpath classmethod 

get_api_endpoint_subpath() -> AI_HORDE_API_ENDPOINT_SUBPATH
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
248
249
250
251
@override
@classmethod
def get_api_endpoint_subpath(cls) -> AI_HORDE_API_ENDPOINT_SUBPATH:
    return AI_HORDE_API_ENDPOINT_SUBPATH.v2_generate_text_async

get_default_success_response_type classmethod 

get_default_success_response_type() -> type[TextGenerateAsyncResponse]
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
253
254
255
256
@override
@classmethod
def get_default_success_response_type(cls) -> type[TextGenerateAsyncResponse]:
    return TextGenerateAsyncResponse

get_success_status_response_pairs classmethod 

get_success_status_response_pairs() -> dict[HTTPStatusCode, type[HordeResponseTypes]]
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
258
259
260
261
262
263
264
@override
@classmethod
def get_success_status_response_pairs(cls) -> dict[HTTPStatusCode, type[HordeResponseTypes]]:
    return {
        HTTPStatusCode.OK: TextGenerateAsyncDryRunResponse,
        HTTPStatusCode.ACCEPTED: cls.get_default_success_response_type(),
    }

get_extra_fields_to_exclude_from_log 

get_extra_fields_to_exclude_from_log() -> set[str]
Source code in horde_sdk/ai_horde_api/apimodels/generate/text/_async.py 
266
267
268
@override
def get_extra_fields_to_exclude_from_log(self) -> set[str]:
    return {"extra_source_images"}