Skip to content

Commit

Permalink
chore: update docs maps
Browse files Browse the repository at this point in the history
  • Loading branch information
tazlin committed May 9, 2024
1 parent 3deca95 commit 51d3128
Show file tree
Hide file tree
Showing 4 changed files with 149 additions and 20 deletions.
6 changes: 5 additions & 1 deletion docs/api_to_sdk_payload_map.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,16 @@
"POST": "horde_sdk.ai_horde_api.apimodels.alchemy._pop.AlchemyPopRequest"
},
"/v2/workers": {
"GET": "horde_sdk.ai_horde_api.apimodels.workers._workers_all.AllWorkersDetailsRequest"
"GET": "horde_sdk.ai_horde_api.apimodels.workers._workers.AllWorkersDetailsRequest"
},
"/v2/generate/status/{id}": {
"DELETE": "horde_sdk.ai_horde_api.apimodels.generate._status.DeleteImageGenerateRequest",
"GET": "horde_sdk.ai_horde_api.apimodels.generate._status.ImageGenerateStatusRequest"
},
"/v2/generate/text/status/{id}": {
"DELETE": "horde_sdk.ai_horde_api.apimodels.generate.text._status.DeleteTextGenerateRequest",
"GET": "horde_sdk.ai_horde_api.apimodels.generate.text._status.TextGenerateStatusRequest"
},
"/v2/find_user": {
"GET": "horde_sdk.ai_horde_api.apimodels._find_user.FindUserRequest"
},
Expand Down
5 changes: 4 additions & 1 deletion docs/api_to_sdk_response_map.json
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,14 @@
"200": "horde_sdk.ai_horde_api.apimodels.alchemy._pop.AlchemyPopResponse"
},
"/v2/workers": {
"200": "horde_sdk.ai_horde_api.apimodels.workers._workers_all.AllWorkersDetailsResponse"
"200": "horde_sdk.ai_horde_api.apimodels.workers._workers.AllWorkersDetailsResponse"
},
"/v2/generate/status/{id}": {
"200": "horde_sdk.ai_horde_api.apimodels.generate._status.ImageGenerateStatusResponse"
},
"/v2/generate/text/status/{id}": {
"200": "horde_sdk.ai_horde_api.apimodels.generate.text._status.TextGenerateStatusResponse"
},
"/v2/find_user": {
"200": "horde_sdk.ai_horde_api.apimodels._find_user.FindUserResponse"
},
Expand Down
64 changes: 46 additions & 18 deletions docs/request_field_names_and_descriptions.json
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,20 @@
null
]
],
"DeleteTextGenerateRequest": [
[
"id_",
null
],
[
"accept",
null
],
[
"client_agent",
null
]
],
"FindUserRequest": [
[
"apikey",
Expand Down Expand Up @@ -313,47 +327,51 @@
],
"ImageGenerateJobPopRequest": [
[
"apikey",
null
"amount",
"How many jobvs to pop at the same time"
],
[
"accept",
null
"bridge_agent",
"The worker name, version and website."
],
[
"client_agent",
"models",
null
],
[
"name",
null
"The Name of the Worker."
],
[
"nsfw",
"Whether this worker can generate NSFW requests or not."
],
[
"priority_usernames",
null
],
[
"nsfw",
null
"require_upfront_kudos",
"If True, this worker will only pick up requests where the owner has the required kudos to consume already available."
],
[
"models",
null
"threads",
"How many threads this worker is running. This is used to accurately the current power available in the horde."
],
[
"bridge_version",
"apikey",
null
],
[
"bridge_agent",
"accept",
null
],
[
"threads",
"client_agent",
null
],
[
"require_upfront_kudos",
"bridge_version",
null
],
[
Expand Down Expand Up @@ -387,10 +405,6 @@
[
"allow_lora",
null
],
[
"amount",
null
]
],
"ImageGenerateStatusRequest": [
Expand Down Expand Up @@ -479,6 +493,20 @@
null
]
],
"TextGenerateStatusRequest": [
[
"id_",
null
],
[
"accept",
null
],
[
"client_agent",
null
]
],
"TextStatsModelsRequest": [
[
"accept",
Expand Down
94 changes: 94 additions & 0 deletions docs/response_field_names_and_descriptions.json
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,96 @@
null
]
],
"TextGenerateStatusResponse": [
[
"finished",
null
],
[
"processing",
null
],
[
"restarted",
null
],
[
"waiting",
null
],
[
"done",
null
],
[
"faulted",
null
],
[
"wait_time",
null
],
[
"queue_position",
null
],
[
"kudos",
null
],
[
"is_possible",
null
],
[
"generations",
"The generations that have been completed in this request."
],
[
"finished",
null
],
[
"processing",
null
],
[
"restarted",
null
],
[
"waiting",
null
],
[
"done",
null
],
[
"faulted",
null
],
[
"wait_time",
null
],
[
"queue_position",
null
],
[
"kudos",
null
],
[
"is_possible",
null
],
[
"generations",
"The generations that have been completed in this request."
]
],
"FindUserResponse": [
[
"admin_comment",
Expand All @@ -178,6 +268,10 @@
"contributions",
null
],
[
"customizer",
"If this user can run custom models."
],
[
"evaluating_kudos",
"(Privileged) The amount of Evaluating Kudos this untrusted user has from generations and uptime. When this number reaches a pre-specified threshold, they automatically become trusted."
Expand Down

0 comments on commit 51d3128

Please sign in to comment.