diff --git a/ai/api-reference/openapi_ai_gateway.json b/ai/api-reference/openapi_ai_gateway.json index ce7615d9..1ce69b30 100644 --- a/ai/api-reference/openapi_ai_gateway.json +++ b/ai/api-reference/openapi_ai_gateway.json @@ -408,11 +408,13 @@ "audio": { "type": "string", "format": "binary", - "title": "Audio" + "title": "Audio", + "description": "Uploaded audio file to be transcribed." }, "model_id": { "type": "string", "title": "Model Id", + "description": "Hugging Face model ID used for transcription.", "default": "" } }, @@ -427,55 +429,66 @@ "properties": { "prompt": { "type": "string", - "title": "Prompt" + "title": "Prompt", + "description": "Text prompt(s) to guide image generation." }, "image": { "type": "string", "format": "binary", - "title": "Image" + "title": "Image", + "description": "Uploaded image to modify with the pipeline." }, "model_id": { "type": "string", "title": "Model Id", + "description": "Hugging Face model ID used for image generation.", "default": "" }, "strength": { "type": "number", "title": "Strength", + "description": "Degree of transformation applied to the reference image (0 to 1).", "default": 0.8 }, "guidance_scale": { "type": "number", "title": "Guidance Scale", + "description": "Encourages model to generate images closely linked to the text prompt (higher values may reduce image quality).", "default": 7.5 }, "image_guidance_scale": { "type": "number", "title": "Image Guidance Scale", + "description": "Degree to which the generated image is pushed towards the initial image.", "default": 1.5 }, "negative_prompt": { "type": "string", "title": "Negative Prompt", + "description": "Text prompt(s) to guide what to exclude from image generation. Ignored if guidance_scale < 1.", "default": "" }, "safety_check": { "type": "boolean", "title": "Safety Check", + "description": "Perform a safety check to estimate if generated images could be offensive or harmful.", "default": true }, "seed": { "type": "integer", - "title": "Seed" + "title": "Seed", + "description": "Seed for random number generation." }, "num_inference_steps": { "type": "integer", "title": "Num Inference Steps", + "description": "Number of denoising steps. More steps usually lead to higher quality images but slower inference. Modulated by strength.", "default": 100 }, "num_images_per_prompt": { "type": "integer", "title": "Num Images Per Prompt", + "description": "Number of images to generate per prompt.", "default": 1 } }, @@ -492,50 +505,60 @@ "image": { "type": "string", "format": "binary", - "title": "Image" + "title": "Image", + "description": "Uploaded image to generate a video from." }, "model_id": { "type": "string", "title": "Model Id", + "description": "Hugging Face model ID used for video generation.", "default": "" }, "height": { "type": "integer", "title": "Height", + "description": "The height in pixels of the generated video.", "default": 576 }, "width": { "type": "integer", "title": "Width", + "description": "The width in pixels of the generated video.", "default": 1024 }, "fps": { "type": "integer", "title": "Fps", + "description": "The frames per second of the generated video.", "default": 6 }, "motion_bucket_id": { "type": "integer", "title": "Motion Bucket Id", + "description": "Used for conditioning the amount of motion for the generation. The higher the number the more motion will be in the video.", "default": 127 }, "noise_aug_strength": { "type": "number", "title": "Noise Aug Strength", + "description": "Amount of noise added to the conditioning image. Higher values reduce resemblance to the conditioning image and increase motion.", "default": 0.02 }, - "seed": { - "type": "integer", - "title": "Seed" - }, "safety_check": { "type": "boolean", "title": "Safety Check", + "description": "Perform a safety check to estimate if generated images could be offensive or harmful.", "default": true }, + "seed": { + "type": "integer", + "title": "Seed", + "description": "Seed for random number generation." + }, "num_inference_steps": { "type": "integer", "title": "Num Inference Steps", + "description": "Number of denoising steps. More steps usually lead to higher quality images but slower inference. Modulated by strength.", "default": 25 } }, @@ -550,30 +573,36 @@ "properties": { "prompt": { "type": "string", - "title": "Prompt" + "title": "Prompt", + "description": "Text prompt(s) to guide upscaled image generation." }, "image": { "type": "string", "format": "binary", - "title": "Image" + "title": "Image", + "description": "Uploaded image to modify with the pipeline." }, "model_id": { "type": "string", "title": "Model Id", + "description": "Hugging Face model ID used for upscaled image generation.", "default": "" }, "safety_check": { "type": "boolean", "title": "Safety Check", + "description": "Perform a safety check to estimate if generated images could be offensive or harmful.", "default": true }, "seed": { "type": "integer", - "title": "Seed" + "title": "Seed", + "description": "Seed for random number generation." }, "num_inference_steps": { "type": "integer", "title": "Num Inference Steps", + "description": "Number of denoising steps. More steps usually lead to higher quality images but slower inference. Modulated by strength.", "default": 75 } }, @@ -686,47 +715,59 @@ "model_id": { "type": "string", "title": "Model Id", + "description": "Hugging Face model ID used for image generation.", "default": "" }, "prompt": { "type": "string", - "title": "Prompt" + "title": "Prompt", + "description": "Text prompt(s) to guide image generation. Separate multiple prompts with '|' if supported by the model." }, "height": { "type": "integer", - "title": "Height" + "title": "Height", + "description": "The height in pixels of the generated image.", + "default": 576 }, "width": { "type": "integer", - "title": "Width" + "title": "Width", + "description": "The width in pixels of the generated image.", + "default": 1024 }, "guidance_scale": { "type": "number", "title": "Guidance Scale", + "description": "Encourages model to generate images closely linked to the text prompt (higher values may reduce image quality).", "default": 7.5 }, "negative_prompt": { "type": "string", "title": "Negative Prompt", + "description": "Text prompt(s) to guide what to exclude from image generation. Ignored if guidance_scale < 1.", "default": "" }, "safety_check": { "type": "boolean", "title": "Safety Check", + "description": "Perform a safety check to estimate if generated images could be offensive or harmful.", "default": true }, "seed": { "type": "integer", - "title": "Seed" + "title": "Seed", + "description": "Seed for random number generation." }, "num_inference_steps": { "type": "integer", "title": "Num Inference Steps", + "description": "Number of denoising steps. More steps usually lead to higher quality images but slower inference. Modulated by strength.", "default": 50 }, "num_images_per_prompt": { "type": "integer", "title": "Num Images Per Prompt", + "description": "Number of images to generate per prompt.", "default": 1 } }, @@ -813,4 +854,4 @@ } } } -} +} \ No newline at end of file