import SuperMap from "@thunder04/supermap"; export declare const ErrorMessages: Readonly<{ readonly MissingPrompt: "The generation prompt was not given"; readonly CorruptPrompt: "The prompts was rejected as unethical"; readonly KudosValidationError: "Something went wrong when transferring kudos. This is a base rc, so you should never typically see it."; readonly NoValidActions: "Something went wrong when modifying an entity on the horde. This is a base rc, so you should never typically see it."; readonly InvalidSize: "Requested image size is not a multiple of 64"; readonly InvalidPromptSize: "Prompt is too large"; readonly TooManySteps: "Too many steps requested for image generation"; readonly Profanity: "Profanity Detected. This is a base rc, so you should never typically see i"; readonly ProfaneWorkerName: "Profanity detected in worker name"; readonly ProfaneBridgeAgent: "Profanity detected in bridge agent"; readonly ProfaneWorkerInfo: "Profanity detected in worker info"; readonly ProfaneUserName: "Profanity detected in username"; readonly ProfaneUserContact: "Profanity detected in user contact details"; readonly ProfaneAdminComment: "Profanity detected in admin comment"; readonly ProfaneTeamName: "Profanity detected in team name"; readonly ProfaneTeamInfo: "Profanity detected in team info"; readonly TooLong: "Provided string was too long. This is a base rc, so you should never typically see it."; readonly TooLongWorkerName: "The provided worker name is too long"; readonly TooLongUserName: "The provided username is too long"; readonly NameAlreadyExists: "The provided name already exists. This is a base rc, so you should never typically see it."; readonly WorkerNameAlreadyExists: "The provided worker name already exists"; readonly TeamNameAlreadyExists: "The provided team name already exists"; readonly PolymorphicNameConflict: "The provided worker name already exists for a different worker type (e.g. Dreamer VS Scribe)"; readonly ImageValidationFailed: "Source image validation failed unexpectedly"; readonly SourceImageResolutionExceeded: "Source image resolution larger than the max allowed by the AI Horde"; readonly SourceImageSizeExceeded: "Source image file size larger than the max allowed by the AI Horde"; readonly SourceImageUrlInvalid: "Source image url does not contain an image"; readonly SourceImageUnreadable: "Source image could not be parsed"; readonly InpaintingMissingMask: "Missing mask or alpha channel for inpainting"; readonly SourceMaskUnnecessary: "Source mask sent without a source image"; readonly UnsupportedSampler: "Selected sampler unsupported with selected model"; readonly UnsupportedModel: "The required model name is unsupported with this payload. This is a base rc, so you should never typically see it."; readonly ControlNetUnsupported: "ControlNet is unsupported in combination with this model"; readonly ControlNetSourceMissing: "Missing source image for ControlNet workflow"; readonly ControlNetInvalidPayload: "sent CN source and requested CN source at the same time"; readonly SourceImageRequiredForModel: "Source image is required for using this model"; readonly UnexpectedModelName: "Model name sent is not a Stable Diffusion checkpoint"; readonly TooManyUpscalers: "Tried to use more than 1 upscaler at a time"; readonly ProcGenNotFound: "The used generation for aesthetic ratings doesn't exist"; readonly InvalidAestheticAttempt: "Aesthetics rating attempt failed"; readonly AestheticsNotCompleted: "Attempted to rate non-completed request"; readonly AestheticsNotPublic: "Attempted to rate non-shared request"; readonly AestheticsDuplicate: "Sent duplicate images in an aesthetics set"; readonly AestheticsMissing: "Aesthetic ratings missing"; readonly AestheticsSolo: "Aesthetic ratings best-of contain a single image"; readonly AestheticsConfused: "The best image is not the one with the highest aesthetic rating"; readonly AestheticsAlreadyExist: "Aesthetic rating already submitted"; readonly AestheticsServerRejected: "Aesthetic server rejected submission"; readonly AestheticsServerError: "Aesthetic server returned error (provided)"; readonly AestheticsServerDown: "Aesthetic server is down"; readonly AestheticsServerTimeout: "Aesthetic server timed out during submission"; readonly InvalidAPIKey: "Invalid AI Horde API key provided"; readonly WrongCredentials: "Provided user does not own this worker"; readonly NotAdmin: "Request needs AI Horded admin credentials"; readonly NotModerator: "Request needs AI Horded moderator credentials"; readonly NotOwner: "Request needs worker owner credentials"; readonly NotPrivileged: "This user is not hardcoded to perform this operation"; readonly AnonForbidden: "Anonymous is not allowed to perform this operation"; readonly AnonForbiddenWorker: "Anonymous tried to run a worker"; readonly AnonForbiddenUserMod: "Anonymous tried to modify their user account"; readonly NotTrusted: "Untrusted users are not allowed to perform this operation"; readonly UntrustedTeamCreation: "Untrusted user tried to create a team"; readonly UntrustedUnsafeIP: "Untrusted user tried to use a VPN for a worker"; readonly WorkerMaintenance: "Worker has been put into maintenance and cannot pop new jobs"; readonly WorkerFlaggedMaintenance: "Worker owner has been flagged and worker has been put into permanent maintenance"; readonly TooManySameIPs: "Same IP attempted to spawn too many workers"; readonly WorkerInviteOnly: "AI Horde is in worker invite-only mode and worker owner needs to request permission"; readonly UnsafeIP: "Worker attempted to connect from VPN"; readonly TimeoutIP: "Operation rejected because user IP in timeout"; readonly TooManyNewIPs: "Too many workers from new IPs currently"; readonly KudosUpfront: "This request requires upfront kudos to accept"; readonly SharedKeyEmpty: "Shared Key used in the request does not have any more kudos"; readonly InvalidJobID: "Job not found when trying to submit. This probably means its request was delected for inactivity"; readonly RequestNotFound: "Request not found. This probably means it was delected for inactivity"; readonly WorkerNotFound: "Worker ID not found"; readonly TeamNotFound: "Team ID not found"; readonly FilterNotFound: "Regex filter not found"; readonly UserNotFound: "User not found"; readonly DuplicateGen: "Job has already been submitted"; readonly AbortedGen: "Request aborted because too many jobs have failed"; readonly RequestExpired: "Request expired"; readonly TooManyPrompts: "User has requested too many generations concurrently"; readonly NoValidWorkers: "No workers online which can pick up this request"; readonly MaintenanceMode: "Request aborted because horde is in maintenance mode"; readonly TargetAccountFlagged: "Action rejected because target user has been flagged for violating Horde ToS"; readonly SourceAccountFlagged: "Action rejected because source user has been flagged for violating Horde ToS"; readonly FaultWhenKudosReceiving: "Unexpected error when receiving kudos"; readonly FaultWhenKudosSending: "Unexpected error when sending kudos"; readonly TooFastKudosTransfers: "User tried to send kudos too fast after receiving them from the same user"; readonly KudosTransferToAnon: "User tried to transfer kudos to Anon"; readonly KudosTransferToSelf: "User tried to transfer kudos to themselves"; readonly KudosTransferNotEnough: "User tried to transfer more kudos than they have"; readonly NegativeKudosTransfer: "User tried to transfer negative kudos"; readonly KudosTransferFromAnon: "User tried to transfer kudos using the Anon API key"; readonly InvalidAwardUsername: "Tried to award kudos to non-existing user"; readonly KudosAwardToAnon: "Tried to award kudos to Anonymous user"; readonly NotAllowedAwards: "This user is not allowed to Award Kudos"; readonly NoWorkerModSelected: "No valid worker modification selected"; readonly NoUserModSelected: "No valid user modification selected"; readonly NoHordeModSelected: "No valid horde modification selected"; readonly NoTeamModSelected: "No valid team modification selected"; readonly NoFilterModSelected: "No valid regex filter modification selected"; readonly NoSharedKeyModSelected: "No valid shared key modification selected"; readonly BadRequest: "Generic HTTP 400 code. You should typically never see this"; readonly Forbidden: "Generic HTTP 401 code. You should typically never see this"; readonly Locked: "Generic HTTP code. You should typically never see this"; readonly Unknown: "Unknown rc code"; }>; export declare const ModelGenerationInputStableSamplers: Readonly<{ readonly lcm: "lcm"; readonly k_lms: "k_lms"; readonly k_heun: "k_heun"; readonly k_euler_a: "k_euler_a"; readonly k_euler: "k_euler"; readonly k_dpm_2: "k_dpm_2"; readonly k_dpm_2_a: "k_dpm_2_a"; readonly DDIM: "DDIM"; readonly PLMS: "PLMS"; readonly k_dpm_fast: "k_dpm_fast"; readonly k_dpm_adaptive: "k_dpm_adaptive"; readonly k_dpmpp_2s_a: "k_dpmpp_2s_a"; readonly k_dpmpp_2m: "k_dpmpp_2m"; readonly dpmsolver: "dpmsolver"; readonly k_dpmpp_sde: "k_dpmpp_sde"; }>; export declare const SourceImageProcessingTypes: Readonly<{ readonly img2img: "img2img"; readonly inpainting: "inpainting"; readonly outpainting: "outpainting"; readonly remix: "remix"; }>; export declare const ModelGenerationInputPostProcessingTypes: Readonly<{ readonly GFPGAN: "GFPGAN"; readonly RealESRGAN_x4plus: "RealESRGAN_x4plus"; readonly RealESRGAN_x2plus: "RealESRGAN_x2plus"; readonly RealESRGAN_x4plus_anime_6B: "RealESRGAN_x4plus_anime_6B"; readonly NMKD_Siax: "NMKD_Siax"; readonly "4x_AnimeSharp": "4x_AnimeSharp"; readonly strip_background: "strip_background"; readonly CodeFormers: "CodeFormers"; }>; export declare const ModelInterrogationFormTypes: Readonly<{ readonly caption: "caption"; readonly interrogation: "interrogation"; readonly nsfw: "nsfw"; readonly GFPGAN: "GFPGAN"; readonly RealESRGAN_x4plus: "RealESRGAN_x4plus"; readonly RealESRGAN_x4plus_anime_6B: "RealESRGAN_x4plus_anime_6B"; readonly NMKD_Siax: "NMKD_Siax"; readonly "4x_AnimeSharp": "4x_AnimeSharp"; readonly CodeFormers: "CodeFormers"; readonly strip_background: "strip_background"; }>; export declare const HordeAsyncRequestStates: Readonly<{ readonly waiting: "waiting"; readonly processing: "processing"; readonly done: "done"; readonly faulted: "faulted"; readonly partial: "partial"; readonly cancelled: "cancelled"; }>; export declare const ModelGenerationInputControlTypes: Readonly<{ readonly canny: "canny"; readonly hed: "hed"; readonly depth: "depth"; readonly normal: "normal"; readonly openpose: "openpose"; readonly seg: "seg"; readonly scribble: "scribble"; readonly fakescribbles: "fakescribbles"; readonly hough: "hough"; }>; export declare const ModelPayloadTextInversionsStable: Readonly<{ readonly prompt: "prompt"; readonly negrpompt: "negprompt"; }>; export declare const ModelGenerationInputWorkflows: Readonly<{ readonly qr_code: "qr_code"; }>; export declare const RequestSingleWarningCodes: Readonly<{ readonly NoAvailableWorker: "NoAvailableWorker"; readonly ClipSkipMismatch: "ClipSkipMismatch"; readonly StepsTooFew: "StepsTooFew"; readonly StepsTooMany: "StepsTooMany"; readonly CfgScaleMismatch: "CfgScaleMismatch"; readonly CfgScaleTooSmall: "CfgScaleTooSmall"; readonly CfgScaleTooLarge: "CfgScaleTooLarge"; readonly SamplerMismatch: "SamplerMismatch"; readonly SchedulerMismatch: "SchedulerMismatch"; }>; export declare const GenerationMetadataStableTypes: Readonly<{ readonly lora: "lora"; readonly ti: "ti"; readonly censorship: "censorship"; readonly source_image: "source_image"; readonly source_mask: "source_mask"; readonly extra_source_images: "extra_source_images"; readonly batch_index: "batch_index"; readonly information: "information"; }>; export declare const GenerationMetadataStableValues: Readonly<{ readonly download_failed: "download_failed"; readonly parse_failed: "parse_failed"; readonly baseline_mismatch: "baseline_mismatch"; readonly csam: "csam"; readonly nsfw: "nsfw"; readonly see_ref: "see_ref"; }>; export declare class APIError extends Error { rawError: RequestError; status: number; method: string; url: string; requestBody: any; errors: Record; error_code: string; constructor(rawError: RequestError | ValidationError, core_res: Response, method?: string, requestBody?: any); get name(): string; } export declare class AIHorde { #private; VERSION: string; ratings: AIHordeRatings; constructor(options?: AIHordeInitOptions); clearCache(): void; get cache(): AIHordeCache; parseAgent(agent: string): { name: string; version: string; link: string; }; generateFieldsString(fields?: string[]): string | undefined; /** * Lookup user details based on their API key. * This can be used to verify a user exists * @param options.token - The token of the user; If none given the default from the contructor is used * @param options.fields - Array of fields that will be included in the returned data * @returns UserDetails - The user data of the requested user */ findUser(options?: { token?: string; fields?: T[]; }): Promise>; /** * Details and statistics about a specific user * @param id - The user ids to get * @param options.token - The token of the requesting user; Has to be Moderator, Admin or Reuqested users token * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns UserDetails - The user data of the requested user */ getUserDetails(id: number, options?: { token?: string; force?: boolean; fields?: T[]; }): Promise>; /** * Details of a worker Team * @param id - The teams id to get * @param options.token - The token of the requesting user * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns TeamDetailsStable - The team data */ getTeam(id: string, options?: { token?: string; force?: boolean; fields?: T[]; }): Promise>; /** * Details of a registered worker. * This can be used to verify a user exists * @param id - The id of the worker * @param options.token - Moderator or API key of workers owner (gives more information if requesting user is owner or moderator) * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns worker details for the requested worker */ getWorkerDetails(id: string, options?: { token?: string; force?: boolean; fields?: T[]; }): Promise>; /** * Retrieve the status of an Asynchronous generation request without images * Use this method to check the status of a currently running asynchronous request without consuming bandwidth. * @param id - The id of the generation * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns RequestStatusCheck - The Check data of the Generation */ getImageGenerationCheck(id: string, options?: { force?: boolean; fields?: T[]; }): Promise>; /** * Retrieve the full status of an Asynchronous generation request * This method will include all already generated images in base64 encoded .webp files. * As such, you are requested to not retrieve this data often. Instead use the getGenerationCheck method first * This method is limited to 1 request per minute * @param id - The id of the generation * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns RequestStatusStable - The Status of the Generation */ getImageGenerationStatus(id: string, options?: { force?: boolean; fields?: T[]; }): Promise>; /** * This request will include all already generated texts. * @param id - The id of the generation * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns RequestStatusStable - The Status of the Generation */ getTextGenerationStatus(id: string, options?: { force?: boolean; fields?: T[]; }): Promise>; /** * This request will include all already generated images. * As such, you are requested to not retrieve this endpoint often. Instead use the /check/ endpoint first * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns InterrogationStatus - The Status data of the Interrogation */ getInterrogationStatus(id: string, options?: { force?: boolean; fields?: T[]; }): Promise>; /** * If this loads, this node is available * @returns true - If request was successful, if not throws error */ getHeartbeat(): Promise; /** * Returns a list of models active currently in this horde * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns ActiveModel[] - Array of Active Models */ getModels(options?: { force?: boolean; fields?: T[]; }): Promise[]>; /** * Returns the statistics of a specific model in this horde * @param model_name - The name of the model to fetch * @param options.fields - Array of fields that will be included in the returned data * @returns ActiveModel - The active model */ getModel(model_name: string, options?: { fields?: T[]; }): Promise[]>; /** * Horde Maintenance Mode Status * Use this method to quicky determine if this horde is in maintenance, invite_only or raid mode * @param options.token - Requires Admin or Owner API key * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns HordeModes - The current modes of the horde */ getModes(options?: { token?: string; force?: boolean; fields?: T[]; }): Promise>; /** * Read the latest happenings on the horde * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns Newspiece[] - Array of all news articles */ getNews(options?: { force?: boolean; fields?: T[]; }): Promise[]>; /** * Details about the current performance of this Horde * @param options.force - Set to true to skip cache * @param options.fields - Array of fields that will be included in the returned data * @returns HordePerformanceStable - The hordes current performance */ getPerformance(options?: { force?: boolean; fields?: T[]; }): Promise>; /** * A List with the details and statistic of all registered users * @param options.fields - Array of fields that will be included in the returned data * @returns UserDetails[] - An array of all users data */ getUsers(options?: { force?: boolean; fields?: T[]; }): Promise[]>; /** * A List with the details of all registered and active workers * @param options.fields - Array of fields that will be included in the returned data * @returns An array of all workers data */ getWorkers(options?: { fields?: T[]; }): Promise[]>; /** * Details how many images were generated per model for the past day, month and total * @param options.fields - Array of fields that will be included in the returned data * @returns ImageModelStats - The stats */ getImageModelStats(options?: { fields?: T[]; }): Promise>; /** * Details how many images have been generated in the past minux,hour,day,month and total * @param options.fields - Array of fields that will be included in the returned data * @returns ImageTotalStats - The stats */ getImageTotalStats(options?: { fields?: T[]; }): Promise>; /** * Details how many texts were generated per model for the past day, month and total * @param options.fields - Array of fields that will be included in the returned data * @returns TextModelStats - The stats */ getTextModelStats(options?: { fields?: T[]; }): Promise>; /** * Details how many images have been generated in the past minux,hour,day,month and total * @param options.fields - Array of fields that will be included in the returned data * @returns TextTotalStats - The stats */ getTextTotalStats(options?: { fields?: T[]; }): Promise>; /** * A List with the details of all teams * @param options.fields - Array of fields that will be included in the returned data * @returns TeamDetailsStable[] - Array of Team Details */ getTeams(options?: { fields?: T[]; }): Promise[]>; /** * A List of filters * @param query.filter_type - The type of filter to show * @param query.contains - Only return filter containing this word * @param options.token - The sending users API key; User must be a moderator * @param options.fields - Array of fields that will be included in the returned data * @returns FilterDetails[] - Array of Filter Details */ getFilters(query?: { filter_type?: string; contains?: string; }, options?: { token?: string; fields?: T[]; }): Promise[]>; /** * Gets Details for a specific filter * @param filter_id - The filter to show * @param options.token - The sending users API key; User must be a moderator * @param options.fields - Array of fields that will be included in the returned data * @returns FilterDetails - Filter Details */ getFilter(filter_id?: string, options?: { token?: string; fields?: T[]; }): Promise>; /** * Gets Details about an existing Shared Key for this user * @param sharedkey_id - The shared key to show * @param options.token - The sending users API key; User must be a moderator * @param options.fields - Array of fields that will be included in the returned data * @returns FilterDetails - Filter Details */ getSharedKey(sharedkey_id?: string, options?: { token?: string; fields?: T[]; }): Promise>; /** * Transfer Kudos to a registered user * @param check_data - The prompt to check * @param options.token - The sending users API key; User must be a moderator * @param options.fields - Array of fields that will be included in the returned data * @returns FilterPromptSuspicion */ postFilters(check_data: FilterCheckPayload, options?: { token?: string; fields?: T[]; }): Promise>; /** * Initiate an Asynchronous request to generate images * This method will immediately return with the UUID of the request for generation. * This method will always be accepted, even if there are no workers available currently to fulfill this request. * Perhaps some will appear in the next 10 minutes. * Asynchronous requests live for 10 minutes before being considered stale and being deleted. * @param generation_data - The data to generate the image * @param options.token - The token of the requesting user * @param options.fields - Array of fields that will be included in the returned data * @returns RequestAsync - The id and message for the async generation request */ postAsyncImageGenerate(generation_data: ImageGenerationInput, options?: { token?: string; fields?: T[]; }): Promise>; /** * Initiate an Asynchronous request to generate text * This endpoint will immediately return with the UUID of the request for generation. * This endpoint will always be accepted, even if there are no workers available currently to fulfill this request. * Perhaps some will appear in the next 20 minutes. * Asynchronous requests live for 20 minutes before being considered stale and being deleted. * @param generation_data - The data to generate the text * @param options.token - The token of the requesting user * @param options.fields - Array of fields that will be included in the returned data * @returns RequestAsync - The id and message for the async generation request */ postAsyncTextGenerate(generation_data: GenerationInputKobold, options?: { token?: string; fields?: T[]; }): Promise>; /** * Submit aesthetic ratings for generated images to be used by LAION * The request has to have been sent as shared: true. * You can select the best image in the set, and/or provide a rating for each or some images in the set. * If you select best-of image, you will gain 4 kudos. Each rating is 5 kudos. Best-of will be ignored when ratings conflict with it. * You can never gain more kudos than you spent for this generation. Your reward at max will be your kudos consumption - 1. * @param generation_id - The ID of the generation to rate * @param rating - The data to rating data * @param options.token - The token of the requesting user * @param options.fields - Array of fields that will be included in the returned data * @returns GenerationSubmitted - The kudos awarded for the rating */ postRating(generation_id: string, rating: AestheticsPayload, options?: { token?: string; fields?: T[]; }): Promise>; /** * Check if there are generation requests queued for fulfillment * This endpoint is used by registered workers only * @param pop_input * @param options.token - The token of the registered user * @param options.fields - Array of fields that will be included in the returned data * @returns GenerationPayloadStable */ postImageGenerationPop(pop_input: PopInputStable, options?: { token?: string; fields?: T[]; }): Promise>; /** * Check if there are generation requests queued for fulfillment * This endpoint is used by registered workers only * @param pop_input * @param options.token - The token of the registered user * @param options.fields - Array of fields that will be included in the returned data * @returns GenerationPayloadKobold */ postTextGenerationPop(pop_input: PopInputKobold, options?: { token?: string; fields?: T[]; }): Promise>; /** * Submit a generated image * This endpoint is used by registered workers only * @param generation_submit * @param options.token - The workers owner API key * @param options.fields - Array of fields that will be included in the returned data * @returns GenerationSubmitted */ postImageGenerationSubmit(generation_submit: { id: string; generation: string; seed: string; }, options?: { token?: string; fields?: T[]; }): Promise>; /** * Submit generated text * This endpoint is used by registered workers only * @param generation_submit * @param options.token - The workers owner API key * @param options.fields - Array of fields that will be included in the returned data * @returns GenerationSubmitted */ postTextGenerationSubmit(generation_submit: { id: string; generation: string; state: "ok" | "censored" | "faulted"; }, options?: { token?: string; fields?: T[]; }): Promise>; /** * Initiate an Asynchronous request to interrogate an image. * This endpoint will immediately return with the UUID of the request for interrogation. * This endpoint will always be accepted, even if there are no workers available currently to fulfill this request. * Perhaps some will appear in the next 20 minutes. * Asynchronous requests live for 20 minutes before being considered stale and being deleted. * @param interrogate_payload * @param options.token - The sending users API key * @param options.fields - Array of fields that will be included in the returned data * @returns RequestInterrogationResponse */ postAsyncInterrogate(interrogate_payload: ModelInterrogationInputStable, options?: { token?: string; fields?: T[]; }): Promise>; /** * Check if there are interrogation requests queued for fulfillment * This endpoint is used by registered workers only * @param pop_input * @param options.token - The token of the registered user * @param options.fields - Array of fields that will be included in the returned data * @returns InterrogationPopPayload */ postInterrogationPop(pop_input: InterrogationPopInput, options?: { token?: string; fields?: T[]; }): Promise>; /** * Submit the results of an interrogated image * This endpoint is used by registered workers only * @param generation_submit * @param options.token - The workers owner API key * @param options.fields - Array of fields that will be included in the returned data * @returns GenerationSubmitted */ postInterrogationSubmit(interrogation_submit: { id: string; result: string; }, options?: { token?: string; fields?: T[]; }): Promise>; /** * Transfer Kudos to a registered user * @param transfer_data - The data specifiying who to send how many kudos * @param options.token - The sending users API key * @param options.fields - Array of fields that will be included in the returned data * @returns KudosTransferred */ postKudosTransfer(transfer_data: { username: string; amount: number; }, options?: { token?: string; fields?: T[]; }): Promise>; /** * Receive kudos from the KoboldAI Horde * @param user_id - The stable horde user id of the receiving user * @param transfer_data - The data specifiying who to send how many kudos * @param options.token - The sending users API key * @param options.fields - Array of fields that will be included in the returned data * @returns null */ postKoboldTransfer(user_id: string, transfer_data: { kai_id: string; kudos_amount: number; trusted: boolean; }, options?: { token?: string; }): Promise; /** * Create a new team * Only trusted users can create new teams. * @param create_payload - The data to create the team with * @param options.token - The API key of a trusted user * @param options.fields - Array of fields that will be included in the returned data * @returns ModifyTeam */ createTeam(create_payload: CreateTeamInput, options?: { token?: string; fields?: T[]; }): Promise>; /** PUT */ /** * Change Horde Modes * @param modes - The new status of the Horde * @param options.token - Requires Admin API key * @param options.fields - Array of fields that will be included in the returned data * @returns HordeModes */ putStatusModes(modes: { maintenance: boolean; shutdown: number; invite_only: boolean; raid: boolean; }, options?: { token?: string; fields?: T[]; }): Promise>; /** * Method for horde admins to perform operations on users * @param update_payload - The data to change on the target user * @param id - The targeted users ID * @param options.token - Requires Admin API key * @param options.fields - Array of fields that will be included in the returned data * @returns ModifyUser */ updateUser(update_payload: ModifyUserInput, id: number, options?: { token?: string; fields?: T[]; }): Promise>; /** * Put the worker into maintenance or pause mode * Maintenance can be set by the owner of the serve or an admin. * When in maintenance, the worker will receive a 503 request when trying to retrieve new requests. Use this to avoid disconnecting your worker in the middle of a generation * Paused can be set only by the admins of this Horde. * When in paused mode, the worker will not be given any requests to generate. * @param update_payload - The data to change on the target worker * @param id - The targeted workers ID * @param options.token - The worker owners API key or Admin API key * @param options.fields - Array of fields that will be included in the returned data * @returns ModifyWorker */ updateWorker(update_payload: ModifyWorkerInput, id: string, options?: { token?: string; fields?: T[]; }): Promise; /** * Adds a new regex filer * @param create_payload - The data to create the filter with * @param options.token - The Moderator API key * @param options.fields - Array of fields that will be included in the returned data * @returns FilterDetails */ addFilter(create_payload: PutNewFilter, id: string, options?: { token?: string; fields?: T[]; }): Promise>; /** * Create a new SharedKey for this user * @param create_payload - The data to create the shared key with * @param options.token - The User API key * @param options.fields - Array of fields that will be included in the returned data * @returns SharedKeyInput */ putSharedKey(create_payload: SharedKeyInput, options?: { token?: string; fields?: T[]; }): Promise>; /** PATCH */ /** * Updates a Team's information * @param update_payload - The data to update the team with * @param options.token - The Moderator or Creator API key * @param options.fields - Array of fields that will be included in the returned data * @returns ModifyTeam */ updateTeam(update_payload: ModifyTeamInput, id: string, options?: { token?: string; fields?: T[]; }): Promise>; /** * Updates an existing regex filer * @param update_payload - The data to update the filter with * @param id - The ID of the filter * @param options.token - The Moderator API key * @param options.fields - Array of fields that will be included in the returned data * @returns FilterDetails */ updateFilter(update_payload: PatchExistingFilter, id: string, options?: { token?: string; fields?: T[]; }): Promise>; /** * Modify an existing Shared Key * @param update_payload - The data to update the shared key with * @param id - The ID of the shared key * @param options.token - The User API key * @param options.fields - Array of fields that will be included in the returned data * @returns SharedKeyDetails */ updateSharedKey(update_payload: SharedKeyInput, id: string, options?: { token?: string; fields?: T[]; }): Promise>; /** DELETE */ /** * Cancel an unfinished request * This request will include all already generated images in base64 encoded .webp files. * @param id - The targeted generations ID * @param options.fields - Array of fields that will be included in the returned data * @returns RequestStatusStable */ deleteImageGenerationRequest(id: string, options?: { fields?: T[]; }): Promise>; /** * Cancel an unfinished request * This request will include all already generated images in base64 encoded .webp files. * @param id - The targeted generations ID * @param options.fields - Array of fields that will be included in the returned data * @returns RequestStatusKobold */ deleteTextGenerationRequest(id: string, options?: { fields?: T[]; }): Promise>; /** * Cancel an unfinished interrogation request * This request will return all already interrogated image results. * @param id - The targeted generations ID * @param options.fields - Array of fields that will be included in the returned data * @returns InterrogationStatus */ deleteInterrogationRequest(id: string, options?: { fields?: T[]; }): Promise>; /** * Delete the worker entry * This will delete the worker and their statistics. Will not affect the kudos generated by that worker for their owner. * Only the worker's owner and an admin can use this endpoint. * This action is unrecoverable! * @param id - The targeted workers ID * @param options.token - The worker owners API key or a Moderators API key * @param options.fields - Array of fields that will be included in the returned data * @returns DeletedWorker */ deleteWorker(id: string, options?: { token?: string; fields?: T[]; }): Promise>; /** * Delete an existing SharedKey for this user * @param id - The targeted Shared Key's ID * @param options.token - The worker owners API key or a Moderators API key * @param options.fields - Array of fields that will be included in the returned data * @returns SimpleResponse */ deleteSharedKey(id: string, options?: { token?: string; fields?: T[]; }): Promise>; /** * Delete the team entry * Only the team's creator or a horde moderator can use this endpoint. * This action is unrecoverable! * @param id - The targeted teams ID * @param options.token - The worker owners API key or a Moderators API key * @param options.fields - Array of fields that will be included in the returned data * @returns DeletedTeam */ deleteTeam(id: string, options?: { token?: string; fields?: T[]; }): Promise>; /** * Remove an IP from timeout * Only usable by horde moderators * @param ip - The IP address * @param options.token - Moderators API key * @param options.fields - Array of fields that will be included in the returned data * @returns SimpleResponse */ deleteIPTimeout(delete_payload: DeleteTimeoutIPInput, options?: { token?: string; fields?: T[]; }): Promise>; /** * Delete a regex filter * @param filter_id - The ID of the filter to delete * @param options.token - The sending users API key; User must be a moderator * @param options.fields - Array of fields that will be included in the returned data * @returns SimpleResponse */ deleteFilter(filter_id: string, options?: { token?: string; fields?: T[]; }): Promise>; } export interface AIHordeInitOptions { /** The configuration for caching results */ cache?: AIHordeCacheConfiguration; /** * The interval to check expired data in the cache * @default 1000 */ cache_interval?: number; /** The default token to use for requests */ default_token?: string; /** The base api domain + route to use for requests */ api_route?: string; /** The ratings api domain + route to use for requests */ ratings_api_route?: string; /** The client agent to pass in the requests. */ client_agent?: string; } export interface AIHordeCacheConfiguration { /** How long to cache a specific user for in Milliseconds */ users?: number; /** How long to cache generation check data for in Milliseconds */ generations_check?: number; /** How long to cache generation status data for in Milliseconds */ generations_status?: number; /** How long to cache interrogation status data for in Milliseconds */ interrogations_status?: number; /** How long to cache models for in Milliseconds */ models?: number; /** How long to cache modes for in Milliseconds */ modes?: number; /** How long to cache news for in Milliseconds */ news?: number; /** How long to cache performance for in Milliseconds */ performance?: number; /** How long to cache workers for in Milliseconds */ workers?: number; /** How long to cache teams for in Milliseconds */ teams?: number; /** How long to cache sharedkeys for in Milliseconds */ sharedkeys?: number; } interface AIHordeCache { users?: SuperMap; generations_check?: SuperMap; generations_status?: SuperMap; interrogations_status?: SuperMap; models?: SuperMap; modes?: SuperMap; news?: SuperMap; performance?: SuperMap; workers?: SuperMap; teams?: SuperMap; sharedkeys?: SuperMap; } export interface ModifyUserInput { /** The amount of kudos to modify (can be negative) */ kudos?: number; /** * The amount of concurrent request this user can have * @minimum 0 * @maximum 100 */ concurrency?: number; /** * The amount by which to multiply the users kudos consumption * @minimum 0.1 * @maximum 10 */ usage_multiplier?: number; /** Set to the amount of workers this user is allowed to join to the horde when in worker invite-only mode. */ worker_invited?: number; /** * Set to true to Make this user a horde moderator * @example false */ moderator?: boolean; /** * Set to true to Make this user a display their worker IDs * @example false */ public_workers?: boolean; /** * When specified, will start assigning the user monthly kudos, starting now! * @minimum 0 */ monthly_kudos?: number; /** * When specified, will change the username. No profanity allowed! * @minLength 3 * @maxLength 100 */ username?: string; /** * When set to true,the user and their servers will not be affected by suspicion * @example false */ trusted?: boolean; /** Set the user's suspicion back to 0 */ reset_suspicion?: boolean; /** * Contact details for the horde admins to reach the user in case of emergency. This is only visible to horde moderators. * @example email@example.com * @minLength 5 * @maxLength 500 */ contact?: string; } export interface ModifyWorkerInput { /** (Mods only) Set to true to put this worker into maintenance. */ maintenance?: boolean; /** (Mods only) Set to true to pause this worker. */ paused?: boolean; /** * You can optionally provide a server note which will be seen in the server details. No profanity allowed! * @minLength 5 * @maxLength 1000 */ info?: string; /** * When this is set, it will change the worker's name. No profanity allowed! * @minLength 5 * @maxLength 100 */ name?: string; /** * The team towards which this worker contributes kudos. No profanity allowed! * @example 0bed257b-e57c-4327-ac64-40cdfb1ac5e6 * @minLength 3 * @maxLength 100 */ team?: string; } /** * @link https://aihorde.net/api/ */ export interface GenerationInputKobold { /** The prompt which will be sent to KoboldAI to generate text */ prompt?: string; params?: ModelGenerationInputKobold; /** * Specify which softpompt needs to be used to service this request * @minLength 1 */ softprompt?: string; /** * When true, only trusted workers will serve this request. When False, Evaluating workers will also be used which can increase speed but adds more risk! * @default true */ trusted_workers?: boolean; /** Specify which workers are allowed to service this request */ workers?: string[]; /** Specify which models are allowed to be used for this request */ models?: string[]; } export interface ModelGenerationInputKobold { /** * @example 1 * @minimum 1 * @maximum 20 */ n?: number; /** * 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. * @example false */ frmtadsnsp?: boolean; /** * Output formatting option. When enabled, replaces all occurrences of two or more consecutive newlines in the output with one newline. * @example false */ frmtrmblln?: boolean; /** * Output formatting option. When enabled, removes #/@%}{+=~|^<> from the output. * @example false */ frmtrmspch?: boolean; /** * 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. * @example false */ frmttriminc?: boolean; /** * Maximum number of tokens to send to the model. * @example 1024 * @minimum 80 * @maximum 2048 */ max_context_length?: number; /** * Number of tokens to generate. * @minimum 16 * @maximum 512 */ max_length?: number; /** * Base repetition penalty value. * @maximum 1 */ rep_pen?: number; /** Repetition penalty range. */ rep_pen_range?: number; /** Repetition penalty slope. */ rep_pen_slope?: number; /** * Output formatting option. When enabled, removes everything after the first line of the output, including the newline. * @example false */ singleline?: boolean; /** Soft prompt to use when generating. If set to the empty string or any other string containing no non-whitespace characters, uses no soft prompt. */ soft_prompt?: string; /** * Temperature value. * @minimum 0 */ temperature?: number; /** Tail free sampling value. */ tfs?: number; /** Top-a sampling value. */ top_a?: number; /** Top-k sampling value. */ top_k?: number; /** Top-p sampling value. */ top_p?: number; /** Typical sampling value. */ typical?: number; /** Array of integers representing the sampler order to be used */ sample_order?: number[]; } export interface ModelPayloadKobold extends ModelGenerationInputKobold { prompt?: string; } export interface ImageGenerationInput { /** The prompt which will be sent to Stable Diffusion to generate an image */ prompt: string; /** The parameters for the generation */ params?: ModelGenerationInputStable; /** * Set to true if this request is NSFW. This will skip workers which censor images. * @default false */ nsfw?: boolean; /** * When true, only trusted workers will serve this request. When False, Evaluating workers will also be used which can increase speed but adds more risk! * @default true */ trusted_workers?: boolean; /** * When true, only inference backends that are validated by the AI Horde devs will serve this request. When False, non-validated backends will also be used which can increase speed but you may end up with unexpected results. * @default true */ validated_backends?: boolean; /** * When True, allows slower workers to pick up this request. Disabling this incurs an extra kudos cost. * @default true */ slow_workers?: boolean; /** * When True, allows very slower workers to pick up this request. Use this when you don't mind waiting a lot. * @default false */ extra_slow_workers?: boolean; /** * If the request is SFW, and the worker accidentaly generates NSFW, it will send back a censored image. * @default false */ censor_nsfw?: boolean; /** Specify which workers are allowed to service this request */ workers?: string[]; /** If true, the worker list will be treated as a blacklist instead of a whitelist. */ worker_blacklist?: boolean; /** Specify which models are allowed to be used for this request */ models?: string[]; /** The Base64-encoded webp to use for img2img, max siue 3072 * 3072 */ source_image?: string; /** If source_image is provided, specifies how to process it. */ source_processing?: typeof SourceImageProcessingTypes[keyof typeof SourceImageProcessingTypes]; /** If source_processing is set to 'inpainting' or 'outpainting', this parameter can be optionally provided as the Base64-encoded webp mask of the areas to inpaint. If this arg is not passed, the inpainting/outpainting mask has to be embedded as alpha channel */ source_mask?: string; extra_source_images?: ExtraSourceImage[]; /** If True, the image will be sent via cloudflare r2 download link */ r2?: boolean; /** If True, The image will be shared with LAION for improving their dataset. This will also reduce your kudos consumption by 2. For anonymous users, this is always True. */ shared?: boolean; /** * If enabled, suspicious prompts are sanitized through a string replacement filter instead. * @default true */ replacement_filter?: boolean; /** * When false, the endpoint will simply return the cost of the request in kudos and exit. * @default false */ dry_run?: boolean; /** If using a service account as a proxy, provide this value to identify the actual account from which this request is coming from. */ proxied_account?: string; /** * When true, this request will not use batching. This will allow you to retrieve accurate seeds. Feature is restricted to trusted users and patreons * @default false */ disable_batching?: boolean; /** * When true and the request requires upfront kudos and the account does not have enough The request will be downgraded in steps and resolution so that it does not need upfront kudos. * @default false */ allow_downgrade?: boolean; /** * 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. * @example https://haidra.net/00000000-0000-0000-0000-000000000000 * @minLength 10 * @maxLength 1024 */ webhook?: string; } export interface ExtraSourceImage { /** * The Base64-encoded webp to use for further processing * @minLength 1 */ image: string; /** * Optional field, determining the strength to use for the processing * @default 1 */ strength?: number; } export interface ModelGenerationInputStable { /** * @default k_euler */ sampler_name?: typeof ModelGenerationInputStableSamplers[keyof typeof ModelGenerationInputStableSamplers]; /** * its how much the AI listens to your prompt, essentially. * @default 7.5 * @minimum 0 * @maximum 100 * * Multiple of 0.5 */ cfg_scale?: number; /** * The strength of denoising * @minimum 0.01 * @maximum 1 * * Multiple of 0.01 */ denoising_strength?: number; /** * @example 0.75 * @minimum 0 * @maximum 1 */ hires_fix_denoising_strength?: number; /** The seed to use to generete this request. */ seed?: string; /** * The height of the image to generate * @default 512 * @minimum 64 * @maximum 3072 * * Multiple of 64 */ height?: number; /** * The width of the image to generate * @default 512 * @minimum 64 * @maximum 3072 * * Multiple of 64 */ width?: number; /** * If passed with multiple n, the provided seed will be incremented every time by this value * @minimum 1 * @maximum 1000 */ seed_variation?: number; /** Set to True to enable karras noise scheduling tweaks */ karras?: boolean; /** The list of post-processors to apply to the image, in the order to be applied */ post_processing?: (typeof ModelGenerationInputPostProcessingTypes[keyof typeof ModelGenerationInputPostProcessingTypes])[]; /** * Set to True to create images that stitch together seamlessly * @default false */ tiling?: boolean; /** * Set to True to process the image at base resolution before upscaling and re-processing * @default false */ hires_fix?: boolean; /** * The number of CLIP language processor layers to skip * @minimum 1 * @maximum 12 */ clip_skip?: number; control_type?: (typeof ModelGenerationInputControlTypes[keyof typeof ModelGenerationInputControlTypes]); /** * Set to True if the image submitted is a pre-generated control map for ControlNet use * @default false */ image_is_control?: boolean; /** * Set to True if you want the ControlNet map returned instead of a generated image * @default false */ return_control_map?: boolean; /** * @example 0.75 * @minimum 0 * @maximum 1 */ facefixer_strength?: number; loras?: ModelPayloadLorasStable[]; tis?: ModelPayloadTextualInversionsStable[]; special?: Record; extra_texts?: ExtraText[]; /** * Explicitly specify the horde-engine workflow to use * @example qr_code */ workflow?: (typeof ModelGenerationInputWorkflows[keyof typeof ModelGenerationInputWorkflows]); /** * Set to True to generate the image using Layer Diffuse, creating an image with a transparent background. * @default false */ transparent?: boolean; /** * @default 30 * @minimum 1 * @maximum 500 */ steps?: number; /** * The amount of images to generate * @minimum 1 * @maximum 20 */ n?: number; } export interface ExtraText { /** * The extra text to send along with this generation * @minLength 1 */ text: string; /** * The reference which points how and where this text should be used * @minLength 1 */ reference: string; } export interface ModelPayloadLorasStable { /** * The exact name of the LoRa * @example GlowingRunesAIV6 * @minLength 1 * @maxLength 255 */ name: string; /** * The strength of the LoRa to apply to the SD model. * @default 1 * @minimum 0 * @maximum 5 */ model?: number; /** * The strength of the LoRa to apply to the clip model. * @default 1 * @minimum 0 * @maximum 5 */ clip?: number; /** * If set, will try to discover a trigger for this LoRa which matches or is similar to this string and inject it into the prompt. I 'any' is specified it will be pick the first trigger. * @minLength 1 * @maxLength 30 */ inject_trigger?: string; /** * If true, will consider the LoRa ID as a CivitAI version ID and search accordingly. Ensure the name is an integer * @default false */ is_version?: boolean; } export interface ModelPayloadTextualInversionsStable { /** * The exact name or CivitAI ID of the Textual Inversion. * @example 7808 * @minLength 1 * @maxLength 255 */ name: string; /** * if set, will automatically add this TI filename to the prompt or negative prompt accordingly using the provided strength. If this is set to None, then the user will have to manually add the embed to the prompt themselves. */ inject_ti?: (typeof ModelPayloadTextInversionsStable[keyof typeof ModelPayloadTextInversionsStable]); /** * The strength with which to apply the TI to the prompt. Only used when inject_ti is not None * @default 1 * @minimum -5 * @maximum 5 */ strength?: number; } export interface ModelPayloadRootStable { /** * @default k_euler */ sampler_name?: typeof ModelGenerationInputStableSamplers[keyof typeof ModelGenerationInputStableSamplers]; /** * Special Toggles used in the SD Webui. To be documented. */ toggles?: number[]; /** * its how much the AI listens to your prompt, essentially. * @default 5 * @minimum -40 * @maximum 30 * * Multiple of 0.5 */ cfg_scale?: number; /** * The strength of denoising * @minimum 0 * @maximum 1 * * Multiple of 0.01 */ denoising_strength?: number; /** The seed to use to generete this request. */ seed?: string; /** * The height of the image to generate * @default 512 * @minimum 64 * @maximum 1024 * * Multiple of 64 */ height?: number; /** * The width of the image to generate * @default 512 * @minimum 64 * @maximum 1024 * * Multiple of 64 */ width?: number; /** * If passed with multiple n, the provided seed will be incremented every time by this value * @minimum 1 * @maximum 1000 */ seed_variation?: number; /** Set to True to enable karras noise scheduling tweaks */ karras?: boolean; /** Set to true to process the generated image with GFPGAN (face correction) */ use_gfpgan?: boolean; /** Set to true to process the generated image with RealESRGAN */ use_real_esrgan?: boolean; /** Set to true to process the generated image with LDSR */ use_ldsr?: boolean; /** Set to true to upscale the image */ use_upscaling?: boolean; } export interface ValidationError extends RequestError { errors: Record; } export interface RequestError { /** The error message for this status code. */ message: string; /** The Error code that can be translated into a text */ rc: string; } export interface RequestStatusStable extends RequestStatusCheck { generations?: GenerationStable[]; /** If True, These images have been shared with LAION */ shared?: boolean; } export interface RequestStatusKobold extends RequestStatusCheck { generations?: GenerationKobold[]; } export interface RequestStatusCheck { /** The amount of finished images in this request */ finished?: number; /** The amount of still processing images in this request */ processing?: number; /** The amount of jobs that timed out and had to be restarted or were reported as failed by a worker. */ restarted?: number; /** The amount of images waiting to be picked up by a worker */ waiting?: number; /** True when all images in this request are done. Else False. */ done?: boolean; /** rue when this request caused an internal server error and cannot be completed. */ faulted?: boolean; /** The expected amount to wait (in seconds) to generate all images in this request */ wait_time?: number; /** The position in the requests queue. This position is determined by relative Kudos amounts. */ queue_position?: number; /** The amount of total Kudos this request has consumed until now. */ kudos?: number; /** If False, this request will not be able to be completed with the pool of workers currently available */ is_possible?: boolean; } export interface Generation { /** The UUID of the worker which generated this image */ worker_id?: string; /** The name of the worker which generated this image */ worker_name?: string; /** The model which generated this image */ model?: string; } export interface GenerationStable extends Generation { /** The generated image as a Base64-encoded .webp file OR a cloudflare r2 download link */ img?: string; /** The seed which generated this image */ seed?: string; /** The ID for this image */ id?: string; /** When true this image has been censored by the worker's safety filter. */ censored?: boolean; gen_metadata?: { type: string; value: string; ref: string; }[]; } export interface GenerationMetadataStable { /** * The relevance of the metadata field * @example Lora */ type: typeof GenerationMetadataStableTypes[keyof typeof GenerationMetadataStableTypes]; /** * The value of the metadata field * @example download_failed */ value: typeof GenerationMetadataStableValues[keyof typeof GenerationMetadataStableValues]; /** * Optionally a reference for the metadata (e.g. a lora ID) * @maxLength 255 */ ref?: string; } export interface GenerationKobold extends Generation { /** * The state of the generation, * @default ok * @example ok */ state: "ok" | "censored"; /** The generated text */ text?: string; /** The seed which generated this text */ seed: number; } export interface RequestAsync { /** The UUID of the request. Use this to retrieve the request status in the future */ id?: string; /** The expected kudos consumption for this request */ kudos?: number; /** Any extra information from the horde about this request */ message?: string; warnings?: RequestSingleWarning[]; } export interface RequestSingleWarning { /** * A unique identifier for this warning. * @example NoAvailableWorker */ code?: typeof RequestSingleWarningCodes[keyof typeof RequestSingleWarningCodes]; /** * Something that you should be aware about this request, in plain text. * @minLength 1 */ message?: string; } export interface PopInputStable extends PopInput { /** * The maximum amount of pixels this worker can generate * @default 262144 */ max_pixels?: number; /** Words which, when detected will refuse to pick up any jobs */ blacklist?: string[]; } export interface PopInputKobold extends PopInput { /** * The maximum amount of pixels this worker can generate * @default 262144 */ max_pixels?: number; /** Words which, when detected will refuse to pick up any jobs */ blacklist?: string[]; } export interface PopInput { /** The Name of the Worker */ name?: string; /** Users with priority to use this worker */ priority_usernames?: string[]; /** * Whether this worker can generate NSFW requests or not. * @default false */ nsfw?: boolean; /** Which models this worker is serving */ models?: string[]; /** * The version of the bridge used by this worker * @default 1 */ bridge_version: number; /** * The worker name, version and website * @default unknown:0:unknown * @example AI Horde Worker:11:https://github.com/db0/AI-Horde-Worker * @maxLength 1000 */ bridge_agent?: string; /** * How many threads this worker is running. This is used to accurately the current power available in the horde * @default 1 * @minimum 1 * @maximum 10 */ threads?: number; /** * If True, this worker will only pick up requests where the owner has the required kudos to consume already available * @default false * @example false */ require_upfront_kudos?: boolean; } export interface GenerationPayloadStable { payload?: ModelPayloadStable; /** The UUID for this image generation */ id?: string; skipped?: NoValidRequestFoundStable; /** Which of the available models to use for this request */ model?: string; /** The Base64-encoded webp to use for img2img */ source_image?: string; } export interface GenerationPayloadKobold { payload?: ModelPayloadKobold; /** The UUID for this text */ id?: string; skipped?: NoValidRequestFoundKobold; /** The soft prompt requested for this generation */ softprompt?: string; /** Which of the available models to use for this request */ model?: string; } export interface ModelPayloadStable { /** * @default k_euler */ sampler_name?: typeof ModelGenerationInputStableSamplers[keyof typeof ModelGenerationInputStableSamplers]; /** * Special Toggles used in the SD Webui. To be documented. */ toggles?: number[]; /** * its how much the AI listens to your prompt, essentially. * @default 5 * @minimum -40 * @maximum 30 * * Multiple of 0.5 */ cfg_scale?: number; /** * The strength of denoising * @minimum 0 * @maximum 1 * * Multiple of 0.01 */ denoising_strength?: number; /** The seed to use to generete this request. */ seed?: string; /** * The height of the image to generate * @default 512 * @minimum 64 * @maximum 3072 * * Multiple of 64 */ height?: number; /** * The width of the image to generate * @default 512 * @minimum 64 * @maximum 3072 * * Multiple of 64 */ width?: number; /** * If passed with multiple n, the provided seed will be incremented every time by this value * @minimum 1 * @maximum 1000 */ seed_variation?: number; /** Set to True to enable karras noise scheduling tweaks */ karras?: boolean; /** The list of post-processors to apply to the image, in the order to be applied */ post_processing?: (typeof ModelGenerationInputPostProcessingTypes[keyof typeof ModelGenerationInputPostProcessingTypes])[]; /** * Set to True to create images that stitch together seamlessly * @default false */ tiling?: boolean; /** * Set to True to process the image at base resolution before upscaling and re-processing * @default false */ hires_fix?: boolean; /** * The number of CLIP language processor layers to skip * @minimum 1 * @maximum 12 */ clip_skip?: number; control_type?: (typeof ModelGenerationInputControlTypes[keyof typeof ModelGenerationInputControlTypes]); /** The prompt which will be sent to Stable Diffusion to generate an image */ prompt?: string; /** * @default 30 */ ddim_steps?: number; /** * The amount of images to generate * @default 1 */ n_iter?: number; /** When true will apply NSFW censoring model on the generation */ use_nsfw_censor?: boolean; } export interface NoValidRequestFoundKobold extends NoValidRequestFound { /** How many waiting requests were skipped because they demanded a higher max_context_length than what this worker provides. */ max_context_length?: number; /** How many waiting requests were skipped because they demanded more generated tokens that what this worker can provide. */ max_length?: number; /** How many waiting requests were skipped because they demanded an available soft-prompt which this worker does not have. */ matching_softprompt?: number; } export interface NoValidRequestFoundStable extends NoValidRequestFound { /** How many waiting requests were skipped because they demanded a higher size than this worker provides */ max_pixels?: number; } export interface NoValidRequestFound { /** How many waiting requests were skipped because they demanded a specific worker */ worker_id?: number; /** How many waiting requests were skipped because they required higher performance */ performance?: number; /** How many waiting requests were skipped because they demanded a nsfw generation which this worker does not provide */ nsfw?: number; /** How many waiting requests were skipped because they demanded a generation with a word that this worker does not accept */ blacklist?: number; /** How many waiting requests were skipped because they demanded a trusted worker which this worker is not */ untrusted?: number; /** How many waiting requests were skipped because they demanded a different model than what this worker provides */ models?: number; /** How many waiting requests were skipped because they require a higher version of the bridge than this worker is running (upgrade if you see this in your skipped list) */ bridge_version?: number; } export interface GenerationSubmitted { /** The amount of kudos gained for submitting this request */ reward?: number; } export interface UserThingUsageRecords { /** * How many megapixelsteps this user has generated or requested * @default 0 */ megapixelsteps?: number; /** * How many tokens this user has generated or requested * @default 0 */ tokens?: number; } export interface UserThingFulfillmentRecords { /** * How many images were generated or requested * @default 0 */ image?: number; /** * How many images were interrogated generated or requested * @default 0 */ interrogation?: number; /** * How many texts were generated or requested * @default 0 */ text?: number; } export interface UserRecords { usage?: UserThingUsageRecords; contribution?: UserThingUsageRecords; fulfillment?: UserThingFulfillmentRecords; request?: UserThingFulfillmentRecords; } export interface UserDetails { /** The user's unique Username. It is a combination of their chosen alias plus their ID. */ username?: string; /** The user unique ID. It is always an integer. */ id?: number; /** The amount of Kudos this user has. The amount of Kudos determines the priority when requesting image generations. */ kudos?: number; /** (Privileged) The amount of Evaluating Kudos this untrusted user has from generations and uptime. When this number reaches 50000, they automatically become trusted. */ evaluating_kudos?: number; /** How many concurrent generations this user may request. */ concurrency?: number; /** Whether this user has been invited to join a worker to the horde and how many of them. When 0, this user cannot add (new) workers to the horde. */ worker_invited?: number; /** This user is a Horde moderator. */ moderator?: boolean; kudos_details?: UserKudosDetails; /** How many workers this user has created (active or inactive) */ worker_count?: number; worker_ids?: string[]; monthly_kudos?: MonthlyKudos; /** This user is a trusted member of the Horde. */ trusted?: boolean; /** This user has been flagged for suspicious activity. */ flagged?: boolean; /** (Privileged) How much suspicion this user has accumulated */ suspicious?: number; /** If true, this user has not registered using an oauth service. */ pseudonymous?: boolean; /** * (Privileged) Contact details for the horde admins to reach the user in case of emergency. * @example email@example.com */ contact?: string; /** * How many seconds since this account was created * @example 60 */ account_age?: number; /** * @deprecated */ usage?: UsageDetailsStable; /** * @deprecated */ contributions?: ContributionsDetailsStable; records?: UserRecords; } export interface UserKudosDetails { /** The ammount of Kudos accumulated or used for generating images. */ accumulated?: number; /** The amount of Kudos this user has given to other users. */ gifted?: number; /** The amount of Kudos this user has been given by the Horde admins. */ admin?: number; /** The amount of Kudos this user has been given by other users. */ received?: number; /** The amount of Kudos this user has received from recurring rewards. */ recurring?: number; /** The amount of Kudos this user has received from rating images. */ awarded?: number; } export interface MonthlyKudos { /** How much recurring Kudos this user receives monthly. */ amount?: number; /** * Last date this user received monthly Kudos. * @type string($date-time) */ last_received?: string; } export interface UsageDetailsStable extends UsageDetails { /** How many images this user has requested */ requests?: number; /** How many megapixelsteps this user has requested */ megapixelsteps?: number; } export interface UsageDetails { /** How many images this user has requested */ requests?: number; } export interface ContributionsDetailsStable extends ContributionsDetails { /** How many images this user has generated */ fulfillments?: number; /** How many megapixelsteps this user has generated */ megapixelsteps?: number; } export interface ContributionsDetails { /** How many images this user has generated */ fulfillments?: number; } export interface ModifyUser { /** The new total Kudos this user has after this request */ new_kudos?: number; /** The request concurrency this user has after this request */ concurrency?: number; /** Multiplies the amount of kudos lost when generating images. */ usage_multiplier?: number; /** This userWhether this user has been invited to join a worker to the horde and how many of them. When 0, this user cannot add (new) workers to the horde. */ worker_invited?: number; /** The user's new moderator status. */ moderator?: boolean; /** The user's new public_workers status. */ public_workers?: number; /** The user's new username. */ username?: string; /** The user's new monthly kudos total */ monthly_kudos?: number; /** The user's new trusted status */ trusted?: boolean; } export interface WorkersPerformanceFilter { /** * Minimal value of performance for worker to have * @default 1.5 */ performance?: number; /** * Minimal filtered workers amount to resort to the list of first `minLength` workers sorted by `performance` value * @default 5 */ size?: number; /** * Worker should support img2img */ img2img?: boolean; /** * List of models workers should have (at least one) */ models?: string[]; } export interface WorkerDetailsStable extends WorkerDetails { /** The maximum pixels in resolution this workr can generate */ max_pixels?: number; /** How many megapixelsteps this worker has generated until now */ megapixelsteps_generated?: number; /** If True, this worker supports and allows img2img requests. */ img2img?: boolean; /** If True, this worker supports and allows inpainting requests. */ painting?: boolean; /** If True, this worker supports and allows post-processing requests. */ "post-processing"?: boolean; } export interface WorkerDetails extends WorkerDetailsLite { /** How many images this worker has generated. */ requests_fulfilled?: number; /** How many Kudos this worker has been rewarded in total. */ kudos_rewards?: number; kudos_details?: WorkerKudosDetails; /** The average performance of this worker in human readable form. */ performance?: string; /** How many threads this worker is running. */ threads?: number; /** The amount of seconds this worker has been online for this Horde. */ uptime?: number; /** When True, this worker will not pick up any new requests */ maintenance_mode?: boolean; /** (Privileged) When True, this worker not be given any new requests. */ paused?: boolean; /** Extra information or comments about this worker provided by its owner. */ info?: string; /** Whether this worker can generate NSFW requests or not. */ nsfw?: boolean; /** Privileged or public if the owner has allowed it. The alias of the owner of this worker. */ owner?: string; /** The worker is trusted to return valid generations. */ trusted?: boolean; /** (Privileged) How much suspicion this worker has accumulated */ suspicious?: number; /** * How many jobs this worker has left uncompleted after it started them. * @example 0 */ uncompleted_jobs?: number; /** Which models this worker if offerring */ models?: string[]; team?: TeamDetailsLite; /** * (Privileged) Contact details for the horde admins to reach the owner of this worker in emergencies. * @example email@example.com * @minLength 5 * @maxLength 500 */ contact?: string; /** * The bridge agent name, version and website * @default: unknown:0:unknown * @example: AI Horde Worker:11:https://github.com/db0/AI-Horde-Worker * @maxLength: 1000 */ bridge_agent?: string; } export interface WorkerDetailsLite { /** The Name given to this worker. */ name?: string; /** The UUID of this worker. */ id?: string; /** True if the worker has checked-in the past 5 minutes. */ online?: boolean; } export interface WorkerKudosDetails { /** How much Kudos this worker has received for generating images */ generated?: number; /** How much Kudos this worker has received for staying online longer */ uptime?: number; } export interface ModifyWorker { /** The new state of the 'maintenance' var for this worker. When True, this worker will not pick up any new requests. */ maintenance?: boolean; /** The new state of the 'paused' var for this worker. When True, this worker will not be given any new requests. */ paused?: boolean; /** The new state of the 'info' var for this worker. */ info?: string; /** The new name for this this worker. */ name?: string; } export interface DeletedWorker { /** The ID of the deleted worker */ deleted_id?: string; /** The Name of the deleted worker*/ deleted_name?: string; } export interface ActiveModel extends ActiveModelLite { /** The average speed of generation for this model */ performance?: number; /** The amount waiting to be generated by this model */ queued?: number; /** Estimated time in seconds for this model's queue to be cleared */ eta?: number; } export interface ActiveModelLite { /** The name of a model available by workers in this horde. */ name?: string; /** How many workers in this horde are running this model. */ count?: number; } export interface KudosTransferred { /** The amount of Kudos tranferred */ transferred?: number; } export interface HordeModes { /** When True, this Horde will not accept new requests for image generation, but will finish processing the ones currently in the queue. */ maintenance_mode?: boolean; /** When True, this Horde will not only accept worker explicitly invited to join. */ invite_only_mode?: boolean; /** When True, this Horde will not always provide full information in order to throw off attackers. */ raid_mode?: boolean; } export interface HordePerformanceStable extends HordePerformance { /** The amount of megapixelsteps in waiting and processing requests currently in this Horde */ queued_megapixelsteps?: number; /** How many megapixelsteps this Horde generated in the last minute */ past_minute_megapixelsteps?: number; /** The amount of image interrogations waiting and processing currently in this Horde */ queued_forms?: number; /** How many workers are actively processing image interrogations in this Horde in the past 5 minutes */ interrogator_count?: number; /** How many worker threads are actively processing image interrogation in this Horde in the past 5 minutes */ interrogator_thread_count?: number; } export interface HordePerformance { /** The amount of waiting and processing requests currently in this Horde */ queued_requests?: number; /** How many workers are actively processing image generations in this Horde in the past 5 minutes */ worker_count?: number; /** How many worker threads are actively processing prompt generations in this Horde in the past 5 minutes */ thread_count?: number; } export interface Newspiece { /** The date this newspiece was published */ date_published?: string; /** The actual piece of news */ newspiece?: string; /** How critical this piece of news is. */ importance?: string; } export interface CreateTeamInput { /** * The name of the team. No profanity allowed! * @minLength 3 * @maxLength 100 */ name: string; /** * Extra information or comments about this team. * @example Anarchy is emergent order. * @minLength 3 * @maxLength 1000 */ info?: string; } export interface ModifyTeam { /** The ID of the team */ id?: string; /** The Name of the team */ name?: string; /** The Info of the team */ info?: string; } export interface TeamDetailsStable extends TeamDetails { /** How many megapixelsteps the workers in this team have been rewarded while part of this team. */ contributions?: number; /** The average performance of the workers in this team, in megapixelsteps per second. */ performance?: number; /** The total expected speed of this team when all workers are working in parallel, in megapixelsteps per second. */ speed?: number; } export interface TeamDetails extends TeamDetailsLite { /** * Extra information or comments about this team provided by its owner * @example Anarchy is emergent order. */ info?: string; /** How many images this team's workers have generated */ requests_fulfilled?: number; /** How many Kudos the workers in this team have been rewarded while part of this team. */ kudos?: number; /** The total amount of time workers have stayed online while on this team */ uptime?: number; /** * How many workers have been dedicated to this team * @example 10 */ worker_count?: number; workers?: WorkerDetailsLite[]; models?: ActiveModelLite[]; } export interface TeamDetailsLite { /** The Name given to this team. */ name?: string; /** The UUID of this team */ id?: string; } export interface ModifyTeamInput { /** * The name of the team. No profanity allowed! * @minLength 3 * @maxLength 100 */ name?: string; /** * Extra information or comments about this team. * @example Anarchy is emergent order. * @minLength 3 * @maxLength 1000 */ info?: string; } export interface DeletedTeam { /** The ID of the deleted team */ deleted_id?: string; /** The Name of the deleted team */ deleted_name?: string; } export interface DeleteTimeoutIPInput { /** * The IP address to remove from timeout * @example 127.0.0.1 * @minLength 7 * @maxLength 15 */ ipaddr: string; } export interface SimpleResponse { /** * The result of this operation * @default OK */ message: string; } export type InterrogationPopFormPayloadStable = Partial>; export type InterrogationFormResult = Partial>>; export interface ModelInterrogationFormStable { /** * The type of interrogation this is */ name: typeof ModelInterrogationFormTypes[keyof typeof ModelInterrogationFormTypes]; payload?: InterrogationPopFormPayload; } export interface ModelInterrogationInputStable { forms: ModelInterrogationFormStable[]; /** The public URL of the image to interrogate */ source_image: string; /** When True, allows slower workers to pick up this request. Disabling this incurs an extra kudos cost. */ slow_workers?: boolean; } export interface RequestInterrogationResponse { /** The UUID of the request. Use this to retrieve the request status in the future */ id?: string; /** Any extra information from the horde about this request */ message?: string; } export interface InterrogationPopInput { /** The Name of the Worker */ name?: string; /** Users with priority to use this worker */ priority_usernames?: string[]; /** The type of interrogation this worker can fulfull */ forms?: (typeof ModelInterrogationFormTypes[keyof typeof ModelInterrogationFormTypes])[]; /** * The amount of forms to pop at the same time * @default 1 */ amount?: number; /** * The version of the bridge used by this worker * @default 1 */ bridge_version?: number; /** * How many threads this worker is running. This is used to accurately estimate the power available in the horde. * @default 1 * @minimum 1 * @maximum 10 */ threads?: number; } export interface InterrogationPopFormPayload { /** The UUID of the interrogation form. Use this to post the results in the future */ id?: string; /** * The name of this interrogation form * @example caption */ name?: typeof ModelInterrogationFormTypes[keyof typeof ModelInterrogationFormTypes]; payload?: InterrogationPopFormPayloadStable; /** The URL From which the source image can be downloaded */ source_image?: string; } export interface NoValidInterrogationsFound { /** * How many waiting requests were skipped because they demanded a specific worker. * @minimum 0 */ worker_id?: number; /** * How many waiting requests were skipped because they demanded a trusted worker which this worker is not. * @minimum 0 */ untrusted?: number; /** * How many waiting requests were skipped because they require a higher version of the bridge than this worker is running (upgrade if you see this in your skipped list). * @example 0 * @minimum 0 */ bridge_version?: number; } export interface InterrogationPopPayload { forms: InterrogationPopFormPayload; skipped?: NoValidInterrogationsFound; } export interface InterrogationFormStatus { /** The name of this interrogation form */ form?: string; /** title: Interrogation State */ state?: typeof HordeAsyncRequestStates[keyof typeof HordeAsyncRequestStates]; result?: InterrogationFormResult; } export interface InterrogationStatus { /** title: Interrogation State */ state?: typeof HordeAsyncRequestStates[keyof typeof HordeAsyncRequestStates]; forms?: InterrogationFormStatus[]; } export interface AestheticsPayload { /** * The UUID of the best image in this generation batch (only used when 2+ images generated). If 2+ aesthetic ratings are also provided, then they take precedence if they're not tied. * @example 6038971e-f0b0-4fdd-a3bb-148f561f815e * @minLength 36 * @maxLength 36 */ best?: string; /** * The team towards which this ratings contributes. It not is passed, it will leave the ratings without a team. * @example 0bed257b-e57c-4327-ac64-40cdfb1ac5e6 * @minLength 36 * @maxLength 36 */ team?: string; ratings?: AestheticRating[]; } export interface AestheticRating { /** * The UUID of image being rated * @example 6038971e-f0b0-4fdd-a3bb-148f561f815e * @minLength 36 * @maxLength 36 */ id: string; /** * The aesthetic rating 1-10 for this image * @minimum 1 * @maximum 10 */ rating: number; } export interface FilterCheckPayload { prompt: string; } export interface FilterPromptSuspicion { /** Rates how suspicious the provided prompt is. A suspicion of 2 means it would be blocked. */ suspicion: string; matches: string[]; } export interface FilterDetails { /** The UUID of this filter */ id: string; /** * The regex for this filter. * @example ac.* */ regex: string; /** * The integer defining this filter type * @minimum 10 * @maximum 29 */ filter_type: number; /** * Description about this regex */ description?: string; /** * The moderator which added or last updated this regex */ user: string; } export interface PatchExistingFilter { /** * The regex for this filter. * @example ac.* */ regex?: string; /** * The integer defining this filter type * @minimum 10 * @maximum 29 */ filter_type?: number; /** * Description about this regex */ description?: string; } export interface PutNewFilter { /** * The regex for this filter. * @example ac.* */ regex: string; /** * The integer defining this filter type * @minimum 10 * @maximum 29 */ filter_type: number; /** * Description about this regex */ description: string; } export interface ImageModelStats { day?: SinglePeriodImageModelStats; month?: SinglePeriodImageModelStats; total?: SinglePeriodImageModelStats; } /** * string - Model Name * number - The amount of requests fulfilled for this model */ export type SinglePeriodImageModelStats = Record; export interface ImageTotalStats { minute?: SinglePeriodImageStats; hour?: SinglePeriodImageStats; day?: SinglePeriodImageStats; month?: SinglePeriodImageStats; total?: SinglePeriodImageStats; } export interface SinglePeriodImageStats { /** The amount of text requests generated during this period. */ requests?: number; /** The amount of tokens generated during this period. */ tokens?: number; } export interface TextModelStats { day?: SinglePeriodTextModelStats; month?: SinglePeriodTextModelStats; total?: SinglePeriodTextModelStats; } /** * string - Model Name * number - The amount of requests fulfilled for this model */ export type SinglePeriodTextModelStats = Record; export interface TextTotalStats { minute?: SinglePeriodTextStats; hour?: SinglePeriodTextStats; day?: SinglePeriodTextStats; month?: SinglePeriodTextStats; total?: SinglePeriodTextStats; } export interface SinglePeriodTextStats { /** The amount of text requests generated during this period. */ requests?: number; /** The amount of tokens generated during this period. */ tokens?: number; } export interface SharedKeyInput { /** * The Kudos limit assigned to this key. If -1, then anyone with this key can use an unlimited amount of kudos from this account. * @default 5000 * @minimum 1 * @maximum 50000000 */ kudos?: number; /** * The amount of days after which this key will expire. If -1, this key will not expire * @default -1 * @example 30 * @minimum -1 */ expiry?: number; /** * A descriptive name for this key * @example Mutual Aid * @minLength 3 * @maxLength 255 */ name?: string; } export interface SharedKeyDetails { /** * The SharedKey ID */ id?: string; /** * The owning user's unique Username. It is a combination of their chosen alias plus their ID. */ username?: string; /** * The Kudos limit assigned to this key */ kudos?: number; /** * The date at which this API key will expire. */ expiry?: string; /** * How mych kudos has been utilized via this shared key until now. */ utilized?: number; } /** * AI Horde Ratings */ export declare const RatingArtifactsRatings: Readonly<{ readonly FLAWLESS: "FLAWLESS"; readonly LITTLE_FLAWS: "LITTLE_FLAWS"; readonly SOME_FLAWS: "SOME_FLAWS"; readonly OBVIOUS_FLAWS: "OBVIOUS_FLAWS"; readonly HARMFUL_FLAWS: "HARMFUL_FLAWS"; readonly GARBAGE: "GARBAGE"; }>; export declare class AIHordeRatings { #private; constructor(options: AIHordeRatingsInitOptions); /** * Display all datasets * @param options.fields - Array of fields that will be included in the returned data * @returns RatingsDatasetResponse - The datasets */ getDatasets(options?: { fields?: T[]; }): Promise[]>; /** * Display all public teams * @param options.fields - Array of fields that will be included in the returned data * @returns RatingsTeamsResponse - The datasets */ getTeams(options?: { fields?: T[]; }): Promise[]>; /** * Retrieve an image to rate from the default dataset * @param image_options.dataset_id - The ID of the dataset to get an image from * @param image_options.model_name - The model name to get an image from * @param options.token - The token of the requesting user * @param options.fields - Array of fields that will be included in the returned data * @returns DatasetImagePopResponse - An images data to rate */ getNewRating(image_options?: { dataset_id: string; model_name?: string; }, options?: { token?: string; fields?: T[]; }): Promise>; /** POST ENDPOINTS */ /** * Check if there are interrogation requests queued for fulfillment * This endpoint is used by registered workers only * @param image_id - The ID if the Image you want to rate * @param rating * @param options.token - The token of the requesting user * @param options.fields - Array of fields that will be included in the returned data * @returns InterrogationPopPayload */ postRating(image_id: string, rating: RatePostInput, options?: { token?: string; fields?: T[]; }): Promise>; } /** * Internal Interfaces */ export interface AIHordeRatingsInitOptions { /** The default token to use for requests */ default_token?: string; /** The base api domain + route to use for requests */ api_route?: string; /** The client agent to pass in the requests. */ client_agent: string; } /** * API Interfaces */ export interface DatasetGetResponse { /** * The unique identifier for this dataset * @example 00000000-0000-0000-0000-000000000000 */ id?: string; /** * The name of this dataset * @example My Dataset */ name?: string; /** * The description of this dataset * @example This is a dataset of images of cats */ description?: string; /** * The number of images in this dataset * @example 100 */ image_count?: number; } export interface TeamsGetResponse { /** * The unique identifier for this team * @example 00000000-0000-0000-0000-000000000000 */ id?: string; /** * The name of this team * @example My Team */ team_name?: string; /** * Whether this team is private or not * @example false */ is_private?: boolean; } export interface DatasetImagePopResponse { /** * The UUID of the image to rate * @example 00000000-0000-0000-0000-000000000000 */ id?: string; /** * The URL from which to download the image * @example https://cdn.droom.cloud/00000000-0000-0000-0000-000000000000.webp */ url?: string; /** * The UUID of the dataset in which this image belongs * @example 00000000-0000-0000-0000-000000000000 */ dataset_id?: string; } export interface RatingRequestError { /** The error message for this status code. */ message: string; } export interface RatePostInput { /** * The aesthetic rating for this image. How much do you like this image subjectively and in isolation from comparison with other images or with its own prompt. * @example 5 * @minimum 1 * @maximum 10 */ rating: number; /** * The artifacts rating for this image. * 0 for flawless generation that perfectly fits to the prompt. * 1 for small, hardly recognizable flaws. * 2 small flaws that can easily be spotted, but don not harm the aesthetic experience. * 3 for flaws that look obviously wrong, but only mildly harm the aesthetic experience. * 4 for flaws that look obviously wrong & significantly harm the aesthetic experience. * 5 for flaws that make the image look like total garbage * @example 1 * @minimum 0 * @maximum 5 */ artifacts?: typeof RatingArtifactsRatings[keyof typeof RatingArtifactsRatings]; } export interface RatePostResponse { /** * The amount of kudos awarded for this rating * @example 5 * @minimum 1 */ reward: number; /** * Any extra information about the submitted rating * @example Rating submitted */ message: string; } export {};