EasyUse/APIgenerated

JoyCaption2 (BizyAIR)(joyCaption2API)

The JoyCaption2 (BizyAIR) node (class joyCaption2API, category EasyUse/API) sends an image to the JoyCaption2 API and returns a generated text caption.

joy Caption2 API

image
caption
do_sample
COMBO
temperature
0.50
max_tokens
256
caption_type
COMBO
caption_length
COMBO
extra_options
STRING
name_input
STRING
custom_prompt
STRING
apikey_override
STRING
Easy Use

Description

The JoyCaption2 (BizyAIR) node (class joyCaption2API, category EasyUse/API) sends an image to the JoyCaption2 API and returns a generated text caption. It is part of the ComfyUI-Easy-Use API node collection and is intended for captioning images directly from your workflow without running a local caption model.

Inputs

NameTypeRequiredDefaultDescription
imageIMAGEYesThe image to be captioned.
do_sampleCOMBO (true / false)YesEnables sampling during generation. When true, captions can vary and are influenced by temperature. When false, generation is deterministic/greedy.
temperatureFLOATYes0.5Sampling randomness. Range: 0.0 to 2.0 (step 0.01). Higher values produce more varied or creative captions; lower values are more focused. Has no effect when do_sample is false.
max_tokensINTYes256Maximum number of tokens to generate. Range: 16 to 512 (step 16). Use a larger value for longer captions and a smaller value to keep captions concise.
caption_typeCOMBOYesPreset caption style. Options: Descriptive, Descriptive (Informal), Training Prompt, MidJourney, Booru tag list, Booru-like tag list, Art Critic, Product Listing, and Social Media Post.
caption_lengthCOMBOYesDesired caption length. The exact choices are provided by the JoyCaption2 API and are not hard-coded in the node definition.
extra_optionsSTRINGYesExtra options passed through with the request. Leave empty unless the API requires additional settings.
name_inputSTRINGYes""Optional name or subject to reference in the caption. Leave empty if no explicit name should be used.
custom_promptSTRINGYes""Custom prompt to use instead of, or in addition to, the selected caption_type. Leave empty to use the default JoyCaption2 prompt behavior.
apikey_overrideSTRINGNo""Optional API key override. Leave empty to use the API key configured elsewhere in ComfyUI-Easy-Use.

Outputs

TypeDescription
STRINGThe generated caption text for the input image.

Usage Notes

  • Use caption_type to quickly switch between different captioning styles, from natural descriptions to Booru-style tag lists.
  • Choose caption_length based on how verbose the caption should be. Keep in mind that longer captions consume more tokens.
  • Set do_sample to true when you want variety across runs; set it to false for reproducible or greedy decoding.
  • If you supply a custom_prompt, use it to tailor the captioning beyond the available presets.
  • Use apikey_override when a specific API key should be used for this node instead of the shared EasyUse configuration.

Comments

Sign in with GitHub to join the discussion.

Loading comments…