diff --git a/.github/scripts/snippets/router-pricing-display.ts b/.github/scripts/snippets/router-pricing-display.ts index 0efe053a02..e9f178ce2b 100644 --- a/.github/scripts/snippets/router-pricing-display.ts +++ b/.github/scripts/snippets/router-pricing-display.ts @@ -205,6 +205,8 @@ const phrases: Record = { const units: Record = { "1M tokens": ["1M tokens", "1M トークン", "1M 令牌", "1M 토큰", "1M de tokens"], + "1K characters": ["1K characters", "1K 文字", "1K 字符", "1K 문자", "1K caracteres"], + "Recraft credit": ["Recraft credit", "Recraft クレジット", "Recraft 积分", "Recraft 크레딧", "crédito de Recraft"], "1K video tokens": ["1K video tokens", "1K 動画トークン", "1K 视频令牌", "1K 동영상 토큰", "1K de tokens de video"], "second": ["second", "秒", "秒", "초", "segundo"], "minute": ["minute", "分", "分钟", "분", "minuto"], "5 seconds": ["5 s", "5 秒", "5 秒", "5초", "5 s"], diff --git a/docs.json b/docs.json index 97cacfd89a..5986fde923 100644 --- a/docs.json +++ b/docs.json @@ -7534,6 +7534,7 @@ "group": "Models", "pages": [ "zh/development/comfy-router/models", + "zh/development/comfy-router/pricing", "zh/development/comfy-router/providers", { "group": "Anthropic", @@ -7734,9 +7735,7 @@ "group": "Luma", "pages": [ "zh/development/comfy-router/models/luma/photon-1/code", - "zh/development/comfy-router/models/luma/photon-flash-1/code", - "zh/development/comfy-router/models/luma/ray-2/code", - "zh/development/comfy-router/models/luma/ray-flash-2/code" + "zh/development/comfy-router/models/luma/photon-flash-1/code" ] }, { @@ -7776,7 +7775,6 @@ "group": "OpenAI", "pages": [ "zh/development/comfy-router/models/openai/gpt-4-1-mini/code", - "zh/development/comfy-router/models/openai/gpt-4-1-nano/code", "zh/development/comfy-router/models/openai/gpt-4-1/code", "zh/development/comfy-router/models/openai/gpt-4o/code", "zh/development/comfy-router/models/openai/gpt-5-5-pro/code", @@ -7787,24 +7785,25 @@ "zh/development/comfy-router/models/openai/gpt-5-mini/code", "zh/development/comfy-router/models/openai/gpt-5-nano/code", "zh/development/comfy-router/models/openai/gpt-5/code", + "zh/development/comfy-router/models/openai/gpt-6-1-sol/code", + "zh/development/comfy-router/models/openai/gpt-6-1-terra/code", "zh/development/comfy-router/models/openai/gpt-6-astra/code", "zh/development/comfy-router/models/openai/gpt-6-luna/code", "zh/development/comfy-router/models/openai/gpt-6-sol/code", "zh/development/comfy-router/models/openai/gpt-image-1-5/code", - "zh/development/comfy-router/models/openai/gpt-image-1/code", "zh/development/comfy-router/models/openai/gpt-image-2-5-flare/code", "zh/development/comfy-router/models/openai/gpt-image-2-5-sunburst/code", "zh/development/comfy-router/models/openai/gpt-image-2/code", - "zh/development/comfy-router/models/openai/o1-pro/code", - "zh/development/comfy-router/models/openai/o1/code", - "zh/development/comfy-router/models/openai/o3/code", - "zh/development/comfy-router/models/openai/o4-mini/code" + "zh/development/comfy-router/models/openai/o3/code" ] }, { "group": "Pika", "pages": [ "zh/development/comfy-router/models/pika/pika-2-5-image-to-video/code", + "zh/development/comfy-router/models/pika/pika-soundtrack/code", + "zh/development/comfy-router/models/pika/pika-sfx/code", + "zh/development/comfy-router/models/pika/pika-music/code", "zh/development/comfy-router/models/pika/pika-2-5-text-to-video/code" ] }, @@ -8017,6 +8016,7 @@ "zh/custom-nodes/js/javascript_commands_keybindings", "zh/custom-nodes/js/javascript_topbar_menu", "zh/custom-nodes/js/subgraphs", + "zh/custom-nodes/js/canvas-pointer-api", "zh/custom-nodes/js/javascript_examples" ] }, @@ -8026,6 +8026,13 @@ "pages": [ "zh/custom-nodes/v3_migration", "zh/custom-nodes/js/context-menu-migration", + "zh/custom-nodes/js/node-id-migration", + "zh/custom-nodes/js/link-registration-migration", + "zh/custom-nodes/js/widgets-migration", + "zh/custom-nodes/js/connection-callbacks-migration", + "zh/custom-nodes/js/serialization-callbacks-migration", + "zh/custom-nodes/js/node-geometry-migration", + "zh/custom-nodes/js/primevue-removal-migration", "zh/custom-nodes/backend/node-replacement" ] } @@ -11613,6 +11620,7 @@ "group": "Models", "pages": [ "ja/development/comfy-router/models", + "ja/development/comfy-router/pricing", "ja/development/comfy-router/providers", { "group": "Anthropic", @@ -11813,9 +11821,7 @@ "group": "Luma", "pages": [ "ja/development/comfy-router/models/luma/photon-1/code", - "ja/development/comfy-router/models/luma/photon-flash-1/code", - "ja/development/comfy-router/models/luma/ray-2/code", - "ja/development/comfy-router/models/luma/ray-flash-2/code" + "ja/development/comfy-router/models/luma/photon-flash-1/code" ] }, { @@ -11855,7 +11861,6 @@ "group": "OpenAI", "pages": [ "ja/development/comfy-router/models/openai/gpt-4-1-mini/code", - "ja/development/comfy-router/models/openai/gpt-4-1-nano/code", "ja/development/comfy-router/models/openai/gpt-4-1/code", "ja/development/comfy-router/models/openai/gpt-4o/code", "ja/development/comfy-router/models/openai/gpt-5-5-pro/code", @@ -11866,24 +11871,25 @@ "ja/development/comfy-router/models/openai/gpt-5-mini/code", "ja/development/comfy-router/models/openai/gpt-5-nano/code", "ja/development/comfy-router/models/openai/gpt-5/code", + "ja/development/comfy-router/models/openai/gpt-6-1-sol/code", + "ja/development/comfy-router/models/openai/gpt-6-1-terra/code", "ja/development/comfy-router/models/openai/gpt-6-astra/code", "ja/development/comfy-router/models/openai/gpt-6-luna/code", "ja/development/comfy-router/models/openai/gpt-6-sol/code", "ja/development/comfy-router/models/openai/gpt-image-1-5/code", - "ja/development/comfy-router/models/openai/gpt-image-1/code", "ja/development/comfy-router/models/openai/gpt-image-2-5-flare/code", "ja/development/comfy-router/models/openai/gpt-image-2-5-sunburst/code", "ja/development/comfy-router/models/openai/gpt-image-2/code", - "ja/development/comfy-router/models/openai/o1-pro/code", - "ja/development/comfy-router/models/openai/o1/code", - "ja/development/comfy-router/models/openai/o3/code", - "ja/development/comfy-router/models/openai/o4-mini/code" + "ja/development/comfy-router/models/openai/o3/code" ] }, { "group": "Pika", "pages": [ "ja/development/comfy-router/models/pika/pika-2-5-image-to-video/code", + "ja/development/comfy-router/models/pika/pika-soundtrack/code", + "ja/development/comfy-router/models/pika/pika-sfx/code", + "ja/development/comfy-router/models/pika/pika-music/code", "ja/development/comfy-router/models/pika/pika-2-5-text-to-video/code" ] }, @@ -12096,6 +12102,7 @@ "ja/custom-nodes/js/javascript_commands_keybindings", "ja/custom-nodes/js/javascript_topbar_menu", "ja/custom-nodes/js/subgraphs", + "ja/custom-nodes/js/canvas-pointer-api", "ja/custom-nodes/js/javascript_examples" ] }, @@ -12105,6 +12112,13 @@ "pages": [ "ja/custom-nodes/v3_migration", "ja/custom-nodes/js/context-menu-migration", + "ja/custom-nodes/js/node-id-migration", + "ja/custom-nodes/js/link-registration-migration", + "ja/custom-nodes/js/widgets-migration", + "ja/custom-nodes/js/connection-callbacks-migration", + "ja/custom-nodes/js/serialization-callbacks-migration", + "ja/custom-nodes/js/node-geometry-migration", + "ja/custom-nodes/js/primevue-removal-migration", "ja/custom-nodes/backend/node-replacement" ] } @@ -15622,6 +15636,7 @@ "group": "Models", "pages": [ "ko/development/comfy-router/models", + "ko/development/comfy-router/pricing", "ko/development/comfy-router/providers", { "group": "Anthropic", @@ -15822,9 +15837,7 @@ "group": "Luma", "pages": [ "ko/development/comfy-router/models/luma/photon-1/code", - "ko/development/comfy-router/models/luma/photon-flash-1/code", - "ko/development/comfy-router/models/luma/ray-2/code", - "ko/development/comfy-router/models/luma/ray-flash-2/code" + "ko/development/comfy-router/models/luma/photon-flash-1/code" ] }, { @@ -15864,7 +15877,6 @@ "group": "OpenAI", "pages": [ "ko/development/comfy-router/models/openai/gpt-4-1-mini/code", - "ko/development/comfy-router/models/openai/gpt-4-1-nano/code", "ko/development/comfy-router/models/openai/gpt-4-1/code", "ko/development/comfy-router/models/openai/gpt-4o/code", "ko/development/comfy-router/models/openai/gpt-5-5-pro/code", @@ -15875,24 +15887,25 @@ "ko/development/comfy-router/models/openai/gpt-5-mini/code", "ko/development/comfy-router/models/openai/gpt-5-nano/code", "ko/development/comfy-router/models/openai/gpt-5/code", + "ko/development/comfy-router/models/openai/gpt-6-1-sol/code", + "ko/development/comfy-router/models/openai/gpt-6-1-terra/code", "ko/development/comfy-router/models/openai/gpt-6-astra/code", "ko/development/comfy-router/models/openai/gpt-6-luna/code", "ko/development/comfy-router/models/openai/gpt-6-sol/code", "ko/development/comfy-router/models/openai/gpt-image-1-5/code", - "ko/development/comfy-router/models/openai/gpt-image-1/code", "ko/development/comfy-router/models/openai/gpt-image-2-5-flare/code", "ko/development/comfy-router/models/openai/gpt-image-2-5-sunburst/code", "ko/development/comfy-router/models/openai/gpt-image-2/code", - "ko/development/comfy-router/models/openai/o1-pro/code", - "ko/development/comfy-router/models/openai/o1/code", - "ko/development/comfy-router/models/openai/o3/code", - "ko/development/comfy-router/models/openai/o4-mini/code" + "ko/development/comfy-router/models/openai/o3/code" ] }, { "group": "Pika", "pages": [ "ko/development/comfy-router/models/pika/pika-2-5-image-to-video/code", + "ko/development/comfy-router/models/pika/pika-soundtrack/code", + "ko/development/comfy-router/models/pika/pika-sfx/code", + "ko/development/comfy-router/models/pika/pika-music/code", "ko/development/comfy-router/models/pika/pika-2-5-text-to-video/code" ] }, @@ -16105,6 +16118,7 @@ "ko/custom-nodes/js/javascript_commands_keybindings", "ko/custom-nodes/js/javascript_topbar_menu", "ko/custom-nodes/js/subgraphs", + "ko/custom-nodes/js/canvas-pointer-api", "ko/custom-nodes/js/javascript_examples" ] }, @@ -16114,6 +16128,13 @@ "pages": [ "ko/custom-nodes/v3_migration", "ko/custom-nodes/js/context-menu-migration", + "ko/custom-nodes/js/node-id-migration", + "ko/custom-nodes/js/link-registration-migration", + "ko/custom-nodes/js/widgets-migration", + "ko/custom-nodes/js/connection-callbacks-migration", + "ko/custom-nodes/js/serialization-callbacks-migration", + "ko/custom-nodes/js/node-geometry-migration", + "ko/custom-nodes/js/primevue-removal-migration", "ko/custom-nodes/backend/node-replacement" ] } @@ -16900,6 +16921,7 @@ { "group": "ByteDance", "pages": [ + "es/tutorials/partner-nodes/bytedance/seedream-5-flash", "es/tutorials/partner-nodes/bytedance/seedream-5-pro", "es/tutorials/partner-nodes/bytedance/seedream-5-lite" ] @@ -17344,7 +17366,8 @@ "es/development/comfy-router/schemas", "es/development/comfy-router/queue", "es/development/comfy-router/errors", - "es/development/comfy-router/billing" + "es/development/comfy-router/billing", + "es/development/comfy-router/realtime" ] }, { @@ -17571,9 +17594,7 @@ "group": "Luma", "pages": [ "es/development/comfy-router/models/luma/photon-1/code", - "es/development/comfy-router/models/luma/photon-flash-1/code", - "es/development/comfy-router/models/luma/ray-2/code", - "es/development/comfy-router/models/luma/ray-flash-2/code" + "es/development/comfy-router/models/luma/photon-flash-1/code" ] }, { @@ -17613,7 +17634,6 @@ "group": "OpenAI", "pages": [ "es/development/comfy-router/models/openai/gpt-4-1-mini/code", - "es/development/comfy-router/models/openai/gpt-4-1-nano/code", "es/development/comfy-router/models/openai/gpt-4-1/code", "es/development/comfy-router/models/openai/gpt-4o/code", "es/development/comfy-router/models/openai/gpt-5-5-pro/code", @@ -17624,18 +17644,16 @@ "es/development/comfy-router/models/openai/gpt-5-mini/code", "es/development/comfy-router/models/openai/gpt-5-nano/code", "es/development/comfy-router/models/openai/gpt-5/code", + "es/development/comfy-router/models/openai/gpt-6-1-sol/code", + "es/development/comfy-router/models/openai/gpt-6-1-terra/code", "es/development/comfy-router/models/openai/gpt-6-astra/code", "es/development/comfy-router/models/openai/gpt-6-luna/code", "es/development/comfy-router/models/openai/gpt-6-sol/code", "es/development/comfy-router/models/openai/gpt-image-1-5/code", - "es/development/comfy-router/models/openai/gpt-image-1/code", "es/development/comfy-router/models/openai/gpt-image-2-5-flare/code", "es/development/comfy-router/models/openai/gpt-image-2-5-sunburst/code", "es/development/comfy-router/models/openai/gpt-image-2/code", - "es/development/comfy-router/models/openai/o1-pro/code", - "es/development/comfy-router/models/openai/o1/code", - "es/development/comfy-router/models/openai/o3/code", - "es/development/comfy-router/models/openai/o4-mini/code" + "es/development/comfy-router/models/openai/o3/code" ] }, { @@ -17648,7 +17666,10 @@ "group": "Pika", "pages": [ "es/development/comfy-router/models/pika/pika-2-5-image-to-video/code", - "es/development/comfy-router/models/pika/pika-2-5-text-to-video/code" + "es/development/comfy-router/models/pika/pika-2-5-text-to-video/code", + "es/development/comfy-router/models/pika/pika-music/code", + "es/development/comfy-router/models/pika/pika-sfx/code", + "es/development/comfy-router/models/pika/pika-soundtrack/code" ] }, { @@ -20113,6 +20134,7 @@ "es/custom-nodes/js/javascript_commands_keybindings", "es/custom-nodes/js/javascript_topbar_menu", "es/custom-nodes/js/subgraphs", + "es/custom-nodes/js/canvas-pointer-api", "es/custom-nodes/js/javascript_examples" ] }, @@ -20122,6 +20144,13 @@ "pages": [ "es/custom-nodes/v3_migration", "es/custom-nodes/js/context-menu-migration", + "es/custom-nodes/js/node-id-migration", + "es/custom-nodes/js/link-registration-migration", + "es/custom-nodes/js/widgets-migration", + "es/custom-nodes/js/connection-callbacks-migration", + "es/custom-nodes/js/serialization-callbacks-migration", + "es/custom-nodes/js/node-geometry-migration", + "es/custom-nodes/js/primevue-removal-migration", "es/custom-nodes/backend/node-replacement" ] } @@ -21801,6 +21830,118 @@ { "source": "/development/comfy-router/models/luma/ray-flash-2/code", "destination": "/development/comfy-router/models" + }, + { + "source": "/ja/development/comfy-router/models/luma/ray-2/code", + "destination": "/ja/development/comfy-router/models" + }, + { + "source": "/ja/development/comfy-router/models/luma/ray-flash-2/code", + "destination": "/ja/development/comfy-router/models" + }, + { + "source": "/ja/development/comfy-router/models/openai/gpt-4-1-nano/code", + "destination": "/ja/development/comfy-router/models" + }, + { + "source": "/ja/development/comfy-router/models/openai/gpt-image-1/code", + "destination": "/ja/development/comfy-router/models" + }, + { + "source": "/ja/development/comfy-router/models/openai/o1-pro/code", + "destination": "/ja/development/comfy-router/models" + }, + { + "source": "/ja/development/comfy-router/models/openai/o1/code", + "destination": "/ja/development/comfy-router/models" + }, + { + "source": "/ja/development/comfy-router/models/openai/o4-mini/code", + "destination": "/ja/development/comfy-router/models" + }, + { + "source": "/zh/development/comfy-router/models/luma/ray-2/code", + "destination": "/zh/development/comfy-router/models" + }, + { + "source": "/zh/development/comfy-router/models/luma/ray-flash-2/code", + "destination": "/zh/development/comfy-router/models" + }, + { + "source": "/zh/development/comfy-router/models/openai/gpt-4-1-nano/code", + "destination": "/zh/development/comfy-router/models" + }, + { + "source": "/zh/development/comfy-router/models/openai/gpt-image-1/code", + "destination": "/zh/development/comfy-router/models" + }, + { + "source": "/zh/development/comfy-router/models/openai/o1-pro/code", + "destination": "/zh/development/comfy-router/models" + }, + { + "source": "/zh/development/comfy-router/models/openai/o1/code", + "destination": "/zh/development/comfy-router/models" + }, + { + "source": "/zh/development/comfy-router/models/openai/o4-mini/code", + "destination": "/zh/development/comfy-router/models" + }, + { + "source": "/ko/development/comfy-router/models/luma/ray-2/code", + "destination": "/ko/development/comfy-router/models" + }, + { + "source": "/ko/development/comfy-router/models/luma/ray-flash-2/code", + "destination": "/ko/development/comfy-router/models" + }, + { + "source": "/ko/development/comfy-router/models/openai/gpt-4-1-nano/code", + "destination": "/ko/development/comfy-router/models" + }, + { + "source": "/ko/development/comfy-router/models/openai/gpt-image-1/code", + "destination": "/ko/development/comfy-router/models" + }, + { + "source": "/ko/development/comfy-router/models/openai/o1-pro/code", + "destination": "/ko/development/comfy-router/models" + }, + { + "source": "/ko/development/comfy-router/models/openai/o1/code", + "destination": "/ko/development/comfy-router/models" + }, + { + "source": "/ko/development/comfy-router/models/openai/o4-mini/code", + "destination": "/ko/development/comfy-router/models" + }, + { + "source": "/es/development/comfy-router/models/luma/ray-2/code", + "destination": "/es/development/comfy-router/models" + }, + { + "source": "/es/development/comfy-router/models/luma/ray-flash-2/code", + "destination": "/es/development/comfy-router/models" + }, + { + "source": "/es/development/comfy-router/models/openai/gpt-4-1-nano/code", + "destination": "/es/development/comfy-router/models" + }, + { + "source": "/es/development/comfy-router/models/openai/gpt-image-1/code", + "destination": "/es/development/comfy-router/models" + }, + { + "source": "/es/development/comfy-router/models/openai/o1-pro/code", + "destination": "/es/development/comfy-router/models" + }, + { + "source": "/es/development/comfy-router/models/openai/o1/code", + "destination": "/es/development/comfy-router/models" + }, + { + "source": "/es/development/comfy-router/models/openai/o4-mini/code", + "destination": "/es/development/comfy-router/models" } ], "search": { diff --git a/es/custom-nodes/js/canvas-pointer-api.mdx b/es/custom-nodes/js/canvas-pointer-api.mdx new file mode 100644 index 0000000000..0c7f1c93be --- /dev/null +++ b/es/custom-nodes/js/canvas-pointer-api.mdx @@ -0,0 +1,77 @@ +--- +title: "API de puntero del lienzo para widgets y cursores" +sidebarTitle: "API de puntero del lienzo" +description: "Gestiona clics, doble clics y arrastres en widgets de lienzo personalizados con onPointerDown y controla los cursores del lienzo desde una extensión del frontend de ComfyUI." +translationSourceHash: 16ea7f38 +translationFrom: custom-nodes/js/canvas-pointer-api.mdx +translationBlockHashes: + "_intro": b1d4c464 + "Default behavior": 27a8751b + "Handle pointer input on a widget": e4fc63fc + "Control the canvas cursor": 9bcc33c8 +--- +El lienzo canaliza la entrada del puntero a través de un `CanvasPointer`. Este decide si una pulsación se convierte en un clic, un doble clic o un arrastre, y ejecuta las funciones de devolución de llamada que asignas para esa pulsación. Los widgets dibujados en el lienzo lo usan mediante `onPointerDown`. + +## Comportamiento predeterminado + +- Arrastrar varios elementos seleccionados ya no requiere mantener presionada Shift. Hacer clic en un elemento mientras varios están seleccionados sigue deseleccionando los demás. +- Hacer clic en un enlace conectado de una entrada ya no lo desconecta y lo vuelve a conectar. +- Una pequeña cantidad de movimiento entre presionar y soltar el puntero sigue contando como un clic. Una vez que el puntero supera el límite de deriva del clic, la pulsación se convierte en un arrastre. El tiempo no afecta la decisión. +- Un doble clic requiere dos pulsaciones dentro del tiempo de doble clic, separadas como máximo por tres veces la deriva del clic. Solo una pulsación que asigne `onDoubleClick` puede completar un doble clic. + +Los usuarios configuran la deriva del clic y el tiempo de doble clic en las configuraciones +(`Comfy.Pointer.ClickDrift` y `Comfy.Pointer.DoubleClickTime`). + +### Seleccionar varios elementos + +- `Ctrl` + arrastrar: inicia una selección múltiple +- `Ctrl` + `Shift` + arrastrar: agrega a la selección +- `Ctrl` + arrastrar, luego `Shift`: agrega a la selección +- `Ctrl` + arrastrar, luego `Alt`: elimina de la selección + +## Manejar la entrada de puntero en un widget + +Asigna `onPointerDown` en un widget. Se ejecuta al presionar con el puntero y recibe el puntero, el nodo y el lienzo. Asigna en el puntero las devoluciones de llamada que necesites; el lienzo ejecuta las adecuadas cuando se resuelve la pulsación: + +```js +widget.onPointerDown = function (pointer, node, canvas) { + const e = pointer.eDown + const offsetFromNode = [e.canvasX - node.pos[0], e.canvasY - node.pos[1]] + + pointer.onClick = (upEvent) => { + console.log(pointer.eDown, pointer.eMove, pointer.eUp) + } + pointer.onDoubleClick = (upEvent) => this.customFunction(upEvent) + + pointer.onDragStart = () => {} + pointer.onDrag = (moveEvent) => {} + pointer.onDragEnd = (upEvent) => {} + pointer.onDragCancel = () => {} + + pointer.finally = () => {} + + return true +} +``` + +- `onClick` y `onDoubleClick` nunca se ejecutan en la misma pulsación que `onDragStart`, `onDragEnd` u `onDragCancel`. `onDrag` sí puede ejecutarse en una pulsación que termina como clic, porque también recibe el movimiento dentro del límite de deriva del clic. +- `onDragStart` se ejecuta una vez por arrastre, cuando el puntero supera por primera vez el límite de deriva del clic. Si el puntero se suelta más allá del límite antes de que se informe de algún evento de movimiento, `onDragStart` se ejecuta al soltar, `onDragEnd` se ejecuta justo después y `onDrag` no se ejecuta. +- Cuando una pulsación asigna `onClick` y `onDoubleClick`, al soltar la primera pulsación de un doble clic se ejecuta `onClick`. La segunda pulsación ejecuta `onDoubleClick` en lugar de `onClick`, así que haz que `onClick` sea seguro si se ejecuta primero. Además, el primer clic puede caer en un elemento cercano en lugar de tu widget, por lo que `onDoubleClick` puede ejecutarse sin que se haya ejecutado tu `onClick`. +- `onDragEnd` recibe el evento de subida del puntero de un arrastre. `onDragCancel` se ejecuta en su lugar cuando el arrastre se interrumpe, por ejemplo cuando se pierde la captura del puntero. +- `finally` se ejecuta una vez al terminar la pulsación. Asignar `pointer.finally` ejecuta de inmediato la devolución de llamada a la que reemplaza. Si `onPointerDown` no devuelve `true`, el lienzo asigna su propio `finally`, así que el tuyo se ejecuta durante la pulsación. Devuelve `true` cuando dependas de `finally` para limpiar. +- `pointer.eDown`, `pointer.eMove` y `pointer.eUp` dan a cada devolución de llamada acceso a toda la secuencia de eventos. +- Devuelve `true` para impedir que el lienzo maneje la pulsación por su cuenta. +- Elimina cualquier manejador `widget.mouse` heredado cuando añadas `onPointerDown`. Si `onPointerDown` devuelve `true`, el lienzo sigue rastreando el widget después de soltar y sigue llamando a `widget.mouse` en cada movimiento del puntero. + +El lienzo resuelve por ti los dobles clics y los arrastres, así que un widget ya no necesita medir ni cronometrar eventos de puntero por separado. También respeta la deriva de clic y la configuración de doble clic del usuario. + +## Controlar el cursor del lienzo + +`canvas.state.hoveringOver` contiene indicadores de bits para los tipos de elemento que están bajo el puntero, como un nodo, un grupo, un Reroute o una conexión. Establece `canvas.state.shouldSetCursor` en `false` para evitar que el lienzo establezca el estilo del cursor y luego establécelo tú mismo: + +```js +canvas.state.shouldSetCursor = false +canvas.canvas.style.cursor = 'pointer' +``` + +Iniciar el redimensionamiento de un nodo sigue estableciendo un cursor de redimensionamiento mientras `shouldSetCursor` es `false`. Vuelve a establecer el cursor después de que finalice el redimensionamiento. diff --git a/es/custom-nodes/js/connection-callbacks-migration.mdx b/es/custom-nodes/js/connection-callbacks-migration.mdx new file mode 100644 index 0000000000..76cb455eee --- /dev/null +++ b/es/custom-nodes/js/connection-callbacks-migration.mdx @@ -0,0 +1,116 @@ +--- +title: "Migración de callbacks de conexión para extensiones del frontend" +sidebarTitle: "Migración de callbacks de conexión" +description: "Orden de los callbacks onConnectionsChange y de eliminación de nodos, SubgraphIO en los límites de subgrafos y graph.events en extensiones de ComfyUI." +translationSourceHash: 06a9ae24 +translationFrom: custom-nodes/js/connection-callbacks-migration.mdx +translationBlockHashes: + "_intro": cd84d91b + "Check for SubgraphIO at subgraph boundaries": c049a9fe + "Subscribe to node lifecycle events with graph.events": 1100692e + "Node removal fires callbacks in this order (partially tested)": 720324f8 + "Workflow load resolves peer nodes before onConnectionsChange runs": 2b775215 + "API prompt import does not reconnect resolved inputs": 619d6b69 + "Reject connections before they are made": b9b94a8e + "Removing a link inside the output callback skips the input callback": 3317def4 + "Replace removed slot events": 5c3ec663 + "Read connection state from callback arguments or node methods": 9da17ab0 +--- +Las firmas de los callbacks no cambiaron. `onConnectionsChange`, `onConnectInput`, `onConnectOutput` y `onBeforeConnectInput` conservan sus argumentos y su comportamiento de ejecución actuales. Para los cambios en el registro de enlaces y en la API de `LinkNetwork`, consulta [Migración del registro de enlaces](/es/custom-nodes/js/link-registration-migration). + +## Comprobar SubgraphIO en los límites de subgrafo + +En un límite de subgrafo (un `SubgraphInput` o un `SubgraphOutput`), `onConnectionsChange` sigue disparándose, pero su quinto argumento es un `SubgraphIO`, no el `INodeInputSlot`/`INodeOutputSlot` habitual. Compruébalo antes de tratar el argumento como un slot normal. Los guardianes `isSubgraphInput` e `isSubgraphOutput` del propio frontend no se exponen a las extensiones, así que comprueba el arreglo `linkIds` y el nodo `parent` que tiene todo `SubgraphIO` y que los slots de nodo no tienen: + +```js +function isSubgraphIO(slot) { + return slot != null && Array.isArray(slot.linkIds) && 'parent' in slot +} + +nodeType.prototype.onConnectionsChange = function ( + type, + index, + isConnected, + link, + slotOrIO +) { + if (isSubgraphIO(slotOrIO)) return + // slotOrIO is INodeInputSlot | INodeOutputSlot +} +``` + +## Suscribirse a eventos del ciclo de vida de los nodos con graph.events + +`graph.events` emite `node:added`, `node:before-removed` y `node:removed`. Úsalos cuando más de una parte de tu extensión necesite observar cuándo se agrega o se elimina un nodo: + +```ts +graph.events.addEventListener('node:added', (e) => { + console.log('added', e.detail.node.id) +}) +``` + +`node.onAdded`, `node.onRemoved` y las versiones de un solo slot `graph.onNodeAdded`/`graph.onNodeRemoved` siguen funcionando, pero asignar `graph.onNodeAdded` reemplaza cualquier manejador existente: un segundo suscriptor descarta el primero sin aviso. Prefiere `graph.events` a menos que necesites vetar o modificar algo durante la adición o eliminación. No hay un equivalente con varios suscriptores para conectar y desconectar; `onConnectionsChange` sigue siendo el único hook por conexión. + +## Al eliminar un nodo, las devoluciones de llamada se disparan en este orden (probado parcialmente) + +Al eliminar un nodo, se disparan, en orden: + +1. `node:before-removed`: el nodo sigue completamente vinculado al gráfico. +2. `onConnectionsChange(..., false, ...)` en el nodo eliminado y en cada nodo conectado a él, mientras el nodo eliminado todavía está en el gráfico. +3. `node.onRemoved()`: `node.graph` todavía está asignado. +4. El nodo se desvincula de los índices y almacenes del gráfico; `node.graph` pasa a ser `null`. +5. `onNodeRemoved(node)` y después `node:removed`, ambas ven un nodo ya desvinculado. + +Las pruebas cubren `node:before-removed → node.onRemoved() → onNodeRemoved(node)` y verifican por separado que `node:removed` ve un nodo desvinculado. La secuencia completa, incluido el paso 2, se observa en el código fuente en lugar de estar garantizada por una prueba de extremo a extremo. + +Para obtener el nodo eliminado desde el controlador `onConnectionsChange` de un nodo conectado, hazlo en el paso 2 mediante `graph.getNodeById()`. En el momento de `node:removed`, el nodo ya no existe. + +## La carga del flujo de trabajo resuelve los nodos pares antes de que se ejecute onConnectionsChange + +`graph.configure()` crea todos los nodos del flujo de trabajo antes de que se ejecute el `configure()` propio de cualquier nodo y de que se dispare `onConnectionsChange` para sus enlaces restaurados. Por eso, cuando tu callback `onConnectionsChange` se dispara durante la carga, todos los nodos pares ya existen y su enlace ya está registrado, así que `graph.getNodeById()` y las búsquedas de enlaces desde dentro de ese callback se resuelven correctamente. + +## La importación de prompts de API no reconecta las entradas resueltas + +`app.loadApiJson()` conecta cada entrada que se puede resolver sin ejecutar una segunda pasada de desconexión y reconexión. Las extensiones no deben depender de notificaciones duplicadas de `onConnectionsChange` durante la importación de prompts de API. Haz que cada controlador de conexión realice su trabajo en la primera notificación; mueve el trabajo que requiere el gráfico importado completo a `afterConfigureGraph` o `afterLoadGraph`. + +Las entradas cuya salida de origen o slot de destino todavía no existe se reintentan mientras una pasada avanza. Esto conserva el comportamiento de las entradas dinámicas: una conexión exitosa puede crear el slot que necesita una conexión pendiente posterior. Las conexiones ya resueltas no se repiten, y una conexión rechazada por una extensión no se reintenta una vez que sus extremos están disponibles. + +Esto solo cambia la importación de prompts de API. La carga normal de flujos de trabajo sigue usando `graph.configure()` como se describe arriba, y las firmas de los callbacks de conexión no cambian. + +## Rechazar conexiones antes de que se creen + +Para rechazar una conexión, devuelve `false` desde `onConnectOutput` en el nodo fuente o `onConnectInput` en el nodo objetivo. Ambos se ejecutan antes de que el gráfico cambie algo, así que un enlace existente en la entrada objetivo se mantiene en su lugar: + +```js +nodeType.prototype.onConnectOutput = function ( + slot, + type, + input, + targetNode, + targetSlot +) { + return !shouldReject(type, targetNode) +} +``` + +No rechaces desde `onConnectionsChange`. Cuando se ejecuta, el nuevo enlace ya ha reemplazado cualquier enlace que tuviera la entrada objetivo, así que eliminar el nuevo enlace deja la entrada desconectada. + +## Quitar un enlace dentro del callback de salida omite el callback de entrada + +Conectar un enlace llama primero al `onConnectionsChange` del lado de salida y después al del lado de entrada. Si el controlador del lado de salida elimina ese mismo enlace antes de retornar, el lado de entrada recibe un callback `isConnected === false` por la eliminación, y su callback `isConnected === true` para el nuevo enlace se omite. No asumas que ambos lados siempre ven la conexión; si tu controlador vuelve a entrar en el gráfico, verifica que el enlace que recibiste siga conectado. Este es un comportamiento observado, no un contrato probado: actualmente ninguna prueba ejercita la ruta de omisión. + +## Reemplazar los eventos de slot eliminados + +`node:slot-links:changed` y `node:slot-errors:changed` se eliminaron, sin +un evento de reemplazo con el mismo nombre. Migra a: + +- `node.isInputConnected()`, `node.isOutputConnected()` o + `node.getOutputNodes()` para una lectura reactiva del estado de conectividad, o +- `onConnectionsChange` cuando necesites ejecutar código en el momento exacto en que un slot + se conecta o se desconecta. + +## Leer el estado de las conexiones desde los argumentos del callback o los métodos del nodo + +`input.link` y `output.links` están obsoletos, y las lecturas pueden desviarse del gráfico actual. Las escrituras solo eliminan enlaces: asignar `null` a `input.link` desconecta la entrada, y asignar o modificar `output.links` desconecta todos los enlaces que no estén en el nuevo arreglo. Las escrituras nunca crean enlaces; usa `node.connect()`, `node.disconnectInput()` o `node.disconnectOutput()`. Usa el argumento `link_info` que tu callback ya recibe, o los métodos de instancia de `LGraphNode` que leen directamente el almacén de enlaces: `node.isInputConnected()`, `node.getInputLink()`, `node.isOutputConnected()` y `node.getOutputNodes()`. No leas `input.link` ni `output.links`. + +Las funciones del almacén detrás de estos métodos son internas y no forman parte de la API de extensión. Usa los métodos del nodo. diff --git a/es/custom-nodes/js/javascript_about_panel_badges.mdx b/es/custom-nodes/js/javascript_about_panel_badges.mdx index 3cd405d312..669727dbb2 100644 --- a/es/custom-nodes/js/javascript_about_panel_badges.mdx +++ b/es/custom-nodes/js/javascript_about_panel_badges.mdx @@ -52,7 +52,7 @@ Los iconos de las insignias usan clases de iconos de [Lucide](https://lucide.dev El frontend genera estas clases al compilarse, así que solo están disponibles los iconos de Lucide que usa el propio frontend. Si un icono no se muestra, elige otro o define tu propia clase de icono en una hoja de estilos que cargue tu extensión. -Las clases de PrimeIcons como `pi pi-file` todavía se muestran por ahora, pero se están retirando gradualmente. No las uses en código nuevo. Consulta la [migración por la eliminación de PrimeVue](/custom-nodes/js/primevue-removal-migration). +Las clases de PrimeIcons como `pi pi-file` todavía se muestran por ahora, pero se están retirando gradualmente. No las uses en código nuevo. Consulta la [migración por la eliminación de PrimeVue](/es/custom-nodes/js/primevue-removal-migration). ## Ejemplo diff --git a/es/custom-nodes/js/javascript_selection_toolbox.mdx b/es/custom-nodes/js/javascript_selection_toolbox.mdx index 40bf097393..efcc988f32 100644 --- a/es/custom-nodes/js/javascript_selection_toolbox.mdx +++ b/es/custom-nodes/js/javascript_selection_toolbox.mdx @@ -1,5 +1,5 @@ --- -title: "Selection Toolbox" +title: "Cuadro de herramientas de selección" description: "Añade comandos de acción personalizados a Selection Toolbox de ComfyUI para nodos, grupos y elementos del lienzo seleccionados con getSelectionToolboxCommands." translationSourceHash: 333b273c translationFrom: custom-nodes/js/javascript_selection_toolbox.mdx @@ -65,7 +65,7 @@ Los botones del cuadro de herramientas de selección usan clases de iconos de [L El frontend genera estas clases al compilarse, así que solo están disponibles los iconos de Lucide que usa el propio frontend. Si un icono no se muestra, elige otro o define tu propia clase de icono en una hoja de estilos que cargue tu extensión. -Las clases de PrimeIcons (`pi pi-*`) y de Material Design Icons (`mdi mdi-*`) todavía se muestran por ahora, pero se están retirando gradualmente. No las uses en código nuevo. Consulta la [migración por la eliminación de PrimeVue](/custom-nodes/js/primevue-removal-migration). +Las clases de PrimeIcons (`pi pi-*`) y de Material Design Icons (`mdi mdi-*`) todavía se muestran por ahora, pero se están retirando gradualmente. No las uses en código nuevo. Consulta la [migración por la eliminación de PrimeVue](/es/custom-nodes/js/primevue-removal-migration). ## Visibilidad dinámica de comandos diff --git a/es/custom-nodes/js/javascript_settings.mdx b/es/custom-nodes/js/javascript_settings.mdx index 0d1b52e233..9a9ccf6d2e 100644 --- a/es/custom-nodes/js/javascript_settings.mdx +++ b/es/custom-nodes/js/javascript_settings.mdx @@ -89,7 +89,7 @@ try { ### Configuración adicional -Cada tipo de configuración muestra un componente de formulario del frontend de ComfyUI. Puedes pasar props adicionales a ese componente en un campo `attrs`. Las props que admite cada tipo se indican en su sección más abajo. +Cada tipo de configuración muestra un componente de formulario del frontend de ComfyUI. Puedes pasar props adicionales a ese componente en un campo `attrs`. Las props que admite cada tipo se indican en [Tipos](#tipos). Por ejemplo, esto limita una entrada de número a un rango y un paso: @@ -109,7 +109,7 @@ Por ejemplo, esto limita una entrada de número a un rango y un paso: }, } ``` -Si tu extensión pasaba props de PrimeVue como `showButtons`, `maxFractionDigits`, `editable` o `filter`, consulta la [migración por la eliminación de PrimeVue](/custom-nodes/js/primevue-removal-migration). El panel de configuración ya no usa componentes de PrimeVue, así que esas props no tienen efecto. +Si tu extensión pasaba props de PrimeVue como `showButtons`, `maxFractionDigits`, `editable` o `filter`, consulta la [migración por la eliminación de PrimeVue](/es/custom-nodes/js/primevue-removal-migration). El panel de configuración ya no usa componentes de PrimeVue, así que esas props no tienen efecto. ## Tipos diff --git a/es/custom-nodes/js/javascript_sidebar_tabs.mdx b/es/custom-nodes/js/javascript_sidebar_tabs.mdx index d9bbbb45cf..fed13ba704 100644 --- a/es/custom-nodes/js/javascript_sidebar_tabs.mdx +++ b/es/custom-nodes/js/javascript_sidebar_tabs.mdx @@ -52,7 +52,7 @@ Los iconos de las pestañas de la barra lateral usan clases de iconos de [Lucide El frontend genera estas clases al compilarse, así que solo están disponibles los iconos de Lucide que usa el propio frontend. Si un icono no se muestra, elige otro o define tu propia clase de icono en una hoja de estilos que cargue tu extensión. -Las clases de PrimeIcons (`pi pi-*`) y de Material Design Icons (`mdi mdi-*`) todavía se muestran por ahora, pero se están retirando gradualmente. No las uses en código nuevo. Consulta la [migración por la eliminación de PrimeVue](/custom-nodes/js/primevue-removal-migration). +Las clases de PrimeIcons (`pi pi-*`) y de Material Design Icons (`mdi mdi-*`) todavía se muestran por ahora, pero se están retirando gradualmente. No las uses en código nuevo. Consulta la [migración por la eliminación de PrimeVue](/es/custom-nodes/js/primevue-removal-migration). ## Ejemplo de pestaña con estado diff --git a/es/custom-nodes/js/link-registration-migration.mdx b/es/custom-nodes/js/link-registration-migration.mdx new file mode 100644 index 0000000000..9005509074 --- /dev/null +++ b/es/custom-nodes/js/link-registration-migration.mdx @@ -0,0 +1,30 @@ +--- +title: "Migración del registro de enlaces para extensiones del frontend" +sidebarTitle: "Migración del registro de enlaces" +description: "Cómo tratar addFloatingLink cuando devuelve undefined, las vistas graph.links respaldadas por el store y las colisiones de ID de enlace en las extensiones del frontend de ComfyUI." +translationSourceHash: 106471af +translationFrom: custom-nodes/js/link-registration-migration.mdx +--- + +`LinkNetwork.addFloatingLink(link)` ahora devuelve `LLink | undefined`. + +Para un enlace de ejecución nuevo, pasa el ID de enlace sin asignar y usa el enlace devuelto: + +```ts +const registeredLink = graph.addFloatingLink(link) +if (!registeredLink) return +``` + +El registro devuelve el enlace guardado cuando tiene éxito o cuando el mismo enlace ya está presente en el store de topología. Si otro enlace de ejecución ya posee el ID, el registro anota un error, deja el enlace entrante sin conectar y devuelve `undefined`. No sustituye en silencio el enlace activo ni le asigna otra identidad al enlace entrante. `graph.floatingLinks` sigue siendo la vista de compatibilidad filtrada para los enlaces con un solo extremo. + +`graph.links` y `graph.floatingLinks` son vistas de compatibilidad filtradas por propietario y respaldadas por el store, no almacenamiento nativo independiente de tipo `Map`. Sus métodos de lectura habituales de `Map` usan una instantánea de pertenencia en caché; obtén un iterador nuevo después de que cambie la pertenencia de la topología en lugar de conservar un iterador existente. Ambas vistas requieren una instancia activa de Pinia y ya no representan un store ausente como un grafo vacío. + +Igual que el `Map.set()` nativo, `view.set(id, link)` devuelve la vista, no un resultado de registro. El registro puede rechazar una colisión de ID o de destino conservando el enlace existente, así que las extensiones que insertan a través de una vista deben confirmar el éxito con `view.get(link.id) === link`. Tras una colisión de ID con un enlace de la misma vista, `has()` devuelve `true` y `get()` devuelve el enlace existente. Prefiere las API de conexión de grafo y de enlace flotante cuando cubran la operación, porque esas API coordinan el ciclo de vida que la rodea. No invoques métodos de `Map.prototype` directamente sobre ninguna de las dos vistas ni dependas del almacenamiento interno nativo de `Map`. + +La sustitución de una entrada confirma el enlace nuevo antes de las devoluciones de llamada de desconexión del enlace antiguo, así que las consultas de las devoluciones de llamada ven el enlace de reemplazo en lugar de una entrada vacía. Después siguen las devoluciones de llamada de conexión habituales. + +Las extensiones que antes ignoraban el valor devuelto deben tratar `undefined` antes de conservar, renderizar o modificar el enlace entrante. No preselecciones un ID de enlace positivo para un enlace de ejecución nuevo; deja que el grafo lo genere. + +La reparación de colisiones de ID persistidos corresponde a la importación y deserialización de flujos de trabajo. Las extensiones que importan topología serializada deben normalizar los ID en conflicto en ese límite antes de usar la API de registro en ejecución. + +Construir un `LGraph` raíz, o configurar uno a partir de datos serializados, requiere una instancia activa de Pinia, porque la topología del grafo se respalda en el store durante todo su ciclo de vida. diff --git a/es/custom-nodes/js/node-geometry-migration.mdx b/es/custom-nodes/js/node-geometry-migration.mdx new file mode 100644 index 0000000000..139c53d2da --- /dev/null +++ b/es/custom-nodes/js/node-geometry-migration.mdx @@ -0,0 +1,85 @@ +--- +title: "Migración de geometría de nodos para extensiones del frontend" +sidebarTitle: "Migración de geometría de nodos" +description: "Tamaño del nodo vs. límites renderizados, renombrado de applyNodePositions y z-order en extensiones del frontend de ComfyUI tras cambiar el layout store." +translationSourceHash: 833ab6fb +translationFrom: custom-nodes/js/node-geometry-migration.mdx +translationBlockHashes: + "Migration checklist": a95abc11 + "What changed": f4ee15bc + "Writes through removed references stay local": ba9b1003 +--- +## Lista de verificación de la migración + +1. Sigue usando `node.pos`, `node.size`, `boundingRect`, `getBounding()`, `setPos()`, `setSize()`: no se requieren cambios en las firmas. +2. Sustituye las llamadas a `repositionNodesVueMode()` por `applyNodePositions()`. +3. Si dependías de que `node.size` reflejara el contenido medido/renderizado, cambia a `getBounding()` / `boundingRect`. Con el renderizador de Vue, `size` ahora refleja estrictamente el valor solicitado. El renderizador clásico sigue aumentando `size` para ajustarse a los widgets. +4. Usa las APIs de geometría de nodos y grupos, no el almacén de respaldo; no importes `layoutStore` ni dependas de su formato interno. +5. Las escrituras mediante una referencia eliminada actualizan el objeto desvinculado, no el estado de diseño compartido. + +## Qué cambió + +`LGraphNode.pos`, `size`, `boundingRect`, `getBounding()`, `setPos()` y +`setSize()` conservan las mismas firmas. Estas llamadas siguen siendo +compatibles a nivel de código fuente. El comportamiento cambió en los tres +casos siguientes. + +```ts +node.pos = [100, 200] +node.pos[0] += 50 +node.setSize([320, 200]) +node.updateArea() +const box = node.getBounding() +``` + +La geometría de nodos y grupos ahora reside en un almacén de diseño compartido +en lugar de en campos por instancia. Usa las APIs anteriores, no el almacén +directamente: es un detalle de implementación interno. + +### `size` frente a los límites renderizados + +`node.size` es el tamaño que solicitaste y el que se serializa. Con el +renderizador Vue, el renderizado nunca lo cambia. `getBounding()` y +`boundingRect` devuelven los límites renderizados, que pueden ser mayores que +`size` cuando el contenido del widget necesita más espacio. Con el renderizador +de lienzo clásico, el nodo todavía crece para ajustarse a sus widgets llamando a +`setSize()`, por lo que `node.size` y el tamaño guardado pueden cambiar después +de un dibujo. Usa los límites renderizados cuando necesites la huella real del +nodo en pantalla. + +El lienzo recalcula `getBounding()` y `boundingRect` al inicio de cada +fotograma. Después de cambiar `pos` o `size`, llama a `node.updateArea()` antes +de leerlos en el mismo fotograma. Con el renderizador Vue, el crecimiento por +contenido DOM solo aparece después de medir el nodo. + +```ts +// Antes: un cambio de tamaño por contenido renderizado podía sobrescribir size, +// por lo que contraer un nodo y volver a expandirlo hacía perder el tamaño original. +node.size // podía convertirse silenciosamente en la huella renderizada + +// Después (renderizador Vue): size se mantiene como lo estableciste; solicita los límites renderizados explícitamente. +node.size // el tamaño solicitado, sin cambios por el renderizado +node.getBounding() // los límites renderizados reales, pueden ser mayores +``` + +### `repositionNodesVueMode()` pasa a llamarse `applyNodePositions()` + +```ts +// Antes +canvas.repositionNodesVueMode(newPositions) +// Después +canvas.applyNodePositions(newPositions) +``` + +`repositionNodesVueMode()` sigue siendo invocable como alias obsoleto. + +### El orden Z ahora no es ambiguo + +El orden Z solía provenir de dos fuentes que podían discrepar: la posición de un +nodo en la lista de nodos y su orden de ejecución. Ahora siempre es el orden de +dibujo. Si tu extensión infería el orden de apilamiento o de hit-test a partir +del orden de ejecución, cambia al orden de dibujo. + +## Las escrituras mediante referencias eliminadas permanecen locales + +Después de la eliminación, las funciones de establecimiento de geometría actualizan solo el nodo, grupo u objeto de Reroute desconectado. No actualizan el estado de diseño compartido ni otra entidad que ahora posea el mismo ID. diff --git a/es/custom-nodes/js/node-id-migration.mdx b/es/custom-nodes/js/node-id-migration.mdx new file mode 100644 index 0000000000..e7a79b6826 --- /dev/null +++ b/es/custom-nodes/js/node-id-migration.mdx @@ -0,0 +1,24 @@ +--- +title: "Migración de ID de nodo para extensiones del frontend" +sidebarTitle: "Migración de ID de nodo" +description: "Migra extensiones del frontend de ComfyUI a ID de nodo de cadena con marca y a los centinelas de límite de subgrafo SUBGRAPH_INPUT_ID y SUBGRAPH_OUTPUT_ID." +translationSourceHash: 168947f8 +translationFrom: custom-nodes/js/node-id-migration.mdx +--- + +El frontend de ComfyUI ahora normaliza los ID de nodo locales al tipo de cadena +con marca `NodeId` en los límites internos. Los flujos de trabajo serializados y +las cargas útiles de la API todavía pueden contener ID numéricos, pero los ID de +nodo en litegraph, como `node.id`, `LLink.origin_id` y `LLink.target_id`, deben +tratarse como cadenas después de entrar al frontend. Los ID de enlace +(`LLink.id`) y los ID de reenrutamiento siguen siendo números. + +Quienes escriben extensiones deben evitar las comparaciones numéricas con los ID +de nodo. En particular, los centinelas de límite de subgrafo se exponen como ID +de cadena con marca: + +- `SUBGRAPH_INPUT_ID` se serializa a partir de `-10` +- `SUBGRAPH_OUTPUT_ID` se serializa a partir de `-20` + +Compara con las cadenas `'-10'` y `'-20'`, o normaliza ambos lados a cadenas +antes de comparar valores clásicos. \ No newline at end of file diff --git a/es/custom-nodes/js/primevue-removal-migration.mdx b/es/custom-nodes/js/primevue-removal-migration.mdx new file mode 100644 index 0000000000..e56e08820d --- /dev/null +++ b/es/custom-nodes/js/primevue-removal-migration.mdx @@ -0,0 +1,67 @@ +--- +title: "Migración tras eliminar PrimeVue en extensiones del frontend" +sidebarTitle: "Migración tras eliminar PrimeVue" +description: "Reemplaza $primevue, componentes de PrimeVue, variables CSS --p-* y selectores de tooltip tras retirar PrimeVue del frontend de ComfyUI." +translationSourceHash: ca5e48dd +translationFrom: custom-nodes/js/primevue-removal-migration.mdx +translationBlockHashes: + "_intro": 5bd8432b + "Extensions that render PrimeVue components": e2b1c44c + "Extensions that read `--p-*` variables": d45a77c2 + "Tooltips": 5252984f + "Deprecated variable names": df1d5960 +--- +El frontend de ComfyUI ya no instala PrimeVue. La aplicación host no llama a +`app.use(PrimeVue)`, así que las extensiones pierden tres cosas en las que podrían haberse apoyado: + +- la propiedad global `$primevue` en la aplicación Vue host; +- la hoja de estilos del tema de PrimeVue, por lo que los componentes de PrimeVue que una extensión + renderiza dentro de la aplicación host se muestran sin estilos; y +- todas las variables CSS globales `--p-*`, como `--p-primary-color`, + `--p-surface-*`, `--p-text-color`, `--p-content-background` y + `--p-form-field-border-color`. + +## Extensiones que renderizan componentes de PrimeVue + +No dependas de la instancia de PrimeVue de la aplicación anfitriona. Reemplaza los componentes de PrimeVue con tu propio marcado, o crea tu propia aplicación Vue para tu UI e instala PrimeVue y su tema en esa aplicación. + +## Extensiones que leen variables `--p-*` + +Reemplázalas con las variables de tema del sistema de diseño, que siguen el tema +claro u oscuro activo y la paleta de colores activa: + +| Variable de PrimeVue | Variable de tema | +| --------------------------------------------------------- | -------------------- | +| `--p-primary-color` | `--primary` | +| `--p-text-color` | `--foreground` | +| `--p-text-muted-color` | `--muted-foreground` | +| `--p-content-background` | `--background` | +| `--p-surface-*` (paneles, áreas elevadas) | `--secondary` | +| `--p-content-border-color`, `--p-form-field-border-color` | `--border` | + +## Información sobre herramientas + +La directiva global `v-tooltip` ya no existe, y la información sobre herramientas ya no renderiza el DOM de PrimeVue: + +- `.p-tooltip` y `.p-tooltip-text` +- el atributo `data-pd-tooltip` +- las propiedades de elemento `$_ptooltip*` + +Ahora, una información sobre herramientas abierta renderiza un solo elemento con `data-slot="tooltip-content"`, colocado en un portal al final de `document.body`. Solo existe mientras la información sobre herramientas está abierta. Las extensiones que oculten la información sobre herramientas durante su propia UI deben apuntar a `[data-slot="tooltip-content"]` en lugar de `.p-tooltip`. + +Las variables CSS `--node-component-tooltip*` también se eliminaron de la hoja de estilos del sistema de diseño. En su lugar, usa las variables del tema: `--background`, `--foreground` y `--border`. Los nombres anteriores `--base-background`, `--base-foreground` y `--border-default` están obsoletos; consulta [Nombres de variables obsoletos](#nombres-de-variables-obsoletos). + +## Nombres de variables obsoletos + +Versiones anteriores de estas notas apuntaban a nombres antiguos del sistema de diseño. Todavía se resuelven, pero están obsoletos y se eliminarán en una versión futura. Cambia ahora a la variable de tema: + +| Nombre obsoleto | Variable de tema | +| ----------------------------- | ---------------- | +| `--base-background` | `--background` | +| `--base-foreground` | `--foreground` | +| `--border-default` | `--border` | +| `--primary-background` | `--primary` | +| `--secondary-background` | `--secondary` | +| `--component-node-background` | `--node` | + +PrimeIcons todavía se carga, así que las clases de icono `pi pi-*` existentes siguen funcionando, pero se están retirando gradualmente. No agregues nuevos usos. diff --git a/es/custom-nodes/js/serialization-callbacks-migration.mdx b/es/custom-nodes/js/serialization-callbacks-migration.mdx new file mode 100644 index 0000000000..ed5d748b50 --- /dev/null +++ b/es/custom-nodes/js/serialization-callbacks-migration.mdx @@ -0,0 +1,50 @@ +--- +title: "Migración de callbacks de serialización para extensiones del frontend" +sidebarTitle: "Migración de callbacks de serialización" +description: "Cómo funcionan onSerialize y onConfigure con grafos basados en store y dónde deben guardar datos personalizados las extensiones del frontend de ComfyUI." +translationSourceHash: de116a13 +translationFrom: custom-nodes/js/serialization-callbacks-migration.mdx +translationBlockHashes: + "_intro": 87be7894 + "Store custom data in properties or extra": 9bd7e443 + "Serialize nodes instead of enumerating properties": f9850471 +--- + +Configurar un `LGraph` raíz a partir de datos serializados ahora requiere una instancia de Pinia activa. `LGraph.configure()` vacía y reconstruye el grafo directamente sobre los almacenes ECS, así que un arnés de pruebas, un worker o un consumidor de LiteGraph independiente que llame a `new LGraph(data)` o `graph.configure(data)` sin una Pinia activa ahora falla de forma directa en lugar de producir en silencio un grafo vacío. Es el mismo requisito que se documenta en [Migración del registro de enlaces](/es/custom-nodes/js/link-registration-migration). + +Las extensiones que se ejecutan en ComfyUI usan la instancia de Pinia activa de la aplicación. No crees ni actives una instancia de Pinia aparte desde el código de la extensión. + +`node.onConfigure`, `node.onSerialize`, `graph.onConfigure` y `graph.onSerialize` conservan sus firmas y su orden de ejecución actuales. Para los hooks de temporización de conexiones, consulta [Migración de callbacks de conexión](/es/custom-nodes/js/connection-callbacks-migration); para `node.widgets` y el almacenamiento de valores de widgets, consulta [Migración del sistema de widgets](/es/custom-nodes/js/widgets-migration). + +`onConfigure` ahora recibe una copia superficial de los datos serializados en lugar del objeto propio de quien llama. Añadir, eliminar o reasignar claves de nivel superior en el argumento del callback no cambia el JSON del flujo de trabajo de quien llama y no se persiste. Los objetos anidados (por ejemplo `inputs`, `pos`, `properties`) se siguen compartiendo con quien llama, así que mutarlos en el lugar todavía se filtra; las extensiones que dependían de cualquiera de los dos tipos de mutación deben guardar su estado propio en `node.properties` o `graph.extra`. + +## Guardar datos propios en properties o extra + +Usa `node.properties` para los datos de extensión por nodo y `graph.extra` para los datos de extensión por grafo. Siguen siendo las superficies de extensión estables y previstas para los datos persistidos. + +`onSerialize` y `onConfigure` se llaman con `this` vinculado al objeto vivo del nodo o del grafo; el argumento que recibe la devolución de llamada es el objeto de datos serializado (`ISerialisedNode`/`ISerialisedGraph`), no el nodo ni el grafo vivos. Como `this` sigue siendo el objeto vivo, un hook puede modificar cualquier campo suyo, incluidos los campos que ahora se respaldan en el store. No uses estos hooks para sobrescribir campos centrales: una escritura mediante `this` desde dentro de `onSerialize`/`onConfigure` llega directamente al store, sin esquema, propiedad ni límite de deshacer propios. + +`onSerialize` se ejecuta después de que el frontend haya copiado `graph.extra` y `node.properties` en el objeto de datos, así que una clave que el hook añada a `this.extra` o `this.properties` falta en este guardado. Dentro de `onSerialize`, escribe en el argumento de la devolución de llamada: `data.extra` para un grafo y `data.properties` para un nodo. De lo contrario, actualiza `graph.extra` o `node.properties` antes de que empiece la serialización. + +`onSerialize` admite una sola devolución de llamada, así que conserva cualquier hook que ya haya instalado otra extensión: + +```js +const previous = graph.onSerialize +graph.onSerialize = function (data) { + previous?.call(this, data) + data.extra.myExtension = { version: 1 } +} +``` + +Solo el grafo raíz ejecuta `onSerialize`. Las definiciones de subgrafo se guardan sin llamar a ningún hook en el subgrafo, así que guarda los datos del subgrafo en `subgraph.extra` antes de guardar el flujo de trabajo. + +Una clave personalizada de nivel superior que un hook añada a `data` permanece en el nivel superior en `LGraph.asSerialisable()`. El punto de entrada heredado `LGraph.serialize()` la mueve a `data.extensions` y deja fuera los valores que no son compatibles con JSON. Al cargar el flujo de trabajo, `onConfigure` vuelve a recibir la clave en el nivel superior. Las claves dentro de `extra` conservan su lugar en ambos puntos de entrada. + +## Serializar nodos en lugar de enumerar propiedades {#serialize-nodes-instead-of-enumerating-properties} + +Si tu extensión crea una representación serializada o de depuración de un nodo enumerando sus propias propiedades, cámbiala a `node.serialize()`. + +`id`, `type`, `title`, `flags`, `mode`, `color`, `bgcolor`, `shape` y `showAdvanced` ahora son propiedades de acceso sobre el almacén de datos del nodo en lugar de propiedades de datos propias en la instancia del nodo. `Object.keys(node)`, `for...in` y `{ ...node }` ya no exponen estos campos, aunque las lecturas y escrituras directas (`node.title`, `node.mode = ...`) siguen funcionando sin cambios. `inputs`, `outputs` y `widgets` siguen siendo enumerables como propiedades propias, así que la propagación y la enumeración todavía detectan esos tres. + +Para `serializeValue` a nivel de widget, una capa de serialización independiente que construye el payload del prompt de la API, no el JSON del flujo de trabajo, consulta +[Migración del sistema de widgets](/es/custom-nodes/js/widgets-migration). diff --git a/es/custom-nodes/js/widgets-migration.mdx b/es/custom-nodes/js/widgets-migration.mdx new file mode 100644 index 0000000000..035480b1db --- /dev/null +++ b/es/custom-nodes/js/widgets-migration.mdx @@ -0,0 +1,100 @@ +--- +title: "Migración del sistema de widgets para extensiones del frontend" +sidebarTitle: "Migración del sistema de widgets" +description: "Valores de widgets respaldados por el store en el frontend de ComfyUI: nombres únicos, node.widgets indefinido, renombres, addCustomWidget y setValue de Agent." +translationSourceHash: 3011c9c5 +translationFrom: custom-nodes/js/widgets-migration.mdx +translationBlockHashes: + "_intro": 87b853c9 + "Gallery values after the PrimeVue replacement": c6a755f6 + "Widget names must be unique and stable": 5988a23b + "`node.widgets` may be undefined": 7cb43a39 + "Prefer `node.addCustomWidget()` to pushing onto `node.widgets`": 5ee6030c + "Remove widgets with `node.removeWidget()`": 7d19ff02 + "Agent edits call `setValue` without a pointer event": 140c58f6 + "Don't call `useWidgetValueStore()` from extension code": 6c2a5cd3 +--- +Los valores de los widgets ahora viven en un store respaldado por Pinia en lugar de estar directamente en la instancia del widget. Los nombres de los widgets deben ser únicos por nodo, y cambiar el nombre de un widget solo funciona cuando el nuevo nombre está disponible. `node.widgets` también puede ser `undefined` hasta que se le asigne por primera vez. + +## Valores de galería después del reemplazo de PrimeVue + +El widget `galleria` de Vue acepta un arreglo de cadenas de URL de imágenes, que coincide con el esquema de entrada `GALLERIA`. Con varias imágenes se muestran miniaturas y botones de anterior/siguiente. La navegación se detiene en la primera y la última imagen. + +Los objetos de imagen de PrimeVue con `itemImageSrc` o `thumbnailImageSrc` ya no son compatibles. Conviértelos a cadenas de URL. El widget ya no lee opciones de PrimeVue como `showThumbnails`, `showItemNavigators`, `circular`, `autoPlay`, `transitionInterval`, `showIndicators`, `numVisible` o `responsiveOptions`. Las extensiones que necesiten estos controles deben proporcionar su propio widget de galería. + +## Los nombres de los widgets deben ser únicos y estables + +Dos widgets en el mismo nodo no pueden compartir un nombre. Si agregas un segundo widget con un nombre que ya está en uso, el frontend renombra el nuevo widget con un sufijo numerado, como `strength#1`, cuando el nodo está en un gráfico. Una búsqueda por el nombre original encuentra solo el primer widget: + +```js +node.addWidget('number', 'strength', 0, () => {}) +const second = node.addWidget('number', 'strength', 1, () => {}) +second.name // 'strength#1' una vez que el nodo está en un gráfico +``` + +Asigna a cada widget un nombre único. + +Asignar un nuevo `widget.name` a un widget registrado mueve su valor almacenado al nuevo nombre. Si otro widget del nodo ya usa ese nombre, la asignación se ignora y `widget.name` conserva su valor anterior, así que verifica `widget.name` después. Las ranuras de entrada que hacen referencia al widget por su nombre no se actualizan. No elimines un widget y agregues uno nuevo para renombrarlo: `removeWidget()` elimina el valor almacenado y borra las ranuras de entrada vinculadas directamente al widget. Las ranuras de entrada que solo hacen referencia a él por nombre conservan ese nombre. + +## `node.widgets` puede ser undefined + +`node.widgets` devuelve `undefined` hasta que se le asigna un valor al menos una vez. +Inicializa el array antes de agregar widgets: + +```ts +export function nodeCreated(node: LGraphNode) { + node.widgets ??= [] + node.widgets.push(myWidget) +} +``` + +La lectura con una guarda se hace de la misma forma: + +```ts +const widgetCount = node.widgets?.length ?? 0 +``` + +**Asignar `node.widgets = undefined` lo borra.** Una lectura posterior devuelve +`undefined` de nuevo, no `[]`. + +**Las modificaciones hechas antes de que el nodo se conecte a un gráfico se detectan +automáticamente.** No necesitas llamar nada por tu cuenta en el caso habitual +de crear widgets en un constructor o en `onNodeCreated`. + +`node.widgets` aparece en `Object.keys(node)` y en las expansiones de objeto como +`{...node}`. + +## Prefiere `node.addCustomWidget()` a empujar sobre `node.widgets` + +Los widgets añadidos con `node.addWidget()`, `node.addCustomWidget()` o `node.addDOMWidget()` se registran automáticamente en el store. Un objeto plano empujado directamente sobre `node.widgets` también se convierte en una instancia de widget y se registra en cuanto el nodo está en un grafo. La conversión suele ocurrir en el mismo objeto, pero un objeto congelado o con propiedades no configurables se sustituye por otro widget distinto, así que conserva el widget que devuelve `addCustomWidget()` o vuelve a leerlo desde `node.widgets`. Aun así, `addCustomWidget()` es la llamada recomendada: devuelve el widget y restaura el valor guardado del widget cuando se carga un flujo de trabajo. + +```js +node.addCustomWidget({ + name: 'my_widget', + type: 'custom', + value: '', + options: {}, + draw(ctx, node, width, y, height) {}, + mouse(event, pos, node) {} +}) +``` + +Si lees o escribes `widget.value` antes de que el nodo esté conectado a un grafo, el valor se mantiene localmente y se sincroniza con el store al conectarlo. No se pierde ningún valor, pero la interfaz guiada por el store (como el panel derecho) no verá el valor hasta entonces. + +## Eliminar widgets con `node.removeWidget()` + +Usa `node.removeWidget(widget)` para eliminar un widget. Si haces splice directamente sobre `node.widgets`, omites la limpieza de los slots y el valor del widget eliminado permanece en el store hasta que el nodo se elimina del gráfico. + +## Las ediciones del Agent llaman a `setValue` sin evento de puntero + +Cuando el Agent integrado cambia un widget que es una instancia de `BaseWidget`, el frontend llama a `widget.setValue(value, { node, canvas })`, el mismo método que usa una edición del usuario. Antes asignaba `widget.value` directamente y luego llamaba a `callback` y a `onWidgetChanged` por su cuenta. Esto incluye los objetos planos añadidos con `addCustomWidget()` o empujados sobre `node.widgets`, porque el frontend los convierte en instancias de `BaseWidget`. Los controladores de recuento de filas de DynamicGroup y los widgets promocionados del host del subgrafo siguen recibiendo la escritura directa. + +Si sobrescribes `setValue`, acepta opciones con la forma `{ node, e?, canvas? }`: en estas llamadas `e` nunca se establece y `canvas` también puede faltar. No leas `options.e` ni `options.canvas` sin comprobarlos antes. Un envoltorio que llama al `setValue` original solo con el valor sigue funcionando: las opciones toman por defecto `{ node: widget.node }`. + +`callback` y `onWidgetChanged` reciben ahora el valor que aceptó el widget, no el que envió el Agent. Un widget numérico limita el valor a `min`/`max` y convierte una cadena numérica en número. En `callback`, `e` es `undefined`, y `pos` también cuando no hay lienzo. + +`setValue` regresa sin cambios cuando el valor, después de que un widget numérico lo limite y lo convierta, ya es idéntico (`===`) al valor actual, así que `'5'` en un widget numérico con valor `5` no cambia nada. También regresa cuando un widget numérico recibe un valor para el que `Number(value)` es `NaN`. No se dispara `callback` ni `onWidgetChanged`, y la versión del grafo no cambia. Una cadena numérica como `'7'` se convierte y se aplica. + +## No llames a `useWidgetValueStore()` desde el código de la extensión + +No llames a `useWidgetValueStore()` desde las extensiones. En su lugar, usa `node.widgets`, `node.addWidget()` / `addCustomWidget()` / `removeWidget()` y `widget.value`. La gestión interna de claves del store y su dependencia de Pinia no son una superficie de extensión compatible. diff --git a/es/custom-nodes/v3_migration.mdx b/es/custom-nodes/v3_migration.mdx index b218e20e86..62ac21ec3e 100644 --- a/es/custom-nodes/v3_migration.mdx +++ b/es/custom-nodes/v3_migration.mdx @@ -1,10 +1,12 @@ --- title: "Migración a V3" description: "Cómo migrar tus nodos V1 existentes al nuevo esquema V3." -translationSourceHash: 0a3a0a17 +translationSourceHash: ef191ae4 translationFrom: custom-nodes/v3_migration.mdx translationBlockHashes: "Overview": 109e87b3 + "Core Concepts": 85282582 + "Migration Steps": 7840c755 --- ## Descripción general diff --git a/es/development/comfy-router/models.mdx b/es/development/comfy-router/models.mdx index 96b3123784..932c53a9e1 100644 --- a/es/development/comfy-router/models.mdx +++ b/es/development/comfy-router/models.mdx @@ -2,11 +2,11 @@ title: "Modelos de Comfy Router" sidebarTitle: "Todos los modelos" description: "Todos los modelos disponibles en Comfy Router, agrupados por proveedor, con su modalidad de entrada y salida." -translationSourceHash: d2265d41 +translationSourceHash: d299c0f0 translationFrom: development/comfy-router/models.mdx translationBlockHashes: "_intro": 2584e428 - "Find by output": 9b1b4039 + "Find by output": 5ddf7991 "Anthropic": de8acc20 "Beeble": b52ea340 "Black Forest Labs": 2934e3eb @@ -28,9 +28,9 @@ translationBlockHashes: "Meshy": 67e26a17 "MiniMax": 87560ab7 "Moonvalley": 9e63fb77 - "OpenAI": a5c1e692 + "OpenAI": 5bbf3b2c "Openrouter": a4f6806b - "Pika": f2b1d797 + "Pika": 8b17ff30 "Pruna": 903d76ee "Qwen": b3ef78a1 "Recraft": 02b7d9cd @@ -44,6 +44,7 @@ translationBlockHashes: "xAI": e1706271 --- + {/* ARCHIVO GENERADO. Generado a partir del catálogo del Router por `pnpm code-pages:gen`. */} Todos los modelos que aparecen a continuación se sirven por la misma ruta, `POST /v2/models/{provider}/{model}`, con el cuerpo JSON propio del modelo. Cada página muestra una solicitud funcional en Python, TypeScript y cURL. Para descubrimiento, esquemas, errores, reintentos y facturación, consulta [Usar la API de Comfy Router](/es/development/comfy-router/api). @@ -53,7 +54,7 @@ Algunos de estos modelos también los puede servir un agregador en la misma ruta ## Buscar por salida - + - [SwitchX](/es/development/comfy-router/models/beeble/switchx/code): `beeble/switchx` - [FLUX 3 Video](/es/development/comfy-router/models/black-forest-labs/flux-3-video/code): `bfl/flux-3-video` @@ -95,6 +96,7 @@ Algunos de estos modelos también los puede servir un agregador en la misma ruta - [Video To Video](/es/development/comfy-router/models/moonvalley/video-to-video/code): `moonvalley/video-to-video` - [Pika 2.5 Image To Video](/es/development/comfy-router/models/pika/pika-2-5-image-to-video/code): `pika/pika-2.5-image-to-video` - [Pika 2.5 Text To Video](/es/development/comfy-router/models/pika/pika-2-5-text-to-video/code): `pika/pika-2.5-text-to-video` +- [Pika Soundtrack](/es/development/comfy-router/models/pika/pika-soundtrack/code): `pika/pika-soundtrack` - [P Video 2](/es/development/comfy-router/models/pruna/p-video-2/code): `pruna/p-video-2` - [Aleph 2](/es/development/comfy-router/models/runway/aleph2/code): `runway/aleph2` - [Gen 4 Turbo](/es/development/comfy-router/models/runway/gen4-turbo/code): `runway/gen4_turbo` @@ -228,7 +230,7 @@ Algunos de estos modelos también los puede servir un agregador en la misma ruta - [Grok Imagine Image](/es/development/comfy-router/models/xai/grok-imagine-image/code): `xai/grok-imagine-image` - + - [FLUX 3 Video](/es/development/comfy-router/models/black-forest-labs/flux-3-video/code): `bfl/flux-3-video` - [Dreamina Seedance 2.0 260128](/es/development/comfy-router/models/byteplus/dreamina-seedance-2-0-260128/code): `byteplus/dreamina-seedance-2-0-260128` @@ -254,6 +256,9 @@ Algunos de estos modelos también los puede servir un agregador en la misma ruta - [LTX 2.5 Fast](/es/development/comfy-router/models/ltx/ltx-2-5-fast/code): `ltx/ltx-2-5-fast` - [LTX 2.5 Pro](/es/development/comfy-router/models/ltx/ltx-2-5-pro/code): `ltx/ltx-2-5-pro` - [MiniMax H3](/es/development/comfy-router/models/minimax/minimax-h3/code): `minimax/minimax-h3` +- [Pika Music](/es/development/comfy-router/models/pika/pika-music/code): `pika/pika-music` +- [Pika Sfx](/es/development/comfy-router/models/pika/pika-sfx/code): `pika/pika-sfx` +- [Pika Soundtrack](/es/development/comfy-router/models/pika/pika-soundtrack/code): `pika/pika-soundtrack` - [P Video 2](/es/development/comfy-router/models/pruna/p-video-2/code): `pruna/p-video-2` - [Clean Audio Video](/es/development/comfy-router/models/veed/clean-audio-video/code): `veed/clean-audio-video` - [Clean Audio](/es/development/comfy-router/models/veed/clean-audio/code): `veed/clean-audio` @@ -287,7 +292,7 @@ Algunos de estos modelos también los puede servir un agregador en la misma ruta - [Hunyuan 3D Uv](/es/development/comfy-router/models/tencent/hunyuan-3d-uv/code): `tencent/hunyuan-3d-uv` - + - [Claude Fable 5.1](/es/development/comfy-router/models/anthropic/claude-fable-5-1/code): `anthropic/claude-fable-5-1` - [Claude Fable 5](/es/development/comfy-router/models/anthropic/claude-fable-5/code): `anthropic/claude-fable-5` @@ -326,6 +331,8 @@ Algunos de estos modelos también los puede servir un agregador en la misma ruta - [GPT 5 Mini](/es/development/comfy-router/models/openai/gpt-5-mini/code): `openai/gpt-5-mini` - [GPT 5 Nano](/es/development/comfy-router/models/openai/gpt-5-nano/code): `openai/gpt-5-nano` - [GPT 5](/es/development/comfy-router/models/openai/gpt-5/code): `openai/gpt-5` +- [GPT 6.1 Sol](/es/development/comfy-router/models/openai/gpt-6-1-sol/code): `openai/gpt-6.1-sol` +- [GPT 6.1 Terra](/es/development/comfy-router/models/openai/gpt-6-1-terra/code): `openai/gpt-6.1-terra` - [GPT 6 Astra](/es/development/comfy-router/models/openai/gpt-6-astra/code): `openai/gpt-6-astra` - [GPT 6 Luna](/es/development/comfy-router/models/openai/gpt-6-luna/code): `openai/gpt-6-luna` - [GPT 6 Sol](/es/development/comfy-router/models/openai/gpt-6-sol/code): `openai/gpt-6-sol` @@ -585,6 +592,8 @@ Algunos de estos modelos también los puede servir un agregador en la misma ruta | [GPT 5 Mini](/es/development/comfy-router/models/openai/gpt-5-mini/code) | `openai/gpt-5-mini` | Texto, Imagen | Texto | | [GPT 5 Nano](/es/development/comfy-router/models/openai/gpt-5-nano/code) | `openai/gpt-5-nano` | Texto, Imagen | Texto | | [GPT 5](/es/development/comfy-router/models/openai/gpt-5/code) | `openai/gpt-5` | Texto, Imagen | Texto | +| [GPT 6.1 Sol](/es/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | Texto, Imagen | Texto | +| [GPT 6.1 Terra](/es/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | Texto, Imagen | Texto | | [GPT 6 Astra](/es/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | Texto, Imagen | Texto | | [GPT 6 Luna](/es/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | Texto, Imagen | Texto | | [GPT 6 Sol](/es/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | Texto, Imagen | Texto | @@ -606,6 +615,9 @@ Algunos de estos modelos también los puede servir un agregador en la misma ruta | --- | --- | --- | --- | | [Pika 2.5 Image To Video](/es/development/comfy-router/models/pika/pika-2-5-image-to-video/code) | `pika/pika-2.5-image-to-video` | Texto, Imagen | Video | | [Pika 2.5 Text To Video](/es/development/comfy-router/models/pika/pika-2-5-text-to-video/code) | `pika/pika-2.5-text-to-video` | Texto | Video | +| [Pika Music](/es/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | Texto, Audio | Audio | +| [Pika Sfx](/es/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | Texto | Audio | +| [Pika Soundtrack](/es/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Video, Texto | Video + Audio | ## Pruna diff --git a/es/development/comfy-router/models/luma/ray-2/code.mdx b/es/development/comfy-router/models/luma/ray-2/code.mdx deleted file mode 100644 index 3e92d377eb..0000000000 --- a/es/development/comfy-router/models/luma/ray-2/code.mdx +++ /dev/null @@ -1,296 +0,0 @@ ---- -title: "Usa Ray 2 con Comfy Router" -description: "Llama a luma/ray-2 mediante Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." -sidebarTitle: "Ray 2" -translationSourceHash: 05a55db0 -translationFrom: development/comfy-router/models/luma/ray-2/code.mdx -translationBlockHashes: - "_intro": 76eb0c5f - "Quick start": 6f46e102 - "Schema": ea1f7cdb - "Examples": 3993fae3 ---- -{/* GENERATED FILE. Generated from router-schemas/luma/ray-2.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; - -Referencia de API para `luma/ray-2`, servida por Comfy Router desde Luma. - -**Entrada:** Texto, Imagen · **Salida:** Video - -## Inicio rápido - -Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada sobre HTTP sin procesar. - -**ID del modelo:** `luma/ray-2` - -**Endpoint:** `POST https://api.comfy.org/v2/models/luma/ray-2` - - - - -```python Python -from comfy_sdk import Comfy - -# Lee COMFY_API_KEY del entorno. -# El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -with Comfy() as client: - result = client.models.run( - "luma/ray-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY del entorno. -// El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -const { data } = await comfy.models.run("luma/ray-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/luma/ray-2 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" -``` - - - -El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/luma/ray-2/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recoge cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida del resultado. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# Lee COMFY_API_KEY del entorno. -# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "luma/ray-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que necesita otro proceso - - # Sondea hasta que la solicitud se completa, esperando el Retry-After que indica el servidor. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # La carga propia del proveedor, el mismo valor que devuelve models.run(). - # Una solicitud que falló o se canceló genera aquí el error tipado de Router. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY del entorno. -// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -const handle = await comfy.models.submit("luma/ray-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); -console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que necesita otro proceso - -// Sondea hasta que la solicitud se completa, esperando el Retry-After que indica el servidor. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. -curl https://api.comfy.org/v2/models/luma/ray-2/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" - -# 2. Sondea hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/luma/ray-2/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. -curl https://api.comfy.org/v2/models/luma/ray-2/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Esquema - -### Entrada - - - La relación de aspecto de la generación - - Valores posibles: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `21:9`, `9:21` - - - - La URL de callback de la generación; se enviará una solicitud POST con el objeto Generation a la URL de callback cuando la generación esté en curso, completada o fallida - - Formato: `uri` - - - - - - - - Valores posibles: `video` - - - - Los fotogramas clave de la generación - - - - Un fotograma clave puede ser una referencia a Generation, una Image o un Video - - - - Un fotograma clave puede ser una referencia a Generation, una Image o un Video - - - - Si se repite el video en bucle - - - - El modelo de video usado para la generación. En la ruta `POST /v2/models/luma/{model}` de Comfy Router este campo se toma de la ruta y NO DEBE enviarse; en la ruta v1 `POST /proxy/luma/generations` es requerido y está restringido al enum LumaVideoModel (`ray-2`, `ray-flash-2`). - - - - El prompt de la generación - - - - - - -Generado a partir del esquema que Router sirve en `GET /v2/models/luma/ray-2/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor. - -### Salida - - - Los recursos de la generación - - - - La URL de la imagen - - Formato: `uri` - - - - La URL del video de progreso - - Formato: `uri` - - - - La URL del video - - Formato: `uri` - - - - La fecha y hora en que se creó la generación - - Formato: `date-time` - - - - El motivo del estado de la generación - - - - Valores posibles: `video`, `image` - - - - El ID de la generación - - Formato: `uuid` - - - - El modelo usado para la generación - - - - La solicitud de la generación - - - - El estado de la generación - - Valores posibles: `queued`, `dreaming`, `completed`, `failed` - - -## Ejemplos - -### Entrada - -```json -{ - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p" -} -``` - -### Salida - -```json -{ - "assets": { - "video": "https://example.invalid/luma/ray-2/generated.mp4" - }, - "created_at": "2027-01-01T00:00:00Z", - "generation_type": "video", - "id": "3f2a7c1e-8b40-4d59-9f6a-1c2d3e4f5a60", - "model": "ray-2", - "state": "completed" -} -``` - - diff --git a/es/development/comfy-router/models/luma/ray-flash-2/code.mdx b/es/development/comfy-router/models/luma/ray-flash-2/code.mdx deleted file mode 100644 index ec37b8cf78..0000000000 --- a/es/development/comfy-router/models/luma/ray-flash-2/code.mdx +++ /dev/null @@ -1,296 +0,0 @@ ---- -title: "Usa Ray Flash 2 con Comfy Router" -description: "Llama a luma/ray-flash-2 con Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." -sidebarTitle: "Ray Flash 2" -translationSourceHash: 398d8142 -translationFrom: development/comfy-router/models/luma/ray-flash-2/code.mdx -translationBlockHashes: - "_intro": bd0b0053 - "Quick start": c53b2450 - "Schema": 8009af73 - "Examples": cb7953b0 ---- -{/* GENERATED FILE. Generated from router-schemas/luma/ray-flash-2.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; - -Referencia de API para `luma/ray-flash-2`, servida por Comfy Router desde Luma. - -**Entrada:** Texto, Imagen · **Salida:** Video - -## Inicio rápido - -Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada por HTTP directo. - -**ID del modelo:** `luma/ray-flash-2` - -**Endpoint:** `POST https://api.comfy.org/v2/models/luma/ray-flash-2` - - - - -```python Python -from comfy_sdk import Comfy - -# Lee COMFY_API_KEY del entorno. -# El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -with Comfy() as client: - result = client.models.run( - "luma/ray-flash-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY del entorno. -// El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -const { data } = await comfy.models.run("luma/ray-flash-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/luma/ray-flash-2 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" -``` - - - -El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/luma/ray-flash-2/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recoge cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# Lee COMFY_API_KEY del entorno. -# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "luma/ray-flash-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que necesita otro proceso - - # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # El payload propio del proveedor, el mismo valor que devuelve models.run(). - # Una solicitud que falló o se canceló genera aquí el error tipado de Router. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY del entorno. -// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -const handle = await comfy.models.submit("luma/ray-flash-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); -console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que necesita otro proceso - -// Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. -curl https://api.comfy.org/v2/models/luma/ray-flash-2/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" - -# 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/luma/ray-flash-2/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. -curl https://api.comfy.org/v2/models/luma/ray-flash-2/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Esquema - -### Entrada - - - La relación de aspecto de la generación - - Valores posibles: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `21:9`, `9:21` - - - - La URL de callback de la generación. Se enviará una solicitud POST con el objeto Generation a la URL de callback cuando la generación esté en proceso, se haya completado o haya fallado - - Formato: `uri` - - - - - - - - Valores posibles: `video` - - - - Los fotogramas clave de la generación - - - - Un fotograma clave puede ser una referencia a Generation, una imagen o un video - - - - Un fotograma clave puede ser una referencia a Generation, una imagen o un video - - - - Indica si el video se repite en bucle - - - - El modelo de video utilizado para la generación. En la ruta de Comfy Router `POST /v2/models/luma/{model}` este campo se obtiene de la ruta y NO DEBE enviarse; en la ruta v1 `POST /proxy/luma/generations` es requerido y está restringido a la enumeración LumaVideoModel (`ray-2`, `ray-flash-2`). - - - - El prompt de la generación - - - - - - -Generado a partir del esquema que Router sirve en `GET /v2/models/luma/ray-flash-2/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor. - -### Salida - - - Los recursos de la generación - - - - La URL de la imagen - - Formato: `uri` - - - - La URL del video de progreso - - Formato: `uri` - - - - La URL del video - - Formato: `uri` - - - - La fecha y hora en que se creó la generación - - Formato: `date-time` - - - - El motivo del estado de la generación - - - - Valores posibles: `video`, `image` - - - - El ID de la generación - - Formato: `uuid` - - - - El modelo utilizado para la generación - - - - La solicitud de la generación - - - - El estado de la generación - - Valores posibles: `queued`, `dreaming`, `completed`, `failed` - - -## Ejemplos - -### Entrada - -```json -{ - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p" -} -``` - -### Salida - -```json -{ - "assets": { - "video": "https://example.invalid/luma/ray-flash-2/generated.mp4" - }, - "created_at": "2027-01-01T00:00:00Z", - "generation_type": "video", - "id": "8c41d0b6-2e7a-4f35-b1d8-9a0e6f3c2b71", - "model": "ray-flash-2", - "state": "completed" -} -``` - - diff --git a/es/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx b/es/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx deleted file mode 100644 index a127cd1d84..0000000000 --- a/es/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx +++ /dev/null @@ -1,594 +0,0 @@ ---- -title: "Usa GPT 4.1 Nano con Comfy Router" -description: "Llama a openai/gpt-4.1-nano con Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." -sidebarTitle: "GPT 4.1 Nano" -translationSourceHash: cb01a907 -translationFrom: development/comfy-router/models/openai/gpt-4-1-nano/code.mdx -translationBlockHashes: - "_intro": 9543bf7b - "Quick start": 9c5ad598 - "Schema": 4e68a487 - "Examples": 67e6c8f1 ---- -{/* ARCHIVO GENERADO. Generado desde router-schemas/openai/gpt-4.1-nano.json por `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; - -Referencia de API para `openai/gpt-4.1-nano`, servida por Comfy Router de OpenAI. - -**Entrada:** Texto, Imagen · **Salida:** Texto - -## Inicio rápido - -Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada mediante HTTP sin procesar. - -**ID del modelo:** `openai/gpt-4.1-nano` - -**Endpoint:** `POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano` - - - - -```python Python -from comfy_sdk import Comfy - -# Lee COMFY_API_KEY del entorno. -# El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -with Comfy() as client: - result = client.models.run( - "openai/gpt-4.1-nano", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY del entorno. -// El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -const { data } = await comfy.models.run("openai/gpt-4.1-nano", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests`. Router responde `201` con un `request_id` en cuanto admite la ejecución, y puedes recoger el resultado en cuanto esté listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# Lee COMFY_API_KEY del entorno. -# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/gpt-4.1-nano", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # con el model ID, es todo lo que necesita otro proceso - - # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # La carga útil propia del proveedor, el mismo valor que devuelve models.run(). - # Una solicitud que falló o se canceló lanza aquí el error tipado de Router. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY del entorno. -// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -const handle = await comfy.models.submit("openai/gpt-4.1-nano", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // con el model ID, es todo lo que necesita otro proceso - -// Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Esquema - -### Entrada - - - Datos de salida adicionales para incluir en la respuesta del modelo. - - - - Entradas de texto, imagen o archivo al modelo, usadas para generar una respuesta. Es el único campo de este contrato que Router no puede suministrar, y la única entrada en `required` a continuación. - - - - Inserta un mensaje de sistema (o de desarrollador) como el primer elemento del contexto del modelo. - - - - Un límite superior para la cantidad de tokens generados en una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento. En un id de razonamiento este techo se comparte con los tokens de razonamiento ocultos, así que un valor pequeño puede consumir todo el presupuesto antes de cualquier texto visible: por eso los casos de prueba de razonamiento envían 1024 donde los de chat envían 16. - - Rango: `1` a `…` - - - - Identificador del modelo de OpenAI. En Comfy Router este campo es OPCIONAL y Router lo rellena desde el segmento de ruta `{model}`; un `null` explícito se reemplaza de la misma forma. Enviar un valor que no coincida con la ruta se rechaza. - - - - Si se permite que el modelo ejecute llamadas a herramientas en paralelo. - - - - El ID de una respuesta anterior, para conversaciones de varios turnos. - - - - SOLO NIVEL DE RAZONAMIENTO. Configuración para modelos de razonamiento, p. ej. `{"effort": "medium"}`. Se reenvía sin cambios; consulta la guía de razonamiento de OpenAI para conocer las claves aceptadas. Un id de nivel chat lo ignora. - - - - Si OpenAI almacena la respuesta generada para recuperarla más tarde. - - - - Se declara para que un llamador que lo envíe no sea rechazado, pero es INERTE en esta superficie: Router lo FIJA en `false` antes del despacho, porque captura la respuesta del proveedor en lugar de retransmitir un `text/event-stream`, que no puede decodificar, así que una generación en streaming la facturaría OpenAI y no la mediría nadie. Ninguna superficie de Comfy sirve el stream: la entrada `POST /proxy/openai/v1/responses` de v1 rechaza `stream: true` con un 400 y nunca reenvía la solicitud al proveedor, así que omite el campo o envía `false` en cualquiera de las dos superficies y lee la respuesta completada como un solo cuerpo JSON. - - - - Temperatura de muestreo. SOLO NIVEL CHAT: los ids de razonamiento de la serie o (`o1`, `o1-pro`, `o3`, `o4-mini`) rechazan este parámetro en OpenAI. Router no lo rechaza por ellos (consulta la nota de este componente sobre por qué los dos niveles comparten un esquema), así que una llamada de razonamiento que lo envíe recibe el error propio de OpenAI. - - Rango: `0` a `2` - - - - Configuración del formato de salida, p. ej. `{"format": {"type": "json_schema", ...}}` para Structured Outputs. Se reenvía sin cambios. - - - - Cómo debe seleccionar el modelo qué herramienta usar. Ya sea una cadena de modo o un objeto que nombra una herramienta. - - - - Definiciones de herramientas que el modelo puede llamar. Router no restringe la taxonomía de herramientas; consulta la referencia de la API Responses de OpenAI para conocer las formas aceptadas. - - - - Corte del muestreo de núcleo. SOLO NIVEL CHAT, en los mismos términos que `temperature`. - - Rango: `0` a `1` - - - - Estrategia de truncamiento cuando el contexto supera la ventana del modelo. La enumeración SÍ se aplica aquí, a diferencia de los tres vocabularios anteriores, porque estos dos valores son el conjunto completo que documenta OpenAI y no ha crecido. Un `null` explícito sigue aceptándose, en los mismos términos que los campos anteriores. - - Valores posibles: `auto`, `disabled` - - - - Envoltorio de uso de tokens. Está presente en este contrato porque la operación v1 lo declara en el cuerpo de la solicitud; OpenAI lo rellena en la RESPUESTA, así que un llamador no tiene motivo para enviarlo. - - -Generado a partir del esquema que Router sirve en `GET /v2/models/openai/gpt-4.1-nano/openapi.json`, el mismo documento contra el que valida una llamada antes de que la solicitud llegue al proveedor. - -### Salida - - - Inserta un mensaje de sistema (o de desarrollador) como primer elemento en el contexto del modelo. - -Cuando se usa junto con `previous_response_id`, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes de sistema (o de desarrollador) en nuevas respuestas. - - - - Un límite superior para la cantidad de tokens que se pueden generar en una respuesta, incluidos los tokens de salida visibles y los [tokens de razonamiento](https://platform.openai.com/docs/guides/reasoning). - - - - El modelo utilizado para generar la respuesta - - - - Controla la aleatoriedad en la respuesta - - Rango: `0` a `2` - - - - Controla la diversidad de la respuesta mediante muestreo de núcleo - - Rango: `0` a `1` - - - - La estrategia de truncamiento que se usará para la respuesta del modelo. -- `auto`: Si el contexto de esta respuesta y las anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarla a la ventana de contexto eliminando elementos de entrada en medio de la conversación. -- `disabled` (predeterminado): Si una respuesta del modelo supera el tamaño de la ventana de contexto de un modelo, la solicitud fallará con un error 400. - - Valores posibles: `auto`, `disabled` - - - - El ID único de la respuesta anterior del modelo. Úsalo para crear conversaciones de varios turnos. Aprende más sobre el [estado de la conversación](https://platform.openai.com/docs/guides/conversation-state). - - - - **Solo modelos de la serie o** - -Opciones de configuración para [modelos de razonamiento](https://platform.openai.com/docs/guides/reasoning). - - - - Controla qué elementos de razonamiento se devuelven al modelo en turnos posteriores, por ejemplo, `auto`, `current_turn` o `all_turns`. - - - - **Solo modelos de la serie o** - -Limita el esfuerzo de razonamiento para [modelos de razonamiento](https://platform.openai.com/docs/guides/reasoning). Los valores admitidos actualmente son `low`, `medium` y `high`. Reducir el esfuerzo de razonamiento puede dar como resultado respuestas más rápidas y menos tokens usados en razonamiento en una respuesta. - - Valores posibles: `low`, `medium`, `high` - - - - **Obsoleto:** usa `summary` en su lugar. - -Un resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. - - Valores posibles: `auto`, `concise`, `detailed` - - - - El modo de razonamiento usado para la respuesta. - - - - Un resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. - - Valores posibles: `auto`, `concise`, `detailed` - - - - - - - - Un objeto que especifica el formato que el modelo debe generar. - -Configurar `{ "type": "json_schema" }` habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON que proporciones. Obtén más información en la [guía de salidas estructuradas](https://platform.openai.com/docs/guides/structured-outputs). - -El formato predeterminado es `{ "type": "text" }` sin opciones adicionales. - -**No recomendado para gpt-4o y modelos más recientes:** - -Establecer `{ "type": "json_object" }` habilita el modo JSON anterior, lo que garantiza que el mensaje que genera el modelo sea JSON válido. Se prefiere usar `json_schema` en los modelos que lo admiten. - - - - Limita la verbosidad de la respuesta del modelo. Uno de `low`, `medium` o `high`. - - - - Cómo debe seleccionar el modelo qué herramienta (o herramientas) usar al generar una respuesta. Consulta el parámetro `tools` para ver cómo especificar qué herramientas puede llamar el modelo. - - - - - - - - Indica si la respuesta del modelo se ejecuta en segundo plano. - - - - Información de facturación de la respuesta. - - - - La parte responsable de pagar por la respuesta. - - - - Marca de tiempo Unix (en segundos) de cuándo se completó esta respuesta. Solo está presente cuando el estado es `completed`. - - - - Marca de tiempo Unix (en segundos) de cuándo se creó esta respuesta. - - - - Un objeto de error que se devuelve cuando el modelo no logra generar una respuesta. - - - - El código de error de la respuesta. - - Valores posibles: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - Una descripción legible del error. - - - - Penaliza los tokens nuevos según su frecuencia actual en el texto generado hasta el momento. - - - - Identificador único de esta respuesta. - - - - Detalles sobre por qué la respuesta está incompleta. - - - - El motivo por el que la respuesta está incompleta. - - Valores posibles: `max_output_tokens`, `content_filter` - - - - El número máximo total de llamadas a herramientas integradas que puede procesar una respuesta. - - - - Conjunto de pares clave-valor que puedes adjuntar a la respuesta. - - - - Resultados de moderación para la entrada y la salida de la respuesta, si solicitaste finalizaciones moderadas. - - - - El tipo de objeto de este recurso; siempre se establece en `response`. - - Valores posibles: `response` - - - - Un arreglo de elementos de contenido generados por el modelo. - -- La longitud y el orden de los elementos del arreglo `output` dependen de la respuesta del modelo. -- En lugar de acceder al primer elemento del arreglo `output` y suponer que es un mensaje `assistant` con el contenido generado por el modelo, considera usar la propiedad `output_text` donde los SDK la admitan. - - - - Propiedad de conveniencia exclusiva de los SDK que contiene la salida de texto agregada de todos los elementos `output_text` del arreglo `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript. - - - - Indica si el modelo puede ejecutar llamadas a herramientas en paralelo. - - - - Penaliza los tokens nuevos según si ya aparecen en el texto generado hasta el momento. - - - - OpenAI lo usa para almacenar en caché las respuestas a solicitudes similares y optimizar la tasa de aciertos de caché. Reemplaza el campo `user`. - - - - La política de retención de la caché de prompts, por ejemplo, `in_memory` o `24h`. - - - - Un identificador estable que se usa para ayudar a detectar usuarios de tu aplicación que puedan estar infringiendo las políticas de uso de OpenAI. - - - - El nivel de procesamiento usado para atender la solicitud, por ejemplo, `auto`, `default`, `flex`, `scale` o `priority`. - - - - El estado de la generación de la respuesta. Puede ser `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. - - Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - Indica si la respuesta se almacena para recuperarla más tarde mediante la API. - - - - Uso de tokens y solicitudes desglosado por herramienta integrada. - - - - Uso de tokens de la herramienta de generación de imágenes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Uso de la herramienta de búsqueda web. - - - - - - - - El número máximo de los tokens más probables que se devuelven en cada posición del token, cada uno con su probabilidad logarítmica asociada. - - - - Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, un desglose de los tokens de salida y el total de tokens usados. - - - - El número de tokens de entrada. - - - - Un desglose detallado de los tokens de entrada. - - - - El número de tokens de entrada escritos en la caché. - - La cantidad de tokens que se recuperaron de la caché. -[Más información sobre la caché de prompts](https://platform.openai.com/docs/guides/prompt-caching). - - - - La cantidad de tokens de salida. - - - - Un desglose detallado de los tokens de salida. - - - - La cantidad de tokens de razonamiento. - - - - La cantidad total de tokens utilizados. - - - - Identificador obsoleto del usuario final. Reemplazado por `safety_identifier` y `prompt_cache_key`. - - -## Ejemplos - -### Entrada - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### Salida - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/es/development/comfy-router/models/openai/o4-mini/code.mdx b/es/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx similarity index 63% rename from es/development/comfy-router/models/openai/o4-mini/code.mdx rename to es/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx index 611a283a91..149e31af2a 100644 --- a/es/development/comfy-router/models/openai/o4-mini/code.mdx +++ b/es/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx @@ -1,30 +1,30 @@ --- -title: "Usa o4-mini con Comfy Router" -description: "Llama a openai/o4-mini mediante Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." -sidebarTitle: "o4-mini" -translationSourceHash: b1b02a55 -translationFrom: development/comfy-router/models/openai/o4-mini/code.mdx +title: "Usa GPT 6.1 Sol con Comfy Router" +description: "Llama a openai/gpt-6.1-sol a través de Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." +sidebarTitle: "GPT 6.1 Sol" +translationSourceHash: d4b3ce5f +translationFrom: development/comfy-router/models/openai/gpt-6-1-sol/code.mdx translationBlockHashes: - "_intro": 23fc3424 - "Quick start": f63680db - "Schema": fcbeee88 + "_intro": 72f9c8de + "Quick start": a04e3ac0 + "Schema": 0e5083e2 "Examples": 67e6c8f1 --- -{/* ARCHIVO GENERADO. Generado a partir de router-schemas/openai/o4-mini.json por `pnpm code-pages:gen`. */} +{/* ARCHIVO GENERADO. Generado desde router-schemas/openai/gpt-6.1-sol.json por `pnpm code-pages:gen`. */} import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; -Referencia de API para `openai/o4-mini`, servida por Comfy Router de OpenAI. +Referencia de API para `openai/gpt-6.1-sol`, servida por Comfy Router de OpenAI. **Entrada:** Texto, Imagen · **Salida:** Texto ## Inicio rápido -Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada por HTTP directo. +Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada sobre HTTP directo. -**ID del modelo:** `openai/o4-mini` +**ID del modelo:** `openai/gpt-6.1-sol` -**Endpoint:** `POST https://api.comfy.org/v2/models/openai/o4-mini` +**Endpoint:** `POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol` @@ -33,10 +33,10 @@ Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/pr from comfy_sdk import Comfy # Lee COMFY_API_KEY del entorno. -# El SDK crea automáticamente una clave de idempotencia y la reutiliza en los reintentos automáticos. +# El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. with Comfy() as client: result = client.models.run( - "openai/o4-mini", + "openai/gpt-6.1-sol", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -50,8 +50,8 @@ print(result) import { comfy } from "@comfyorg/sdk"; // Lee COMFY_API_KEY del entorno. -// El SDK crea automáticamente una clave de idempotencia y la reutiliza en los reintentos automáticos. -const { data } = await comfy.models.run("openai/o4-mini", { +// El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. +const { data } = await comfy.models.run("openai/gpt-6.1-sol", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); @@ -60,7 +60,7 @@ console.log(data); ``` ```bash cURL -curl https://api.comfy.org/v2/models/openai/o4-mini \ +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ @@ -68,8 +68,8 @@ curl https://api.comfy.org/v2/models/openai/o4-mini \ ``` - -El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/openai/o4-mini/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recopila cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recopilación. + +El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recoge cuando está listo, desde este proceso o desde otro. [Queued delivery](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida del resultado. ```python Python @@ -77,23 +77,23 @@ import asyncio from comfy_sdk import AsyncComfy # Lee COMFY_API_KEY del entorno. -# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza en los reintentos automáticos. +# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. async def main(): async with AsyncComfy() as client: handle = await client.models.submit( - "openai/o4-mini", + "openai/gpt-6.1-sol", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, }, ) - print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que otro proceso necesita + print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que necesita otro proceso # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. async for update in handle.iter_events(): print(update.status, update.queue_position) - # El payload propio del proveedor, el mismo valor que devuelve models.run(). + # La carga útil propia del proveedor, el mismo valor que devuelve models.run(). # Una solicitud que falló o se canceló lanza aquí el error tipado de Router. result = await handle.get() @@ -106,12 +106,12 @@ asyncio.run(main()) import { comfy } from "@comfyorg/sdk"; // Lee COMFY_API_KEY del entorno. -// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza en los reintentos automáticos. -const handle = await comfy.models.submit("openai/o4-mini", { +// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. +const handle = await comfy.models.submit("openai/gpt-6.1-sol", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); -console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que otro proceso necesita +console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que necesita otro proceso // Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. for await (const update of handle.events()) { @@ -126,7 +126,7 @@ console.log(result.data); ```bash cURL # 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. -curl https://api.comfy.org/v2/models/openai/o4-mini/requests \ +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ @@ -134,11 +134,11 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests \ # 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID/status \ +curl -i https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" -# 3. Recopila. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. -curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ +# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras aún se ejecuta. +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``` @@ -150,25 +150,25 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ ### Entrada - Datos de salida adicionales que se incluyen en la respuesta del modelo. + Datos de salida adicionales para incluir en la respuesta del modelo. - Entradas de texto, imagen o archivo al modelo, usadas para generar una respuesta. Es el único campo de este contrato que Router no puede suministrar, y la única entrada en `required` más abajo. + Entradas de texto, imagen o archivo para el modelo, que se usan para generar una respuesta. El único campo de este contrato que Router no puede suministrar, y la única entrada en `required` a continuación. - Inserta un mensaje de sistema (o de desarrollador) como el primer elemento del contexto del modelo. + Inserta un mensaje de sistema (o de desarrollador) como el primer elemento en el contexto del modelo. - Un límite superior para la cantidad de tokens generados en una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento. En un id de razonamiento este techo se comparte con los tokens de razonamiento ocultos, así que un valor pequeño puede consumir todo el presupuesto antes de cualquier texto visible: por eso los casos de prueba de humo de razonamiento envían 1024 donde los de chat envían 16. + Un límite superior para la cantidad de tokens generados en una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento. En un id de razonamiento, este límite superior se comparte con los tokens de razonamiento ocultos, así que un valor pequeño puede consumir todo el presupuesto antes de que se genere cualquier texto visible. Por eso los casos de prueba de humo de razonamiento envían 1024, mientras que los de chat envían 16. Rango: `1` a `…` - Identificador de modelo de OpenAI. En Comfy Router este campo es OPCIONAL y Router lo rellena a partir del segmento de ruta `{model}`; un `null` explícito se reemplaza de la misma manera. Se rechaza el envío de un valor que no coincida con la ruta. + Identificador de modelo de OpenAI. En Comfy Router este campo es OPCIONAL y Router lo rellena desde el segmento de ruta `{model}`; un `null` explícito se reemplaza de la misma forma. Se rechaza cualquier valor que no coincida con la ruta. @@ -180,7 +180,7 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - SOLO NIVEL DE RAZONAMIENTO. Configuración para modelos de razonamiento, por ejemplo `{"effort": "medium"}`. Se reenvía sin cambios; consulta la guía de razonamiento de OpenAI para conocer las claves aceptadas. Un id de nivel chat la ignora. + SOLO PARA EL NIVEL DE RAZONAMIENTO. Configuración para modelos de razonamiento, p. ej. `{"effort": "medium"}`. Router lo reenvía sin cambios; consulta la guía de razonamiento de OpenAI para conocer las claves aceptadas. Un id del nivel de chat lo ignora. @@ -188,17 +188,17 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - Se declara para que quien lo envíe no sea rechazado, pero es INERTE en esta superficie: Router lo FIJA en `false` antes del despacho, porque captura la respuesta del proveedor en lugar de retransmitir un `text/event-stream`, el cual no puede decodificar, así que una generación en streaming sería facturada por OpenAI y medida por nadie. Ninguna superficie de Comfy sirve el stream: la entrada `POST /proxy/openai/v1/responses` de v1 rechaza `stream: true` con un 400 y nunca reenvía la solicitud al proveedor, así que omite el campo o envía `false` en cualquiera de las dos superficies y lee la respuesta completada como un solo cuerpo JSON. + Se declara para que no se rechace a quien lo envíe, pero es INERTE en esta superficie: Router lo FIJA en `false` antes del despacho, porque captura la respuesta del proveedor en lugar de retransmitir un `text/event-stream`, que Router no puede decodificar. Por eso OpenAI facturaría una generación en streaming y nadie la contabilizaría. Ninguna superficie de Comfy entrega el stream: la entrada `POST /proxy/openai/v1/responses` de v1 rechaza `stream: true` con un 400 y nunca reenvía la solicitud al proveedor, así que omite el campo o envía `false` en cualquiera de las dos superficies y lee la respuesta completada como un solo cuerpo JSON. - Temperatura de muestreo. SOLO NIVEL DE CHAT: los ids de razonamiento de la serie o (`o1`, `o1-pro`, `o3`, `o4-mini`) rechazan este parámetro en OpenAI. Router no lo rechaza por ellos (consulta la nota de este componente sobre por qué los dos niveles comparten un esquema), así que OpenAI responde a una llamada de razonamiento que lo envía con su propio error. + Temperatura de muestreo. SOLO PARA EL NIVEL DE CHAT: los ids de razonamiento de la serie o (`o1`, `o1-pro`, `o3`, `o4-mini`) rechazan este parámetro en OpenAI. Router no lo rechaza por ellos (consulta la nota de este componente sobre por qué los dos niveles comparten un esquema), así que OpenAI responde con su propio error a una llamada de razonamiento que lo envíe. Rango: `0` a `2` - Configuración del formato de salida, por ejemplo `{"format": {"type": "json_schema", ...}}` para Structured Outputs. Se reenvía sin cambios. + Configuración del formato de salida, p. ej. `{"format": {"type": "json_schema", ...}}` para Structured Outputs. Router lo reenvía sin cambios. @@ -206,37 +206,37 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - Definiciones de herramientas que el modelo puede llamar. Router no restringe la taxonomía de herramientas; consulta la referencia de la API Responses de OpenAI para las formas aceptadas. + Definiciones de herramientas que el modelo puede llamar. Router no restringe la taxonomía de herramientas; consulta la referencia de la API Responses de OpenAI para conocer las formas aceptadas. - Corte del muestreo de núcleo. SOLO NIVEL DE CHAT, en los mismos términos que `temperature`. + Corte del muestreo de núcleo. SOLO PARA EL NIVEL DE CHAT, en los mismos términos que `temperature`. Rango: `0` a `1` - Estrategia de truncamiento cuando el contexto supera la ventana del modelo. La enumeración SÍ se aplica aquí, a diferencia de los tres vocabularios anteriores, porque estos dos valores son el conjunto completo que OpenAI documenta y no ha crecido. Un `null` explícito sigue aceptándose, en los mismos términos que los campos anteriores. + Estrategia de truncamiento cuando el contexto supera la ventana del modelo. El enum SÍ se aplica aquí, a diferencia de los tres vocabularios anteriores, porque estos dos valores son el conjunto completo que documenta OpenAI y no ha aumentado. Un `null` explícito todavía se acepta, en los mismos términos que los campos anteriores. Valores posibles: `auto`, `disabled` - Envolvente de uso de tokens. Está presente en este contrato porque la operación de v1 la declara en el cuerpo de la solicitud; OpenAI la rellena en la RESPUESTA, así que quien llama no tiene motivo para enviarla. + Estructura de uso de tokens. Está presente en este contrato porque la operación de v1 la declara en el cuerpo de la solicitud; OpenAI la completa en la RESPUESTA, así que un llamador no tiene motivo para enviarla. -Generado a partir del esquema que Router sirve en `GET /v2/models/openai/o4-mini/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor. +Generado a partir del esquema que Router sirve en `GET /v2/models/openai/gpt-6.1-sol/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor.# ### Salida - Inserta un mensaje de sistema (o de desarrollador) como primer elemento en el contexto del modelo. + Inserta un mensaje de sistema (o de desarrollador) como el primer elemento en el contexto del modelo. -Cuando se usa junto con `previous_response_id`, las instrucciones de una respuesta anterior no se trasladan a la siguiente respuesta. Esto facilita cambiar los mensajes de sistema (o de desarrollador) en las nuevas respuestas. +Cuando lo uses junto con `previous_response_id`, las instrucciones de una respuesta anterior no se trasladarán a la siguiente respuesta. Esto facilita reemplazar los mensajes de sistema (o de desarrollador) en respuestas nuevas. - Un límite superior para la cantidad de tokens que se pueden generar en una respuesta, incluidos los tokens de salida visibles y los [tokens de razonamiento](https://platform.openai.com/docs/guides/reasoning). + Un límite superior para la cantidad de tokens que puede generar una respuesta, incluidos los tokens de salida visibles y los [tokens de razonamiento](https://platform.openai.com/docs/guides/reasoning). @@ -257,14 +257,14 @@ Cuando se usa junto con `previous_response_id`, las instrucciones de una respues La estrategia de truncamiento que se usa para la respuesta del modelo. -- `auto`: si el contexto de esta respuesta y de las anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarla a la ventana de contexto descartando elementos de entrada en medio de la conversación. -- `disabled` (predeterminado): si una respuesta del modelo supera el tamaño de la ventana de contexto de un modelo, la solicitud fallará con un error 400. +- `auto`: Si el contexto de esta respuesta y de las anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarla a la ventana de contexto descartando elementos de entrada en medio de la conversación. +- `disabled` (predeterminado): Si una respuesta del modelo supera el tamaño de la ventana de contexto de un modelo, la solicitud fallará con un error 400. Valores posibles: `auto`, `disabled` - El ID único de la respuesta anterior del modelo. Úsalo para + El ID único de la respuesta anterior al modelo. Úsalo para crear conversaciones de varios turnos. Aprende más sobre el [estado de la conversación](https://platform.openai.com/docs/guides/conversation-state). @@ -277,16 +277,16 @@ Opciones de configuración para los - Controla qué elementos de razonamiento se devuelven al modelo en turnos posteriores, por ejemplo `auto`, `current_turn` o `all_turns`. + Controla qué elementos de razonamiento se vuelven a mostrar al modelo en turnos posteriores, p. ej., `auto`, `current_turn` o `all_turns`. **Solo para modelos de la serie o** -Limita el esfuerzo de razonamiento de los +Limita el esfuerzo dedicado al razonamiento para los [modelos de razonamiento](https://platform.openai.com/docs/guides/reasoning). Los valores admitidos actualmente son `low`, `medium` y `high`. Reducir -el esfuerzo de razonamiento puede dar respuestas más rápidas y usar menos tokens +el esfuerzo de razonamiento puede dar como resultado respuestas más rápidas y menos tokens usados en razonamiento dentro de una respuesta. Valores posibles: `low`, `medium`, `high` @@ -295,20 +295,20 @@ en razonamiento dentro de una respuesta. **Obsoleto:** usa `summary` en su lugar. -Un resumen del razonamiento que realizó el modelo. Puede ser -útil para depurar y entender el proceso de razonamiento del modelo. +Un resumen del razonamiento realizado por el modelo. Esto puede ser +útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed` - El modo de razonamiento que se usa para la respuesta. + El modo de razonamiento usado para la respuesta. - Un resumen del razonamiento que realizó el modelo. Puede ser -útil para depurar y entender el proceso de razonamiento del modelo. + Un resumen del razonamiento realizado por el modelo. Esto puede ser +útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed` @@ -322,14 +322,14 @@ Uno de `auto`, `concise` o `detailed`. Un objeto que especifica el formato que el modelo debe generar. Configurar `{ "type": "json_schema" }` habilita las salidas estructuradas, -lo que garantiza que el modelo coincida con el esquema JSON que proporciones. Aprende más en la +lo que garantiza que el modelo coincida con el esquema JSON que proporcionaste. Aprende más en la [guía de salidas estructuradas](https://platform.openai.com/docs/guides/structured-outputs). El formato predeterminado es `{ "type": "text" }` sin opciones adicionales. -**No recomendado para gpt-4o y modelos más nuevos:** +**No recomendado para gpt-4o y modelos más recientes:** -Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que +Configurar `{ "type": "json_object" }` habilita el modo JSON anterior, que garantiza que el mensaje que genera el modelo sea JSON válido. Se prefiere usar `json_schema` en los modelos que lo admiten. @@ -339,7 +339,7 @@ en los modelos que lo admiten. - Cómo debe elegir el modelo qué herramienta (o herramientas) usar al generar + Cómo debe seleccionar el modelo qué herramienta (o herramientas) usar al generar una respuesta. Consulta el parámetro `tools` para ver cómo especificar qué herramientas puede llamar el modelo. @@ -357,7 +357,7 @@ puede llamar el modelo. - La parte responsable de pagar la respuesta. + La parte responsable de pagar por la respuesta. @@ -369,7 +369,7 @@ puede llamar el modelo. - Un objeto de error que se devuelve cuando el modelo no logra generar una respuesta. + Objeto de error que se devuelve cuando el modelo no logra generar una respuesta. @@ -379,7 +379,7 @@ puede llamar el modelo. - Una descripción del error legible para humanos. + Una descripción del error legible por humanos. @@ -387,7 +387,7 @@ puede llamar el modelo. - Identificador único para esta respuesta. + Identificador único de esta respuesta. @@ -395,13 +395,13 @@ puede llamar el modelo. - El motivo por el que la respuesta está incompleta. + El motivo por el cual la respuesta está incompleta. Valores posibles: `max_output_tokens`, `content_filter` - El número máximo de llamadas totales a herramientas integradas que puede procesar una respuesta. + El número máximo total de llamadas a herramientas integradas que puede procesar una respuesta. @@ -409,11 +409,11 @@ puede llamar el modelo. - Resultados de moderación para la entrada y salida de la respuesta, si se solicitaron completaciones moderadas. + Resultados de moderación para la entrada y la salida de la respuesta, si se solicitaron finalizaciones moderadas. - El tipo de objeto de este recurso, siempre establecido en `response`. + El tipo de objeto de este recurso; siempre se establece en `response`. Valores posibles: `response` @@ -421,16 +421,16 @@ puede llamar el modelo. Un arreglo de elementos de contenido generados por el modelo. -- La longitud y el orden de los elementos en el arreglo `output` depende de la respuesta del modelo. -- En lugar de acceder al primer elemento del arreglo `output` y asumir que es un mensaje de `assistant` con el contenido generado por el modelo, considera usar la propiedad `output_text` donde sea compatible en los SDK. +- La longitud y el orden de los elementos del arreglo `output` dependen de la respuesta del modelo. +- En lugar de acceder al primer elemento del arreglo `output` y suponer que es un mensaje `assistant` con el contenido generado por el modelo, considera usar la propiedad `output_text` cuando los SDK la admitan. - Propiedad de conveniencia solo para SDK que contiene la salida de texto agregada de todos los elementos `output_text` en el arreglo `output`, si los hay. Compatible con los SDK de Python y JavaScript. + Propiedad de conveniencia exclusiva de los SDK que contiene la salida de texto agregada de todos los elementos `output_text` del arreglo `output`, si hay alguno. Compatible con los SDK de Python y JavaScript. - Si se permite que el modelo ejecute llamadas a herramientas en paralelo. + Indica si el modelo puede ejecutar llamadas a herramientas en paralelo. @@ -438,19 +438,19 @@ puede llamar el modelo. - Usado por OpenAI para almacenar en caché las respuestas de solicitudes similares y optimizar las tasas de aciertos de caché. Reemplaza el campo `user`. + OpenAI lo usa para almacenar en caché las respuestas de solicitudes similares y optimizar la tasa de aciertos de la caché. Reemplaza el campo `user`. - La política de retención para la caché de prompts, por ejemplo, `in_memory` o `24h`. + La política de retención de la caché de prompts, p. ej., `in_memory` o `24h`. - Un identificador estable que se usa para ayudar a detectar usuarios de tu aplicación que puedan estar violando las políticas de uso de OpenAI. + Un identificador estable que ayuda a detectar a los usuarios de tu aplicación que podrían estar infringiendo las políticas de uso de OpenAI. - El nivel de procesamiento usado para atender la solicitud, por ejemplo, `auto`, `default`, `flex`, `scale` o `priority`. + El nivel de procesamiento usado para atender la solicitud, p. ej., `auto`, `default`, `flex`, `scale` o `priority`. @@ -460,7 +460,7 @@ puede llamar el modelo. - Si la respuesta se almacena para recuperarla más tarde a través de la API. + Indica si la respuesta se almacena para recuperarla más tarde mediante la API. @@ -533,9 +533,23 @@ puede llamar el modelo. El número de tokens de entrada que se escribieron en la caché. - + + + + Las escrituras en caché desglosadas por la vida útil de la caché. Los dos conteos suman `cache_write_tokens`. + + + + El número de tokens de entrada escritos en la caché con la vida útil de 12 horas. + + + + El número de tokens de entrada escritos en la caché con la vida útil de 30 minutos. + + + El número de tokens que se recuperaron de la caché. -[Más información sobre la caché de prompts](https://platform.openai.com/docs/guides/prompt-caching). +[Más sobre el almacenamiento en caché de prompts](https://platform.openai.com/docs/guides/prompt-caching). @@ -555,7 +569,7 @@ puede llamar el modelo. - Identificador obsoleto para el usuario final. Reemplazado por `safety_identifier` y `prompt_cache_key`. + Identificador obsoleto del usuario final. Reemplazado por `safety_identifier` y `prompt_cache_key`. ## Ejemplos @@ -608,5 +622,4 @@ puede llamar el modelo. } ``` - diff --git a/es/development/comfy-router/models/openai/o1-pro/code.mdx b/es/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx similarity index 68% rename from es/development/comfy-router/models/openai/o1-pro/code.mdx rename to es/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx index a2d12043d0..0eb8761ed4 100644 --- a/es/development/comfy-router/models/openai/o1-pro/code.mdx +++ b/es/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx @@ -1,30 +1,30 @@ --- -title: "Usa o1-pro con Comfy Router" -description: "Llama a openai/o1-pro a través de Comfy Router: endpoint, forma de la solicitud y respuesta del Router." -sidebarTitle: "o1-pro" -translationSourceHash: f672098e -translationFrom: development/comfy-router/models/openai/o1-pro/code.mdx +title: "Usa GPT 6.1 Terra con Comfy Router" +description: "Llama a openai/gpt-6.1-terra mediante Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." +sidebarTitle: "GPT 6.1 Terra" +translationSourceHash: 27d99514 +translationFrom: development/comfy-router/models/openai/gpt-6-1-terra/code.mdx translationBlockHashes: - "_intro": a236f94d - "Quick start": f09ba6ce - "Schema": 4d31797d + "_intro": c31ab629 + "Quick start": 72fe9e32 + "Schema": aa04e432 "Examples": 67e6c8f1 --- -{/* GENERATED FILE. Generated from router-schemas/openai/o1-pro.json by `pnpm code-pages:gen`. */} +{/* ARCHIVO GENERADO. Generado a partir de router-schemas/openai/gpt-6.1-terra.json por `pnpm code-pages:gen`. */} import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; -Referencia de API para `openai/o1-pro`, servida por Comfy Router de OpenAI. +Referencia de API para `openai/gpt-6.1-terra`, servido por Comfy Router de OpenAI. **Entrada:** Texto, Imagen · **Salida:** Texto ## Inicio rápido -Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada mediante HTTP directo. +Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada sobre HTTP sin procesar. -**ID del modelo:** `openai/o1-pro` +**ID del modelo:** `openai/gpt-6.1-terra` -**Endpoint:** `POST https://api.comfy.org/v2/models/openai/o1-pro` +**Endpoint:** `POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra` @@ -36,7 +36,7 @@ from comfy_sdk import Comfy # El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. with Comfy() as client: result = client.models.run( - "openai/o1-pro", + "openai/gpt-6.1-terra", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -51,7 +51,7 @@ import { comfy } from "@comfyorg/sdk"; // Lee COMFY_API_KEY del entorno. // El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -const { data } = await comfy.models.run("openai/o1-pro", { +const { data } = await comfy.models.run("openai/gpt-6.1-terra", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); @@ -60,7 +60,7 @@ console.log(data); ``` ```bash cURL -curl https://api.comfy.org/v2/models/openai/o1-pro \ +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ @@ -68,8 +68,8 @@ curl https://api.comfy.org/v2/models/openai/o1-pro \ ``` - -El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/openai/o1-pro/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recoge cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida. + +El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recoge cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida. ```python Python @@ -81,7 +81,7 @@ from comfy_sdk import AsyncComfy async def main(): async with AsyncComfy() as client: handle = await client.models.submit( - "openai/o1-pro", + "openai/gpt-6.1-terra", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -89,7 +89,7 @@ async def main(): ) print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que necesita otro proceso - # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. + # Sondea hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. async for update in handle.iter_events(): print(update.status, update.queue_position) @@ -107,13 +107,13 @@ import { comfy } from "@comfyorg/sdk"; // Lee COMFY_API_KEY del entorno. // Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -const handle = await comfy.models.submit("openai/o1-pro", { +const handle = await comfy.models.submit("openai/gpt-6.1-terra", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que necesita otro proceso -// Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. +// Sondea hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } @@ -125,20 +125,20 @@ console.log(result.data); ``` ```bash cURL -# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. -curl https://api.comfy.org/v2/models/openai/o1-pro/requests \ +# 1. Enviar. Router responde 201 con request_id, status_url, response_url y cancel_url. +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -# 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. +# 2. Sondea hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID/status \ +curl -i https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" -# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo del estado mientras aún se ejecuta. -curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ +# 3. Recoger. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``` @@ -150,11 +150,11 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ ### Entrada - Datos de salida adicionales para incluir en la respuesta del modelo. + Datos de salida adicionales que se deben incluir en la respuesta del modelo. - Entradas de texto, imagen o archivo para el modelo, que se usan para generar una respuesta. El único campo de este contrato que Router no puede proporcionar, y la única entrada en `required` a continuación. + Entradas de texto, imagen o archivo para el modelo, que se usan para generar una respuesta. Es el único campo de este contrato que Router no puede suministrar, y la única entrada en `required` a continuación. @@ -162,13 +162,13 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - Un límite superior para la cantidad de tokens generados en una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento. En un id de razonamiento este techo se comparte con los tokens de razonamiento ocultos, así que un valor pequeño puede consumir todo el presupuesto antes de que aparezca cualquier texto visible: por eso los casos de prueba de razonamiento envían 1024 donde los de chat envían 16. + Un límite superior para la cantidad de tokens generados en una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento. En un id de razonamiento este techo se comparte con los tokens de razonamiento ocultos, así que un valor pequeño puede consumir todo el presupuesto antes de que aparezca cualquier texto visible, y por eso los casos de prueba de razonamiento envían 1024 donde los de chat envían 16. Rango: `1` a `…` - Identificador del modelo de OpenAI. En Comfy Router este campo es OPCIONAL y Router lo rellena desde el segmento de ruta `{model}`; un `null` explícito se reemplaza de la misma forma. Un valor que no coincida con la ruta se rechaza. + Identificador del modelo de OpenAI. En Comfy Router este campo es OPCIONAL y Router lo rellena a partir del segmento de ruta `{model}`; un `null` explícito se reemplaza de la misma forma. Se rechaza el envío de un valor que no coincida con la ruta. @@ -180,7 +180,7 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - SOLO NIVEL DE RAZONAMIENTO. Configuración para modelos de razonamiento, por ejemplo `{"effort": "medium"}`. Se reenvía sin cambios; consulta la guía de razonamiento de OpenAI para ver las claves aceptadas. Un id del nivel de chat la ignora. + SOLO NIVEL DE RAZONAMIENTO. Configuración para modelos de razonamiento, p. ej. `{"effort": "medium"}`. Se reenvía sin cambios; consulta la guía de razonamiento de OpenAI para conocer las claves aceptadas. Un id de nivel de chat lo ignora. @@ -188,17 +188,17 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - Se declara para que no se rechace a quien la envíe, pero es INERTE en esta superficie: Router la FIJA en `false` antes del despacho, porque captura la respuesta del proveedor en lugar de retransmitir un `text/event-stream`, que no puede decodificar, así que OpenAI facturaría una generación transmitida en streaming y nadie la mediría. Ninguna superficie de Comfy sirve el stream: la entrada v1 `POST /proxy/openai/v1/responses` rechaza `stream: true` con un 400 y nunca reenvía la solicitud al proveedor, así que omite el campo o envía `false` en cualquiera de las dos superficies y lee la respuesta completada como un solo cuerpo JSON. + Se declara para que no se rechace a quien lo envíe, pero es INERTE en esta superficie: Router lo FIJA en `false` antes del despacho, porque captura la respuesta del proveedor en lugar de retransmitir un `text/event-stream`, el cual no puede decodificar, así que una generación transmitida en streaming sería facturada por OpenAI y medida por nadie. Ninguna superficie de Comfy sirve el stream: la entrada v1 `POST /proxy/openai/v1/responses` rechaza `stream: true` con un 400 y nunca reenvía la solicitud al proveedor, así que omite el campo o envía `false` en cualquiera de las dos superficies y lee la respuesta completada como un solo cuerpo JSON. - Temperatura de muestreo. SOLO NIVEL DE CHAT: los ids de razonamiento de la serie o (`o1`, `o1-pro`, `o3`, `o4-mini`) rechazan este parámetro en OpenAI. Router no lo rechaza por ellos (consulta la nota de este componente sobre por qué los dos niveles comparten un esquema), así que OpenAI responde con su propio error a una llamada de razonamiento que lo envíe. + Temperatura de muestreo. SOLO NIVEL DE CHAT: los ids de razonamiento de la serie o (`o1`, `o1-pro`, `o3`, `o4-mini`) rechazan este parámetro en OpenAI. Router no lo rechaza por ellos (consulta la nota de este componente sobre por qué los dos niveles comparten un mismo esquema), así que OpenAI responde con su propio error a una llamada de razonamiento que lo envíe. Rango: `0` a `2` - Configuración del formato de salida, por ejemplo `{"format": {"type": "json_schema", ...}}` para Structured Outputs. Se reenvía sin cambios. + Configuración del formato de salida, p. ej. `{"format": {"type": "json_schema", ...}}` para Structured Outputs. Se reenvía sin cambios. @@ -206,17 +206,17 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - Definiciones de herramientas que el modelo puede llamar. Router no restringe la taxonomía de herramientas; consulta la referencia de la API Responses de OpenAI para ver las formas aceptadas. + Definiciones de herramientas que el modelo puede llamar. Router no restringe la taxonomía de herramientas; consulta la referencia de la API Responses de OpenAI para conocer las formas aceptadas. - Corte de muestreo de núcleo. SOLO NIVEL DE CHAT, en los mismos términos que `temperature`. + Corte del muestreo de núcleo. SOLO NIVEL DE CHAT, en los mismos términos que `temperature`. Rango: `0` a `1` - Estrategia de truncado cuando el contexto excede la ventana del modelo. El enum SÍ se aplica aquí, a diferencia de los tres vocabularios anteriores, porque estos dos valores son el conjunto completo que OpenAI documenta y no ha crecido. Un `null` explícito sigue aceptándose, en los mismos términos que los campos anteriores. + Estrategia de truncamiento cuando el contexto supera la ventana del modelo. La enumeración SÍ se aplica aquí, a diferencia de los tres vocabularios anteriores, porque estos dos valores son el conjunto completo que documenta OpenAI y no ha crecido. Aun así se acepta un `null` explícito, en los mismos términos que los campos anteriores. Valores posibles: `auto`, `disabled` @@ -225,39 +225,39 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ Envoltorio de uso de tokens. Está presente en este contrato porque la operación v1 lo declara en el cuerpo de la solicitud; OpenAI lo rellena en la RESPUESTA, así que quien llama no tiene motivo para enviarlo. -Generado a partir del esquema que Router sirve en `GET /v2/models/openai/o1-pro/openapi.json`, el mismo documento contra el que valida una llamada antes de que la solicitud llegue al proveedor. +Generado a partir del esquema que Router sirve en `GET /v2/models/openai/gpt-6.1-terra/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor.# ### Salida - Inserta un mensaje de sistema (o de desarrollador) como el primer elemento en el contexto del modelo. + Inserta un mensaje de sistema (o de desarrollador) como el primer elemento del contexto del modelo. -Cuando lo uses junto con `previous_response_id`, las instrucciones de una respuesta anterior no pasarán a la siguiente respuesta. Esto facilita el reemplazo de los mensajes de sistema (o de desarrollador) en nuevas respuestas. +Cuando se usa junto con `previous_response_id`, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita reemplazar los mensajes de sistema (o de desarrollador) en las nuevas respuestas. - Un límite superior para la cantidad de tokens que puede generar una respuesta, incluidos los tokens de salida visibles y los [tokens de razonamiento](https://platform.openai.com/docs/guides/reasoning). + Un límite superior para la cantidad de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los [tokens de razonamiento](https://platform.openai.com/docs/guides/reasoning). - El modelo que se utiliza para generar la respuesta + El modelo usado para generar la respuesta. - Controla la aleatoriedad en la respuesta + Controla la aleatoriedad en la respuesta. Rango: `0` a `2` - Controla la diversidad de la respuesta mediante muestreo de núcleo + Controla la diversidad de la respuesta mediante el muestreo de núcleo. Rango: `0` a `1` La estrategia de truncamiento que se usará para la respuesta del modelo. -- `auto`: Si el contexto de esta respuesta y de las anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarla a la ventana de contexto eliminando elementos de entrada en medio de la conversación. +- `auto`: Si el contexto de esta respuesta y las anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarla a la ventana de contexto eliminando elementos de entrada en medio de la conversación. - `disabled` (predeterminado): Si una respuesta del modelo supera el tamaño de la ventana de contexto de un modelo, la solicitud fallará con un error 400. Valores posibles: `auto`, `disabled` @@ -268,7 +268,7 @@ Cuando lo uses junto con `previous_response_id`, las instrucciones de una respue - **Solo modelos de la serie o** + **Solo para modelos de la serie o** Opciones de configuración para los [modelos de razonamiento](https://platform.openai.com/docs/guides/reasoning). @@ -278,10 +278,9 @@ Opciones de configuración para los [modelos de razonamiento](https://platform.o - **Solo modelos de la serie o** + **Solo para modelos de la serie o** -Limita el esfuerzo dedicado al razonamiento en los [modelos de razonamiento](https://platform.openai.com/docs/guides/reasoning). -Los valores admitidos actualmente son `low`, `medium` y `high`. Reducir el esfuerzo de razonamiento puede dar como resultado respuestas más rápidas y menos tokens usados en el razonamiento de una respuesta. +Limita el esfuerzo dedicado al razonamiento para los [modelos de razonamiento](https://platform.openai.com/docs/guides/reasoning). Los valores admitidos actualmente son `low`, `medium` y `high`. Reducir el esfuerzo de razonamiento puede dar como resultado respuestas más rápidas y menos tokens usados en razonamiento dentro de una respuesta. Valores posibles: `low`, `medium`, `high` @@ -289,17 +288,17 @@ Los valores admitidos actualmente son `low`, `medium` y `high`. Reducir el esfue **Obsoleto:** usa `summary` en su lugar. -Un resumen del razonamiento que realizó el modelo. Puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. +Un resumen del razonamiento realizado por el modelo. Puede resultar útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed` - El modo de razonamiento que se usa para la respuesta. + El modo de razonamiento usado para la respuesta. - Un resumen del razonamiento que realizó el modelo. Puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. + Un resumen del razonamiento realizado por el modelo. Puede resultar útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. Valores posibles: `auto`, `concise`, `detailed` @@ -317,7 +316,7 @@ El formato predeterminado es `{ "type": "text" }` sin opciones adicionales. **No recomendado para gpt-4o y modelos más recientes:** -Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que garantiza que el mensaje que genera el modelo sea JSON válido. Es preferible usar `json_schema` en los modelos que lo admiten. +Configurar `{ "type": "json_object" }` habilita el modo JSON anterior, que garantiza que el mensaje que genera el modelo sea JSON válido. Se prefiere usar `json_schema` en los modelos que lo admiten. @@ -333,7 +332,7 @@ Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que - Indica si la respuesta del modelo se ejecuta en segundo plano. + Si la respuesta del modelo se ejecuta en segundo plano. @@ -341,7 +340,7 @@ Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que - La entidad responsable de pagar la respuesta. + La entidad responsable de pagar por la respuesta. @@ -353,7 +352,7 @@ Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que - Un objeto de error que se devuelve cuando el modelo no puede generar una respuesta. + Un objeto de error que se devuelve cuando el modelo no logra generar una respuesta. @@ -363,7 +362,7 @@ Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que - Una descripción legible por humanos del error. + Una descripción del error legible para humanos. @@ -371,7 +370,7 @@ Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que - Identificador único de esta Response. + Identificador único de esta respuesta. @@ -389,15 +388,15 @@ Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que - Conjunto de pares clave-valor que se pueden adjuntar a la respuesta. + Conjunto de pares clave-valor que puedes adjuntar a la respuesta. - Resultados de moderación para la entrada y la salida de la respuesta, si se solicitaron completados moderados. + Resultados de moderación para la entrada y la salida de la respuesta, si se solicitaron finalizaciones moderadas. - El tipo de objeto de este recurso: siempre se establece en `response`. + El tipo de objeto de este recurso, siempre establecido en `response`. Valores posibles: `response` @@ -408,14 +407,14 @@ Establecerlo en `{ "type": "json_object" }` habilita el modo JSON anterior, que - La longitud y el orden de los elementos del arreglo `output` dependen de la respuesta del modelo. - En lugar de acceder al primer elemento del arreglo `output` y - suponer que es un mensaje `assistant` con el contenido generado por + suponer que es un mensaje de `assistant` con el contenido generado por el modelo, considera usar la propiedad `output_text` donde sea compatible en los SDK. Propiedad de conveniencia exclusiva del SDK que contiene la salida de texto agregada -de todos los elementos `output_text` del arreglo `output`, si los hay. +de todos los elementos `output_text` del arreglo `output`, si hay alguno presente. Compatible con los SDK de Python y JavaScript. @@ -424,11 +423,11 @@ Compatible con los SDK de Python y JavaScript. - Penaliza los tokens nuevos según si ya aparecen en el texto hasta el momento. + Penaliza los tokens nuevos según si aparecen en el texto hasta el momento. - OpenAI lo usa para almacenar en caché las respuestas de solicitudes similares y optimizar la tasa de aciertos de la caché. Reemplaza al campo `user`. + OpenAI lo usa para almacenar en caché las respuestas de solicitudes similares y optimizar la tasa de aciertos de la caché. Reemplaza el campo `user`. @@ -436,7 +435,7 @@ Compatible con los SDK de Python y JavaScript. - Un identificador estable que ayuda a detectar usuarios de tu aplicación que podrían estar infringiendo las políticas de uso de OpenAI. + Un identificador estable que ayuda a detectar a los usuarios de tu aplicación que podrían estar infringiendo las políticas de uso de OpenAI. @@ -506,7 +505,7 @@ Compatible con los SDK de Python y JavaScript. - El número máximo de tokens más probables que se devuelven en cada posición de token, cada uno con su probabilidad logarítmica asociada. + El número máximo de tokens más probables que se devolverán en cada posición de token, cada uno con su probabilidad logarítmica asociada. @@ -524,7 +523,21 @@ un desglose de los tokens de salida y el total de tokens usados. El número de tokens de entrada que se escribieron en la caché. - + + + + Las escrituras en caché desglosadas por tiempo de vida de la caché. Los dos recuentos suman `cache_write_tokens`. + + + + El número de tokens de entrada escritos en la caché con un tiempo de vida de 12 horas. + + + + El número de tokens de entrada escritos en la caché con un tiempo de vida de 30 minutos. + + + El número de tokens que se recuperaron de la caché. [Más sobre el almacenamiento en caché de prompts](https://platform.openai.com/docs/guides/prompt-caching). @@ -546,7 +559,7 @@ un desglose de los tokens de salida y el total de tokens usados. - Identificador obsoleto del usuario final. Reemplazado por `safety_identifier` y `prompt_cache_key`. + Identificador obsoleto para el usuario final. Reemplazado por `safety_identifier` y `prompt_cache_key`. ## Ejemplos diff --git a/es/development/comfy-router/models/openai/gpt-image-1/code.mdx b/es/development/comfy-router/models/openai/gpt-image-1/code.mdx deleted file mode 100644 index 7b5a2c242c..0000000000 --- a/es/development/comfy-router/models/openai/gpt-image-1/code.mdx +++ /dev/null @@ -1,356 +0,0 @@ ---- -title: "Usa GPT Image 1 con Comfy Router" -description: "Llama a openai/gpt-image-1 con Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." -sidebarTitle: "GPT Image 1" -translationSourceHash: 02331b72 -translationFrom: development/comfy-router/models/openai/gpt-image-1/code.mdx -translationBlockHashes: - "_intro": 410036c3 - "Quick start": b83102e7 - "Schema": 8be561c9 - "Examples": c73859ec ---- -{/* GENERATED FILE. Generated from router-schemas/openai/gpt-image-1.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; - -Referencia de API para `openai/gpt-image-1`, servida por Comfy Router desde OpenAI. - -**Entrada:** Texto, Imagen · **Salida:** Imagen - -## Inicio rápido - -Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada sobre HTTP directo. - -**ID del modelo:** `openai/gpt-image-1` - -**Endpoint:** `POST https://api.comfy.org/v2/models/openai/gpt-image-1` - - - - -```python Python -from comfy_sdk import Comfy - -# Lee COMFY_API_KEY del entorno. -# El SDK crea automáticamente una clave de idempotencia y la reutiliza en los reintentos automáticos. -with Comfy() as client: - result = client.models.run( - "openai/gpt-image-1", - { - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY del entorno. -// El SDK crea automáticamente una clave de idempotencia y la reutiliza en los reintentos automáticos. -const { data } = await comfy.models.run("openai/gpt-image-1", { - prompt: "a rocketship on a launchpad", - quality: "low", - size: "1024x1024", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/gpt-image-1 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" -``` - - - -El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/openai/gpt-image-1/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y puedes recoger el resultado cuando esté listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# Lee COMFY_API_KEY del entorno. -# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza en los reintentos automáticos. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/gpt-image-1", - { - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024", - }, - ) - print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que necesita otro proceso - - # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # La carga útil propia del proveedor, el mismo valor que devuelve models.run(). - # Una solicitud que falló o se canceló lanza aquí el error tipado de Router. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY del entorno. -// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza en los reintentos automáticos. -const handle = await comfy.models.submit("openai/gpt-image-1", { - prompt: "a rocketship on a launchpad", - quality: "low", - size: "1024x1024", -}); -console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que necesita otro proceso - -// Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. -curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" - -# 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras aún se ejecuta. -curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Esquema - -### Entrada - - - Transparencia del fondo. `auto` deja que el modelo elija. - - Valores posibles: `transparent`, `opaque`, `auto` - - - - La imagen o imágenes fuente que se van a editar. LA PRESENCIA DE ESTE CAMPO SELECCIONA LA OPERACIÓN DE EDICIÓN: omítelo por completo para la generación de texto a imagen. -El ejemplo publicado del modelo es la llamada de GENERACIÓN, que omite este campo. Agregar `image` es toda la diferencia entre los dos modos: mismo endpoint, mismo id de modelo; salvo que un prompt de edición describe el CAMBIO que quieres, no la escena, así que el cuerpo de edición de abajo se lee distinto del ejemplo de generación aunque solo este campo sea estructuralmente nuevo. -Puedes copiarlo exactamente como se muestra: `{"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}`. La carga útil es un PNG 1x1 completo, no una abreviatura, y este cuerpo está fijado como un caso aceptado en las pruebas de validación de solicitudes del propio Router. Sustituye los bytes por los de tu propia imagen. -Acepta una imagen o un arreglo de ellas; gpt-image-1 y versiones posteriores aceptan hasta 16, y Router lo aplica desde este esquema antes de despachar. - - - - Una imagen, ya sea una URL https que Router obtiene en nombre de quien llama o un URI `data:image/;base64,` que lleva los bytes en línea. Los tipos de imagen aceptados son png, webp y jpeg, y ese conjunto se APLICA en el momento de resolver, en lugar de dejarlo al proveedor: un svg, gif, avif o tiff se rechaza aquí, nombrando la imagen que enviaste, en vez de convertirse en un error del socio a dos saltos de la causa. -Prefiere la forma de URL. Una carga útil en base64 se infla aproximadamente 4/3 y todo el cuerpo de la solicitud tiene un límite de 100 MiB, así que la forma en línea llega como máximo a una imagen fuente de unos 75 MB; una URL evita eso por completo. Los techos de medios por imagen y por solicitud indicados al final de esta descripción son más estrictos que el límite del cuerpo, así que para una imagen de cualquier tamaño real son lo primero que encuentras. -**La URL debe resolverse sin tus credenciales.** Router la obtiene del lado del servidor y no envía ninguna credencial de quien llama con la solicitud, así que una URL prefirmada, cuya firma está en la cadena de consulta, es la forma admitida. Un endpoint autenticado como `/api/assets/{id}/content` le responde a Router con 401 en lugar de la imagen; solicita esa URL tú mismo y pasa la URL firmada a la que redirige. -**La obtención está limitada a un conjunto nombrado de hosts** en lugar de a la internet abierta, y la misma lista se vuelve a aplicar a cada salto de redirección, así como a la URL que envías: por eso, una URL en cualquier otro host, o una que redirija fuera de la lista, se rechaza antes de contactar a cualquier proveedor. Hoy esa lista es solo la entrega de recursos propia de Comfy: una URL firmada de `storage.googleapis.com` dentro de un bucket de recursos de Comfy, que es la forma a la que te redirige `/api/assets/{id}/content`. Un CDN de un socio o un host https simple NO está en la lista. -**Dos ampliaciones se están implementando y ambas están desactivadas por defecto hoy.** Se lanzan detrás de UN interruptor y se habilitan juntas, así que trata todo lo que sigue como algo próximo, no como algo sobre lo que construir todavía: pregunta antes de depender de cualquiera de las dos. -La PRIMERA es el bucket en el que `POST /customers/storage` firma tu carga. Hasta que la implementación llegue a tu entorno, una URL de carga de ese endpoint se rechaza aquí, aunque el bucket sea propio de Comfy y el host sea el mismo: así que “subir a Comfy y luego pasar la URL” NO funciona todavía, y la forma que sí funciona es la URL firmada a la que redirige `/api/assets/{id}/content`. -La SEGUNDA se HABILITA POR CUENTA, no para todos a la vez, porque el bucket detrás de estos hosts es tuyo, no nuestro: incluso una vez que el interruptor anterior está activado, una cuenta a la que no se le han habilitado los medios entrantes de terceros se rechaza, y se le dice con esas palabras en lugar de decirle que el host no es compatible. Pide a tu contacto de Comfy que lo habilite para tu cuenta. Además, admite estos hosts de almacenamiento de objetos de terceros, donde el bucket es tuyo y Router no reclama su propiedad: Cloudflare R2 (`.r2.cloudflarestorage.com`, `pub-.r2.dev`), Amazon S3 (`s3.amazonaws.com` y `s3..amazonaws.com`, ya sea en la forma de estilo de ruta o con el prefijo `.`), Azure Blob Storage (`.blob.core.windows.net`) y Alibaba Cloud OSS (`.oss-.aliyuncs.com`, incluido el endpoint `oss-accelerate`). Esos son endpoints de almacenamiento de objetos específicamente: un endpoint de propósito general en el mismo dominio del proveedor, como un disparador de Alibaba Function Compute, no está en la lista y se rechaza. -**Lo que se compara es la forma del nombre de host, no el proveedor**: por eso, nombrar un proveedor arriba NO significa que se acepte cada URL que ese proveedor pueda emitir, y vale la pena enunciar directamente tres casos que casi encajan, porque es razonable que quien llama llegue con cualquiera de ellos. Un DOMINIO PERSONALIZADO de R2 (`cdn.example.com`) NO se acepta: Cloudflare documenta `pub-.r2.dev` como un nombre de host de depuración con límite de velocidad y dirige el tráfico de producción a un dominio personalizado, pero un dominio personalizado no lleva nada en su nombre de host que lo identifique como R2, así que Router no puede distinguirlo de cualquier otro host y lo rechaza: prefirma el endpoint `.r2.cloudflarestorage.com` o usa la forma `pub-.r2.dev`. El endpoint dualstack IPv6 de S3 (`s3.dualstack..amazonaws.com`) tampoco se acepta; usa el endpoint regional simple. Tampoco se acepta la zona DNS alternativa de Azure Blob (`.z.blob.storage.azure.net`); usa `.blob.core.windows.net`. El rechazo que recibes nombra estas mismas formas, así que no tienes que venir aquí para leerlas. -Los marcadores de posición `` y `pub-` de arriba muestran la forma con la que normalmente llegarás; no son una restricción de profundidad. La coincidencia se hace sobre el sufijo de dominio del almacenamiento de objetos, así que un nombre más profundo bajo el mismo espacio de nombres (`a.b.pub-.r2.dev`) también es válido. Lo que NO se amplía con eso es el propio espacio de nombres: el sufijo debe seguir siendo uno de los listados. -El ejemplo de abajo muestra solo la forma: un valor real también incluye los parámetros de consulta de firma, que se omiten aquí a propósito porque un ejemplo publicado permanece en la especificación para siempre y una firma real es a la vez una credencial filtrada y un enlace que deja de funcionar. -Cada imagen tiene un límite de 25 MiB y las imágenes de una misma solicitud, de 64 MiB en total. - - - - El modelo gpt-image que se va a ejecutar. Router inserta el id del modelo direccionado, así que quien llama a /v2/models/openai/gpt-image-2 no envía este campo. - - - - Ajuste de moderación de contenido - - Valores posibles: `low`, `auto` - - - - El número de imágenes a generar (1-10). - - Rango: de `1` a `10` - - - - Nivel de compresión para JPEG o WebP (0-100) - - Rango: de `0` a `100` - - - - Formato de la imagen de salida - - Valores posibles: `png`, `webp`, `jpeg` - - - - Solo tiene sentido junto a un flujo en vivo, que esta superficie no puede servir: `stream` se fija en `false` incluso cuando lo envías. En una generación, cualquier valor distinto de `0` o `null` se rechaza con un 400, tanto si la solicitud también envía `stream: true` como si no; en una solicitud que lleva `image`, el campo se descarta en lugar de reenviarse. Omítelo. - - Rango: de `0` a `3` - - - - Una descripción de texto de la imagen que se va a generar, o de la edición que se va a hacer en `image`. - - - - La calidad de la imagen generada o editada. `xhigh` y `max` son los dos niveles para los que se añadieron gpt-image-2.5-flare y gpt-image-2.5-sunburst; `standard` y `hd` son grafías de la época de dall-e que ningún modelo admitido lee. - - Valores posibles: `auto`, `low`, `medium`, `high`, `xhigh`, `max`, `standard`, `hd` - - - - Tamaño de la imagen (p. ej., 1024x1024, 1536x1024, auto) - - - - Se declara para que a quien lo envíe no se le rechace, pero es INERTE en esta superficie: Router lo FIJA en `false` antes del despacho, porque captura la respuesta del proveedor en lugar de retransmitir un `text/event-stream` (una solicitud que lleva `image` descarta el campo, ya que la edición se recodifica sin él). Ninguna superficie de Comfy sirve el streaming de imágenes parciales de gpt-image: la entrada v1 `POST /proxy/openai/images/generations` rechaza `stream: true` con un 400 y nunca reenvía la solicitud al proveedor, así que omite el campo y lee la respuesta completada como un único cuerpo JSON. Como el stream nunca se abre, la restricción de OpenAI sobre combinar `stream: true` con `n` mayor que 1 no aplica aquí; `n` se reenvía tal como se envía. - - - - Un identificador único para el monitoreo de usuarios finales - - -Generado a partir del esquema que Router sirve en `GET /v2/models/openai/gpt-image-1/openapi.json`, el mismo documento contra el que valida una llamada antes de que la solicitud llegue al proveedor. - -### Salida - - - - - - - Datos de la imagen codificados en Base64 - - - - Prompt revisado - - - - URL de la imagen - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Indica si el fondo de la imagen generada es `opaque` o `transparent`, tal como OpenAI lo resolvió para esta generación. El parámetro de la solicitud tiene como valor predeterminado `auto`, así que aquí es donde quien llama y no lo fijó se entera de cuál se produjo. - - - - Marca de tiempo Unix, en segundos, de cuándo se completó la generación. Es el único miembro que OpenAI declara como REQUIRED en una respuesta de generación de imágenes, así que está presente siempre que OpenAI es el productor; una respuesta servida por fal, pika, wavespeed o runware en cualquiera de los ids respaldados por alternativas lo omite por completo, igual que los otros cuatro miembros de parámetros resueltos. Se declara `int64` porque un valor de época actual está lo bastante cerca de 2^31 como para que un `integer` sin formato genere un campo de 32 bits en muchos generadores de SDK. - - Formato: `int64` - - - - La codificación de los bytes en `data[].b64_json`: `png`, `webp` o `jpeg`. Es el formato que OpenAI realmente codificó, que es el `output_format` de la solicitud cuando se envió uno y `png` cuando no se envió ninguno, de modo que un decodificador puede basarse en él en lugar de volver a deducir el formato a partir de la solicitud. - - - - El nivel de calidad con el que realmente se ejecutó la generación. OpenAI informa uno de `low`, `medium`, `high`, `xhigh` o `max`. Es el nivel RESUELTO, no un eco de la solicitud, cuyo propio `quality` tiene como valor predeterminado `auto`. - - - - Las dimensiones en píxeles con las que realmente se ejecutó la generación, como `x`. Es el tamaño RESUELTO: el `size` de la solicitud tiene como valor predeterminado `auto` y admite explícitamente `auto`, así que este es el único lugar donde se informan las dimensiones realmente usadas. - - -## Ejemplos - -### Entrada - -```json -{ - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024" -} -``` - -### Salida - -```json -{ - "created": 1767225600, - "data": [ - { - "b64_json": "PGJhc2U2ND4=" - } - ], - "usage": { - "input_tokens": 12, - "input_tokens_details": { - "image_tokens": 0, - "text_tokens": 12 - }, - "output_tokens": 1056, - "total_tokens": 1068 - } -} -``` - - - diff --git a/es/development/comfy-router/models/openai/o1/code.mdx b/es/development/comfy-router/models/openai/o1/code.mdx deleted file mode 100644 index bdd4544fd5..0000000000 --- a/es/development/comfy-router/models/openai/o1/code.mdx +++ /dev/null @@ -1,601 +0,0 @@ ---- -title: "Usa o1 con Comfy Router" -description: "Llama a openai/o1 mediante Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." -sidebarTitle: "o1" -translationSourceHash: f0eb94c8 -translationFrom: development/comfy-router/models/openai/o1/code.mdx -translationBlockHashes: - "_intro": 86454249 - "Quick start": 7a99b942 - "Schema": 6de26ff5 - "Examples": 67e6c8f1 ---- -{/* ARCHIVO GENERADO. Generado a partir de router-schemas/openai/o1.json con `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; - -Referencia de API de `openai/o1`, servida por Comfy Router desde OpenAI. - -**Entrada:** Texto, Imagen · **Salida:** Texto - -## Inicio rápido - -Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada mediante HTTP sin procesar. - -**ID del modelo:** `openai/o1` - -**Endpoint:** `POST https://api.comfy.org/v2/models/openai/o1` - - - - -```python Python -from comfy_sdk import Comfy - -# Lee COMFY_API_KEY desde el entorno. -# El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -with Comfy() as client: - result = client.models.run( - "openai/o1", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY desde el entorno. -// El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. -const { data } = await comfy.models.run("openai/o1", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/o1 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/openai/o1/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recoge cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# Lee COMFY_API_KEY desde el entorno. -# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/o1", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que necesita otro proceso - - # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # El payload propio del proveedor, el mismo valor que devuelve models.run(). - # Una solicitud que falló o se canceló genera aquí el error tipado de Router. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// Lee COMFY_API_KEY desde el entorno. -// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. -const handle = await comfy.models.submit("openai/o1", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que necesita otro proceso - -// Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. -curl https://api.comfy.org/v2/models/openai/o1/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. -curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Esquema - -### Entrada - - - Datos de salida adicionales que se incluirán en la respuesta del modelo. - - - - Entradas de texto, imagen o archivo para el modelo, usadas para generar una respuesta. El único campo de este contrato que Router no puede proporcionar, y la única entrada en `required` a continuación. - - - - Inserta un mensaje de sistema (o de desarrollador) como el primer elemento del contexto del modelo. - - - - Un límite superior para la cantidad de tokens generados en una respuesta, incluidos los tokens de salida visibles y los tokens de razonamiento. En un ID de razonamiento, este límite se comparte con los tokens de razonamiento ocultos, por lo que un valor pequeño puede consumir todo el presupuesto antes de que aparezca cualquier texto visible. Por eso los casos de prueba de razonamiento envían 1024 donde los de chat envían 16. - - Rango: `1` a `…` - - - - Identificador del modelo de OpenAI. En Comfy Router este campo es OPCIONAL y Router lo completa desde el segmento de ruta `{model}`; Router reemplaza un `null` explícito de la misma manera. Router rechaza un valor que no coincida con la ruta. - - - - Indica si el modelo puede ejecutar llamadas a herramientas en paralelo. - - - - El ID de una respuesta anterior, para conversaciones de varios turnos. - - - - SOLO PARA EL NIVEL DE RAZONAMIENTO. Configuración para modelos de razonamiento, p. ej. `{"effort": "medium"}`. Router lo reenvía sin cambios; consulta la guía de razonamiento de OpenAI para conocer las claves aceptadas. Un ID de nivel de chat lo ignora. - - - - Indica si OpenAI almacena la respuesta generada para recuperarla más tarde. - - - - Declarado para que no se rechace a quien lo envíe, pero INERTE en esta superficie: Router lo FIJA en `false` antes del despacho, porque captura la respuesta del proveedor en lugar de retransmitir un `text/event-stream`, que no puede decodificar; por eso OpenAI facturaría una generación transmitida y nadie mediría su consumo. Ninguna superficie de Comfy ofrece el stream: el punto de entrada v1 `POST /proxy/openai/v1/responses` rechaza `stream: true` con un 400 y nunca reenvía la solicitud al proveedor, así que omite el campo o envía `false` en cualquiera de las dos superficies y lee la respuesta completada como un único cuerpo JSON. - - - - Temperatura de muestreo. SOLO PARA EL NIVEL DE CHAT: los IDs de razonamiento de la serie o (`o1`, `o1-pro`, `o3`, `o4-mini`) rechazan este parámetro en OpenAI. Router no lo rechaza para ellos (consulta la nota de este componente sobre por qué los dos niveles comparten un esquema), así que OpenAI responde a una llamada de razonamiento que lo envíe con su propio error. - - Rango: `0` a `2` - - - - Configuración del formato de salida, p. ej. `{"format": {"type": "json_schema", ...}}` para Structured Outputs. Router lo reenvía sin cambios. - - - - Cómo debe seleccionar el modelo qué herramienta usar. Un modo de tipo cadena o un objeto que nombra una herramienta. - - - - Definiciones de herramientas que el modelo puede llamar. Router no restringe la taxonomía de herramientas; consulta la referencia de la API Responses de OpenAI para conocer las formas aceptadas. - - - - Corte del muestreo de núcleo. SOLO PARA EL NIVEL DE CHAT, en los mismos términos que `temperature`. - - Rango: `0` a `1` - - - - Estrategia de truncamiento cuando el contexto supera la ventana del modelo. El enum SÍ se aplica aquí, a diferencia de los tres vocabularios anteriores, porque estos dos valores son el conjunto completo que documenta OpenAI y no ha crecido. Un `null` explícito todavía se acepta, en los mismos términos que los campos anteriores. - - Valores posibles: `auto`, `disabled` - - - - Envoltorio de uso de tokens. Está presente en este contrato porque la operación v1 lo declara en el cuerpo de la solicitud; OpenAI lo completa en la RESPUESTA, así que quien llama no tiene motivo para enviarlo. - - -Generado a partir del esquema que Router sirve en `GET /v2/models/openai/o1/openapi.json`, el mismo documento contra el que valida una llamada antes de que la solicitud llegue al proveedor. - -### Salida - - - Inserta un mensaje de sistema (o de desarrollador) como primer elemento en el contexto del modelo. - -Cuando se usa junto con `previous_response_id`, las instrucciones de una respuesta anterior no se transferirán a la siguiente respuesta. Esto facilita el intercambio de mensajes de sistema (o de desarrollador) en nuevas respuestas. - - - - Un límite superior para la cantidad de tokens que se pueden generar para una respuesta, incluidos los tokens de salida visibles y los [tokens de razonamiento](https://platform.openai.com/docs/guides/reasoning). - - - - El modelo usado para generar la respuesta - - - - Controla la aleatoriedad de la respuesta - - Rango: `0` a `2` - - - - Controla la diversidad de la respuesta mediante muestreo de núcleo - - Rango: `0` a `1` - - - - La estrategia de truncamiento que se usa para la respuesta del modelo. -- `auto`: si el contexto de esta respuesta y las anteriores supera el tamaño de la ventana de contexto del modelo, el modelo truncará la respuesta para ajustarla a la ventana de contexto descartando elementos de entrada en el medio de la conversación. -- `disabled` (predeterminado): si una respuesta del modelo supera el tamaño de la ventana de contexto de un modelo, la solicitud fallará con un error 400. - - Valores posibles: `auto`, `disabled` - - - - El ID único de la respuesta anterior del modelo. Úsalo para crear conversaciones de varios turnos. Aprende más sobre el [estado de la conversación](https://platform.openai.com/docs/guides/conversation-state). - - - - **Solo modelos de la serie o** - -Opciones de configuración para [modelos de razonamiento](https://platform.openai.com/docs/guides/reasoning). - - - - Controla qué elementos de razonamiento se devuelven al modelo en turnos posteriores, por ejemplo `auto`, `current_turn` o `all_turns`. - - - - **Solo modelos de la serie o** - -Limita el esfuerzo de razonamiento de los [modelos de razonamiento](https://platform.openai.com/docs/guides/reasoning). Actualmente los valores admitidos son `low`, `medium` y `high`. Reducir el esfuerzo de razonamiento puede dar como resultado respuestas más rápidas y menos tokens usados en el razonamiento de una respuesta. - - Valores posibles: `low`, `medium`, `high` - - - - **Obsoleto:** usa `summary` en su lugar. - -Un resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. - - Valores posibles: `auto`, `concise`, `detailed` - - - - El modo de razonamiento usado para la respuesta. - - - - Un resumen del razonamiento realizado por el modelo. Esto puede ser útil para depurar y comprender el proceso de razonamiento del modelo. Uno de `auto`, `concise` o `detailed`. - - Valores posibles: `auto`, `concise`, `detailed` - - - - - - - - Un objeto que especifica el formato que el modelo debe generar. - -Configurar `{ "type": "json_schema" }` habilita las salidas estructuradas, lo que garantiza que el modelo coincida con el esquema JSON que proporciones. Aprende más en la [guía de salidas estructuradas](https://platform.openai.com/docs/guides/structured-outputs). - -El formato predeterminado es `{ "type": "text" }` sin opciones adicionales. - -**No recomendado para gpt-4o y modelos más nuevos:** - -Configurar `{ "type": "json_object" }` habilita el modo JSON anterior, que garantiza que el mensaje que genera el modelo sea JSON válido. Se prefiere usar `json_schema` para los modelos que lo admiten. - - - - Limita la verbosidad de la respuesta del modelo. Uno de `low`, `medium` o `high`. - - - - Cómo debe seleccionar el modelo qué herramienta (o herramientas) usar al generar una respuesta. Consulta el parámetro `tools` para ver cómo especificar qué herramientas puede llamar el modelo. - - - - - - - - Indica si la respuesta del modelo se ejecuta en segundo plano. - - - - Información de facturación de la respuesta. - - - - La parte responsable de pagar por la respuesta. - - - - Marca de tiempo Unix (en segundos) de cuándo se completó esta respuesta. Solo está presente cuando el estado es `completed`. - - - - Marca de tiempo Unix (en segundos) de cuándo se creó esta respuesta. - - - - Un objeto de error que se devuelve cuando el modelo no logra generar una respuesta. - - - - El código de error de la respuesta. - - Valores posibles: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - Una descripción legible del error. - - - - Penaliza los tokens nuevos según su frecuencia existente en el texto hasta el momento. - - - - Identificador único de esta Response. - - - - Detalles sobre por qué la respuesta está incompleta. - - - - El motivo por el que la respuesta está incompleta. - - Valores posibles: `max_output_tokens`, `content_filter` - - - - El número máximo total de llamadas a herramientas integradas que se pueden procesar en una respuesta. - - - - Conjunto de pares clave-valor que se pueden adjuntar a la respuesta. - - - - Resultados de moderación para la entrada y la salida de la respuesta, si se solicitaron completados moderados. - - - - El tipo de objeto de este recurso. Siempre se establece en `response`. - - Valores posibles: `response` - - - - Un arreglo de elementos de contenido generados por el modelo. - -- La longitud y el orden de los elementos del arreglo `output` dependen - de la respuesta del modelo. -- En lugar de acceder al primer elemento del arreglo `output` y - suponer que es un mensaje `assistant` con el contenido generado por - el modelo, considera usar la propiedad `output_text` donde - los SDK lo admitan. - - - - Propiedad de conveniencia exclusiva del SDK que contiene la salida de texto agregada -de todos los elementos `output_text` del arreglo `output`, si los hay. -Compatible con los SDK de Python y JavaScript. - - - - Indica si se permite que el modelo ejecute llamadas a herramientas en paralelo. - - - - Penaliza los tokens nuevos según si ya aparecen en el texto hasta el momento. - - - - OpenAI la usa para almacenar en caché las respuestas de solicitudes similares y optimizar la tasa de aciertos de la caché. Reemplaza el campo `user`. - - - - La política de retención de la caché de prompts, p. ej. `in_memory` o `24h`. - - - - Un identificador estable que ayuda a detectar usuarios de tu aplicación que podrían estar infringiendo las políticas de uso de OpenAI. - - - - El nivel de procesamiento usado para atender la solicitud, p. ej. `auto`, `default`, `flex`, `scale` o `priority`. - - - - El estado de la generación de la respuesta. Uno de `completed`, `failed`, `in_progress`, `cancelled`, `queued` o `incomplete`. - - Valores posibles: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - Indica si la respuesta se almacena para recuperarla más tarde mediante la API. - - - - Uso de tokens y solicitudes desglosado por herramienta integrada. - - - - Uso de tokens de la herramienta de generación de imágenes. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Uso de la herramienta de búsqueda web. - - - - - - - - El número máximo de tokens más probables que se devuelven en cada posición de token, cada uno con su probabilidad logarítmica asociada. - - - - Representa los detalles de uso de tokens, incluidos los tokens de entrada, los tokens de salida, -un desglose de los tokens de salida y el total de tokens usados. - - - - La cantidad de tokens de entrada. - - - - Un desglose detallado de los tokens de entrada. - - - - La cantidad de tokens de entrada que se escribieron en la caché. - - La cantidad de tokens que se recuperaron de la caché. -[Más información sobre el almacenamiento en caché de prompt](https://platform.openai.com/docs/guides/prompt-caching). - - - - La cantidad de tokens de salida. - - - - Un desglose detallado de los tokens de salida. - - - - La cantidad de tokens de razonamiento. - - - - La cantidad total de tokens utilizados. - - - - Identificador obsoleto para el usuario final. Reemplazado por `safety_identifier` y `prompt_cache_key`. - - -## Ejemplos - -### Entrada - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### Salida - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/es/development/comfy-router/models/pika/pika-music/code.mdx b/es/development/comfy-router/models/pika/pika-music/code.mdx new file mode 100644 index 0000000000..57f69155f9 --- /dev/null +++ b/es/development/comfy-router/models/pika/pika-music/code.mdx @@ -0,0 +1,294 @@ +--- +title: "Usar Pika Music con Comfy Router" +description: "Llama a pika/pika-music con Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve el Router." +sidebarTitle: "Pika Music" +translationSourceHash: 62ef6d01 +translationFrom: development/comfy-router/models/pika/pika-music/code.mdx +translationBlockHashes: + "_intro": d1b9e7b6 + "Quick start": f073a693 + "Schema": 738d1494 + "Examples": a7cf936e +--- +{/* ARCHIVO GENERADO. Generado desde router-schemas/pika/pika-music.json por `pnpm code-pages:gen`. */} + +import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; + +Referencia de API de `pika/pika-music`, servida por Comfy Router desde Pika. + +**Entrada:** Texto, Audio · **Salida:** Audio + +## Inicio rápido + +Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada sobre HTTP sin procesar. + +**ID del modelo:** `pika/pika-music` + +**Endpoint:** `POST https://api.comfy.org/v2/models/pika/pika-music` + + + + +```python Python +from comfy_sdk import Comfy + +# Lee COMFY_API_KEY del entorno. +# El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. +with Comfy() as client: + result = client.models.run( + "pika/pika-music", + { + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// Lee COMFY_API_KEY del entorno. +// El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. +const { data } = await comfy.models.run("pika/pika-music", { + duration: 30, + mode: "text_to_music", + prompt: "warm lo-fi hip hop with soft piano and vinyl crackle", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-music \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}" +``` + + + +El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/pika/pika-music/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recopila cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) recorre el estado, la cancelación y la recopilación. + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# Lee COMFY_API_KEY del entorno. +# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-music", + { + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle", + }, + ) + print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que otro proceso necesita + + # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # La carga propia del proveedor, el mismo valor que devuelve models.run(). + # Una solicitud que falló o se canceló genera aquí el error tipado de Router. + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// Lee COMFY_API_KEY del entorno. +// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. +const handle = await comfy.models.submit("pika/pika-music", { + duration: 30, + mode: "text_to_music", + prompt: "warm lo-fi hip hop with soft piano and vinyl crackle", +}); +console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que otro proceso necesita + +// Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí. +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. +curl https://api.comfy.org/v2/models/pika/pika-music/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}" + +# 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. Recopila. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. +curl https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## Esquema + +### Entrada + + + Limpia el audio de referencia antes de usarlo. + + + + Duración de la música en segundos, de 10 a 360. + + Rango: `10` a `360` + + + + Letra para cantar. + + + + Modo de generación: text_to_music, voice_conditioned_text_to_music o music_cover. + + Valores posibles: `text_to_music`, `voice_conditioned_text_to_music`, `music_cover` + + + + Descripción de la música. + + + + URL de una referencia de voz. Requiere que `voice_consent_attested` esté establecido en true. + + + + Expande un prompt corto con un modelo antes de la generación. + + + + Semilla para una salida reproducible, de -1 a 2147483647. -1 elige una semilla aleatoria. + + Rango: `-1` a `2147483647` + + + + URL de la canción fuente para `music_cover`. + + + + Confirma que quien llama tiene los derechos para clonar la voz en `reference_audio`. + + +Generado a partir del esquema que Router sirve en `GET /v2/models/pika/pika-music/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor. + +### Salida + + + Se establece en una tarea `failed`. + + + + Código de fallo legible por máquina, como invalid_input, content_moderation o provider_error. + + + + Texto de diagnóstico. + + + + ID de trabajo usado para consultar el estado. + + + + La entrada del catálogo de Pika que ejecutó la tarea. + + + + Los archivos multimedia de la tarea finalizada, establecidos cuando `status` es `completed`. + + + + Un archivo multimedia generado. + + + + Tipo MIME del archivo. + + + + URL de descarga del archivo generado. + + + + Qué campo contiene el archivo: video o audio. + + + + Un archivo multimedia generado. + + + + Tipo MIME del archivo. + + + + URL de descarga del archivo generado. + + + + Estado de la tarea: queued, running, completed o failed. + + + + Unidades que Pika reportó para la tarea. + + +## Ejemplos + +### Entrada + +```json +{ + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle" +} +``` + +### Salida + +```json +{ + "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44", + "output": { + "audio": { + "content_type": "audio/mpeg", + "url": "https://example.invalid/pika/audio.mp3" + }, + "media_type": "audio" + }, + "status": "completed" +} +``` + + diff --git a/es/development/comfy-router/models/pika/pika-sfx/code.mdx b/es/development/comfy-router/models/pika/pika-sfx/code.mdx new file mode 100644 index 0000000000..6de26d00f4 --- /dev/null +++ b/es/development/comfy-router/models/pika/pika-sfx/code.mdx @@ -0,0 +1,259 @@ +--- +title: "Usa Pika Sfx con Comfy Router" +description: "Llama a pika/pika-sfx mediante Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." +sidebarTitle: "Pika Sfx" +translationSourceHash: 2df41acd +translationFrom: development/comfy-router/models/pika/pika-sfx/code.mdx +translationBlockHashes: + "_intro": f4076086 + "Quick start": e5b7bc82 + "Schema": c9ccd2ee + "Examples": f88686f5 +--- +{/* GENERATED FILE. Generated from router-schemas/pika/pika-sfx.json by `pnpm code-pages:gen`. */} + +import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; + +Referencia de API para `pika/pika-sfx`, servida por Comfy Router desde Pika. + +**Entrada:** Texto · **Salida:** Audio + +## Inicio rápido + +Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada por HTTP directo. + +**ID del modelo:** `pika/pika-sfx` + +**Endpoint:** `POST https://api.comfy.org/v2/models/pika/pika-sfx` + + + + +```python Python +from comfy_sdk import Comfy + +# Lee COMFY_API_KEY del entorno. +# El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. +with Comfy() as client: + result = client.models.run( + "pika/pika-sfx", + { + "duration": 2, + "prompt": "a wooden door creaking open", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// Lee COMFY_API_KEY del entorno. +// El SDK crea automáticamente una clave de idempotencia y la reutiliza para los reintentos automáticos. +const { data } = await comfy.models.run("pika/pika-sfx", { + duration: 2, + prompt: "a wooden door creaking open", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-sfx \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" +``` + + + +El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/pika/pika-sfx/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se obtiene cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) describe el estado, la cancelación y la obtención del resultado. + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# Lee COMFY_API_KEY del entorno. +# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-sfx", + { + "duration": 2, + "prompt": "a wooden door creaking open", + }, + ) + print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que otro proceso necesita + + # Consulta repetidamente hasta que la solicitud se complete, esperando el Retry-After que indique el servidor. + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # La carga útil propia del proveedor, el mismo valor que devuelve models.run(). + # Una solicitud que falló o se canceló lanza aquí el error tipado de Router. + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// Lee COMFY_API_KEY del entorno. +// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza para los reintentos automáticos. +const handle = await comfy.models.submit("pika/pika-sfx", { + duration: 2, + prompt: "a wooden door creaking open", +}); +console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que otro proceso necesita + +// Consulta repetidamente hasta que la solicitud se complete, esperando el Retry-After que indique el servidor. +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló provoca un rechazo aquí. +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. +curl https://api.comfy.org/v2/models/pika/pika-sfx/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" + +# 2. Consulta repetidamente hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indique cada respuesta. +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. Obtén. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. +curl https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## Esquema + +### Entrada + + + Duración del efecto de sonido en segundos, de 1 a 20. + + Rango: `1` a `20` + + + + Descripción del efecto de sonido. + + + + Semilla para obtener resultados reproducibles, de -1 a 2147483647. Con -1 se elige una semilla aleatoria. + + Rango: `-1` a `2147483647` + + +Generado a partir del esquema que Router publica en `GET /v2/models/pika/pika-sfx/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor. + +### Salida + + + Se asigna cuando la tarea está `failed`. + + + + Código de error legible por máquina, como invalid_input, content_moderation o provider_error. + + + + Texto de diagnóstico. + + + + ID de trabajo que se usa para consultar el estado. + + + + La entrada del catálogo de Pika con la que se ejecutó la tarea. + + + + Los archivos multimedia de la tarea finalizada; se asigna cuando `status` es `completed`. + + + + Un archivo multimedia generado. + + + + Tipo MIME del archivo. + + + + URL de descarga del archivo generado. + + + + Indica qué campo contiene el archivo: video o audio. + + + + Un archivo multimedia generado. + + + + Tipo MIME del archivo. + + + + URL de descarga del archivo generado. + + + + Estado de la tarea: queued, running, completed o failed. + + + + Unidades que Pika informó para la tarea. + + +## Ejemplos + +### Entrada + +```json +{ + "duration": 2, + "prompt": "a wooden door creaking open" +} +``` + +### Salida + +```json +{ + "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44", + "output": { + "audio": { + "content_type": "audio/mpeg", + "url": "https://example.invalid/pika/audio.mp3" + }, + "media_type": "audio" + }, + "status": "completed" +} +``` + + diff --git a/es/development/comfy-router/models/pika/pika-soundtrack/code.mdx b/es/development/comfy-router/models/pika/pika-soundtrack/code.mdx new file mode 100644 index 0000000000..7ce47acaff --- /dev/null +++ b/es/development/comfy-router/models/pika/pika-soundtrack/code.mdx @@ -0,0 +1,257 @@ +--- +title: "Usa Pika Soundtrack con Comfy Router" +description: "Llama a pika/pika-soundtrack mediante Comfy Router: endpoint, forma de la solicitud y respuesta que devuelve Router." +sidebarTitle: "Pika Soundtrack" +translationSourceHash: f897473f +translationFrom: development/comfy-router/models/pika/pika-soundtrack/code.mdx +translationBlockHashes: + "_intro": 51801b91 + "Quick start": f4397b26 + "Schema": 48e8da0c + "Examples": 3da11fda +--- +{/* GENERATED FILE. Generated from router-schemas/pika/pika-soundtrack.json by `pnpm code-pages:gen`. */} + +import RouterCodeFooter from "/snippets/es/comfy-router/model-code-footer.mdx"; + +Referencia de API para `pika/pika-soundtrack`, servida por Comfy Router desde Pika. + +**Entrada:** Video, Texto · **Salida:** Video + Audio + +## Inicio rápido + +Crea una clave en [tu espacio de trabajo de Comfy](https://platform.comfy.org/profile/api-keys?onboarding=router) y expórtala como `COMFY_API_KEY`. Los fragmentos de Python y TypeScript usan los SDK de Comfy (`pip install comfy-sdk` y `npm install @comfyorg/sdk`); el fragmento de cURL es la misma llamada sobre HTTP directo. + +**ID del modelo:** `pika/pika-soundtrack` + +**Endpoint:** `POST https://api.comfy.org/v2/models/pika/pika-soundtrack` + + + + +```python Python +from comfy_sdk import Comfy + +# Lee COMFY_API_KEY desde las variables de entorno. +# El SDK crea automáticamente una clave de idempotencia y la reutiliza en los reintentos automáticos. +with Comfy() as client: + result = client.models.run( + "pika/pika-soundtrack", + { + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// Lee COMFY_API_KEY desde las variables de entorno. +// El SDK crea automáticamente una clave de idempotencia y la reutiliza en los reintentos automáticos. +const { data } = await comfy.models.run("pika/pika-soundtrack", { + seed: -1, + video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-soundtrack \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" +``` + + + +El mismo cuerpo, enviado a `POST https://api.comfy.org/v2/models/pika/pika-soundtrack/requests`. Router responde `201` con un `request_id` en cuanto se admite la ejecución, y el resultado se recoge cuando está listo, desde este proceso o desde otro. [Entrega en cola](/es/development/comfy-router/queue) explica el estado, la cancelación y la recogida. + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# Lee COMFY_API_KEY desde las variables de entorno. +# Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza en los reintentos automáticos. +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-soundtrack", + { + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", + }, + ) + print("request_id:", handle.request_id) # junto con el ID del modelo, es todo lo que necesita otro proceso + + # Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # El payload propio del proveedor, el mismo valor que devuelve models.run(). + # Una solicitud que falló o se canceló lanza aquí el error tipado de Router. + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// Lee COMFY_API_KEY desde las variables de entorno. +// Cada llamada a submit() genera su propia Idempotency-Key y la reutiliza en los reintentos automáticos. +const handle = await comfy.models.submit("pika/pika-soundtrack", { + seed: -1, + video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", +}); +console.log("requestId:", handle.requestId); // junto con el ID del modelo, es todo lo que necesita otro proceso + +// Consulta hasta que la solicitud se complete, esperando el Retry-After que indica el servidor. +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// El mismo resultado que devuelve models.run(). Una solicitud que falló o se canceló se rechaza aquí. +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. Envía. Router responde 201 con request_id, status_url, response_url y cancel_url. +curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" + +# 2. Consulta hasta que el estado sea COMPLETED, esperando los segundos de Retry-After que indica cada respuesta. +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. Recoge. 200 con la salida nativa del modelo, 202 con el cuerpo de estado mientras sigue en ejecución. +curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## Esquema + +### Entrada + + + Qué debe ser el audio y cómo acompaña a la acción. Omítelo para hacer diseño de sonido solo a partir del video. + + + + Semilla de -1 a 2147483647. -1 elige una semilla aleatoria. + + Rango: `-1` a `2147483647` + + + + URL del video de origen, H.264 o HEVC, de 1200 segundos y 2 GB como máximo. + + +Generado a partir del esquema que Router sirve en `GET /v2/models/pika/pika-soundtrack/openapi.json`, el mismo documento con el que valida una llamada antes de que la solicitud llegue al proveedor. + +### Salida + + + Se asigna cuando la tarea está `failed`. + + + + Código de fallo legible por máquina, como invalid_input, content_moderation o provider_error. + + + + Texto de diagnóstico. + + + + ID de trabajo que se usa para consultar el estado. + + + + La entrada del catálogo de Pika con la que se ejecutó la tarea. + + + + Los medios de la tarea finalizada, asignados cuando `status` es `completed`. + + + + Un archivo de medios generado. + + + + Tipo MIME del archivo. + + + + URL de descarga del archivo generado. + + + + Qué campo lleva el archivo: video o audio. + + + + Un archivo de medios generado. + + + + Tipo MIME del archivo. + + + + URL de descarga del archivo generado. + + + + Estado de la tarea: queued, running, completed o failed. + + + + Unidades que Pika informó para la tarea. + + +## Ejemplos + +### Entrada + +```json +{ + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4" +} +``` + +### Salida + +```json +{ + "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0", + "output": { + "media_type": "video", + "video": { + "content_type": "video/mp4", + "url": "https://example.invalid/pika/video.mp4" + } + }, + "status": "completed" +} +``` + + diff --git a/es/development/comfy-router/pricing.mdx b/es/development/comfy-router/pricing.mdx index 0d4e046f06..6fe6729241 100644 --- a/es/development/comfy-router/pricing.mdx +++ b/es/development/comfy-router/pricing.mdx @@ -131,26 +131,26 @@ Las tarifas por uso de Comfy se facturan por segundo de GPU activo; el costo tot | [Qwen Image 3.0 Pro](/es/development/comfy-router/models/qwen/qwen-image-3-0-pro/code) | `qwen/qwen-image-3.0-pro` | Imagen de entrada · 1K / 2K | 0.9052 / imagen de entrada | | [Seedream 5.0 Pro](/es/development/comfy-router/models/byteplus/seedream-5-0-pro-260628/code) | `byteplus/seedream-5-0-pro-260628` | Imágenes de entrada después de la primera | 0.633 / imagen de entrada | -#### Tarifas por Recraft credit +#### Tarifas por crédito de Recraft | Nombre | ID del modelo | Créditos | | --- | --- | ---: | -| [Recraft V2](/es/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | 0.3017 / Recraft credit | -| [Recraft V3](/es/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | 0.3017 / Recraft credit | -| [Recraft V4](/es/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | 0.3017 / Recraft credit | -| [Recraft V4 Pro](/es/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | 0.3017 / Recraft credit | -| [Recraft V4 Styles](/es/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Pro](/es/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Vector](/es/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1](/es/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | 0.3017 / Recraft credit | -| [Recraft V4.1 Pro](/es/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | 0.3017 / Recraft credit | -| [Recraft V4.1 Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility](/es/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Pro](/es/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Vector](/es/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Vector](/es/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | 0.3017 / Recraft credit | +| [Recraft V2](/es/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | 0.3017 / crédito de Recraft | +| [Recraft V3](/es/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | 0.3017 / crédito de Recraft | +| [Recraft V4](/es/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | 0.3017 / crédito de Recraft | +| [Recraft V4 Pro](/es/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | 0.3017 / crédito de Recraft | +| [Recraft V4 Styles](/es/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | 0.3017 / crédito de Recraft | +| [Recraft V4 Styles Pro](/es/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | 0.3017 / crédito de Recraft | +| [Recraft V4 Styles Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | 0.3017 / crédito de Recraft | +| [Recraft V4 Styles Vector](/es/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | 0.3017 / crédito de Recraft | +| [Recraft V4.1](/es/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | 0.3017 / crédito de Recraft | +| [Recraft V4.1 Pro](/es/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | 0.3017 / crédito de Recraft | +| [Recraft V4.1 Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | 0.3017 / crédito de Recraft | +| [Recraft V4.1 Utility](/es/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | 0.3017 / crédito de Recraft | +| [Recraft V4.1 Utility Pro](/es/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | 0.3017 / crédito de Recraft | +| [Recraft V4.1 Utility Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | 0.3017 / crédito de Recraft | +| [Recraft V4.1 Utility Vector](/es/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | 0.3017 / crédito de Recraft | +| [Recraft V4.1 Vector](/es/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | 0.3017 / crédito de Recraft | #### Tarifas por imagen de referencia @@ -392,7 +392,7 @@ Las imágenes se facturan por imagen de salida. Los videos se facturan por cada | --- | --- | --- | ---: | | [Aleph 2](/es/development/comfy-router/models/runway/aleph2/code) | `runway/aleph2` | - | 84.4844 / s | | [Gen 4 Turbo](/es/development/comfy-router/models/runway/gen4-turbo/code) | `runway/gen4_turbo` | - | 15.0865 / s | -| [Pika Soundtrack](/es/development/comfy-router/models) | `pika/pika-soundtrack` | Input video | 1.50865 / s | +| [Pika Soundtrack](/es/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Input video | 1.50865 / s | | [Sync 3](/es/development/comfy-router/models/synclabs/sync-3/code) | `synclabs/sync-3` | - | 40.1301 / s | | [Erase](/es/development/comfy-router/models/bria/video-edit-erase/code) | `bria/video-edit-erase` | - | 13.5778 / s | | [Green Screen](/es/development/comfy-router/models/bria/video-edit-green-screen/code) | `bria/video-edit-green-screen` | - | 10.55 / s | @@ -596,8 +596,8 @@ Las tarifas por uso de Comfy se facturan por segundo de GPU activo; el costo tot | [Google Gemini](/es/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-2.5-pro` | - | Audio / Imagen / Texto / Video: 263.75 | Texto: 2110 | | [Google Gemini](/es/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.1-pro-preview` | - | Audio / Imagen / Texto / Video: 422 | Texto / Razonamiento: 2532
Imagen: 25320 | | [Google Gemini](/es/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.5-flash` | - | Audio / Imagen / Texto / Video: 316.5 | Texto / Razonamiento: 1899 | -| [GPT 6.1 Sol](/es/development/comfy-router/models) | `openai/gpt-6.1-sol` | Lectura: 30.173
Escritura: 754.325 | Texto: 603.46 | Texto: 3017.3 | -| [GPT 6.1 Terra](/es/development/comfy-router/models) | `openai/gpt-6.1-terra` | Lectura: 15.0865
Escritura: 377.1625 | Texto: 301.73 | Texto: 1508.65 | +| [GPT 6.1 Sol](/es/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | Lectura: 30.173
Escritura: 754.325 | Texto: 603.46 | Texto: 3017.3 | +| [GPT 6.1 Terra](/es/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | Lectura: 15.0865
Escritura: 377.1625 | Texto: 301.73 | Texto: 1508.65 | | [GPT 6 Astra](/es/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | Lectura: 301.73
Escritura: 3771.625 | Texto: 3017.3 | Texto: 15086.5 | | [GPT 6 Luna](/es/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | Lectura: 3.0173
Escritura: 37.7162 | Texto: 30.173 | Texto: 150.865 | | [GPT 6 Sol](/es/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | Lectura: 60.346
Escritura: 754.325 | Texto: 603.46 | Texto: 3017.3 | @@ -642,22 +642,22 @@ Las tarifas por uso de Comfy se facturan por segundo de GPU activo; el costo tot | --- | --- | ---: | | [Clean Audio](/es/development/comfy-router/models/veed/clean-audio/code) | `veed/clean-audio` | No publicado | -#### Tarifas por 1K characters +#### Tarifas por 1K caracteres | Nombre | ID del modelo | Opción | Créditos | | --- | --- | --- | ---: | -| [Eleven Multilingual V2](/es/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | Texto a voz | 50.64 / 1K characters | -| [Eleven V3](/es/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | Diálogo / Texto a voz | 21.1 / 1K characters | -| [Eleven V4](/es/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | Diálogo | 24.1384 / 1K characters | -| [Eleven V4 Turbo](/es/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | Diálogo | 12.0692 / 1K characters | +| [Eleven Multilingual V2](/es/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | Texto a voz | 50.64 / 1K caracteres | +| [Eleven V3](/es/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | Diálogo / Texto a voz | 21.1 / 1K caracteres | +| [Eleven V4](/es/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | Diálogo | 24.1384 / 1K caracteres | +| [Eleven V4 Turbo](/es/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | Diálogo | 12.0692 / 1K caracteres | #### Tarifas por duración | Nombre | ID del modelo | Créditos | | --- | --- | ---: | | [Eleven Sfx V2](/es/development/comfy-router/models/elevenlabs/eleven-sfx-v2/code) | `elevenlabs/eleven_sfx_v2` | 29.54 / minuto | -| [Pika Music](/es/development/comfy-router/models) | `pika/pika-music` | 4.52595 / minuto | -| [Pika Sfx](/es/development/comfy-router/models) | `pika/pika-sfx` | 0.060346 / s | +| [Pika Music](/es/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | 4.52595 / minuto | +| [Pika Sfx](/es/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | 0.060346 / s | | [Seed Audio 1.0](/es/development/comfy-router/models/byteplus/seed-audio-1-0/code) | `byteplus/seed-audio-1.0` | 0.7543 / s | | [Seed Audio 1.0 Multilingual](/es/development/comfy-router/models/byteplus/seed-audio-1-0-multilingual/code) | `byteplus/seed-audio-1.0-multilingual` | 0.7543 / s | | [Starfish](/es/development/comfy-router/models/heygen/starfish/code) | `heygen/starfish` | 0.2013 / s | @@ -820,26 +820,26 @@ Las tarifas por uso de Comfy se facturan por segundo de GPU activo; el costo tot | [Qwen Image 3.0 Pro](/es/development/comfy-router/models/qwen/qwen-image-3-0-pro/code) | `qwen/qwen-image-3.0-pro` | Imagen de entrada · 1K / 2K | $0.00429 / imagen de entrada | | [Seedream 5.0 Pro](/es/development/comfy-router/models/byteplus/seedream-5-0-pro-260628/code) | `byteplus/seedream-5-0-pro-260628` | Imágenes de entrada después de la primera | $0.003 / imagen de entrada | -#### Tarifas por Recraft credit +#### Tarifas por crédito de Recraft | Nombre | ID del modelo | USD | | --- | --- | ---: | -| [Recraft V2](/es/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | $0.00143 / Recraft credit | -| [Recraft V3](/es/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | $0.00143 / Recraft credit | -| [Recraft V4](/es/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | $0.00143 / Recraft credit | -| [Recraft V4 Pro](/es/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | $0.00143 / Recraft credit | -| [Recraft V4 Styles](/es/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Pro](/es/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Vector](/es/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1](/es/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | $0.00143 / Recraft credit | -| [Recraft V4.1 Pro](/es/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | $0.00143 / Recraft credit | -| [Recraft V4.1 Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility](/es/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Pro](/es/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Vector](/es/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Vector](/es/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | $0.00143 / Recraft credit | +| [Recraft V2](/es/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | $0.00143 / crédito de Recraft | +| [Recraft V3](/es/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | $0.00143 / crédito de Recraft | +| [Recraft V4](/es/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | $0.00143 / crédito de Recraft | +| [Recraft V4 Pro](/es/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | $0.00143 / crédito de Recraft | +| [Recraft V4 Styles](/es/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | $0.00143 / crédito de Recraft | +| [Recraft V4 Styles Pro](/es/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | $0.00143 / crédito de Recraft | +| [Recraft V4 Styles Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | $0.00143 / crédito de Recraft | +| [Recraft V4 Styles Vector](/es/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | $0.00143 / crédito de Recraft | +| [Recraft V4.1](/es/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | $0.00143 / crédito de Recraft | +| [Recraft V4.1 Pro](/es/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | $0.00143 / crédito de Recraft | +| [Recraft V4.1 Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | $0.00143 / crédito de Recraft | +| [Recraft V4.1 Utility](/es/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | $0.00143 / crédito de Recraft | +| [Recraft V4.1 Utility Pro](/es/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | $0.00143 / crédito de Recraft | +| [Recraft V4.1 Utility Pro Vector](/es/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | $0.00143 / crédito de Recraft | +| [Recraft V4.1 Utility Vector](/es/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | $0.00143 / crédito de Recraft | +| [Recraft V4.1 Vector](/es/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | $0.00143 / crédito de Recraft | #### Tarifas por imagen de referencia @@ -1081,7 +1081,7 @@ Las imágenes se facturan por imagen de salida. Los videos se facturan por cada | --- | --- | --- | ---: | | [Aleph 2](/es/development/comfy-router/models/runway/aleph2/code) | `runway/aleph2` | - | $0.4004 / s | | [Gen 4 Turbo](/es/development/comfy-router/models/runway/gen4-turbo/code) | `runway/gen4_turbo` | - | $0.0715 / s | -| [Pika Soundtrack](/es/development/comfy-router/models) | `pika/pika-soundtrack` | Input video | $0.00715 / s | +| [Pika Soundtrack](/es/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Input video | $0.00715 / s | | [Sync 3](/es/development/comfy-router/models/synclabs/sync-3/code) | `synclabs/sync-3` | - | $0.19019 / s | | [Erase](/es/development/comfy-router/models/bria/video-edit-erase/code) | `bria/video-edit-erase` | - | $0.06435 / s | | [Green Screen](/es/development/comfy-router/models/bria/video-edit-green-screen/code) | `bria/video-edit-green-screen` | - | $0.05 / s | @@ -1285,8 +1285,8 @@ Las tarifas por uso de Comfy se facturan por segundo de GPU activo; el costo tot | [Google Gemini](/es/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-2.5-pro` | - | Audio / Imagen / Texto / Video: $1.25 | Texto: $10.00 | | [Google Gemini](/es/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.1-pro-preview` | - | Audio / Imagen / Texto / Video: $2.00 | Texto / Razonamiento: $12.00
Imagen: $120.00 | | [Google Gemini](/es/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.5-flash` | - | Audio / Imagen / Texto / Video: $1.50 | Texto / Razonamiento: $9.00 | -| [GPT 6.1 Sol](/es/development/comfy-router/models) | `openai/gpt-6.1-sol` | Lectura: $0.143
Escritura: $3.575 | Texto: $2.86 | Texto: $14.30 | -| [GPT 6.1 Terra](/es/development/comfy-router/models) | `openai/gpt-6.1-terra` | Lectura: $0.0715
Escritura: $1.7875 | Texto: $1.43 | Texto: $7.15 | +| [GPT 6.1 Sol](/es/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | Lectura: $0.143
Escritura: $3.575 | Texto: $2.86 | Texto: $14.30 | +| [GPT 6.1 Terra](/es/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | Lectura: $0.0715
Escritura: $1.7875 | Texto: $1.43 | Texto: $7.15 | | [GPT 6 Astra](/es/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | Lectura: $1.43
Escritura: $17.875 | Texto: $14.30 | Texto: $71.50 | | [GPT 6 Luna](/es/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | Lectura: $0.0143
Escritura: $0.17875 | Texto: $0.143 | Texto: $0.715 | | [GPT 6 Sol](/es/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | Lectura: $0.286
Escritura: $3.575 | Texto: $2.86 | Texto: $14.30 | @@ -1331,22 +1331,22 @@ Las tarifas por uso de Comfy se facturan por segundo de GPU activo; el costo tot | --- | --- | ---: | | [Clean Audio](/es/development/comfy-router/models/veed/clean-audio/code) | `veed/clean-audio` | No publicado | -#### Tarifas por 1K characters +#### Tarifas por 1K caracteres | Nombre | ID del modelo | Opción | USD | | --- | --- | --- | ---: | -| [Eleven Multilingual V2](/es/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | Texto a voz | $0.24 / 1K characters | -| [Eleven V3](/es/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | Diálogo / Texto a voz | $0.10 / 1K characters | -| [Eleven V4](/es/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | Diálogo | $0.1144 / 1K characters | -| [Eleven V4 Turbo](/es/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | Diálogo | $0.0572 / 1K characters | +| [Eleven Multilingual V2](/es/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | Texto a voz | $0.24 / 1K caracteres | +| [Eleven V3](/es/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | Diálogo / Texto a voz | $0.10 / 1K caracteres | +| [Eleven V4](/es/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | Diálogo | $0.1144 / 1K caracteres | +| [Eleven V4 Turbo](/es/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | Diálogo | $0.0572 / 1K caracteres | #### Tarifas por duración | Nombre | ID del modelo | USD | | --- | --- | ---: | | [Eleven Sfx V2](/es/development/comfy-router/models/elevenlabs/eleven-sfx-v2/code) | `elevenlabs/eleven_sfx_v2` | $0.14 / minuto | -| [Pika Music](/es/development/comfy-router/models) | `pika/pika-music` | $0.02145 / minuto | -| [Pika Sfx](/es/development/comfy-router/models) | `pika/pika-sfx` | $0.000286 / s | +| [Pika Music](/es/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | $0.02145 / minuto | +| [Pika Sfx](/es/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | $0.000286 / s | | [Seed Audio 1.0](/es/development/comfy-router/models/byteplus/seed-audio-1-0/code) | `byteplus/seed-audio-1.0` | $0.003575 / s | | [Seed Audio 1.0 Multilingual](/es/development/comfy-router/models/byteplus/seed-audio-1-0-multilingual/code) | `byteplus/seed-audio-1.0-multilingual` | $0.003575 / s | | [Starfish](/es/development/comfy-router/models/heygen/starfish/code) | `heygen/starfish` | $0.000954 / s | diff --git a/es/development/comfy-router/queue.mdx b/es/development/comfy-router/queue.mdx index 99dcd34f0a..0fe55ee955 100644 --- a/es/development/comfy-router/queue.mdx +++ b/es/development/comfy-router/queue.mdx @@ -2,12 +2,13 @@ title: "Poner en cola solicitudes de Comfy Router" sidebarTitle: "Solicitudes en cola" description: "Envía una ejecución de Comfy Router, consulta su estado y recógela o cancélala después con las rutas de cola o los SDK de Python y TypeScript." -translationSourceHash: 003a7ce7 +translationSourceHash: 2d60a78d translationFrom: development/comfy-router/queue.mdx translationBlockHashes: "_intro": bb9adff0 "Choose a delivery mode": 04a18c01 "Queue routes": e666df87 + "Submit and collect a request": 8e776a91 "Queue response shapes": 5d24692b "Idempotency and billing": b03b4156 "Queue error responses": 01118a93 diff --git a/es/development/comfy-router/reference.mdx b/es/development/comfy-router/reference.mdx index 970a45c97b..559eb6a86c 100644 --- a/es/development/comfy-router/reference.mdx +++ b/es/development/comfy-router/reference.mdx @@ -2,17 +2,17 @@ title: "Referencia de la API de Comfy Router" sidebarTitle: "Referencia de la API" description: "Todos los endpoints, parámetros, respuestas y errores de Comfy Router, según el contrato de la API de Comfy." -translationSourceHash: 1b971d1c +translationSourceHash: aee933a1 translationFrom: development/comfy-router/reference.mdx translationBlockHashes: "_intro": 3f6e5d23 - "Endpoints": fbcaaf0e - "Error buckets": 36170340 + "Endpoints": e0879d3c + "Error buckets": 02a09cb4 "Response headers": 403c8bf5 - "Pre-flight cost estimates": 3ecabac6 - "Result assets": 65fc939b + "Pre-flight cost estimates": f0ba96a1 + "Result assets": 5936427c "Per-model input and output schemas": 61c6bde8 - "Schemas": 77cfa4db + "Schemas": c1245cc9 --- {/* ARCHIVO GENERADO -- NO EDITAR A MANO. @@ -294,7 +294,7 @@ La entrada JSON nativa del modelo socio. Sin `model_provider`, la solicitud ejec **Calcula el precio de una llamada a un modelo antes de ejecutarla, sin ejecutarla.** -Devuelve una estimación previa, en dólares estadounidenses, de lo que costará ejecutar este cuerpo en este modelo, con precios tomados de la misma tarifa con la que se factura la ejecución. Es una estimación, no el cargo final: lo que pagas es el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo. El cuerpo se valida primero contra el esquema de entrada del modelo, tal como lo valida una ejecución predeterminada (sin `strict_mode`, sin `reject_unknown_fields`), así que un cuerpo que no cumple el esquema del modelo produce aquí el mismo `422` que en la ejecución; no se despacha nada a un proveedor y no se cobra nada. La respuesta no es un bloqueo de precio: se calcula con las tarifas vigentes en `pricing_as_of`, y una ejecución se cobra con las tarifas vigentes cuando se tarifica. Mientras la función se está desplegando, la ruta responde `403` con `error_type: not_enabled`. +Devuelve una estimación previa, en dólares estadounidenses, de lo que costará ejecutar este cuerpo en este modelo, con precios tomados de la misma tarifa con la que se factura la ejecución (un modelo que se factura al costo que informa su proveedor se estima a partir de la lista de precios publicada por ese proveedor). Es una estimación, no el cargo final: lo que pagas es el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo. El cuerpo se valida primero contra el esquema de entrada del modelo, tal como lo valida una ejecución predeterminada (sin `strict_mode`, sin `reject_unknown_fields`), así que un cuerpo que no cumple el esquema del modelo produce aquí el mismo `422` que en la ejecución; no se despacha nada a un proveedor y no se cobra nada. La respuesta no es un bloqueo de precio: se calcula con las tarifas vigentes en `pricing_as_of`, y una ejecución se cobra con las tarifas vigentes cuando se tarifica. Mientras la función se está desplegando, la ruta responde `403` con `error_type: not_enabled`; un modelo que Router aún no puede ejecutar responde el mismo `403` con el `detail` propio de la ruta de ejecución, así que lee `detail` para distinguir ambos casos. **Parámetros** @@ -826,6 +826,7 @@ Las genera el propio Router, antes de la llamada al modelo o en torno a ella. | `queue_timeout` | Una solicitud en cola esperó más allá de su tiempo de espera en cola sin llegar a ser admitida. | | `request_not_found` | El `request_id` no identifica ninguna solicitud de quien llama con este modelo. | | `queue_backlog_full` | Quien llama ya tiene demasiadas solicitudes en cola esperando ejecutarse, por lo que este envío se rechazó. | +| `result_expired` | La solicitud existió y finalizó, pero su resultado ya no está almacenado, así que la recogida no tiene nada que devolver. | ## Encabezados de respuesta @@ -955,7 +956,7 @@ Las genera el propio Router, antes de la llamada al modelo o en torno a ella. ## Estimaciones de costos previas a la ejecución -`POST /v2/models/{provider}/{model}/estimate` tarifica un cuerpo sin ejecutarlo, y un envío en cola (`POST /v2/models/{provider}/{model}/requests`) devuelve el mismo [`RouterCostEstimate`](#routercostestimate) que `estimate` en su `201`. Ambos se calculan con la tarjeta de tarifas contra la que Comfy factura la ejecución. Cada cifra que devuelve cualquiera de los dos es una estimación, no el cargo final: el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo es el definitivo. Comfy no factura una ejecución con tu propia clave de proveedor (ver abajo). Mientras la estimación se está implementando, la ruta responde `403` con `error_type: not_enabled` y la respuesta del envío omite `estimate`. El catálogo sigue sin mostrar precios. +`POST /v2/models/{provider}/{model}/estimate` tarifica un cuerpo sin ejecutarlo, y un envío en cola (`POST /v2/models/{provider}/{model}/requests`) devuelve el mismo [`RouterCostEstimate`](#routercostestimate) que `estimate` en su `201`. Ambos se calculan con la tarjeta de tarifas contra la que Comfy factura la ejecución, salvo un modelo que se factura al costo que informa su proveedor, que se marca como `estimated` a partir de la lista de precios publicada por ese proveedor. Cada cifra que devuelve cualquiera de los dos es una estimación, no el cargo final: el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo es el definitivo. Comfy no factura una ejecución con tu propia clave de proveedor (ver abajo). Mientras la estimación se está implementando, la ruta responde `403` con `error_type: not_enabled` y la respuesta del envío omite `estimate`. El catálogo sigue sin mostrar precios. Lee `source` antes de cualquier cantidad. Que falte una cifra nunca significa que sea gratis. @@ -963,6 +964,7 @@ Lee `source` antes de cualquier cantidad. Que falte una cifra nunca significa qu | --- | --- | --- | | `exact` | `amount`, `amount_cents`, `credits` | Una estimación igual al cargo de este cuerpo con las tarifas de `pricing_as_of`; el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo es el definitivo. | | `estimated` | `min_amount`, `max_amount` y sus formas `_cents`, sin `amount` | Una estimación cuyo cargo depende de una cantidad que el proveedor reporta de vuelta y que el cuerpo acota; se espera que el cargo esté entre los límites, y el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo es el definitivo. | +| `free` | `amount` "0", `amount_cents` y `credits` `0` | La tarjeta de tarifas da a esta solicitud un precio de cero, así que la estimación es `0`; el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo es el definitivo. Solo una cotización `free` dice `0`. | | `unknown` | `reason`, sin cifra | No se pudo dar un precio antes de la ejecución. Trata cualquier otro valor de `source` como `unknown`. | El `reason` de una estimación `unknown` es uno de los siguientes: @@ -982,8 +984,8 @@ Cuándo la estimación falla de forma segura: Límites de la estimación. Una cifra de `200` no garantiza que la ejecución se acepte ni que se cobre exactamente eso: -- `/estimate` no acepta `strict_mode` ni `reject_unknown_fields`, así que solo comprueba el contrato nativo del modelo: un cuerpo que una ejecución con `strict_mode=true` acepta en el esquema propio del proveedor alternativo puede recibir aquí un `422`, y aquí se calcula el precio de un campo de nivel superior no declarado que una ejecución con `reject_unknown_fields=true` rechazaría. -- `pricing_as_of` indica cuándo se obtuvo la tarjeta de tarifas (o, cuando no se leyó ninguna, cuándo se respondió la estimación). No es un bloqueo de precio: la ejecución se cobra con las tarifas vigentes cuando se tarifica. +- `/estimate` no acepta `strict_mode` ni `reject_unknown_fields`, así que solo comprueba el contrato nativo del modelo: un cuerpo que una ejecución con `strict_mode=true` acepta en el esquema propio del proveedor alternativo puede recibir aquí un `422`, y aquí se calcula el precio de un campo de nivel superior no declarado que una ejecución con `reject_unknown_fields=true` rechazaría. Un modelo de Anthropic Messages es la excepción: su esquema permite campos no declarados, así que una ejecución con `reject_unknown_fields=true` no rechaza ninguno, y la estimación solo tarifica los campos de nivel superior no declarados `tools`, `tool_choice`, `temperature`, `top_p`, `top_k`, `stop_sequences`, `metadata`, `thinking` y un `mcp_servers` vacío. Cualquier otro campo de nivel superior no declarado hace que responda `unknown` con `reason: not_quotable`. +- `pricing_as_of` indica cuándo se obtuvo la tarjeta de tarifas. Una cotización `estimated` tomada de la lista de precios publicada por el proveedor lleva la fecha en que se leyó esa lista. Una cotización `exact` o `estimated` cuya cantidad facturable se predice a partir de un calendario publicado por el proveedor lleva la fecha de lectura de ese calendario cuando es anterior a la de la tarjeta. Cuando no se leyó ni tarjeta ni calendario, indica cuándo se respondió la estimación. No es un bloqueo de precio: la ejecución se cobra con las tarifas vigentes cuando se tarifica. - `/estimate` cotiza el tramo que indica `model_provider`, o el proveedor nativo. No acepta el parámetro `fallback_provider` ni `strict_mode`. Una ejecución síncrona cuyo reintento de respaldo recae en otro proveedor se cobra con la tarifa de ese proveedor, que la estimación no cotizó; `X-Comfy-Router-Fallback-Provider` en la respuesta de la ejecución indica que ocurrió. Un envío en cola no tiene respaldo, así que su `estimate` cotiza el tramo que se ejecuta. - `/estimate` y el `estimate` de un envío en cola pueden calcular el precio de documentos ligeramente distintos para el mismo cuerpo en un tramo de `model_provider`, o para un cuerpo que se ejecuta en una operación hermana. El `estimate` del envío se calcula sobre el documento que envía la ejecución. - `/estimate` siempre cotiza el cargo de la plataforma. Comfy no factura una ejecución con tu propia clave de proveedor, pero `/estimate` no lo detecta y aun así devuelve una cifra; solo un envío en cola responde `reason: byok`. @@ -1000,7 +1002,7 @@ Un modelo puede devolver URL de recursos, bytes en línea o ambos. Los proveedor | `minimax/*` | el video finalizado | 12 horas | | `xai/*` | cada imagen generada, y el video finalizado | 24 horas | -Estos tiempos de vida empiezan cuando se firma la URL, no cuando la abres. Las URL en caché o de una llamada repetida pueden tener menos tiempo restante; repetir la llamada no las renueva. Descarga el recurso cuanto antes. Solo se copian los recursos indicados en cada fila: las imágenes `byteplus/seedream-*` y `byteplus/seededit-*` no están cubiertas por la fila de video de BytePlus. +Estos tiempos de vida empiezan cuando se firma la URL, no cuando la abres. Las URL en caché o de una llamada repetida pueden tener menos tiempo restante; repetir la llamada no las renueva. Un registro de `Idempotency-Key` puede sobrevivir a las URL que contiene, así que desde una hora antes de que expire una URL de ese tipo, un reintento con la misma clave recibe `409 invalid_input` en lugar de la respuesta registrada; una respuesta que ya estaba tan cerca de expirar cuando se sirvió sigue siendo reproducible durante 5 minutos. Descarga el recurso cuanto antes. Solo se copian los recursos indicados en cada fila: las imágenes `byteplus/seedream-*` y `byteplus/seededit-*` no están cubiertas por la fila de video de BytePlus. La copia la realiza únicamente el proveedor nativo del modelo. Una ejecución atendida por un proveedor alternativo (`model_provider` que nombre uno, o una ejecución nativa cuyo reintento de respaldo haya recaído en uno, indicado por `X-Comfy-Router-Fallback-Provider`) devuelve las URL propias de ese proveedor, que siguen la caducidad del proveedor y no se copian. Los valores `default`, `comfy` y `comfyui` de `model_provider` no nombran ningún proveedor alternativo, por lo que esas ejecuciones son nativas y se copian como se describe arriba, igual que una ejecución con `model_provider` cuyo reintento de respaldo haya vuelto a recaer en el proveedor nativo. @@ -1008,6 +1010,8 @@ La copia la realiza únicamente el proveedor nativo del modelo. Una ejecución a Otros modelos devuelven referencias a recursos del proveedor o bytes en línea. Las URL del proveedor siguen la caducidad del proveedor, que puede ser mucho más corta que los tiempos de vida anteriores y no está especificada por el contrato del Router. +**URL originales de BytePlus (Seedance 2.x, opcional).** En un espacio de trabajo al que Comfy haya habilitado la opción del lado del servidor, un resultado de Seedance 2.x también incluye las URL propias de BytePlus en `content.upstream_video_url` y `content.upstream_last_frame_url`, junto a las copiadas, además de `content.upstream_expires_at`. No hay ningún parámetro de solicitud y ningún espacio de trabajo tiene la opción habilitada de forma predeterminada. Estas URL expiran 24 horas después de la generación y dejan de estar presentes cuando BytePlus las borra; en Seedance 2.5, BytePlus limita cada una a 100 descargas, y la copia propia de Router usa una. Cada una es una credencial de portador para su objeto: cualquiera que la tenga puede descargar el recurso hasta que expire. + La copia se hace con el mejor esfuerzo en cada recurso. Si una copia falla, esa entrada conserva su referencia del proveedor; la respuesta puede contener tanto URL de Comfy como del proveedor, sin un campo explícito de estado de copia por recurso. La generación se completa igualmente y se cobra. No deduzcas el tiempo de vida de todas las URL a partir de un recurso realojado con éxito. Que un resultado esté alojado en Comfy también determina si más tarde aún es posible repetir una llamada completada desde su registro de `Idempotency-Key`; el parámetro `Idempotency-Key` de arriba indica qué recibe un reintento cuando no es posible. @@ -1020,6 +1024,24 @@ Lee los campos de cada modelo desde `GET /v2/models/{provider}/{model}/openapi.j ## Esquemas +### RouterBilledWorkspace + +La cartera a la que se habría cobrado una llamada rechazada, en `RouterErrorResponse.billed_workspace`. Responde a «¿qué cartera está vacía?»: no es necesariamente el espacio de trabajo que la interfaz del llamador tiene seleccionado en ese momento, y la credencial personal de un miembro del equipo nombra aquí su cartera personal incluso mientras hay un equipo con fondos abierto. Presente solo junto con `denied_reason`. + +**Campos** + + + El id del espacio de trabajo de Cloud. Ausente en la vía heredada. + + + + `personal` o `team`. Cadena abierta: trata cualquier otro valor como personal. + + + + `legacy` cuando la llamada factura al cliente de Metronome previo a los espacios de trabajo en lugar de a un espacio de trabajo de Cloud; ese cliente no tiene id de espacio de trabajo. Ausente para un espacio de trabajo de Cloud. + + ### RouterChargesOnPolicyRejection Indica si un rechazo por política de contenido se cobra en este modelo. Trata un valor desconocido como potencialmente cobrado. @@ -1028,12 +1050,12 @@ Tipo: `string` ### RouterCostEstimate -Una estimación previa de cuánto costará esta llamada, en dólares estadounidenses, calculada antes del despacho a partir de la misma tabla de tarifas con la que se factura la ejecución. No es el cargo final: el cargo que pagas es el liquidado en los registros de uso y facturación de tu espacio de trabajo. `X-Comfy-Credits-Used`, que se informa después de la ejecución, es una cifra redondeada calculada a posteriori, no un recibo. `source` indica cuánto puedes confiar en el número: `exact` incluye `amount`; `estimated` incluye `min_amount` y `max_amount` y ningún `amount`; `unknown` no incluye ninguno de los dos y sí un `reason`. Nunca interpretes un `amount` ausente como gratis. No es un bloqueo de precio: consulta `pricing_as_of`. +Una estimación previa de cuánto costará esta llamada, en dólares estadounidenses, calculada antes del despacho a partir de la misma tabla de tarifas con la que se factura la ejecución (o, para un modelo que se factura al costo que informa su proveedor, estimada a partir de la lista de precios publicada por ese proveedor). No es el cargo final: el cargo que pagas es el liquidado en los registros de uso y facturación de tu espacio de trabajo. `X-Comfy-Credits-Used`, que se informa después de la ejecución, es una cifra redondeada calculada a posteriori, no un recibo. `source` indica cuánto puedes confiar en el número: `exact` incluye `amount`; `free` incluye `amount` "0" (la tabla de tarifas da a esta solicitud un precio de cero); `estimated` incluye `min_amount` y `max_amount` y ningún `amount`; `unknown` no incluye ninguno de los dos y sí un `reason`. Nunca interpretes un `amount` ausente como gratis. No es un bloqueo de precio: consulta `pricing_as_of`. **Campos** - `exact` | `estimated` | `unknown`; interpreta cualquier otro valor como `unknown`. Tanto `exact` como `estimated` etiquetan una estimación; ninguno es el cargo final. `unknown` no incluye ninguna cifra. + `exact` | `estimated` | `free` | `unknown`; interpreta cualquier otro valor como `unknown`. Tanto `exact` como `estimated` etiquetan una estimación; ninguno es el cargo final. `free` significa que la tabla de tarifas da a esta solicitud un precio de cero, así que `amount` es "0". `unknown` no incluye ninguna cifra. @@ -1041,7 +1063,7 @@ Una estimación previa de cuánto costará esta llamada, en dólares estadounide - El costo estimado en dólares como cadena decimal, por ejemplo "0.04", con hasta 8 decimales y sin exponente. Un precio inferior a un centavo que sí se cobra nunca se representa como "0". Presente solo cuando `source` es `exact`. No es el cargo final: lo es el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo. + El costo estimado en dólares como cadena decimal, por ejemplo "0.04", con hasta 8 decimales y sin exponente. Un precio inferior a un centavo que sí se cobra nunca se representa como "0"; solo una cotización `free` dice "0". Presente solo cuando `source` es `exact` o `free`. No es el cargo final: lo es el cargo liquidado en los registros de uso y facturación de tu espacio de trabajo. @@ -1087,7 +1109,7 @@ Una estimación previa de cuánto costará esta llamada, en dólares estadounide - Cuándo se obtuvo la tabla de tarifas con la que se calculó esta cotización. La estimación no es un bloqueo de precio: la ejecución se cobra a las tarifas vigentes cuando se tarifica, no en este instante. Siempre que no se leyó ninguna tabla de tarifas (`reason: pricing_unavailable`, `byok`, o una llamada `not_quotable` que no puede cotizarse con ninguna tabla), esto es el momento en que se respondió la cotización. + Cuándo se obtuvo la tabla de tarifas con la que se calculó esta cotización. Una cotización `estimated` tomada de la lista de precios publicada por el proveedor (un modelo que se factura al costo que informa su proveedor) lleva en su lugar la fecha en que se leyó esa lista. Una cotización cuya cantidad facturable se predice a partir de un calendario publicado por el proveedor y luego se tarifica con la tabla de tarifas lleva la más antigua entre la fecha de lectura de ese calendario y el momento en que se obtuvo la tabla, tanto para una respuesta `exact` como para una `estimated` (un modelo que se factura con los créditos que informa su proveedor es el caso `estimated`). La estimación no es un bloqueo de precio: la ejecución se cobra a las tarifas vigentes cuando se tarifica, no en este instante. Siempre que no se leyó ninguna tabla de tarifas (`reason: pricing_unavailable`, `byok`, o una llamada `not_quotable` que no puede cotizarse con ninguna tabla), esto es el momento en que se respondió la cotización. date-time @@ -1107,7 +1129,7 @@ Cuerpo de error para fallos de autenticación, acceso, búsqueda de modelos, cuo - Grupo amplio y legible por máquina para un fallo del Router, replicado en el encabezado de respuesta `X-Comfy-Error-Type` para que quien llama pueda ramificar sin analizar el cuerpo. El conjunto está cerrado en diecinueve valores: los seis grupos de nivel de solicitud `invalid_input`, `content_policy_violation`, `provider_error`, `provider_timeout`, `insufficient_credits` y `model_not_found`, más los de nivel de transporte `unauthorized`, `forbidden`, `concurrency_limit_exceeded`, `client_disconnected`, `internal_error`, `deadline_exceeded`, `not_enabled`, `service_unavailable`, `rate_limited`, `cancelled`, `queue_timeout`, `request_not_found` y `queue_backlog_full`. «Cerrado» describe el conjunto tal como se documenta hoy, no un límite que se mantenga para siempre: se espera que el conjunto crezca, y por eso esto es deliberadamente una cadena simple y no un `enum`, de modo que un cliente debe tratar cualquier valor no reconocido como `internal_error` en lugar de hacer un switch exhaustivo sobre la lista anterior y romperse con la próxima adición. + Grupo amplio y legible por máquina para un fallo del Router, replicado en el encabezado de respuesta `X-Comfy-Error-Type` para que quien llama pueda ramificar sin analizar el cuerpo. El conjunto está cerrado en veinte valores: los seis grupos de nivel de solicitud `invalid_input`, `content_policy_violation`, `provider_error`, `provider_timeout`, `insufficient_credits` y `model_not_found`, más los de nivel de transporte `unauthorized`, `forbidden`, `concurrency_limit_exceeded`, `client_disconnected`, `internal_error`, `deadline_exceeded`, `not_enabled`, `service_unavailable`, `rate_limited`, `cancelled`, `queue_timeout`, `request_not_found`, `queue_backlog_full` y `result_expired`. «Cerrado» describe el conjunto tal como se documenta hoy, no un límite que se mantenga para siempre: se espera que el conjunto crezca, y por eso esto es deliberadamente una cadena simple y no un `enum`, de modo que un cliente debe tratar cualquier valor no reconocido como `internal_error` en lugar de hacer un switch exhaustivo sobre la lista anterior y romperse con la próxima adición. Tipo: [`RouterErrorType`](#routererrortype) @@ -1120,6 +1142,20 @@ Cuerpo de error para fallos de autenticación, acceso, búsqueda de modelos, cuo Sobre qué entrada o salida se produjo un rechazo por políticas de contenido, como vocabulario cerrado a nivel del Router: `input`, `output`, `input_text`, `input_image`, `input_video`, `input_audio`, `output_text`, `output_image`, `output_video`, `output_audio`. Los valores simples `input` / `output` indican el lado cuando el proveedor no especificó una modalidad. Solo está presente cuando `error_type` es `content_policy_violation` y el proveedor indicó el sujeto rechazado con un código legible por máquina; en caso contrario, está ausente. Nunca es texto del proveedor. Hoy se rellena para rechazos de BytePlus, Runway, BFL, Gemini, Veo, Vertex, xAI y Wan, y para los rechazos de Gemini de las vertientes Nano Banana del Router de MiniMax; un proveedor cuyo rechazo no indica de qué lado se trataba lo deja ausente. Replica el encabezado `X-Comfy-Refusal-Subject`. + + La rama de política de facturación para una denegación de gasto de un nodo asociado: `no_funds` cuando la cartera facturada está vacía, `unspecified` cuando la llamada se rechazó sin una lectura de fondos que lo indicara. Presente solo cuando `error_type` es `insufficient_credits` y el despliegue informa datos de la cartera; ausente en caso contrario. Es un código legible por máquina, no texto para mostrar: muestra `detail` y ramifica según este valor. + + + + La cartera a la que se habría cobrado una llamada rechazada, en `RouterErrorResponse.billed_workspace`. Responde a «¿qué cartera está vacía?»: no es necesariamente el espacio de trabajo que la interfaz del llamador tiene seleccionado, y la credencial personal de un miembro del equipo nombra aquí su cartera personal incluso mientras hay un equipo con fondos abierto. Presente solo junto con `denied_reason`. + + Tipo: [`RouterBilledWorkspace`](#routerbilledworkspace) + + + + Cómo se autenticó la solicitud rechazada: `personal_api_key`, `team_api_key`, `personal_session` o `team_session`. Responde a «¿a qué credencial cambio para facturar a la otra cartera?». No es un permiso y no concede nada. Presente solo junto con `denied_reason`. + + ### RouterErrorType Categoría de error del Router legible por máquina, que también se envía en el encabezado `X-Comfy-Error-Type`. @@ -1133,7 +1169,7 @@ Comportamiento de facturación que debes revisar antes de invocar un modelo. No **Campos** - Si una llamada que este modelo rechaza por motivos de política de contenido se cobra de todos modos a quien realiza la llamada. Los proveedores difieren, la diferencia es invisible en el momento de la llamada, y un usuario que ve un error y un cargo por la misma llamada no tendría forma de saberlo, así que se indica por modelo, antes de la llamada, en lugar de dejarlo a la tradición de cada proveedor. + Si una llamada que este modelo rechaza por motivos de política de contenido se cobra de todos modos a quien realiza la llamada. Los proveedores difieren, la diferencia es invisible en el momento de la llamada, y un usuario que ve un error y un cargo por la misma llamada no tendría forma de saberlo, así que se indica por modelo, antes de la llamada, en lugar de dejarlo a la tradición de cada proveedor. Cuando es `yes`, un error `content_policy_violation` en la ruta síncrona puede incluir `X-Comfy-Credits-Used`: lo hace cuando el proveedor rechazó la salida generada por el modelo y Comfy registró uso para esa generación rechazada, y entonces incluye ese importe. Un rechazo del lado de la entrada, una repetición con la misma clave (`Idempotent-Replayed: true`) y un cargo demasiado pequeño para verse en los dos decimales del encabezado no lo incluyen; un rechazo sin el encabezado no se informa, y eso no prueba que fuera gratis. Tipo: [`RouterChargesOnPolicyRejection`](#routerchargesonpolicyrejection) diff --git a/es/registry/api-reference/nodes/create-a-new-custom-node.mdx b/es/registry/api-reference/nodes/create-a-new-custom-node.mdx index c6b2905964..fdbcddb30c 100644 --- a/es/registry/api-reference/nodes/create-a-new-custom-node.mdx +++ b/es/registry/api-reference/nodes/create-a-new-custom-node.mdx @@ -1,3 +1,5 @@ --- openapi: post /publishers/{publisherId}/nodes +translationSourceHash: c29b437f +translationFrom: registry/api-reference/nodes/create-a-new-custom-node.mdx --- \ No newline at end of file diff --git a/es/registry/api-reference/nodes/delete-a-specific-node.mdx b/es/registry/api-reference/nodes/delete-a-specific-node.mdx index 05d45a996b..ad046f1f36 100644 --- a/es/registry/api-reference/nodes/delete-a-specific-node.mdx +++ b/es/registry/api-reference/nodes/delete-a-specific-node.mdx @@ -1,3 +1,5 @@ --- openapi: delete /publishers/{publisherId}/nodes/{nodeId} +translationSourceHash: 50f3c2d7 +translationFrom: registry/api-reference/nodes/delete-a-specific-node.mdx --- \ No newline at end of file diff --git a/es/registry/api-reference/nodes/retrieve-all-nodes.mdx b/es/registry/api-reference/nodes/retrieve-all-nodes.mdx index 3f263ad811..b6a4905007 100644 --- a/es/registry/api-reference/nodes/retrieve-all-nodes.mdx +++ b/es/registry/api-reference/nodes/retrieve-all-nodes.mdx @@ -1,3 +1,5 @@ --- openapi: get /publishers/{publisherId}/nodes +translationSourceHash: 608af9fb +translationFrom: registry/api-reference/nodes/retrieve-all-nodes.mdx --- \ No newline at end of file diff --git a/es/registry/api-reference/nodes/update-a-specific-node.mdx b/es/registry/api-reference/nodes/update-a-specific-node.mdx index 2975316ed9..c48ebe0dfe 100644 --- a/es/registry/api-reference/nodes/update-a-specific-node.mdx +++ b/es/registry/api-reference/nodes/update-a-specific-node.mdx @@ -1,3 +1,5 @@ --- openapi: put /publishers/{publisherId}/nodes/{nodeId} +translationSourceHash: 04c4bfe0 +translationFrom: registry/api-reference/nodes/update-a-specific-node.mdx --- \ No newline at end of file diff --git a/es/registry/api-reference/token-management/create-a-new-personal-access-token.mdx b/es/registry/api-reference/token-management/create-a-new-personal-access-token.mdx new file mode 100644 index 0000000000..1e9535fc8d --- /dev/null +++ b/es/registry/api-reference/token-management/create-a-new-personal-access-token.mdx @@ -0,0 +1,5 @@ +--- +openapi: post /publishers/{publisherId}/tokens +translationSourceHash: e5097177 +translationFrom: registry/api-reference/token-management/create-a-new-personal-access-token.mdx +--- \ No newline at end of file diff --git a/es/registry/api-reference/token-management/delete-a-specific-personal-access-token.mdx b/es/registry/api-reference/token-management/delete-a-specific-personal-access-token.mdx new file mode 100644 index 0000000000..b28f7b6e21 --- /dev/null +++ b/es/registry/api-reference/token-management/delete-a-specific-personal-access-token.mdx @@ -0,0 +1,5 @@ +--- +openapi: delete /publishers/{publisherId}/tokens/{tokenId} +translationSourceHash: 7dd5257f +translationFrom: registry/api-reference/token-management/delete-a-specific-personal-access-token.mdx +--- \ No newline at end of file diff --git a/es/registry/api-reference/token-management/retrieve-all-personal-access-tokens-for-a-publisher.mdx b/es/registry/api-reference/token-management/retrieve-all-personal-access-tokens-for-a-publisher.mdx new file mode 100644 index 0000000000..2a950ae663 --- /dev/null +++ b/es/registry/api-reference/token-management/retrieve-all-personal-access-tokens-for-a-publisher.mdx @@ -0,0 +1,5 @@ +--- +openapi: get /publishers/{publisherId}/tokens +translationSourceHash: 1d53c4fe +translationFrom: registry/api-reference/token-management/retrieve-all-personal-access-tokens-for-a-publisher.mdx +--- \ No newline at end of file diff --git a/es/registry/api-reference/versions/publish-a-new-version-of-a-node.mdx b/es/registry/api-reference/versions/publish-a-new-version-of-a-node.mdx new file mode 100644 index 0000000000..7904fe0046 --- /dev/null +++ b/es/registry/api-reference/versions/publish-a-new-version-of-a-node.mdx @@ -0,0 +1,5 @@ +--- +openapi: post /publishers/{publisherId}/nodes/{nodeId}/versions +translationSourceHash: 8e74bb3a +translationFrom: registry/api-reference/versions/publish-a-new-version-of-a-node.mdx +--- \ No newline at end of file diff --git a/es/registry/api-reference/versions/retrieve-a-specific-version-of-a-node.mdx b/es/registry/api-reference/versions/retrieve-a-specific-version-of-a-node.mdx new file mode 100644 index 0000000000..ce9b4e4478 --- /dev/null +++ b/es/registry/api-reference/versions/retrieve-a-specific-version-of-a-node.mdx @@ -0,0 +1,5 @@ +--- +openapi: get /nodes/{nodeId}/versions/{versionId} +translationSourceHash: f0cf191e +translationFrom: registry/api-reference/versions/retrieve-a-specific-version-of-a-node.mdx +--- \ No newline at end of file diff --git a/es/registry/api-reference/versions/unpublish-delete-a-specific-version-of-a-node.mdx b/es/registry/api-reference/versions/unpublish-delete-a-specific-version-of-a-node.mdx new file mode 100644 index 0000000000..99b1d7d006 --- /dev/null +++ b/es/registry/api-reference/versions/unpublish-delete-a-specific-version-of-a-node.mdx @@ -0,0 +1,5 @@ +--- +openapi: delete /publishers/{publisherId}/nodes/{nodeId}/versions/{versionId} +translationSourceHash: afc0a935 +translationFrom: registry/api-reference/versions/unpublish-delete-a-specific-version-of-a-node.mdx +--- \ No newline at end of file diff --git a/es/registry/api-reference/versions/update-changelog-and-deprecation-status-of-a-node-version.mdx b/es/registry/api-reference/versions/update-changelog-and-deprecation-status-of-a-node-version.mdx new file mode 100644 index 0000000000..db8f3b5ea8 --- /dev/null +++ b/es/registry/api-reference/versions/update-changelog-and-deprecation-status-of-a-node-version.mdx @@ -0,0 +1,5 @@ +--- +openapi: put /publishers/{publisherId}/nodes/{nodeId}/versions/{versionId} +translationSourceHash: 2cb8ac12 +translationFrom: registry/api-reference/versions/update-changelog-and-deprecation-status-of-a-node-version.mdx +--- \ No newline at end of file diff --git a/ja/custom-nodes/js/canvas-pointer-api.mdx b/ja/custom-nodes/js/canvas-pointer-api.mdx new file mode 100644 index 0000000000..7d919feb02 --- /dev/null +++ b/ja/custom-nodes/js/canvas-pointer-api.mdx @@ -0,0 +1,77 @@ +--- +title: "ウィジェットとカーソル向けのキャンバスポインタAPI" +sidebarTitle: "キャンバスポインタAPI" +description: "onPointerDown でカスタムキャンバスウィジェットのクリック、ダブルクリック、ドラッグを処理し、ComfyUI フロントエンド拡張からキャンバスカーソルを制御する方法について説明します。" +translationSourceHash: 16ea7f38 +translationFrom: custom-nodes/js/canvas-pointer-api.mdx +translationBlockHashes: + "_intro": b1d4c464 + "Default behavior": 27a8751b + "Handle pointer input on a widget": e4fc63fc + "Control the canvas cursor": 9bcc33c8 +--- + +キャンバスは、ポインタ入力を `CanvasPointer` 経由でルーティングします。押下がクリック、ダブルクリック、ドラッグのいずれになるかを判定し、その押下に対して割り当てたコールバックを実行します。キャンバス上に描画されたウィジェットは、`onPointerDown` を通じてこれを利用します。 + +## デフォルトの動作 + +- 複数の選択済み項目をドラッグする際に、Shift キーを押し続ける必要がなくなりました。複数の項目が選択されている状態で1つの項目をクリックすると、他の項目は引き続き選択解除されます。 +- 入力上の接続済みリンクをクリックしても、切断と再接続は行われなくなりました。 +- ポインタのダウンからアップまでのわずかな移動量は、引き続きクリックとして扱われます。ポインタがクリックドリフトの上限を超えて移動すると、その押下はドラッグになります。時間はこの判定に影響しません。 +- ダブルクリックには、ダブルクリック時間内に2回の押下が必要で、その間隔は最大でクリックドリフトの3倍までです。`onDoubleClick` を割り当てた押下のみがダブルクリックを完了できます。 + +ユーザーは設定でクリックドリフトとダブルクリック時間を設定します(`Comfy.Pointer.ClickDrift` と `Comfy.Pointer.DoubleClickTime`)。 + +### 複数項目の選択 + +- `Ctrl` + ドラッグ: 複数選択を開始 +- `Ctrl` + `Shift` + ドラッグ: 選択に追加 +- `Ctrl` + ドラッグ、その後 `Shift`: 選択に追加 +- `Ctrl` + ドラッグ、その後 `Alt`: 選択から削除 + +## ウィジェットでポインター入力を処理する + +ウィジェットに `onPointerDown` を設定します。これはポインターの押下時に実行され、ポインター、ノード、キャンバスを受け取ります。必要なコールバックをポインターに設定すると、押下が確定した時点でキャンバスが適切なものを実行します。 + +```js +widget.onPointerDown = function (pointer, node, canvas) { + const e = pointer.eDown + const offsetFromNode = [e.canvasX - node.pos[0], e.canvasY - node.pos[1]] + + pointer.onClick = (upEvent) => { + console.log(pointer.eDown, pointer.eMove, pointer.eUp) + } + pointer.onDoubleClick = (upEvent) => this.customFunction(upEvent) + + pointer.onDragStart = () => {} + pointer.onDrag = (moveEvent) => {} + pointer.onDragEnd = (upEvent) => {} + pointer.onDragCancel = () => {} + + pointer.finally = () => {} + + return true +} +``` + +- `onClick` と `onDoubleClick` は、`onDragStart`、`onDragEnd`、`onDragCancel` と同じ押下では実行されません。`onDrag` はクリックとして終わる押下でも実行されます。クリックのドリフト範囲内の移動も受け取るためです。 +- `onDragStart` はドラッグごとに 1 回、ポインターが最初にクリックのドリフト範囲を超えて移動したときに実行されます。移動イベントが報告される前にポインターが範囲外で離された場合、`onDragStart` は離した時点で実行され、`onDragEnd` がその直後に実行され、`onDrag` は実行されません。 +- 1 回の押下で `onClick` と `onDoubleClick` の両方を設定した場合、ダブルクリックの 1 回目の押下を離すと `onClick` が実行されます。2 回目の押下では `onClick` の代わりに `onDoubleClick` が実行されるため、`onClick` は先に実行されても安全にしてください。1 回目のクリックがウィジェットではなく近くの項目に当たることもあるため、`onClick` が実行されていない状態で `onDoubleClick` が実行される場合があります。 +- `onDragEnd` はドラッグのポインターアップイベントを受け取ります。ドラッグが中断された場合(ポインターキャプチャを失った場合など)は代わりに `onDragCancel` が実行されます。 +- `finally` は押下が終わったときに 1 回実行されます。`pointer.finally` を設定すると、置き換えられるコールバックが即座に実行されます。`onPointerDown` が `true` を返さない場合、キャンバスが独自の `finally` を設定するため、あなたのコールバックはポインター押下の間に実行されます。クリーンアップを `finally` に依存する場合は `true` を返してください。 +- `pointer.eDown`、`pointer.eMove`、`pointer.eUp` により、すべてのコールバックがイベントの流れ全体にアクセスできます。 +- キャンバス自身に押下を処理させない場合は `true` を返します。 +- `onPointerDown` を追加するときは、レガシーの `widget.mouse` ハンドラーを削除してください。`onPointerDown` が `true` を返す場合、キャンバスは離した後もウィジェットを追跡し続け、ポインターが移動するたびに `widget.mouse` を呼び続けます。 + +キャンバスがダブルクリックとドラッグを判定するため、ウィジェット側で個々のポインターイベントを計測したり時間を測ったりする必要はありません。ユーザーのクリックドリフトとダブルクリックの設定も尊重されます。 + +## キャンバスカーソルを制御する + +`canvas.state.hoveringOver` は、ポインタの下にある項目タイプ(ノード、グループ、リルート、リンクなど)のビットフラグを保持します。`canvas.state.shouldSetCursor` を `false` に設定すると、キャンバスがカーソルスタイルを設定しなくなるので、その後は自分でカーソルを設定します: + +```js +canvas.state.shouldSetCursor = false +canvas.canvas.style.cursor = 'pointer' +``` + +`shouldSetCursor` が `false` のままでも、ノードのリサイズを開始するとリサイズカーソルが設定されます。リサイズが終了した後、カーソルを再度設定してください。 diff --git a/ja/custom-nodes/js/connection-callbacks-migration.mdx b/ja/custom-nodes/js/connection-callbacks-migration.mdx new file mode 100644 index 0000000000..b6f64317ed --- /dev/null +++ b/ja/custom-nodes/js/connection-callbacks-migration.mdx @@ -0,0 +1,125 @@ +--- +title: "フロントエンド拡張機能向けの接続コールバック移行" +sidebarTitle: "接続コールバックの移行" +description: "ComfyUI拡張機能における onConnectionsChange とノード削除コールバックの順序、サブグラフ境界での SubgraphIO、graph.events についての説明。" +translationSourceHash: 06a9ae24 +translationFrom: custom-nodes/js/connection-callbacks-migration.mdx +translationBlockHashes: + "_intro": cd84d91b + "Check for SubgraphIO at subgraph boundaries": c049a9fe + "Subscribe to node lifecycle events with graph.events": 1100692e + "Node removal fires callbacks in this order (partially tested)": 720324f8 + "Workflow load resolves peer nodes before onConnectionsChange runs": 2b775215 + "API prompt import does not reconnect resolved inputs": 619d6b69 + "Reject connections before they are made": b9b94a8e + "Removing a link inside the output callback skips the input callback": 3317def4 + "Replace removed slot events": 5c3ec663 + "Read connection state from callback arguments or node methods": 9da17ab0 +--- + +コールバックのシグネチャは変更されていません。`onConnectionsChange`、`onConnectInput`、 +`onConnectOutput`、`onBeforeConnectInput` は既存の引数とタイミングを維持します。 +リンク登録と `LinkNetwork` API の変更については、 +[リンク登録の移行](/ja/custom-nodes/js/link-registration-migration)を参照してください。 + +## サブグラフ境界で SubgraphIO を確認する + +サブグラフ境界(`SubgraphInput` または `SubgraphOutput`)でも `onConnectionsChange` は発火しますが、5 番目の引数は通常の `INodeInputSlot`/`INodeOutputSlot` ではなく `SubgraphIO` です。その引数を通常のスロットとして扱う前に確認してください。フロントエンド自身の `isSubgraphInput` と `isSubgraphOutput` ガードは拡張機能に公開されていないため、すべての `SubgraphIO` が持ち、ノードのスロットは持たない `linkIds` 配列と `parent` ノードを確認します。 + +```js +function isSubgraphIO(slot) { + return slot != null && Array.isArray(slot.linkIds) && 'parent' in slot +} + +nodeType.prototype.onConnectionsChange = function ( + type, + index, + isConnected, + link, + slotOrIO +) { + if (isSubgraphIO(slotOrIO)) return + // slotOrIO is INodeInputSlot | INodeOutputSlot +} +``` + +## graph.events でノードのライフサイクルイベントを購読する + +`graph.events` は `node:added`、`node:before-removed`、`node:removed` をディスパッチします。拡張の複数の箇所でノードの追加や削除を監視する必要がある場合は、これらを使用してください。 + +```ts +graph.events.addEventListener('node:added', (e) => { + console.log('added', e.detail.node.id) +}) +``` + +`node.onAdded`、`node.onRemoved`、および単一スロットの `graph.onNodeAdded`/`graph.onNodeRemoved` は引き続き動作しますが、`graph.onNodeAdded` に代入すると既存のハンドラが置き換えられます。2 番目の購読者は 1 番目の購読者を通知なく破棄してしまいます。追加/削除の際に拒否したり変更したりする必要がない限り、`graph.events` を優先してください。connect/disconnect には複数購読者向けの同等の仕組みはありません。`onConnectionsChange` が依然として唯一の接続単位のフックです。 + +## ノードの削除はこの順序でコールバックを発火する(一部検証済み) + +ノードを削除すると、次の順序で発火します。 + +1. `node:before-removed`: ノードはまだ完全にアタッチされた状態です。 +2. 削除されるノードと、接続されている各ピアで + `onConnectionsChange(..., false, ...)` が呼ばれます。このとき削除されるノードはまだグラフ内にあります。 +3. `node.onRemoved()`: `node.graph` はまだ設定されています。 +4. ノードがグラフのインデックスとストアから切り離され、`node.graph` が + `null` になります。 +5. `onNodeRemoved(node)`、続いて `node:removed`。どちらもすでに切り離された + ノードを受け取ります。 + +テストは `node:before-removed → node.onRemoved() → onNodeRemoved(node)` をカバーし、 +`node:removed` が切り離されたノードを受け取ることを別途検証しています。手順 2 を含む +完全な順序は、単一のエンドツーエンドテストで保証されているのではなく、ソースコードから +確認されたものです。 + +ピアの `onConnectionsChange` ハンドラで削除されるノードを特定するには、手順 2 の時点で +`graph.getNodeById()` を使ってください。`node:removed` の時点では、ノードはすでに +存在しません。 + +## ワークフローの読み込みでは、onConnectionsChange が実行される前にピアノードが解決される + +`graph.configure()` は、どのノードの `configure()` も実行される前にワークフロー内のすべてのノードを作成し、復元されたリンクに対して `onConnectionsChange` を発火します。そのため、読み込み中に `onConnectionsChange` コールバックが発火した時点では、すべてのピアノードがすでに存在し、そのリンクもすでに登録されているので、そのコールバック内からの `graph.getNodeById()` やリンクの検索は正しく解決されます。 + +## API prompt インポートでは解決済みの入力が再接続されない + +`app.loadApiJson()` は、2 回目の切断/再接続パスを実行せずに、解決可能な各入力を接続します。拡張機能は、API prompt インポート中の複製された `onConnectionsChange` 通知に依存すべきではありません。各接続ハンドラは最初の通知で処理を完了させ、インポート済みの完全なグラフを必要とする処理は `afterConfigureGraph` または `afterLoadGraph` に移動してください。 + +ソース出力または接続先スロットがまだ存在しない入力は、パスが進行している間は再試行されます。これにより動的入力の動作が維持されます。つまり、接続に成功すると、後で保留中の接続が必要とするスロットを作成できます。すでに解決済みの接続は繰り返されず、拡張機能によって拒否された接続は、その端点が利用可能になっても再試行されません。 + +これは API prompt インポートのみを変更します。通常のワークフロー読み込みでは、上記のとおり引き続き `graph.configure()` が使用され、接続コールバックのシグネチャは変更されません。 + +## 接続が作成される前に接続を拒否する + +接続を拒否するには、ソースノードの `onConnectOutput`、または接続先ノードの `onConnectInput` から `false` を返します。どちらもグラフが何かを変更する前に実行されるため、接続先の入力に既存のリンクがある場合はそのまま残ります。 + +```js +nodeType.prototype.onConnectOutput = function ( + slot, + type, + input, + targetNode, + targetSlot +) { + return !shouldReject(type, targetNode) +} +``` + +`onConnectionsChange` から拒否しないでください。これが実行される時点では、新しいリンクが接続先の入力にあったリンクをすでに置き換え済みであるため、新しいリンクを削除すると入力が切断されたままになります。 + +## 出力コールバック内でリンクを削除すると入力コールバックがスキップされる + +リンクを接続すると、まず出力側の `onConnectionsChange` が呼ばれ、その後に入力側のものが呼ばれます。出力側のハンドラが戻る前に同じリンクを削除すると、入力側はその削除による `isConnected === false` コールバックを受け取り、新しいリンクに対する `isConnected === true` コールバックはスキップされます。両側が常に接続を認識すると仮定しないでください。ハンドラがグラフに再入する場合は、渡されたリンクがまだ接続されているか確認してください。これは観察された動作であり、テストされた契約ではありません。現時点でこのスキップ経路を検証するテストはありません。 + +## 削除されたスロットイベントを置き換える + +`node:slot-links:changed` と `node:slot-errors:changed` は削除され、同名の代替イベントはありません。以下のいずれかへ移行してください。 + +- 接続状態をリアクティブに読み取るには `node.isInputConnected()`、`node.isOutputConnected()`、または `node.getOutputNodes()` +- スロットが接続または切断されたまさにその瞬間にコードを実行する必要がある場合は `onConnectionsChange` + +## コールバック引数またはノードメソッドから接続状態を読み取る + +`input.link` と `output.links` は非推奨であり、読み取り結果が現在のグラフとずれる可能性があります。書き込みはリンクを削除するだけです。`input.link` に `null` を代入するとその入力が切断され、`output.links` への代入や変更を行うと、新しい配列に含まれないすべてのリンクが切断されます。書き込みによってリンクが作成されることはありません。`node.connect()`、`node.disconnectInput()`、`node.disconnectOutput()` を使用してください。コールバックがすでに受け取っている `link_info` 引数、またはリンクストアを直接読み取る `LGraphNode` インスタンスメソッドである `node.isInputConnected()`、`node.getInputLink()`、`node.isOutputConnected()`、`node.getOutputNodes()` を使用してください。`input.link` や `output.links` は読み取らないでください。 + +これらのメソッドの背後にあるストア関数は内部的なものであり、拡張 API の一部ではありません。ノードメソッドを使用してください。 diff --git a/ja/custom-nodes/js/javascript_about_panel_badges.mdx b/ja/custom-nodes/js/javascript_about_panel_badges.mdx index c78c197719..ac189ce152 100644 --- a/ja/custom-nodes/js/javascript_about_panel_badges.mdx +++ b/ja/custom-nodes/js/javascript_about_panel_badges.mdx @@ -52,7 +52,7 @@ app.registerExtension({ これらのクラスはフロントエンドのビルド時に生成されるため、使用できるのはフロントエンド自体が使用している Lucide アイコンのみです。アイコンが表示されない場合は、別のアイコンを選ぶか、拡張機能が読み込むスタイルシートで独自のアイコンクラスを定義してください。 -`pi pi-file` などの PrimeIcons クラスは現時点ではまだ表示されますが、段階的に廃止されています。新しいコードでは使用しないでください。[PrimeVue 削除に伴う移行](/custom-nodes/js/primevue-removal-migration) を参照してください。 +`pi pi-file` などの PrimeIcons クラスは現時点ではまだ表示されますが、段階的に廃止されています。新しいコードでは使用しないでください。[PrimeVue 削除に伴う移行](/ja/custom-nodes/js/primevue-removal-migration) を参照してください。 ## 例 diff --git a/ja/custom-nodes/js/javascript_selection_toolbox.mdx b/ja/custom-nodes/js/javascript_selection_toolbox.mdx index 75f85e7175..e9bde4ec46 100644 --- a/ja/custom-nodes/js/javascript_selection_toolbox.mdx +++ b/ja/custom-nodes/js/javascript_selection_toolbox.mdx @@ -66,7 +66,7 @@ app.registerExtension({ これらのクラスはフロントエンドのビルド時に生成されるため、使用できるのはフロントエンド自体が使用している Lucide アイコンのみです。アイコンが表示されない場合は、別のアイコンを選ぶか、拡張機能が読み込むスタイルシートで独自のアイコンクラスを定義してください。 -PrimeIcons(`pi pi-*`)と Material Design Icons(`mdi mdi-*`)のクラスは現時点ではまだ表示されますが、段階的に廃止されています。新しいコードでは使用しないでください。[PrimeVue 削除に伴う移行](/custom-nodes/js/primevue-removal-migration) を参照してください。 +PrimeIcons(`pi pi-*`)と Material Design Icons(`mdi mdi-*`)のクラスは現時点ではまだ表示されますが、段階的に廃止されています。新しいコードでは使用しないでください。[PrimeVue 削除に伴う移行](/ja/custom-nodes/js/primevue-removal-migration) を参照してください。 ## 動的なコマンドの表示 diff --git a/ja/custom-nodes/js/javascript_settings.mdx b/ja/custom-nodes/js/javascript_settings.mdx index ed3f7798c1..e23e76c3db 100644 --- a/ja/custom-nodes/js/javascript_settings.mdx +++ b/ja/custom-nodes/js/javascript_settings.mdx @@ -85,7 +85,7 @@ try { ### 追加設定 -各設定タイプは ComfyUI フロントエンドのフォームコンポーネントを表示します。`attrs` フィールドで、そのコンポーネントに追加の Props を渡せます。各タイプがサポートする Props は、以下の各タイプの説明に記載しています。 +各設定タイプは ComfyUI フロントエンドのフォームコンポーネントを表示します。`attrs` フィールドで、そのコンポーネントに追加の Props を渡せます。各タイプがサポートする Props は、[タイプ](#タイプ) に記載しています。 例えば、これは数値入力の範囲とステップを制限します: @@ -107,7 +107,7 @@ try { ``` -拡張機能で `showButtons`、`maxFractionDigits`、`editable`、`filter` などの PrimeVue の Props を渡していた場合は、[PrimeVue 削除に伴う移行](/custom-nodes/js/primevue-removal-migration) を参照してください。設定パネルは PrimeVue コンポーネントを使用しなくなったため、これらの Props は効果がありません。 +拡張機能で `showButtons`、`maxFractionDigits`、`editable`、`filter` などの PrimeVue の Props を渡していた場合は、[PrimeVue 削除に伴う移行](/ja/custom-nodes/js/primevue-removal-migration) を参照してください。設定パネルは PrimeVue コンポーネントを使用しなくなったため、これらの Props は効果がありません。 ## タイプ diff --git a/ja/custom-nodes/js/javascript_sidebar_tabs.mdx b/ja/custom-nodes/js/javascript_sidebar_tabs.mdx index a1e5eeb745..6c88e9b4c6 100644 --- a/ja/custom-nodes/js/javascript_sidebar_tabs.mdx +++ b/ja/custom-nodes/js/javascript_sidebar_tabs.mdx @@ -54,7 +54,7 @@ app.extensionManager.registerSidebarTab({ これらのクラスはフロントエンドのビルド時に生成されるため、使用できるのはフロントエンド自体が使用している Lucide アイコンのみです。アイコンが表示されない場合は、別のアイコンを選ぶか、拡張機能が読み込むスタイルシートで独自のアイコンクラスを定義してください。 -PrimeIcons(`pi pi-*`)と Material Design Icons(`mdi mdi-*`)のクラスは現時点ではまだ表示されますが、段階的に廃止されています。新しいコードでは使用しないでください。[PrimeVue 削除に伴う移行](/custom-nodes/js/primevue-removal-migration) を参照してください。 +PrimeIcons(`pi pi-*`)と Material Design Icons(`mdi mdi-*`)のクラスは現時点ではまだ表示されますが、段階的に廃止されています。新しいコードでは使用しないでください。[PrimeVue 削除に伴う移行](/ja/custom-nodes/js/primevue-removal-migration) を参照してください。 ## 状態を持つタブの例 diff --git a/ja/custom-nodes/js/link-registration-migration.mdx b/ja/custom-nodes/js/link-registration-migration.mdx new file mode 100644 index 0000000000..f9126e20d5 --- /dev/null +++ b/ja/custom-nodes/js/link-registration-migration.mdx @@ -0,0 +1,30 @@ +--- +title: "フロントエンド拡張機能のリンク登録マイグレーション" +sidebarTitle: "リンク登録マイグレーション" +description: "addFloatingLink が undefined を返す場合、ストアに支えられた graph.links ビュー、ComfyUI フロントエンド拡張機能でのリンク ID の衝突への対処。" +translationSourceHash: 106471af +translationFrom: custom-nodes/js/link-registration-migration.mdx +--- + +`LinkNetwork.addFloatingLink(link)` は `LLink | undefined` を返すようになりました。 + +新しい実行時リンクでは、未割り当てのリンク ID を渡し、返されたリンクを使用します。 + +```ts +const registeredLink = graph.addFloatingLink(link) +if (!registeredLink) return +``` + +登録が成功した場合、または同じリンクがすでにトポロジストアに存在する場合、登録は保存済みのリンクを返します。別の実行時リンクがすでにその ID を所有している場合、登録はエラーをログに記録し、渡されたリンクを未接続のままにして `undefined` を返します。稼働中のリンクを暗黙に置き換えたり、渡されたリンクに別の ID を割り当てたりはしません。`graph.floatingLinks` は片端リンクのためのフィルタ済み互換ビューのままです。 + +`graph.links` と `graph.floatingLinks` は、独立したネイティブの `Map` ストレージではなく、所有者でフィルタされたストアに支えられた互換ビューです。通常の `Map` 読み取りメソッドはキャッシュされたメンバーシップスナップショットを使用します。トポロジのメンバーが変わった後は、既存のイテレーターを保持せず、新しいイテレーターを取得してください。どちらのビューも有効な Pinia を必要とし、ストアがない状態を空のグラフとしては表さなくなりました。 + +ネイティブの `Map.set()` と同様に、`view.set(id, link)` は登録結果ではなくビューを返します。登録は既存のリンクを保持したまま ID の衝突やターゲットの衝突を拒否することがあるため、ビュー経由で挿入する拡張機能は `view.get(link.id) === link` で成功を確認してください。同じビュー内のリンクと ID が衝突した後は、`has()` は `true` を返し、`get()` は既存のリンクを返します。その操作をカバーできる場合はグラフ接続 API とフローティングリンク API を優先してください。これらの API は周辺のライフサイクルを調整するためです。どちらのビューに対しても `Map.prototype` のメソッドを直接呼び出したり、ネイティブ `Map` の内部ストレージに依存したりしないでください。 + +入力の置き換えは、古いリンクの切断コールバックより前に新しいリンクをコミットするため、コールバックからの問い合わせは空の入力ではなく置き換え後のリンクを参照します。通常の接続コールバックはその後に続きます。 + +以前に戻り値を無視していた拡張機能は、渡されたリンクを保持、描画、変更する前に `undefined` を処理してください。新しい実行時リンクに正のリンク ID をあらかじめ指定せず、グラフに生成させてください。 + +永続化された ID の衝突修復は、ワークフローのインポートとデシリアライズの責務です。シリアライズされたトポロジをインポートする拡張機能は、実行時登録 API を使う前にその境界で競合する ID を正規化してください。 + +ルートの `LGraph` を構築する場合、またはシリアライズされたデータから設定する場合は、グラフのトポロジがライフサイクル全体を通じてストアに支えられているため、有効な Pinia が必要です。 diff --git a/ja/custom-nodes/js/node-geometry-migration.mdx b/ja/custom-nodes/js/node-geometry-migration.mdx new file mode 100644 index 0000000000..52d95976ff --- /dev/null +++ b/ja/custom-nodes/js/node-geometry-migration.mdx @@ -0,0 +1,74 @@ +--- +title: "フロントエンド拡張機能向けのノードジオメトリ移行" +sidebarTitle: "ノードジオメトリの移行" +description: "ノードのサイズとレンダリング境界、applyNodePositions の名前変更、レイアウトストア変更後の ComfyUI フロントエンド拡張機能における描画順の z-order について説明します。" +translationSourceHash: 833ab6fb +translationFrom: custom-nodes/js/node-geometry-migration.mdx +translationBlockHashes: + "Migration checklist": a95abc11 + "What changed": f4ee15bc + "Writes through removed references stay local": ba9b1003 +--- + +## 移行チェックリスト + +1. `node.pos`、`node.size`、`boundingRect`、`getBounding()`、 + `setPos()`、`setSize()` は引き続き使用できます。シグネチャの変更は不要です。 +2. `repositionNodesVueMode()` の呼び出しを `applyNodePositions()` に置き換えてください。 +3. `node.size` が測定/レンダリングされたコンテンツを反映することに依存していた場合は、 + `getBounding()` / `boundingRect` に切り替えてください。Vue レンダラーでは、`size` は + 要求された値を厳密に反映するようになりました。レガシーレンダラーでは、ウィジェットに合わせて + `size` が拡大されます。 +4. バッキングストアではなく、ノード/グループのジオメトリ API を使用してください。 + `layoutStore` をインポートしたり、その内部フォーマットに依存したりしないでください。 +5. 削除された参照を介した書き込みは、共有レイアウト状態ではなく、 + 切り離されたオブジェクトを更新します。 + +## 変更点 + +`LGraphNode.pos`、`size`、`boundingRect`、`getBounding()`、`setPos()`、`setSize()` は同じシグネチャのままです。これらの呼び出しは引き続きソース互換です。動作が変わったのは以下の 3 つのケースです。 + +```ts +node.pos = [100, 200] +node.pos[0] += 50 +node.setSize([320, 200]) +node.updateArea() +const box = node.getBounding() +``` + +ノードとグループのジオメトリは、インスタンスごとのフィールドではなく、共有のレイアウトストアに保存されるようになりました。上記の API を使用し、ストアを直接使わないでください。ストアは内部実装の詳細です。 + +### `size` とレンダリング後の境界 + +`node.size` は要求したサイズであり、シリアライズされる値でもあります。Vue レンダラーでは、レンダリングがこれを変更することはありません。`getBounding()` と `boundingRect` はレンダリング後の境界を返します。ウィジェットのコンテンツがより多くのスペースを必要とする場合、これは `size` より大きくなることがあります。レガシーのキャンバスレンダラーでは、ウィジェットに合わせてノードを拡張するために `setSize()` が呼ばれるため、描画後に `node.size` と保存されたサイズが変わる可能性があります。ノードの実際の画面上のフットプリントが必要な場合は、レンダリング後の境界を使用してください。 + +キャンバスは各フレームの開始時に `getBounding()` と `boundingRect` を再計算します。`pos` または `size` を変更した後、同じフレーム内でそれらを読み取る前に `node.updateArea()` を呼び出してください。Vue レンダラーでは、DOM コンテンツによる拡張はノードが計測された後にのみ反映されます。 + +```ts +// 変更前: レンダリングされたコンテンツによるリサイズが size を上書きすることがあり、 +// ノードを折りたたんで再展開すると元のサイズが失われていました。 +node.size // 気づかないうちにレンダリング後のフットプリントになる可能性があった + +// 変更後(Vue レンダラー): size は設定した値のまま。レンダリング後の境界を明示的に取得します。 +node.size // 要求したサイズ。レンダリングによって変化しない +node.getBounding() // 実際のレンダリング後の境界。より大きくなる場合がある +``` + +### `repositionNodesVueMode()` から `applyNodePositions()` への改名 + +```ts +// 変更前 +canvas.repositionNodesVueMode(newPositions) +// 変更後 +canvas.applyNodePositions(newPositions) +``` + +`repositionNodesVueMode()` は非推奨のエイリアスとして引き続き呼び出せます。 + +### Z オーダーが明確になりました + +Z オーダーは以前、互いに矛盾する可能性のある 2 つの情報源、つまりノードリスト内のノードの位置と実行順序から決まっていました。現在は常に描画順序です。拡張が実行順序から重なり順やヒットテスト順を推測していた場合は、描画順序に切り替えてください。 + +## 削除された参照を介した書き込みはローカルに留まる {#writes-through-removed-references-stay-local} + +削除後、geometry setter は切り離されたノード、グループ、またはリルートオブジェクトのみを更新します。共有レイアウト状態や、同じ ID を所有するようになった別のエンティティは更新されません。 diff --git a/ja/custom-nodes/js/node-id-migration.mdx b/ja/custom-nodes/js/node-id-migration.mdx new file mode 100644 index 0000000000..839cae149d --- /dev/null +++ b/ja/custom-nodes/js/node-id-migration.mdx @@ -0,0 +1,16 @@ +--- +title: "フロントエンド拡張機能のノード ID 移行" +sidebarTitle: "ノード ID 移行" +description: "ComfyUI フロントエンド拡張機能を、ブランド化された文字列ノード ID、および文字列のサブグラフ境界センチネル SUBGRAPH_INPUT_ID と SUBGRAPH_OUTPUT_ID に移行します。" +translationSourceHash: 168947f8 +translationFrom: custom-nodes/js/node-id-migration.mdx +--- + +ComfyUI フロントエンドは現在、内部境界においてローカルノード ID をブランド化された文字列型 `NodeId` に正規化します。シリアライズされたワークフローや API ペイロードには依然として数値 ID が含まれる場合がありますが、litegraph (レガシー) 内のノード ID(`node.id`、`LLink.origin_id`、`LLink.target_id` など)は、フロントエンドに入力された後は文字列として扱う必要があります。リンク ID(`LLink.id`)とリルート ID は数値のままです。 + +拡張機能の作者は、ノード ID に対する数値比較を避けるべきです。特に、サブグラフ境界センチネルはブランド化された文字列 ID として公開されています: + +- `SUBGRAPH_INPUT_ID` は `-10` からシリアライズされます +- `SUBGRAPH_OUTPUT_ID` は `-20` からシリアライズされます + +文字列 `'-10'` および `'-20'` と比較するか、レガシー値を比較する前に両辺を文字列に正規化してください。 \ No newline at end of file diff --git a/ja/custom-nodes/js/primevue-removal-migration.mdx b/ja/custom-nodes/js/primevue-removal-migration.mdx new file mode 100644 index 0000000000..769d19bc20 --- /dev/null +++ b/ja/custom-nodes/js/primevue-removal-migration.mdx @@ -0,0 +1,63 @@ +--- +title: "フロントエンド拡張機能向けPrimeVue削除移行" +sidebarTitle: "PrimeVue削除の移行" +description: "ComfyUIフロントエンドでPrimeVueが削除された後、$primevue、PrimeVueコンポーネント、--p-* CSS変数、PrimeVueツールチップセレクタを置き換えます。" +translationSourceHash: ca5e48dd +translationFrom: custom-nodes/js/primevue-removal-migration.mdx +translationBlockHashes: + "_intro": 5bd8432b + "Extensions that render PrimeVue components": e2b1c44c + "Extensions that read `--p-*` variables": d45a77c2 + "Tooltips": 5252984f + "Deprecated variable names": df1d5960 +--- + +ComfyUI フロントエンドは PrimeVue をインストールしなくなりました。ホストアプリは `app.use(PrimeVue)` を呼び出さないため、拡張機能は依存していた可能性のある3つの要素を失います: + +- ホスト Vue アプリの `$primevue` グローバルプロパティ。 +- PrimeVue テーマスタイルシート。これにより、拡張機能がホストアプリ内でレンダリングする PrimeVue コンポーネントはスタイルが適用されずにレンダリングされます。 +- `--p-primary-color`、`--p-surface-*`、`--p-text-color`、`--p-content-background`、`--p-form-field-border-color` などのすべてのグローバル `--p-*` CSS 変数。 + +## PrimeVueコンポーネントをレンダリングする拡張機能 + +ホストアプリのPrimeVueインスタンスに依存しないでください。PrimeVueコンポーネントを独自のマークアップに置き換えるか、UI用に独自のVueアプリを作成し、そのアプリにPrimeVueとそのテーマをインストールしてください。 + +## `--p-*` 変数を読み取る拡張機能 + +これらをデザインシステムのテーマ変数に置き換えてください。テーマ変数は、アクティブなライトまたはダークテーマと、アクティブなカラーパレットに従います。 + +| PrimeVue 変数 | テーマ変数 | +| --------------------------------------------------------- | -------------------- | +| `--p-primary-color` | `--primary` | +| `--p-text-color` | `--foreground` | +| `--p-text-muted-color` | `--muted-foreground` | +| `--p-content-background` | `--background` | +| `--p-surface-*` (パネル、浮き上がった領域) | `--secondary` | +| `--p-content-border-color`, `--p-form-field-border-color` | `--border` | + +## ツールチップ + +グローバルな `v-tooltip` ディレクティブは削除され、ツールチップは PrimeVue の DOM をレンダリングしなくなりました: + +- `.p-tooltip` と `.p-tooltip-text` +- `data-pd-tooltip` 属性 +- `$_ptooltip*` 要素のプロパティ + +開いているツールチップは、`data-slot="tooltip-content"` を持つ1つの要素をレンダリングし、`document.body` の末尾にポータルされるようになりました。この要素はツールチップが開いている間だけ存在します。独自の UI の表示中にツールチップを非表示にする拡張機能は、`.p-tooltip` ではなく `[data-slot="tooltip-content"]` を対象にしてください。 + +`--node-component-tooltip*` CSS 変数もデザインシステムのスタイルシートから削除されました。代わりにテーマ変数を使用してください: `--background`、`--foreground`、`--border`。古い名前 `--base-background`、`--base-foreground`、`--border-default` は非推奨です。詳細は[非推奨の変数名](#非推奨の変数名)を参照してください。 + +## 非推奨の変数名 + +これらのノートの以前のバージョンでは、古いデザインシステムの名前を指していました。それらはまだ有効ですが、非推奨であり、将来のリリースで削除される予定です。今すぐテーマ変数に移行してください: + +| 非推奨の名前 | テーマ変数 | +| ------------ | ---------- | +| `--base-background` | `--background` | +| `--base-foreground` | `--foreground` | +| `--border-default` | `--border` | +| `--primary-background` | `--primary` | +| `--secondary-background` | `--secondary` | +| `--component-node-background` | `--node` | + +PrimeIcons はまだ読み込まれているため、既存の `pi pi-*` アイコンクラスは引き続き機能しますが、段階的に廃止されます。新たな使用を追加しないでください。 diff --git a/ja/custom-nodes/js/serialization-callbacks-migration.mdx b/ja/custom-nodes/js/serialization-callbacks-migration.mdx new file mode 100644 index 0000000000..a03442c350 --- /dev/null +++ b/ja/custom-nodes/js/serialization-callbacks-migration.mdx @@ -0,0 +1,50 @@ +--- +title: "フロントエンド拡張機能のシリアライズコールバック移行" +sidebarTitle: "シリアライズコールバックの移行" +description: "ストアに保存されたグラフにおいて onSerialize と onConfigure がどのように動作するか、および ComfyUI フロントエンド拡張機能がカスタムデータをどこに永続化すべきかについて説明します。" +translationSourceHash: de116a13 +translationFrom: custom-nodes/js/serialization-callbacks-migration.mdx +translationBlockHashes: + "_intro": 87be7894 + "Store custom data in properties or extra": 9bd7e443 + "Serialize nodes instead of enumerating properties": f9850471 +--- + + +シリアライズされたデータからルート `LGraph` を構成するには、有効な Pinia インスタンスが必要になりました。`LGraph.configure()` は ECS ストアを直接対象としてグラフをクリアして再構築するため、有効な Pinia なしで `new LGraph(data)` や `graph.configure(data)` を呼ぶテストハーネス、ワーカー、単体の LiteGraph コンシューマーは、空のグラフを黙って生成するのではなく即座に失敗するようになります。これは[リンク登録マイグレーション](/ja/custom-nodes/js/link-registration-migration)で説明している要件と同じです。 + +ComfyUI 内で動作する拡張機能は、アプリケーションの有効な Pinia インスタンスを使用します。拡張機能のコードから別の Pinia インスタンスを作成したり有効化したりしないでください。 + +`node.onConfigure`、`node.onSerialize`、`graph.onConfigure`、`graph.onSerialize` は、既存のシグネチャと発火順を維持します。接続タイミングのフックについては[接続コールバック移行](/ja/custom-nodes/js/connection-callbacks-migration)を、`node.widgets` とウィジェット値の保存については[ウィジェットシステムの移行](/ja/custom-nodes/js/widgets-migration)を参照してください。 + +`onConfigure` は、呼び出し元のオブジェクトではなく、シリアライズされたデータの浅いコピーを受け取るようになりました。コールバック引数のトップレベルキーを追加、削除、再代入しても、呼び出し元のワークフロー JSON は変わらず、永続化もされません。ネストしたオブジェクト(たとえば `inputs`、`pos`、`properties`)は引き続き呼び出し元と共有されるため、その場で変更すると漏れは残ります。どちらの変更方法に依存していた拡張機能も、カスタム状態は `node.properties` または `graph.extra` に保存してください。 + +## カスタムデータは properties または extra に保存する + +ノード単位の拡張データには `node.properties`、グラフ単位の拡張データには `graph.extra` を使用します。これらは永続化データのための安定した公式の拡張サーフェスです。 + +`onSerialize` と `onConfigure` は `this` が実際のノード/グラフオブジェクトに束縛された状態で呼び出されます。コールバックに渡される引数はシリアライズ済みのデータオブジェクト(`ISerialisedNode`/`ISerialisedGraph`)であり、実際のノード/グラフではありません。`this` は実際のオブジェクトのままなので、フックはストアに支えられたフィールドを含め、そのオブジェクトの任意のフィールドを変更できます。これらのフックでコアフィールドを上書きしないでください。`onSerialize`/`onConfigure` の内部から `this` 経由で書き込むと、独自のスキーマ、所有権、元に戻す境界を持たずにストアへ直接反映されます。 + +`onSerialize` は、フロントエンドが `graph.extra` と `node.properties` をデータオブジェクトへコピーした後に実行されるため、フックが `this.extra` や `this.properties` に追加したキーは今回の保存には含まれません。`onSerialize` の内部では、コールバック引数へ書き込んでください。グラフなら `data.extra`、ノードなら `data.properties` です。それ以外の場合は、シリアライズが始まる前に `graph.extra` や `node.properties` を更新してください。 + +`onSerialize` が保持できるコールバックは 1 つだけなので、他の拡張機能がすでに設定したフックは残してください。 + +```js +const previous = graph.onSerialize +graph.onSerialize = function (data) { + previous?.call(this, data) + data.extra.myExtension = { version: 1 } +} +``` + +`onSerialize` を実行するのはルートグラフだけです。サブグラフ定義はサブグラフ上でフックを呼ばずに保存されるため、ワークフローを保存する前にサブグラフのデータを `subgraph.extra` へ保存してください。 + +フックが `data` に追加したカスタムのトップレベルキーは、`LGraph.asSerialisable()` でもトップレベルのまま残ります。レガシーの `LGraph.serialize()` エントリポイントはそれを `data.extensions` の下へ移し、JSON 互換でない値は省きます。ワークフローの読み込み時、`onConfigure` は再びそのキーをトップレベルで受け取ります。`extra` の下のキーはどちらのエントリポイントでも位置を保ちます。 + +## プロパティを列挙する代わりにノードをシリアライズする + +拡張機能がノード自身のプロパティを列挙してノードのシリアライズ済み表現やデバッグ用表現を構築している場合は、`node.serialize()` を使うように切り替えてください。 + +`id`、`type`、`title`、`flags`、`mode`、`color`、`bgcolor`、`shape`、`showAdvanced` は、ノードインスタンス上の独自データプロパティではなく、ノードデータストアを参照するアクセサプロパティになりました。`Object.keys(node)`、`for...in`、`{ ...node }` ではこれらのフィールドが取得されなくなりましたが、直接の読み取りと書き込み(`node.title`、`node.mode = ...`)はこれまでどおり動作します。`inputs`、`outputs`、`widgets` は引き続き自身の列挙可能プロパティであるため、スプレッドや列挙ではこれら3つが取得されます。 + +ウィジェットレベルの `serializeValue`(ワークフロー JSON ではなく API プロンプトのペイロードを構築する、独立したシリアライズ層)については、[ウィジェットシステムの移行](/ja/custom-nodes/js/widgets-migration)を参照してください。 diff --git a/ja/custom-nodes/js/widgets-migration.mdx b/ja/custom-nodes/js/widgets-migration.mdx new file mode 100644 index 0000000000..9c6c1389bd --- /dev/null +++ b/ja/custom-nodes/js/widgets-migration.mdx @@ -0,0 +1,97 @@ +--- +title: "フロントエンド拡張機能のウィジェットシステム移行" +sidebarTitle: "ウィジェットシステム移行" +description: "ComfyUI フロントエンドにおけるストアベースのウィジェット値: 一意のウィジェット名、undefined の node.widgets、ウィジェット名の変更、addCustomWidget および Agent の setValue 呼び出し。" +translationSourceHash: 3011c9c5 +translationFrom: custom-nodes/js/widgets-migration.mdx +translationBlockHashes: + "_intro": 87b853c9 + "Gallery values after the PrimeVue replacement": c6a755f6 + "Widget names must be unique and stable": 5988a23b + "`node.widgets` may be undefined": 7cb43a39 + "Prefer `node.addCustomWidget()` to pushing onto `node.widgets`": 5ee6030c + "Remove widgets with `node.removeWidget()`": 7d19ff02 + "Agent edits call `setValue` without a pointer event": 140c58f6 + "Don't call `useWidgetValueStore()` from extension code": 6c2a5cd3 +--- + +ウィジェットの値は、ウィジェットインスタンス上に直接保持されるのではなく、Pinia をバックエンドとするストアに保存されるようになりました。ウィジェット名はノードごとに一意である必要があり、ウィジェットの名前変更は、新しい名前が未使用の場合にのみ成功します。また `node.widgets` は、最初に代入されるまでは `undefined` である可能性があります。 + +## PrimeVue 置き換え後のギャラリー値 {#gallery-values-after-the-primevue-replacement} + +Vue の `galleria` ウィジェットは、`GALLERIA` 入力スキーマに一致する画像URL文字列の配列を受け取ります。複数の画像を指定すると、サムネイルと前へ/次へボタンが表示されます。ナビゲーションは最初と最後の画像で停止します。 + +`itemImageSrc` や `thumbnailImageSrc` を持つ PrimeVue の画像オブジェクトはサポートされなくなりました。URL文字列に変換してください。ウィジェットは `showThumbnails`、`showItemNavigators`、`circular`、`autoPlay`、`transitionInterval`、`showIndicators`、`numVisible`、`responsiveOptions` などの PrimeVue オプションを読み取らなくなりました。これらの制御が必要な拡張機能は、独自のギャラリーウィジェットを提供する必要があります。 + +## ウィジェット名は一意かつ安定している必要があります + +同じノード上の2つのウィジェットが同じ名前を共有することはできません。すでに使用されている名前で2つ目のウィジェットを追加すると、ノードがグラフ内にある場合、フロントエンドは新しいウィジェットに `strength#1` のような番号付きのサフィックスを付けて名前を変更します。元の名前で検索すると、最初のウィジェットのみが見つかります: + +```js +node.addWidget('number', 'strength', 0, () => {}) +const second = node.addWidget('number', 'strength', 1, () => {}) +second.name // ノードがグラフ内にあると 'strength#1' +``` + +各ウィジェットに一意の名前を付けてください。 + +登録済みのウィジェットに新しい `widget.name` を割り当てると、保存されている値が新しい名前へ移動します。ノード上の別のウィジェットがすでにその名前を使用している場合、割り当ては無視され、`widget.name` は古い値を保持するため、後で `widget.name` を確認してください。ウィジェットを名前で参照する入力スロットは更新されません。名前を変更するためにウィジェットを削除して新しいウィジェットを追加しないでください。`removeWidget()` は保存された値を削除し、ウィジェットに直接バインドされた入力スロットをクリアします。それを名前だけで参照する入力スロットは、その名前を保持します。 + +## `node.widgets` が undefined の可能性がある + +`node.widgets` は、少なくとも一度代入されるまで `undefined` を返します。 +ウィジェットを追加する前に配列を初期化してください: + +```ts +export function nodeCreated(node: LGraphNode) { + node.widgets ??= [] + node.widgets.push(myWidget) +} +``` + +読み取り時のガードも同様です: + +```ts +const widgetCount = node.widgets?.length ?? 0 +``` + +**`node.widgets = undefined` を設定すると、クリアされます。** 後で読み取ると、`[]` ではなく再び `undefined` が返ります。 + +**ノードがグラフにアタッチされる前に加えられた変更は自動的に反映されます。** コンストラクターや `onNodeCreated` でウィジェットを構築する一般的なケースでは、自分で何かを呼び出す必要はありません。 + +`node.widgets` は `Object.keys(node)` や、`{...node}` のようなオブジェクトスプレッドに現れます。 + +## `node.widgets` への push より `node.addCustomWidget()` を優先する + +`node.addWidget()`、`node.addCustomWidget()`、`node.addDOMWidget()` で追加したウィジェットはストアに自動的に登録されます。`node.widgets` に直接 push したプレーンオブジェクトも、ノードがグラフに入るとウィジェットインスタンスに変換され登録されます。変換は通常その場で行われますが、凍結されたオブジェクトや設定変更できないプロパティを持つオブジェクトは別のウィジェットに置き換えられるため、`addCustomWidget()` が返すウィジェットを保持するか、`node.widgets` から読み戻してください。それでも `addCustomWidget()` が推奨される呼び出しです。ウィジェットを返し、ワークフローの読み込み時にウィジェットの保存済みの値を復元します。 + +```js +node.addCustomWidget({ + name: 'my_widget', + type: 'custom', + value: '', + options: {}, + draw(ctx, node, width, y, height) {}, + mouse(event, pos, node) {} +}) +``` + +ノードがグラフに接続される前に `widget.value` を読み書きすると、値はローカルに保持され、接続時にストアへ同期されます。値が失われることはありませんが、その時点までストア駆動の UI(右側のパネルなど)には値が見えません。 + +## `node.removeWidget()` でウィジェットを削除する + +`node.removeWidget(widget)` を使用してウィジェットを削除します。`node.widgets` を直接 splice するとスロットのクリーンアップがスキップされ、削除されたウィジェットの値はノード自体がグラフから削除されるまでストアに残ります。 + +## アプリ内 Agent の編集はポインターイベントなしで `setValue` を呼び出す + +アプリ内 Agent が `BaseWidget` インスタンスであるウィジェットを変更すると、フロントエンドは `widget.setValue(value, { node, canvas })` を呼び出します。これはユーザーの編集と同じメソッドです。以前は `widget.value` を直接代入し、その後に `callback` と `onWidgetChanged` を自分で呼び出していました。`addCustomWidget()` で追加した、または `node.widgets` に直接 push したプレーンオブジェクトも対象です。フロントエンドがそれらを `BaseWidget` インスタンスに変換するためです。DynamicGroup の行数コントローラーとプロモートされたサブグラフホストのウィジェットは、引き続き直接書き込みを受けます。 + +`setValue` をオーバーライドする場合は、`{ node, e?, canvas? }` の形のオプションを受け取ってください。これらの呼び出しでは `e` は設定されず、`canvas` も存在しないことがあります。`options.e` や `options.canvas` は必ず確認してから読んでください。値だけを渡して元の `setValue` を呼ぶラッパーは引き続き動作します。オプションは `{ node: widget.node }` が既定になります。 + +`callback` と `onWidgetChanged` は、Agent が送った値ではなく、ウィジェットが受け入れた値を受け取ります。数値ウィジェットは `min`/`max` でクランプし、数値文字列を数値に変換します。`callback` 内では `e` は `undefined` で、キャンバスがない場合は `pos` も `undefined` です。 + +`setValue` は、数値ウィジェットのクランプと変換を経た値が現在の値とすでに同一(`===`)であれば、変更なしで戻ります。そのため、値が `5` の数値ウィジェットに `'5'` を渡しても何も変わりません。数値ウィジェットが `Number(value)` が `NaN` になる値を受け取った場合も戻ります。`callback` も `onWidgetChanged` も発火せず、グラフのバージョンも変わりません。`'7'` のような数値文字列は変換されて適用されます。 + +## 拡張機能のコードから `useWidgetValueStore()` を呼び出さない + +拡張機能から `useWidgetValueStore()` を呼び出さないでください。代わりに `node.widgets`、`node.addWidget()` / `addCustomWidget()` / `removeWidget()`、および `widget.value` を使用してください。ストアの内部キー管理と、その Pinia への依存は、サポートされる拡張サーフェスではありません。 diff --git a/ja/development/comfy-router/models.mdx b/ja/development/comfy-router/models.mdx index d414e73e79..f09bac6288 100644 --- a/ja/development/comfy-router/models.mdx +++ b/ja/development/comfy-router/models.mdx @@ -2,11 +2,11 @@ title: "Comfy Router モデル" sidebarTitle: "すべてのモデル" description: "Comfy Router で利用できるすべてのモデルを、各モデルの入力と出力のモダリティとあわせて、プロバイダー別にまとめています。" -translationSourceHash: d2265d41 +translationSourceHash: d299c0f0 translationFrom: development/comfy-router/models.mdx translationBlockHashes: "_intro": 2584e428 - "Find by output": 9b1b4039 + "Find by output": 5ddf7991 "Anthropic": de8acc20 "Beeble": b52ea340 "Black Forest Labs": 2934e3eb @@ -28,9 +28,9 @@ translationBlockHashes: "Meshy": 67e26a17 "MiniMax": 87560ab7 "Moonvalley": 9e63fb77 - "OpenAI": a5c1e692 + "OpenAI": 5bbf3b2c "Openrouter": a4f6806b - "Pika": f2b1d797 + "Pika": 8b17ff30 "Pruna": 903d76ee "Qwen": b3ef78a1 "Recraft": 02b7d9cd @@ -54,7 +54,7 @@ translationBlockHashes: ## 出力から探す - + - [SwitchX](/ja/development/comfy-router/models/beeble/switchx/code): `beeble/switchx` - [FLUX 3 Video](/ja/development/comfy-router/models/black-forest-labs/flux-3-video/code): `bfl/flux-3-video` @@ -96,6 +96,7 @@ translationBlockHashes: - [Video To Video](/ja/development/comfy-router/models/moonvalley/video-to-video/code): `moonvalley/video-to-video` - [Pika 2.5 Image To Video](/ja/development/comfy-router/models/pika/pika-2-5-image-to-video/code): `pika/pika-2.5-image-to-video` - [Pika 2.5 Text To Video](/ja/development/comfy-router/models/pika/pika-2-5-text-to-video/code): `pika/pika-2.5-text-to-video` +- [Pika Soundtrack](/ja/development/comfy-router/models/pika/pika-soundtrack/code): `pika/pika-soundtrack` - [P Video 2](/ja/development/comfy-router/models/pruna/p-video-2/code): `pruna/p-video-2` - [Aleph 2](/ja/development/comfy-router/models/runway/aleph2/code): `runway/aleph2` - [Gen 4 Turbo](/ja/development/comfy-router/models/runway/gen4-turbo/code): `runway/gen4_turbo` @@ -229,7 +230,7 @@ translationBlockHashes: - [Grok Imagine Image](/ja/development/comfy-router/models/xai/grok-imagine-image/code): `xai/grok-imagine-image` - + - [FLUX 3 Video](/ja/development/comfy-router/models/black-forest-labs/flux-3-video/code): `bfl/flux-3-video` - [Dreamina Seedance 2.0 260128](/ja/development/comfy-router/models/byteplus/dreamina-seedance-2-0-260128/code): `byteplus/dreamina-seedance-2-0-260128` @@ -255,6 +256,9 @@ translationBlockHashes: - [LTX 2.5 Fast](/ja/development/comfy-router/models/ltx/ltx-2-5-fast/code): `ltx/ltx-2-5-fast` - [LTX 2.5 Pro](/ja/development/comfy-router/models/ltx/ltx-2-5-pro/code): `ltx/ltx-2-5-pro` - [MiniMax H3](/ja/development/comfy-router/models/minimax/minimax-h3/code): `minimax/minimax-h3` +- [Pika Music](/ja/development/comfy-router/models/pika/pika-music/code): `pika/pika-music` +- [Pika Sfx](/ja/development/comfy-router/models/pika/pika-sfx/code): `pika/pika-sfx` +- [Pika Soundtrack](/ja/development/comfy-router/models/pika/pika-soundtrack/code): `pika/pika-soundtrack` - [P Video 2](/ja/development/comfy-router/models/pruna/p-video-2/code): `pruna/p-video-2` - [Clean Audio Video](/ja/development/comfy-router/models/veed/clean-audio-video/code): `veed/clean-audio-video` - [Clean Audio](/ja/development/comfy-router/models/veed/clean-audio/code): `veed/clean-audio` @@ -288,7 +292,7 @@ translationBlockHashes: - [Hunyuan 3D Uv](/ja/development/comfy-router/models/tencent/hunyuan-3d-uv/code): `tencent/hunyuan-3d-uv` - + - [Claude Fable 5.1](/ja/development/comfy-router/models/anthropic/claude-fable-5-1/code): `anthropic/claude-fable-5-1` - [Claude Fable 5](/ja/development/comfy-router/models/anthropic/claude-fable-5/code): `anthropic/claude-fable-5` @@ -327,6 +331,8 @@ translationBlockHashes: - [GPT 5 Mini](/ja/development/comfy-router/models/openai/gpt-5-mini/code): `openai/gpt-5-mini` - [GPT 5 Nano](/ja/development/comfy-router/models/openai/gpt-5-nano/code): `openai/gpt-5-nano` - [GPT 5](/ja/development/comfy-router/models/openai/gpt-5/code): `openai/gpt-5` +- [GPT 6.1 Sol](/ja/development/comfy-router/models/openai/gpt-6-1-sol/code): `openai/gpt-6.1-sol` +- [GPT 6.1 Terra](/ja/development/comfy-router/models/openai/gpt-6-1-terra/code): `openai/gpt-6.1-terra` - [GPT 6 Astra](/ja/development/comfy-router/models/openai/gpt-6-astra/code): `openai/gpt-6-astra` - [GPT 6 Luna](/ja/development/comfy-router/models/openai/gpt-6-luna/code): `openai/gpt-6-luna` - [GPT 6 Sol](/ja/development/comfy-router/models/openai/gpt-6-sol/code): `openai/gpt-6-sol` @@ -586,6 +592,8 @@ translationBlockHashes: | [GPT 5 Mini](/ja/development/comfy-router/models/openai/gpt-5-mini/code) | `openai/gpt-5-mini` | テキスト, 画像 | テキスト | | [GPT 5 Nano](/ja/development/comfy-router/models/openai/gpt-5-nano/code) | `openai/gpt-5-nano` | テキスト, 画像 | テキスト | | [GPT 5](/ja/development/comfy-router/models/openai/gpt-5/code) | `openai/gpt-5` | テキスト, 画像 | テキスト | +| [GPT 6.1 Sol](/ja/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | テキスト, 画像 | テキスト | +| [GPT 6.1 Terra](/ja/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | テキスト, 画像 | テキスト | | [GPT 6 Astra](/ja/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | テキスト, 画像 | テキスト | | [GPT 6 Luna](/ja/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | テキスト, 画像 | テキスト | | [GPT 6 Sol](/ja/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | テキスト, 画像 | テキスト | @@ -607,6 +615,9 @@ translationBlockHashes: | --- | --- | --- | --- | | [Pika 2.5 画像から動画](/ja/development/comfy-router/models/pika/pika-2-5-image-to-video/code) | `pika/pika-2.5-image-to-video` | テキスト、画像 | ビデオ | | [Pika 2.5 テキストから動画](/ja/development/comfy-router/models/pika/pika-2-5-text-to-video/code) | `pika/pika-2.5-text-to-video` | テキスト | ビデオ | +| [Pika Music](/ja/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | テキスト、オーディオ | オーディオ | +| [Pika Sfx](/ja/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | テキスト | オーディオ | +| [Pika Soundtrack](/ja/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | ビデオ、テキスト | ビデオ + オーディオ | ## Pruna diff --git a/ja/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx b/ja/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx index 00cf5cb887..cd46a40a06 100644 --- a/ja/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx +++ b/ja/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx @@ -2,14 +2,14 @@ title: "Comfy Router で Kling 3.0 Turbo を使用する" description: "Comfy Router 経由で kling/kling-3.0-turbo を呼び出します: エンドポイント、リクエスト形状、Router が返すレスポンスについて説明します。" sidebarTitle: "Kling 3.0 Turbo" -translationSourceHash: d03a4ba5 +translationSourceHash: d09b3876 translationFrom: development/comfy-router/models/kling/kling-3-0-turbo/code.mdx translationBlockHashes: "_intro": 5a8c5f4b "Quick start": a2145573 "Serving providers": 7ec93d4f - "Schema": 4ec53894 - "Examples": 0a9a8bbe + "Schema": 992b8da2 + "Examples": 5ce1484a --- @@ -398,7 +398,7 @@ Router が `GET /v2/models/kling/kling-3.0-turbo/openapi.json` で提供する "duration": "5", "id": "kling-v2-output-2b1a0f9e8d7c", "type": "video", - "url": "https://example.invalid/kling/kling-3.0-turbo/generated.mp4" + "url": "https://example.invalid/kling/v2/generated.mp4" } ], "status": "succeeded", diff --git a/ja/development/comfy-router/models/kling/kling-image-o1/code.mdx b/ja/development/comfy-router/models/kling/kling-image-o1/code.mdx index 387a47e476..7d4fd76042 100644 --- a/ja/development/comfy-router/models/kling/kling-image-o1/code.mdx +++ b/ja/development/comfy-router/models/kling/kling-image-o1/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で Kling Image O1 を使用する" description: "Comfy Router を通じて kling/kling-image-o1 を呼び出します: エンドポイント、リクエスト形状、Router が返すレスポンスについて説明します。" sidebarTitle: "Kling Image O1" -translationSourceHash: 0d76917c +translationSourceHash: ca32c929 translationFrom: development/comfy-router/models/kling/kling-image-o1/code.mdx translationBlockHashes: "_intro": 513c65df "Quick start": 6256a30d - "Schema": 61821697 + "Schema": 60d9f6fd "Examples": 826db173 --- @@ -16,7 +16,7 @@ translationBlockHashes: import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; -Comfy Router が Kling から提供する `kling/kling-image-o1` の APIリファレンス です。 +Comfy Router が Kling から提供する `kling/kling-image-o1` の API リファレンスです。 **入力:** テキスト, 画像 · **出力:** 画像 @@ -214,7 +214,7 @@ curl https://api.comfy.org/v2/models/kling/kling-image-o1/requests/$REQUEST_ID \ - 単一の画像を生成するか、一連の画像を生成するかを制御します。 + 単一の画像を生成するか、一連の画像を生成するかを制御します。kling-image-o1 では series はサポートされていません(これは `model_name` を省略した場合に v1 プロキシが使用する値でもあります)。そのようなリクエストは HTTP 400 で拒否されます。 指定可能な値: `single`, `series` diff --git a/ja/development/comfy-router/models/luma/ray-2/code.mdx b/ja/development/comfy-router/models/luma/ray-2/code.mdx deleted file mode 100644 index f209ee3c2e..0000000000 --- a/ja/development/comfy-router/models/luma/ray-2/code.mdx +++ /dev/null @@ -1,299 +0,0 @@ ---- -title: "Comfy Router で Ray 2 を使用する" -description: "Comfy Router を通じて luma/ray-2 を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンス。" -sidebarTitle: "Ray 2" -translationSourceHash: 05a55db0 -translationFrom: development/comfy-router/models/luma/ray-2/code.mdx -translationBlockHashes: - "_intro": 76eb0c5f - "Quick start": 6f46e102 - "Schema": ea1f7cdb - "Examples": 3993fae3 ---- - - -{/* 生成済みファイル。`router-schemas/luma/ray-2.json` から `pnpm code-pages:gen` により生成。 */} - -import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; - -`luma/ray-2` の API リファレンス。Luma から Comfy Router によって提供されます。 - -**入力:** テキスト, 画像 · **出力:** ビデオ - -## クイックスタート - -[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で実行するものです。 - -**モデル ID:** `luma/ray-2` - -**エンドポイント:** `POST https://api.comfy.org/v2/models/luma/ray-2` - - - - -```python Python -from comfy_sdk import Comfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# SDK は自動的に冪等性キーを作成し、自動リトライ時に再利用します。 -with Comfy() as client: - result = client.models.run( - "luma/ray-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// SDK は自動的に冪等性キーを作成し、自動リトライ時に再利用します。 -const { data } = await comfy.models.run("luma/ray-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/luma/ray-2 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" -``` - - - -同じボディを `POST https://api.comfy.org/v2/models/luma/ray-2/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は[キュー配信](/ja/development/comfy-router/queue)を参照してください。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# submit() 呼び出しごとに独自の Idempotency-Key を生成し、自動リトライ時に再利用します。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "luma/ray-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - print("request_id:", handle.request_id) # モデル ID と合わせれば、別のプロセスに必要なものはこれだけです - - # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の秒数だけ待機します。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。 - # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// submit() 呼び出しごとに独自の Idempotency-Key を生成し、自動リトライ時に再利用します。 -const handle = await comfy.models.submit("luma/ray-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); -console.log("requestId:", handle.requestId); // モデル ID と合わせれば、別のプロセスに必要なものはこれだけです - -// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の秒数だけ待機します。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 送信。Router は request_id、status_url、response_url、cancel_url を含む 201 を返します。 -curl https://api.comfy.org/v2/models/luma/ray-2/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" - -# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/luma/ray-2/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 取得。200 ならモデル固有の出力、まだ実行中なら 202 とステータスボディが返ります。 -curl https://api.comfy.org/v2/models/luma/ray-2/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## スキーマ - -### 入力 - - - 生成のアスペクト比 - - 指定可能な値: `1:1`、`16:9`、`9:16`、`4:3`、`3:4`、`21:9`、`9:21` - - - - 生成の callback URL。生成が dreaming、完了、または失敗したときに、Generation オブジェクトを含む POST リクエストが callback URL に送信されます - - フォーマット: `uri` - - - - - - - - 指定可能な値: `video` - - - - 生成のキーフレーム - - - - キーフレームは、Generation 参照、Image、または Video のいずれかです - - - - キーフレームは、Generation 参照、Image、または Video のいずれかです - - - - ビデオをループするかどうか - - - - 生成に使用するビデオモデル。Comfy Router のルート `POST /v2/models/luma/{model}` では、このフィールドはパスから供給されるため、送信してはいけません。v1 の `POST /proxy/luma/generations` ルートでは必須であり、LumaVideoModel enum(`ray-2`、`ray-flash-2`)に制限されます。 - - - - 生成のプロンプト - - - - - - -Router が `GET /v2/models/luma/ray-2/openapi.json` で提供するスキーマから生成されており、これはリクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するドキュメントと同じものです。 - -### 出力 - - - 生成のアセット - - - - 画像の URL - - フォーマット: `uri` - - - - 進行状況ビデオの URL - - フォーマット: `uri` - - - - ビデオの URL - - フォーマット: `uri` - - - - 生成が作成された日時 - - フォーマット: `date-time` - - - - 生成の状態の理由 - - - - 指定可能な値: `video`、`image` - - - - 生成の ID - - フォーマット: `uuid` - - - - 生成に使用されたモデル - - - - 生成のリクエスト - - - - 生成の状態 - - 指定可能な値: `queued`、`dreaming`、`completed`、`failed` - - -## 例 - -### 入力 - -```json -{ - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p" -} -``` - -### 出力 - -```json -{ - "assets": { - "video": "https://example.invalid/luma/ray-2/generated.mp4" - }, - "created_at": "2027-01-01T00:00:00Z", - "generation_type": "video", - "id": "3f2a7c1e-8b40-4d59-9f6a-1c2d3e4f5a60", - "model": "ray-2", - "state": "completed" -} -``` - - - diff --git a/ja/development/comfy-router/models/luma/ray-flash-2/code.mdx b/ja/development/comfy-router/models/luma/ray-flash-2/code.mdx deleted file mode 100644 index 7c9c469c06..0000000000 --- a/ja/development/comfy-router/models/luma/ray-flash-2/code.mdx +++ /dev/null @@ -1,300 +0,0 @@ ---- -title: "Comfy Router で Ray Flash 2 を使用する" -description: "Comfy Router 経由で luma/ray-flash-2 を呼び出します。endpoint、リクエストの形状、Router が返すレスポンスについて説明します。" -sidebarTitle: "Ray Flash 2" -translationSourceHash: 398d8142 -translationFrom: development/comfy-router/models/luma/ray-flash-2/code.mdx -translationBlockHashes: - "_intro": bd0b0053 - "Quick start": c53b2450 - "Schema": 8009af73 - "Examples": cb7953b0 ---- - - - -{/* GENERATED FILE. Generated from router-schemas/luma/ray-flash-2.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; - -`luma/ray-flash-2` の API リファレンスです。Comfy Router が Luma から提供しています。 - -**入力:** テキスト, 画像 · **出力:** ビデオ - -## クイックスタート - -[あなたの Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用します。cURL スニペットは同じ呼び出しを生の HTTP で実行します。 - -**モデル ID:** `luma/ray-flash-2` - -**エンドポイント:** `POST https://api.comfy.org/v2/models/luma/ray-flash-2` - - - - -```python Python -from comfy_sdk import Comfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。 -with Comfy() as client: - result = client.models.run( - "luma/ray-flash-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。 -const { data } = await comfy.models.run("luma/ray-flash-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/luma/ray-flash-2 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" -``` - - - -同じボディを `POST https://api.comfy.org/v2/models/luma/ray-flash-2/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、取得の流れについては [キュー配信](/ja/development/comfy-router/queue) で説明しています。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "luma/ray-flash-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - print("request_id:", handle.request_id) # モデル ID とともに、別のプロセスが必要とするすべての情報 - - # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # プロバイダー自身のペイロードで、models.run() が返す値と同じです。 - # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -const handle = await comfy.models.submit("luma/ray-flash-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); -console.log("requestId:", handle.requestId); // モデル ID とともに、別のプロセスが必要とするすべての情報 - -// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストはここで reject されます。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。 -curl https://api.comfy.org/v2/models/luma/ray-flash-2/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" - -# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/luma/ray-flash-2/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 結果を収集。モデルのネイティブ出力とともに 200、まだ実行中の場合はステータスボディとともに 202 を返します。 -curl https://api.comfy.org/v2/models/luma/ray-flash-2/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## スキーマ - -### 入力 - - - 生成のアスペクト比 - - 指定可能な値: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `21:9`, `9:21` - - - - 生成のコールバック URL。生成が dreaming、完了、または失敗したときに、Generation オブジェクトを含む POST リクエストがコールバック URL に送信されます - - 形式: `uri` - - - - - - - - 指定可能な値: `video` - - - - 生成のキーフレーム - - - - キーフレームは Generation 参照、Image、または Video のいずれかです - - - - キーフレームは Generation 参照、Image、または Video のいずれかです - - - - ビデオをループするかどうか - - - - 生成に使用されるビデオモデル。Comfy Router のルート `POST /v2/models/luma/{model}` では、このフィールドはパスから供給されるため送信してはなりません(MUST NOT)。v1 の `POST /proxy/luma/generations` ルートでは必須であり、LumaVideoModel enum(`ray-2`、`ray-flash-2`)に制約されます。 - - - - 生成のプロンプト - - - - - - -Router が `GET /v2/models/luma/ray-flash-2/openapi.json` で提供するスキーマから生成されたもので、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるドキュメントと同じものです。 - -### 出力 - - - 生成のアセット - - - - 画像の URL - - 形式: `uri` - - - - 進行状況ビデオの URL - - 形式: `uri` - - - - ビデオの URL - - 形式: `uri` - - - - 生成が作成された日時 - - 形式: `date-time` - - - - 生成の状態の理由 - - - - 指定可能な値: `video`, `image` - - - - 生成の ID - - 形式: `uuid` - - - - 生成に使用されたモデル - - - - 生成のリクエスト - - - - 生成の状態 - - 指定可能な値: `queued`, `dreaming`, `completed`, `failed` - - -## 例 - -### 入力 - -```json -{ - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p" -} -``` - -### 出力 - -```json -{ - "assets": { - "video": "https://example.invalid/luma/ray-flash-2/generated.mp4" - }, - "created_at": "2027-01-01T00:00:00Z", - "generation_type": "video", - "id": "8c41d0b6-2e7a-4f35-b1d8-9a0e6f3c2b71", - "model": "ray-flash-2", - "state": "completed" -} -``` - - - diff --git a/ja/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx b/ja/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx index be1d7ee653..c6a5f3f305 100644 --- a/ja/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 4.1 Mini を使用する" description: "Comfy Router 経由で openai/gpt-4.1-mini を呼び出します。エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 4.1 Mini" -translationSourceHash: d34bebbe +translationSourceHash: 4e94ce52 translationFrom: development/comfy-router/models/openai/gpt-4-1-mini/code.mdx translationBlockHashes: "_intro": b8a49e6e "Quick start": bd92ba2a - "Schema": 445b15a8 + "Schema": 80382523 "Examples": 67e6c8f1 --- @@ -521,6 +521,18 @@ Python SDK と JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx b/ja/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx deleted file mode 100644 index accdbb7403..0000000000 --- a/ja/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx +++ /dev/null @@ -1,604 +0,0 @@ ---- -title: "Comfy Router で GPT 4.1 Nano を使う" -description: "Comfy Router 経由で openai/gpt-4.1-nano を呼び出す: endpoint、リクエストの形状、Router が返すレスポンス。" -sidebarTitle: "GPT 4.1 Nano" -translationSourceHash: cb01a907 -translationFrom: development/comfy-router/models/openai/gpt-4-1-nano/code.mdx -translationBlockHashes: - "_intro": 9543bf7b - "Quick start": 9c5ad598 - "Schema": 4e68a487 - "Examples": 67e6c8f1 ---- - - - -{/* GENERATED FILE. Generated from router-schemas/openai/gpt-4.1-nano.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; - -`openai/gpt-4.1-nano` の API リファレンスです。OpenAI から Comfy Router を通じて提供されます。 - -**入力:** テキスト, 画像 · **出力:** テキスト - -## クイックスタート - -[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL のスニペットは同じ呼び出しを raw HTTP で行うものです。 - -**モデル ID:** `openai/gpt-4.1-nano` - -**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano` - - - - -```python Python -from comfy_sdk import Comfy - -# 環境から COMFY_API_KEY を読み取ります。 -# SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。 -with Comfy() as client: - result = client.models.run( - "openai/gpt-4.1-nano", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境から COMFY_API_KEY を読み取ります。 -// SDK は自動的に冪等キーを作成し、自動リトライのために再利用します。 -const { data } = await comfy.models.run("openai/gpt-4.1-nano", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は [キュー配信](/ja/development/comfy-router/queue) を参照してください。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 環境から COMFY_API_KEY を読み取ります。 -# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/gpt-4.1-nano", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # モデル ID と合わせて、別のプロセスに必要なのはこれだけです - - # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。 - # 失敗またはキャンセル済みのリクエストでは、ここで型付きの Router エラーが発生します。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境から COMFY_API_KEY を読み取ります。 -// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -const handle = await comfy.models.submit("openai/gpt-4.1-nano", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスに必要なのはこれだけです - -// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストはここで reject されます。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。 -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 収集。モデルのネイティブ出力とともに 200、まだ実行中であればステータスボディとともに 202 を返します。 -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## スキーマ - -### 入力 - - - モデルのレスポンスに含める追加の出力データ。 - - - - モデルへのテキスト、画像、ファイルの入力。レスポンスの生成に使用されます。このコントラクトで Router が補うことのできない唯一のフィールドであり、以下の `required` にある唯一の項目です。 - - - - モデルのコンテキストの最初の項目として、システム(または developer)メッセージを挿入します。 - - - - レスポンスで生成されるトークン数の上限。可視出力トークンと reasoning トークンを含みます。reasoning id ではこの上限は隠れた reasoning トークンと共有されるため、小さな値では可視テキストが出る前に予算を使い切ってしまう可能性があります。reasoning のスモークケースが 1024 を送り、chat のケースが 16 を送るのはこのためです。 - - 範囲: `1` から `…` - - - - OpenAI モデル識別子。Comfy Router ではこのフィールドは任意で、Router が `{model}` パスセグメントから補います。明示的な `null` も同様に置き換えられます。パスと一致しない値を送信すると拒否されます。 - - - - モデルがツール呼び出しを並列に実行できるようにするかどうか。 - - - - 前のレスポンスの ID。マルチターンの会話で使用します。 - - - - REASONING ティア専用。reasoning モデル用の設定です。例: `{"effort": "medium"}`。変更されずに転送されます。受け入れられるキーについては OpenAI の reasoning ガイドを参照してください。chat ティアの id はこれを無視します。 - - - - OpenAI が生成されたレスポンスを後で取得できるように保存するかどうか。 - - - - 送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを `false` に確定させます。Router は `text/event-stream` を中継するのではなくプロバイダーのレスポンスを取得するためであり、これをデコードできないため、ストリーミングされた生成は OpenAI から課金され、誰からもメータリングされません。Comfy のどのサーフェスもストリームを提供しません。v1 の `POST /proxy/openai/v1/responses` イングレスは `stream: true` を 400 で拒否し、リクエストをアップストリームへ転送することはありません。そのため、いずれのサーフェスでもこのフィールドを省略するか `false` を送信し、完了したレスポンスを 1 つの JSON ボディとして読み取ってください。 - - - - サンプリング温度。CHAT ティア専用です。o シリーズの reasoning id(`o1`、`o1-pro`、`o3`、`o4-mini`)は OpenAI 側でこのパラメーターを拒否します。Router はそれらに対してこれを拒否しません(2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送信する reasoning 呼び出しには OpenAI 自身のエラーが返されます。 - - 範囲: `0` から `2` - - - - 出力形式の設定。例: Structured Outputs 用の `{"format": {"type": "json_schema", ...}}`。変更されずに転送されます。 - - - - モデルが使用するツールをどのように選択するか。文字列のモードか、ツールを指定するオブジェクトのいずれかです。 - - - - モデルが呼び出せるツール定義。Router はツールの分類を絞り込みません。受け入れられる形については OpenAI の Responses API リファレンスを参照してください。 - - - - ニュークリアスサンプリングのカットオフ。`temperature` と同じ条件で CHAT ティア専用です。 - - 範囲: `0` から `1` - - - - コンテキストがモデルのウィンドウを超えた場合の切り詰め戦略。上記の 3 つの語彙とは異なり、ここでは enum が実際に適用されます。この 2 つの値が OpenAI のドキュメントに記載された完全なセットであり、増えていないためです。明示的な `null` は、上記のフィールドと同じ条件で引き続き受け入れられます。 - - 指定可能な値: `auto`、`disabled` - - - - トークン使用量のエンベロープ。v1 オペレーションがリクエストボディでこれを宣言しているため、このコントラクトに存在します。OpenAI はこれをレスポンス側で設定するため、呼び出し元が送信する理由はありません。 - - -Router が `GET /v2/models/openai/gpt-4.1-nano/openapi.json` で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証するのと同じドキュメントです。 - -### 出力 - - - システム(または開発者)メッセージをモデルのコンテキストの最初の項目として挿入します。 - -`previous_response_id` と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または開発者)メッセージを簡単に差し替えられます。 - - - - レスポンスに対して生成できるトークン数の上限。可視出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)を含みます。 - - - - レスポンスの生成に使用されるモデル - - - - レスポンスのランダム性を制御します - - 範囲: `0` から `2` - - - - nucleus サンプリングによってレスポンスの多様性を制御します - - 範囲: `0` から `1` - - - - モデルレスポンスに使用する切り捨て戦略。 -- `auto`: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中の入力項目を削除してコンテキストウィンドウに収まるようにレスポンスを切り捨てます。 -- `disabled`(デフォルト): モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 - - 指定可能な値: `auto`, `disabled` - - - - モデルへの前のレスポンスの一意の ID。これを使用してマルチターンの会話を作成します。[会話状態](https://platform.openai.com/docs/guides/conversation-state)の詳細を学ぶ。 - - - - **o シリーズモデルのみ** - -[推論モデル](https://platform.openai.com/docs/guides/reasoning)の構成オプション。 - - - - 後のターンでモデルに返される推論項目を制御します。例: `auto`、`current_turn`、`all_turns`。 - - - - **o シリーズモデルのみ** - -[推論モデル](https://platform.openai.com/docs/guides/reasoning)の推論の努力量を制約します。現在サポートされている値は `low`、`medium`、`high` です。推論の努力量を減らすと、レスポンスが高速化し、レスポンスでの推論に使用されるトークンが少なくなる可能性があります。 - - 指定可能な値: `low`, `medium`, `high` - - - - **非推奨:** 代わりに `summary` を使用してください。 - -モデルによって実行された推論の要約。これはデバッグやモデルの推論プロセスの理解に役立ちます。`auto`、`concise`、`detailed` のいずれかです。 - - 指定可能な値: `auto`, `concise`, `detailed` - - - - レスポンスに使用される推論モード。 - - - - モデルによって実行された推論の要約。これはデバッグやモデルの推論プロセスの理解に役立ちます。`auto`、`concise`、`detailed` のいずれかです。 - - 指定可能な値: `auto`, `concise`, `detailed` - - - - - - - - モデルが出力する必要がある形式を指定するオブジェクト。 - -`{ "type": "json_schema" }` を構成すると Structured Outputs が有効になり、モデルが指定された JSON schema に一致することが保証されます。詳細は[Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs)を参照してください。 - -デフォルトの形式は追加オプションなしの `{ "type": "text" }` です。 - -**gpt-4o 以降のモデルでは推奨されません:** - -`{ "type": "json_object" }` に設定すると古い JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。サポートしているモデルでは `json_schema` の使用が推奨されます。 - - - - モデルのレスポンスの冗長性を制約します。`low`、`medium`、`high` のいずれかです。 - - - - レスポンスを生成するときにモデルが使用するツールをどのように選択するか。モデルが呼び出せるツールの指定方法については `tools` パラメータを参照してください。 - - - - - - - - モデルレスポンスがバックグラウンドで実行されるかどうか。 - - - - レスポンスの課金情報。 - - - - レスポンスの支払いを担当する主体。 - - - - この Response が完了したときの Unix タイムスタンプ(秒)。ステータスが `completed` の場合にのみ存在します。 - - - - この Response が作成されたときの Unix タイムスタンプ(秒)。 - - - - モデルが Response の生成に失敗したときに返されるエラーオブジェクト。 - - - - レスポンスのエラーコード。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - エラーの人間が読める形式の説明。 - - - - これまでにテキスト内に出現した頻度に基づいて、新しいトークンにペナルティを与えます。 - - - - この Response の一意の識別子。 - - - - レスポンスが不完全である理由の詳細。 - - - - レスポンスが不完全である理由。 - - 指定可能な値: `max_output_tokens`, `content_filter` - - - - 1 つのレスポンスで処理できる、組み込みツールへの合計呼び出しの最大数。 - - - - レスポンスに付加できるキーと値のペアのセット。 - - - - モデレーション済みの completion が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。 - - - - このリソースのオブジェクト型。常に `response` に設定されます。 - - 指定可能な値: `response` - - - - モデルによって生成されたコンテンツ項目の配列。 - -- `output` 配列内の項目の長さと順序は、モデルのレスポンスによって - 異なります。 -- `output` 配列の最初の項目にアクセスし、それがモデルによって - 生成されたコンテンツを含む `assistant` メッセージであると仮定する - のではなく、SDK でサポートされている場合は `output_text` - プロパティの使用を検討してください。 - - - - SDK 専用の便利なプロパティで、`output` 配列内のすべての `output_text` -項目からの集約されたテキスト出力を(存在する場合)含みます。 -Python および JavaScript の SDK でサポートされています。 - - - - モデルがツール呼び出しを並列で実行することを許可するかどうか。 - - - - これまでにテキスト内に出現したかどうかに基づいて、新しいトークンにペナルティを与えます。 - - - - 類似したリクエストのレスポンスをキャッシュしてキャッシュヒット率を最適化するために OpenAI が使用します。`user` フィールドを置き換えます。 - - - - プロンプトキャッシュの保持ポリシー(例: `in_memory` または `24h`)。 - - - - OpenAI の利用ポリシーに違反している可能性のあるアプリケーションのユーザーを検出するために使用される安定した識別子。 - - - - リクエストの処理に使用される処理層(例: `auto`、`default`、`flex`、`scale`、`priority`)。 - - - - レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれか。 - - 指定可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - API 経由で後で取得するためにレスポンスを保存するかどうか。 - - - - 組み込みツールごとに分類されたトークンとリクエストの使用量。 - - - - 画像生成ツールのトークン使用量。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 検索ツールの使用量。 - - - - - - - - 各トークン位置で返す、最も可能性の高いトークンの最大数。それぞれにログ確率が関連付けられます。 - - - - 入力トークン、出力トークン、出力トークンの内訳、および使用された -合計トークンを含むトークン使用量の詳細を表します。 - - - - 入力トークンの数。 - - - - 入力トークンの詳細な内訳。 - - - - キャッシュに書き込まれた入力トークンの数。 - - - - キャッシュから取得されたトークン数です。 -[プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 - - - - 出力トークン数です。 - - - - 出力トークンの詳細な内訳です。 - - - - 推論トークン数です。 - - - - 使用されたトークンの合計数です。 - - - - エンドユーザー用の非推奨の識別子です。`safety_identifier` と `prompt_cache_key` に置き換えられました。 - - -## 例 - -### 入力 - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### 出力 - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/ja/development/comfy-router/models/openai/gpt-4-1/code.mdx b/ja/development/comfy-router/models/openai/gpt-4-1/code.mdx index d6cd533de1..addfdf603e 100644 --- a/ja/development/comfy-router/models/openai/gpt-4-1/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-4-1/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 4.1 を使用する" description: "Comfy Router 経由で openai/gpt-4.1 を呼び出す: エンドポイント、リクエスト形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 4.1" -translationSourceHash: 96680ba8 +translationSourceHash: dd1cf710 translationFrom: development/comfy-router/models/openai/gpt-4-1/code.mdx translationBlockHashes: "_intro": d46021bd "Quick start": c2b30778 - "Schema": a12283e7 + "Schema": db0693d7 "Examples": 67e6c8f1 --- @@ -524,6 +524,18 @@ Python および JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-4o/code.mdx b/ja/development/comfy-router/models/openai/gpt-4o/code.mdx index d3ca517a44..c8b825262e 100644 --- a/ja/development/comfy-router/models/openai/gpt-4o/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-4o/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 4o を使用する" description: "Comfy Router 経由で openai/gpt-4o を呼び出します。エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 4o" -translationSourceHash: a1049a5c +translationSourceHash: 50b6ccc0 translationFrom: development/comfy-router/models/openai/gpt-4o/code.mdx translationBlockHashes: "_intro": 1091e92b "Quick start": 90bca1e0 - "Schema": 86fcee74 + "Schema": 012a1d42 "Examples": 67e6c8f1 --- @@ -375,7 +375,7 @@ Router が `GET /v2/models/openai/gpt-4o/openapi.json` で提供するスキー - レスポンスのエラーコード。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + レスポンスのエラーコード。可能な値: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -397,7 +397,7 @@ Router が `GET /v2/models/openai/gpt-4o/openapi.json` で提供するスキー レスポンスが不完全である理由。 - Possible values: `max_output_tokens`, `content_filter` + 可能な値: `max_output_tokens`, `content_filter` @@ -415,7 +415,7 @@ Router が `GET /v2/models/openai/gpt-4o/openapi.json` で提供するスキー このリソースのオブジェクト型。常に `response` に設定されます。 - Possible values: `response` + 可能な値: `response` @@ -457,7 +457,7 @@ Python SDK と JavaScript SDK でサポートされています。 レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、または `incomplete` のいずれか。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -536,6 +536,18 @@ Python SDK と JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx b/ja/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx index fa2db098d1..eea8a233bd 100644 --- a/ja/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx @@ -2,12 +2,12 @@ title: "GPT 5.5 Pro を Comfy Router で使用する" description: "Comfy Router 経由で openai/gpt-5.5-pro を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 5.5 Pro" -translationSourceHash: 5ac845f9 +translationSourceHash: 7809e0ac translationFrom: development/comfy-router/models/openai/gpt-5-5-pro/code.mdx translationBlockHashes: "_intro": 38a9f8f3 "Quick start": 1fe98270 - "Schema": b1702eff + "Schema": 11ef4bcf "Examples": 67e6c8f1 --- @@ -525,6 +525,18 @@ Python および JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークンの数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-5-5/code.mdx b/ja/development/comfy-router/models/openai/gpt-5-5/code.mdx index 4a903d952e..3408c05db1 100644 --- a/ja/development/comfy-router/models/openai/gpt-5-5/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-5-5/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 5.5 を使う" description: "Comfy Router 経由で openai/gpt-5.5 を呼び出します: エンドポイント、リクエスト形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 5.5" -translationSourceHash: 58c95f4f +translationSourceHash: b6f75b15 translationFrom: development/comfy-router/models/openai/gpt-5-5/code.mdx translationBlockHashes: "_intro": 40d43e07 "Quick start": 1c6f8445 - "Schema": 0324fd46 + "Schema": 7cb284e6 "Examples": 67e6c8f1 --- @@ -239,7 +239,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5/requests/$REQUEST_ID \ - レスポンスで生成できるトークン数の上限。可視出力トークンと[reasoning tokens](https://platform.openai.com/docs/guides/reasoning)が含まれます。 + レスポンスで生成できるトークン数の上限。可視出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)が含まれます。 @@ -522,6 +522,18 @@ Python SDK と JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数です。 [プロンプトキャッシュの詳細はこちら](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx b/ja/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx index d8d0593924..ac1550b513 100644 --- a/ja/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 5.6 Luna を使う" description: "Comfy Router 経由で openai/gpt-5.6-luna を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンスについて。" sidebarTitle: "GPT 5.6 Luna" -translationSourceHash: 3dbd42c0 +translationSourceHash: 60531ced translationFrom: development/comfy-router/models/openai/gpt-5-6-luna/code.mdx translationBlockHashes: "_intro": 13db323c "Quick start": 28d289f6 - "Schema": 9edcb210 + "Schema": 939850da "Examples": 67e6c8f1 --- @@ -239,7 +239,7 @@ Router が `GET /v2/models/openai/gpt-5.6-luna/openapi.json` で提供するス - レスポンスで生成できるトークン数の上限。可視出力トークンと[reasoning tokens](https://platform.openai.com/docs/guides/reasoning)が含まれます。 + レスポンスで生成できるトークン数の上限。可視出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)が含まれます。 @@ -267,13 +267,13 @@ Router が `GET /v2/models/openai/gpt-5.6-luna/openapi.json` で提供するス - モデルに対する前のレスポンスの一意な ID。これを使用してマルチターンの会話を作成します。[conversation state](https://platform.openai.com/docs/guides/conversation-state)について詳しく学びましょう。 + モデルに対する前のレスポンスの一意な ID。これを使用してマルチターンの会話を作成します。[会話状態](https://platform.openai.com/docs/guides/conversation-state)について詳しく学びましょう。 **o シリーズモデル専用** -[reasoning models](https://platform.openai.com/docs/guides/reasoning)の設定オプション。 +[推論モデル](https://platform.openai.com/docs/guides/reasoning)の設定オプション。 @@ -283,7 +283,7 @@ Router が `GET /v2/models/openai/gpt-5.6-luna/openapi.json` で提供するス **o シリーズモデル専用** -[reasoning models](https://platform.openai.com/docs/guides/reasoning)の reasoning にかける effort を制約します。現在サポートされている値は `low`、`medium`、`high` です。reasoning effort を下げると、レスポンスが速くなり、レスポンスで reasoning に使用されるトークンが少なくなる場合があります。 +[推論モデル](https://platform.openai.com/docs/guides/reasoning)の reasoning にかける effort を制約します。現在サポートされている値は `low`、`medium`、`high` です。reasoning effort を下げると、レスポンスが速くなり、レスポンスで reasoning に使用されるトークンが少なくなる場合があります。 指定可能な値: `low`, `medium`, `high` @@ -522,6 +522,18 @@ Python SDK と JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx b/ja/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx index acabb22e9f..dd958865ef 100644 --- a/ja/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 5.6 Sol を使用する" description: "Comfy Router を通じて openai/gpt-5.6-sol を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンス。" sidebarTitle: "GPT 5.6 Sol" -translationSourceHash: 53c40b5a +translationSourceHash: 946fbb02 translationFrom: development/comfy-router/models/openai/gpt-5-6-sol/code.mdx translationBlockHashes: "_intro": fd209e5e "Quick start": ac41609e - "Schema": d3e5bdbd + "Schema": 74ed2ee6 "Examples": 67e6c8f1 --- @@ -359,7 +359,7 @@ Router が `GET /v2/models/openai/gpt-5.6-sol/openapi.json` で提供するス - レスポンスのエラーコード。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + レスポンスのエラーコード。可能な値: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -525,6 +525,18 @@ Python SDK と JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークンの数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx b/ja/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx index 853b3487c9..a6c4d0a254 100644 --- a/ja/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx @@ -2,12 +2,12 @@ title: "GPT 5.6 Terra を Comfy Router で使用する" description: "openai/gpt-5.6-terra を Comfy Router 経由で呼び出します。エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 5.6 Terra" -translationSourceHash: b276b982 +translationSourceHash: 7aa80915 translationFrom: development/comfy-router/models/openai/gpt-5-6-terra/code.mdx translationBlockHashes: "_intro": 3d1bd737 "Quick start": f76d67fd - "Schema": e854248f + "Schema": f66cb808 "Examples": 67e6c8f1 --- @@ -240,7 +240,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ - レスポンスで生成できるトークン数の上限。表示される出力トークンと [reasoning tokens](https://platform.openai.com/docs/guides/reasoning) が含まれます。 + レスポンスで生成できるトークン数の上限。表示される出力トークンと [推論トークン](https://platform.openai.com/docs/guides/reasoning) が含まれます。 @@ -274,7 +274,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ **o シリーズモデルのみ** -[reasoning models](https://platform.openai.com/docs/guides/reasoning) の設定オプション。 +[推論モデル](https://platform.openai.com/docs/guides/reasoning) の設定オプション。 @@ -284,7 +284,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ **o シリーズモデルのみ** -[reasoning models](https://platform.openai.com/docs/guides/reasoning) の reasoning にかける労力を制約します。現在サポートされている値は `low`、`medium`、`high` です。reasoning effort を下げると、レスポンスが速くなり、レスポンス内で reasoning に使用されるトークンが少なくなる場合があります。 +[推論モデル](https://platform.openai.com/docs/guides/reasoning) の reasoning にかける労力を制約します。現在サポートされている値は `low`、`medium`、`high` です。reasoning effort を下げると、レスポンスが速くなり、レスポンス内で reasoning に使用されるトークンが少なくなる場合があります。 取り得る値: `low`, `medium`, `high` @@ -362,7 +362,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ レスポンスのエラーコード。 -Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` +可能な値: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -384,7 +384,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto レスポンスが不完全である理由。 - Possible values: `max_output_tokens`, `content_filter` + 可能な値: `max_output_tokens`, `content_filter` @@ -402,7 +402,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto このリソースのオブジェクト型。常に `response` に設定されます。 - Possible values: `response` + 可能な値: `response` @@ -447,7 +447,7 @@ Python SDK と JavaScript SDK でサポートされています。 レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれか。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -526,6 +526,18 @@ Python SDK と JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-5-mini/code.mdx b/ja/development/comfy-router/models/openai/gpt-5-mini/code.mdx index eb600f900f..f521d3bf3d 100644 --- a/ja/development/comfy-router/models/openai/gpt-5-mini/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-5-mini/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 5 Mini を使用する" description: "Comfy Router 経由で openai/gpt-5-mini を呼び出します。エンドポイント、リクエスト形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 5 Mini" -translationSourceHash: 6f93b322 +translationSourceHash: 1fdb782a translationFrom: development/comfy-router/models/openai/gpt-5-mini/code.mdx translationBlockHashes: "_intro": 3a0b2e17 "Quick start": e4ce6833 - "Schema": 426552ef + "Schema": b1c7b0c6 "Examples": 67e6c8f1 --- @@ -239,7 +239,7 @@ Router が `GET /v2/models/openai/gpt-5-mini/openapi.json` で提供するスキ - レスポンスで生成できるトークン数の上限。表示される出力トークンと[reasoning tokens](https://platform.openai.com/docs/guides/reasoning)が含まれます。 + レスポンスで生成できるトークン数の上限。表示される出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)が含まれます。 @@ -267,13 +267,13 @@ Router が `GET /v2/models/openai/gpt-5-mini/openapi.json` で提供するスキ - モデルへの前のレスポンスの一意の ID。これを使用してマルチターンの会話を作成します。[conversation state](https://platform.openai.com/docs/guides/conversation-state)の詳細を参照してください。 + モデルへの前のレスポンスの一意の ID。これを使用してマルチターンの会話を作成します。[会話状態](https://platform.openai.com/docs/guides/conversation-state)の詳細を参照してください。 **o シリーズモデル専用** -[reasoning models](https://platform.openai.com/docs/guides/reasoning)の設定オプション。 +[推論モデル](https://platform.openai.com/docs/guides/reasoning)の設定オプション。 @@ -283,7 +283,7 @@ Router が `GET /v2/models/openai/gpt-5-mini/openapi.json` で提供するスキ **o シリーズモデル専用** -[reasoning models](https://platform.openai.com/docs/guides/reasoning)の推論にかける労力を制約します。現在サポートされている値は `low`、`medium`、`high` です。推論の労力を下げると、レスポンスが高速になり、レスポンスの推論に使用されるトークン数が減る場合があります。 +[推論モデル](https://platform.openai.com/docs/guides/reasoning)の推論にかける労力を制約します。現在サポートされている値は `low`、`medium`、`high` です。推論の労力を下げると、レスポンスが高速になり、レスポンスの推論に使用されるトークン数が減る場合があります。 指定可能な値: `low`、`medium`、`high` @@ -313,7 +313,7 @@ Router が `GET /v2/models/openai/gpt-5-mini/openapi.json` で提供するスキ モデルが出力しなければならない形式を指定するオブジェクト。 -`{ "type": "json_schema" }` を設定すると Structured Outputs が有効になり、モデルが指定された JSON スキーマに一致することが保証されます。詳細は[Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs)を参照してください。 +`{ "type": "json_schema" }` を設定すると Structured Outputs が有効になり、モデルが指定された JSON スキーマに一致することが保証されます。詳細は[Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs)を参照してください。 デフォルトの形式は `{ "type": "text" }` で、追加のオプションはありません。 @@ -359,7 +359,7 @@ Router が `GET /v2/models/openai/gpt-5-mini/openapi.json` で提供するスキ - レスポンスのエラーコード。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + レスポンスのエラーコード。可能な値: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -381,7 +381,7 @@ Router が `GET /v2/models/openai/gpt-5-mini/openapi.json` で提供するスキ レスポンスが不完全である理由。 - Possible values: `max_output_tokens`, `content_filter` + 可能な値: `max_output_tokens`, `content_filter` @@ -399,7 +399,7 @@ Router が `GET /v2/models/openai/gpt-5-mini/openapi.json` で提供するスキ このリソースのオブジェクトタイプ。常に `response` に設定されます。 - Possible values: `response` + 可能な値: `response` @@ -441,7 +441,7 @@ PythonおよびJavaScript SDKでサポートされています。 レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれかです。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -520,6 +520,18 @@ PythonおよびJavaScript SDKでサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-5-nano/code.mdx b/ja/development/comfy-router/models/openai/gpt-5-nano/code.mdx index 695542832b..1c6d119b44 100644 --- a/ja/development/comfy-router/models/openai/gpt-5-nano/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-5-nano/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 5 Nano を使用する" description: "Comfy Router 経由で openai/gpt-5-nano を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 5 Nano" -translationSourceHash: dea6c7dc +translationSourceHash: 608ede54 translationFrom: development/comfy-router/models/openai/gpt-5-nano/code.mdx translationBlockHashes: "_intro": e9be10ab "Quick start": 2ff521ab - "Schema": 3e04e36e + "Schema": d555e85f "Examples": 67e6c8f1 --- @@ -526,6 +526,18 @@ Python および JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-5/code.mdx b/ja/development/comfy-router/models/openai/gpt-5/code.mdx index 6e69086d72..23f3de4c26 100644 --- a/ja/development/comfy-router/models/openai/gpt-5/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-5/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で GPT 5 を使う" description: "Comfy Router 経由で openai/gpt-5 を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 5" -translationSourceHash: b66e1420 +translationSourceHash: fc79531a translationFrom: development/comfy-router/models/openai/gpt-5/code.mdx translationBlockHashes: "_intro": 1f35e583 "Quick start": b8543ef7 - "Schema": 37e7ebd8 + "Schema": bfb88182 "Examples": 67e6c8f1 --- @@ -239,7 +239,7 @@ Router が `GET /v2/models/openai/gpt-5/openapi.json` で提供するスキー - レスポンスで生成できるトークン数の上限。表示される出力トークンと[reasoning tokens](https://platform.openai.com/docs/guides/reasoning)が含まれます。 + レスポンスで生成できるトークン数の上限。表示される出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)が含まれます。 @@ -267,7 +267,7 @@ Router が `GET /v2/models/openai/gpt-5/openapi.json` で提供するスキー - モデルに対する前のレスポンスの一意の ID。マルチターンの会話を作成するために使用します。詳しくは[conversation state](https://platform.openai.com/docs/guides/conversation-state)をご覧ください。 + モデルに対する前のレスポンスの一意の ID。マルチターンの会話を作成するために使用します。詳しくは[会話状態](https://platform.openai.com/docs/guides/conversation-state)をご覧ください。 @@ -359,7 +359,7 @@ Router が `GET /v2/models/openai/gpt-5/openapi.json` で提供するスキー - レスポンスのエラーコード。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + レスポンスのエラーコード。可能な値: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -381,7 +381,7 @@ Router が `GET /v2/models/openai/gpt-5/openapi.json` で提供するスキー レスポンスが不完全である理由。 - Possible values: `max_output_tokens`, `content_filter` + 可能な値: `max_output_tokens`, `content_filter` @@ -399,7 +399,7 @@ Router が `GET /v2/models/openai/gpt-5/openapi.json` で提供するスキー このリソースのオブジェクトタイプ。常に `response` に設定されます。 - Possible values: `response` + 可能な値: `response` @@ -442,7 +442,7 @@ Router が `GET /v2/models/openai/gpt-5/openapi.json` で提供するスキー レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれかです。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -521,6 +521,18 @@ Router が `GET /v2/models/openai/gpt-5/openapi.json` で提供するスキー キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークンの数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx b/ja/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx new file mode 100644 index 0000000000..59f9635bdd --- /dev/null +++ b/ja/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx @@ -0,0 +1,612 @@ +--- +title: "GPT 6.1 Sol を Comfy Router で使用する" +description: "Comfy Router 経由で openai/gpt-6.1-sol を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" +sidebarTitle: "GPT 6.1 Sol" +translationSourceHash: d4b3ce5f +translationFrom: development/comfy-router/models/openai/gpt-6-1-sol/code.mdx +translationBlockHashes: + "_intro": 72f9c8de + "Quick start": a04e3ac0 + "Schema": 0e5083e2 + "Examples": 67e6c8f1 +--- + +{/* 生成済みファイル。`pnpm code-pages:gen` により router-schemas/openai/gpt-6.1-sol.json から生成済み。 */} + +import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; + +OpenAI が提供し、Comfy Router が配信する `openai/gpt-6.1-sol` の API リファレンスです。 + +**入力:** テキスト、画像 · **出力:** テキスト + +## クイックスタート + +[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で行うものです。 + +**モデル ID:** `openai/gpt-6.1-sol` + +**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol` + + + + +```python Python +from comfy_sdk import Comfy + +# 環境変数から COMFY_API_KEY を読み取ります。 +# SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。 +with Comfy() as client: + result = client.models.run( + "openai/gpt-6.1-sol", + { + "input": "Reply with the single word: ok", + "max_output_tokens": 1024, + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境変数から COMFY_API_KEY を読み取ります。 +// SDK は自動的に冪等性キーを作成し、自動リトライのために再利用します。 +const { data } = await comfy.models.run("openai/gpt-6.1-sol", { + input: "Reply with the single word: ok", + max_output_tokens: 1024, +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" +``` + + + +同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests` に送信します。Router は実行が受け付けられるとすぐに `201` と `request_id` を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも取得できます。[キュー配信](/ja/development/comfy-router/queue)では、ステータス、キャンセル、取得の流れを説明します。 + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 環境変数から COMFY_API_KEY を読み取ります。 +# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "openai/gpt-6.1-sol", + { + "input": "Reply with the single word: ok", + "max_output_tokens": 1024, + }, + ) + print("request_id:", handle.request_id) # モデル ID と合わせて、別のプロセスに必要なものはこれだけです + + # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の間待機します。 + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # プロバイダー自身のペイロードで、models.run() が返す値と同じです。 + # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを送出します。 + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境変数から COMFY_API_KEY を読み取ります。 +// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 +const handle = await comfy.models.submit("openai/gpt-6.1-sol", { + input: "Reply with the single word: ok", + max_output_tokens: 1024, +}); +console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスに必要なものはこれだけです + +// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の間待機します。 +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。 +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。 +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" + +# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。 +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 取得。実行中は 202 とステータスボディ、完了時は 200 とモデルのネイティブ出力を返します。 +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## スキーマ + +### 入力 + + + モデル応答に含める追加の出力データ。 + + + + モデルへのテキスト、画像、ファイル入力で、応答の生成に使用されます。このコントラクトのうち Router が補えない唯一のフィールドであり、下記の `required` に含まれる唯一の項目でもあります。 + + + + システム(または開発者)メッセージを、モデルのコンテキストの最初の項目として挿入します。 + + + + 応答のために生成されるトークン数の上限。可視出力トークンと reasoning トークンを含みます。reasoning 系の id では、この上限は隠れた reasoning トークンと共有されるため、小さな値を指定すると可視テキストが現れる前にバジェット全体を消費してしまいます。そのため reasoning のスモークケースでは 1024 を、チャットのケースでは 16 を送信しています。 + + 範囲: `1` から `…` + + + + OpenAI のモデル識別子。Comfy Router ではこのフィールドは任意で、Router が `{model}` パスセグメントから補います。明示的な `null` も同じように置き換えられます。パスと一致しない値を送信すると拒否されます。 + + + + モデルがツール呼び出しを並列に実行することを許可するかどうか。 + + + + 前の応答の ID で、マルチターンの会話に使用します。 + + + + reasoning ティア専用。reasoning モデルの設定で、たとえば `{"effort": "medium"}` です。そのまま転送されます。受け付けられるキーについては OpenAI の reasoning ガイドを参照してください。チャットティアの id では無視されます。 + + + + OpenAI が生成済みの応答を後で取得できるよう保存するかどうか。 + + + + 送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを `false` に確定します。Router は `text/event-stream` を中継するのではなくプロバイダーの応答を取得するためです。`text/event-stream` をデコードできないため、ストリーミング生成は OpenAI に課金されつつ、どこにもメータリングされないことになります。Comfy のどのサーフェスもストリームを提供しません。v1 の `POST /proxy/openai/v1/responses` イングレスは `stream: true` を 400 で拒否し、リクエストを上流へ転送することは一切ありません。したがって、どちらのサーフェスでもこのフィールドを省略するか `false` を送信し、完了した応答を 1 つの JSON ボディとして読み取ってください。 + + + + サンプリングの temperature。チャットティア専用です。o シリーズの reasoning id(`o1`、`o1-pro`、`o3`、`o4-mini`)は、OpenAI 側でこのパラメータを拒否します。Router はそれらに対して拒否しません(2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送信する reasoning 呼び出しには OpenAI 自身のエラーが返されます。 + + 範囲: `0` から `2` + + + + 出力フォーマットの設定で、たとえば Structured Outputs 用の `{"format": {"type": "json_schema", ...}}` です。そのまま転送されます。 + + + + モデルが使用するツールをどのように選択すべきか。文字列のモード、またはツールを指定するオブジェクトのいずれかです。 + + + + モデルが呼び出せるツール定義。Router はツールの分類を狭めません。受け付けられる形については OpenAI の Responses API リファレンスを参照してください。 + + + + ニュークラスサンプリングのカットオフ。チャットティア専用で、`temperature` と同じ条件です。 + + 範囲: `0` から `1` + + + + コンテキストがモデルのウィンドウを超えた場合の切り詰め戦略。上記の 3 つの語彙とは異なり、ここでは enum が実際に適用されます。これらの 2 つの値が OpenAI のドキュメントに記載された完全な集合であり、それ以上増えていないためです。明示的な `null` は、上記のフィールドと同じ条件で引き続き受け付けられます。 + + 可能な値: `auto`, `disabled` + + + + トークン使用量のエンベロープ。v1 オペレーションがリクエストボディでこれを宣言しているため、このコントラクトに含まれています。OpenAI はこれをレスポンスで設定するため、呼び出し元が送信する理由はありません。 + + +`GET /v2/models/openai/gpt-6.1-sol/openapi.json` で Router が提供するスキーマから生成されており、リクエストがプロバイダーに届く前に呼び出しを検証するのと同じドキュメントです。 + +### 出力 + + + システム(または開発者)メッセージをモデルのコンテキストの最初の項目として挿入します。 + +`previous_response_id` と併用する場合、前の応答の instructions は次の応答に引き継がれません。これにより、新しい応答でシステム(または開発者)メッセージを簡単に差し替えられます。 + + + + 応答で生成できるトークン数の上限。表示される出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)を含みます。 + + + + 応答の生成に使用されるモデル + + + + 応答のランダム性を制御します + + 範囲: `0` から `2` + + + + nucleus サンプリングによる応答の多様性を制御します + + 範囲: `0` から `1` + + + + モデル応答に使用するトランケーション戦略。 +- `auto`: この応答および以前の応答のコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中にある入力項目を削除してコンテキストウィンドウに収まるように応答をトランケーションします。 +- `disabled`(デフォルト): モデル応答がモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 + + 可能な値: `auto`、`disabled` + + + + モデルへの前の応答の一意の ID。これを使用してマルチターンの会話を作成します。詳細は[会話状態](https://platform.openai.com/docs/guides/conversation-state)をご覧ください。 + + + + **o シリーズモデル専用** + +[推論モデル](https://platform.openai.com/docs/guides/reasoning)の設定オプション。 + + + + 以降のターンでどの推論項目をモデルに返すかを制御します(例: `auto`、`current_turn`、`all_turns`)。 + + + + **o シリーズモデル専用** + +[推論モデル](https://platform.openai.com/docs/guides/reasoning)の推論にかかる労力を制約します。現在サポートされている値は `low`、`medium`、`high` です。推論の労力を減らすと、応答が速くなり、応答で推論に使用されるトークン数が少なくなる場合があります。 + + 可能な値: `low`、`medium`、`high` + + + + **非推奨:** 代わりに `summary` を使用してください。 + +モデルによって実行された推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。`auto`、`concise`、`detailed` のいずれかです。 + + 可能な値: `auto`、`concise`、`detailed` + + + + 応答に使用される推論モード。 + + + + モデルによって実行された推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。`auto`、`concise`、`detailed` のいずれかです。 + + 可能な値: `auto`、`concise`、`detailed` + + + + + + + + モデルが出力する必要がある形式を指定するオブジェクト。 + +`{ "type": "json_schema" }` を設定すると Structured Outputs が有効になり、モデルが指定した JSON スキーマに一致するようになります。詳細は [Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs)をご覧ください。 + +デフォルトの形式は `{ "type": "text" }` で、追加のオプションはありません。 + +**gpt-4o 以降のモデルには推奨されません:** + +`{ "type": "json_object" }` に設定すると、古い JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。サポートしているモデルでは `json_schema` の使用が推奨されます。 + + + + モデル応答の冗長性を制約します。`low`、`medium`、`high` のいずれかです。 + + + + 応答を生成するときにモデルが使用するツールをどのように選択するか。モデルが呼び出せるツールを指定する方法については、`tools` パラメータを参照してください。 + + + + + + + + モデル応答がバックグラウンドで実行されるかどうか。 + + + + 応答の請求情報。 + + + + 応答の支払い責任者。 + + + + この Response が完了したときの Unix タイムスタンプ(秒)。status が `completed` の場合にのみ存在します。 + + + + この Response が作成されたときの Unix タイムスタンプ(秒)。 + + + + モデルが Response の生成に失敗したときに返されるエラーオブジェクト。 + + + + 応答のエラーコード。可能な値: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + + + + エラーの人間が読める形式の説明。 + + + + これまでにテキスト中に出現した頻度に基づいて、新しいトークンにペナルティを与えます。 + + + + このレスポンスの一意な識別子。 + + + + レスポンスが不完全である理由の詳細。 + + + + レスポンスが不完全である理由。 + + 可能な値: `max_output_tokens`, `content_filter` + + + + 1つのレスポンスで処理できる、組み込みツールへの総呼び出し回数の上限。 + + + + レスポンスに添付できるキーと値のペアのセット。 + + + + モデレーション済みの補完が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。 + + + + このリソースのオブジェクト型。常に `response` に設定されます。 + + 可能な値: `response` + + + + モデルによって生成されたコンテンツ項目の配列。 + +- `output` 配列内の項目の長さと順序は、モデルのレスポンスによって異なります。 +- `output` 配列の最初の項目にアクセスして、それがモデルによって生成された + コンテンツを含む `assistant` メッセージであると仮定するのではなく、 + SDK でサポートされている場合は `output_text` プロパティの使用を検討してください。 + + + + SDK 専用の便利なプロパティで、`output` 配列内のすべての `output_text` 項目に含まれる +集約されたテキスト出力を保持します(存在する場合)。 +Python と JavaScript の SDK でサポートされています。 + + + + モデルがツール呼び出しを並列で実行することを許可するかどうか。 + + + + これまでにテキスト中に出現したかどうかに基づいて、新しいトークンにペナルティを与えます。 + + + + 類似したリクエストのレスポンスをキャッシュし、キャッシュヒット率を最適化するために OpenAI が使用します。`user` フィールドを置き換えます。 + + + + プロンプトキャッシュの保持ポリシー。例: `in_memory` または `24h`。 + + + + OpenAI の利用ポリシーに違反している可能性があるアプリケーションのユーザーを検出するために使用される、安定した識別子。 + + + + リクエストの処理に使用される処理階層。例: `auto`、`default`、`flex`、`scale`、`priority`。 + + + + レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれか。 + + 可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + + + + API 経由で後から取得できるようにレスポンスを保存するかどうか。 + + + + 組み込みツールごとに分類されたトークンとリクエストの使用量。 + + + + 画像生成ツールのトークン使用量。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Web 検索ツールの使用量。 + + + + + + + + 各トークン位置で返される、最も確率の高いトークンの最大数。それぞれに対数確率が付きます。 + + + + 入力トークン、出力トークン、出力トークンの内訳、および使用された合計トークンを含むトークン使用量の詳細を表します。 + + + + 入力トークン数。 + + + + 入力トークンの詳細な内訳。 + + + + キャッシュに書き込まれた入力トークン数。 + + + + キャッシュ書き込みをキャッシュの有効期間ごとに分割したものです。2つのカウントの合計は `cache_write_tokens` になります。 + + + + 12時間の有効期間でキャッシュに書き込まれた入力トークンの数。 + + + + 30分の有効期間でキャッシュに書き込まれた入力トークンの数。 + + + + キャッシュから取得されたトークンの数。 +[プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 + + + + 出力トークンの数。 + + + + 出力トークンの詳細な内訳。 + + + + 推論トークンの数。 + + + + 使用されたトークンの総数。 + + + + エンドユーザーの非推奨の識別子。`safety_identifier` と `prompt_cache_key` に置き換えられました。 + + +## 例 + +### 入力 + +```json +{ + "input": "Reply with the single word: ok", + "max_output_tokens": 1024 +} +``` + +### 出力 + +```json +{ + "completed_at": 1767225601, + "created_at": 1767225600, + "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", + "object": "response", + "output": [ + { + "content": [ + { + "annotations": [], + "text": "ok", + "type": "output_text" + } + ], + "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", + "role": "assistant", + "status": "completed", + "type": "message" + } + ], + "output_text": "ok", + "status": "completed", + "usage": { + "input_tokens": 14, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 2, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 16 + } +} +``` + + + diff --git a/ja/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx b/ja/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx new file mode 100644 index 0000000000..04bff11006 --- /dev/null +++ b/ja/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx @@ -0,0 +1,611 @@ +--- +title: "GPT 6.1 Terra を Comfy Router で使用する" +description: "Comfy Router 経由で openai/gpt-6.1-terra を呼び出します。エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" +sidebarTitle: "GPT 6.1 Terra" +translationSourceHash: 27d99514 +translationFrom: development/comfy-router/models/openai/gpt-6-1-terra/code.mdx +translationBlockHashes: + "_intro": c31ab629 + "Quick start": 72fe9e32 + "Schema": aa04e432 + "Examples": 67e6c8f1 +--- + +{/* 生成済みファイル。`pnpm code-pages:gen` により router-schemas/openai/gpt-6.1-terra.json から生成されました。 */} + +import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; + +OpenAI の `openai/gpt-6.1-terra` の API リファレンス。このモデルは Comfy Router によって提供されます。 + +**入力:** テキスト、画像 · **出力:** テキスト + +## クイックスタート + +[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL のスニペットは、生の HTTP による同じ呼び出しです。 + +**モデル ID:** `openai/gpt-6.1-terra` + +**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra` + + + + +```python Python +from comfy_sdk import Comfy + +# 環境変数から COMFY_API_KEY を読み取ります。 +# SDK は自動的に冪等性キーを作成し、自動リトライの間で再利用します。 +with Comfy() as client: + result = client.models.run( + "openai/gpt-6.1-terra", + { + "input": "Reply with the single word: ok", + "max_output_tokens": 1024, + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境変数から COMFY_API_KEY を読み取ります。 +// SDK は自動的に冪等性キーを作成し、自動リトライの間で再利用します。 +const { data } = await comfy.models.run("openai/gpt-6.1-terra", { + input: "Reply with the single word: ok", + max_output_tokens: 1024, +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" +``` + + + +同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests` に送信します。Router は実行が受け付けられるとすぐに `request_id` を含む `201` を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも取得できます。[キューによる配信](/ja/development/comfy-router/queue)では、ステータス、キャンセル、取得について説明しています。 + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 環境変数から COMFY_API_KEY を読み取ります。 +# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライの間で再利用します。 +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "openai/gpt-6.1-terra", + { + "input": "Reply with the single word: ok", + "max_output_tokens": 1024, + }, + ) + print("request_id:", handle.request_id) # モデル ID と合わせて、別のプロセスに必要な情報はこれだけです + + # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。 + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # プロバイダー自身のペイロードで、models.run() が返す値と同じものです。 + # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。 + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境変数から COMFY_API_KEY を読み取ります。 +// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライの間で再利用します。 +const handle = await comfy.models.submit("openai/gpt-6.1-terra", { + input: "Reply with the single word: ok", + max_output_tokens: 1024, +}); +console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスに必要な情報はこれだけです + +// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。 +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。 +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 送信します。Router は request_id、status_url、response_url、cancel_url を含む 201 を返します。 +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" + +# 2. status が COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After の秒数だけ待機します。 +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 取得します。まだ実行中の場合はステータスボディとともに 202、完了時はモデルのネイティブな出力とともに 200 を返します。 +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## スキーマ + +### 入力 + + + モデルのレスポンスに含める追加の出力データ。 + + + + モデルへのテキスト、画像、またはファイルの入力。レスポンスの生成に使用されます。このコントラクトのうち Router が供給できない唯一のフィールドであり、以下の `required` に含まれる唯一の項目でもあります。 + + + + モデルのコンテキストの先頭項目として、システム(または開発者)メッセージを挿入します。 + + + + レスポンスのために生成されるトークン数の上限。表示される出力トークンと推論トークンを含みます。reasoning の id では、この上限は隠れた推論トークンと共有されるため、小さな値を指定すると表示テキストが何も出力される前にバジェット全体を消費してしまう可能性があります。そのため、reasoning のスモークテストでは 1024 を送信し、chat のテストでは 16 を送信しています。 + + 範囲: `1` から `…` + + + + OpenAI のモデル識別子。Comfy Router ではこのフィールドは任意(OPTIONAL)であり、Router が `{model}` パスセグメントから設定します。明示的な `null` も同じ方法で置き換えられます。パスと矛盾する値を送信すると拒否されます。 + + + + モデルがツール呼び出しを並列で実行することを許可するかどうか。 + + + + マルチターンの会話のための、前回のレスポンスの ID。 + + + + reasoning ティア専用。推論モデルの設定です(例: `{"effort": "medium"}`)。変更されずに転送されます。受け入れられるキーについては OpenAI の reasoning ガイドを参照してください。chat ティアの id はこれを無視します。 + + + + OpenAI が生成されたレスポンスを後で取得できるように保存するかどうか。 + + + + 送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効(INERT)です。Router はディスパッチ前にこれを `false` に確定(SETTLE)します。これは、`text/event-stream` を中継するのではなくプロバイダーのレスポンスをキャプチャするためであり、その形式はデコードできないため、ストリーミングされた生成は OpenAI から課金されても誰もメーター計測しないことになります。Comfy のどのサーフェスもストリームを提供しません。v1 の `POST /proxy/openai/v1/responses` イングレスは `stream: true` を 400 で拒否し、リクエストを上流へ転送しません。そのため、いずれのサーフェスでもこのフィールドを省略するか `false` を送信し、完了したレスポンスを 1 つの JSON ボディとして読み取ってください。 + + + + サンプリング温度。chat ティア専用です。o シリーズの reasoning id(`o1`、`o1-pro`、`o3`、`o4-mini`)は OpenAI 側でこのパラメーターを拒否します。Router はそれらのためにこのパラメーターを拒否しません(2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送信する reasoning 呼び出しは OpenAI 自身のエラーとして返答されます。 + + 範囲: `0` から `2` + + + + 出力フォーマットの設定です(例: Structured Outputs のための `{"format": {"type": "json_schema", ...}}`)。変更されずに転送されます。 + + + + モデルが使用するツールをどのように選択するか。文字列のモード、またはツールを指名するオブジェクトのいずれかです。 + + + + モデルが呼び出せるツール定義。Router はツールの分類を狭めません。受け入れられる形については OpenAI の Responses API リファレンスを参照してください。 + + + + Nucleus サンプリングのカットオフ。chat ティア専用で、`temperature` と同じ条件です。 + + 範囲: `0` から `1` + + + + コンテキストがモデルのウィンドウを超えた場合の切り詰め戦略。上記の 3 つの語彙とは異なり、ここでは enum が実際に適用されます。これは、これらの 2 つの値が OpenAI のドキュメントに記載された完全なセットであり、それ以上増えていないためです。明示的な `null` も、上記のフィールドと同じ条件で引き続き受け入れられます。 + + 可能な値: `auto`、`disabled` + + + + トークン使用量のエンベロープ。v1 のオペレーションがリクエストボディでこれを宣言しているため、このコントラクトに存在します。OpenAI はこれをレスポンスで設定するため、呼び出し元が送信する理由はありません。 + + +Router が `GET /v2/models/openai/gpt-6.1-terra/openapi.json` で提供するスキーマから生成されています。これは、リクエストがプロバイダーに届く前に呼び出しを検証する際に使用するのと同じドキュメントです。 + +### 出力 + + + システム(または開発者)メッセージを、モデルのコンテキストの最初の項目として挿入します。 + +`previous_response_id` と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または開発者)メッセージを簡単に差し替えられます。 + + + + レスポンスで生成できるトークン数の上限。可視出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)を含みます。 + + + + レスポンスの生成に使用されたモデル + + + + レスポンスのランダム性を制御します + + 範囲: `0` から `2` + + + + nucleus サンプリングによるレスポンスの多様性を制御します + + 範囲: `0` から `1` + + + + モデルレスポンスに使用する切り詰め戦略。 +- `auto`: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中にある入力項目を削除して、コンテキストウィンドウに収まるようにレスポンスを切り詰めます。 +- `disabled` (デフォルト): モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 + + 指定可能な値: `auto`, `disabled` + + + + モデルへの前のレスポンスの一意の ID。複数ターンの会話を作成するために使用します。[会話状態](https://platform.openai.com/docs/guides/conversation-state)の詳細をご覧ください。 + + + + **o シリーズモデルのみ** + +[推論モデル](https://platform.openai.com/docs/guides/reasoning)の設定オプション。 + + + + 後のターンでどの推論項目をモデルに返すかを制御します。例: `auto`、`current_turn`、`all_turns`。 + + + + **o シリーズモデルのみ** + +[推論モデル](https://platform.openai.com/docs/guides/reasoning)の推論にかける労力を制約します。現在サポートされている値は `low`、`medium`、`high` です。推論の労力を減らすと、レスポンスが速くなり、レスポンス内の推論に使用されるトークン数も少なくなる場合があります。 + + 指定可能な値: `low`, `medium`, `high` + + + + **非推奨:** 代わりに `summary` を使用してください。 + +モデルが実行した推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。`auto`、`concise`、`detailed` のいずれかです。 + + 指定可能な値: `auto`, `concise`, `detailed` + + + + レスポンスに使用される推論モード。 + + + + モデルが実行した推論の要約。デバッグやモデルの推論プロセスの理解に役立ちます。`auto`、`concise`、`detailed` のいずれかです。 + + 指定可能な値: `auto`, `concise`, `detailed` + + + + + + + + モデルが出力しなければならない形式を指定するオブジェクト。 + +`{ "type": "json_schema" }` を設定すると Structured Outputs が有効になり、モデルが指定した JSON スキーマに一致することが保証されます。詳細は [Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs)をご覧ください。 + +デフォルトの形式は `{ "type": "text" }` で、追加のオプションはありません。 + +**gpt-4o 以降のモデルには推奨されません:** + +`{ "type": "json_object" }` に設定すると古い JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。サポートしているモデルでは `json_schema` の使用が推奨されます。 + + + + モデルレスポンスの冗長性を制約します。`low`、`medium`、`high` のいずれかです。 + + + + レスポンス生成時にモデルがどのツール(または複数のツール)を選択するか。モデルが呼び出せるツールの指定方法については `tools` パラメータを参照してください。 + + + + + + + + モデルレスポンスをバックグラウンドで実行するかどうか。 + + + + レスポンスの課金情報。 + + + + レスポンスの支払いを担当する当事者。 + + + + このレスポンスが完了したときの Unix タイムスタンプ(秒単位)。ステータスが `completed` の場合にのみ存在します。 + + + + このレスポンスが作成されたときの Unix タイムスタンプ(秒単位)。 + + + + モデルがレスポンスの生成に失敗したときに返されるエラーオブジェクト。 + + + + レスポンスのエラーコード。可能な値: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + + + + エラーの人間が読める形式の説明。 + + + + これまでのテキスト内での出現頻度に基づいて、新しいトークンにペナルティを課します。 + + + + この Response の一意な識別子。 + + + + レスポンスが不完全である理由の詳細。 + + + + レスポンスが不完全である理由。 + + 可能な値: `max_output_tokens`, `content_filter` + + + + 1 つのレスポンスで処理できる、組み込みツールへの総呼び出し回数の上限。 + + + + レスポンスに付加できるキーと値のペアの集合。 + + + + モデレーション付きの補完が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。 + + + + このリソースのオブジェクト型。常に `response` に設定されます。 + + 可能な値: `response` + + + + モデルによって生成されたコンテンツ項目の配列。 + +- `output` 配列内の項目の長さと順序は、モデルのレスポンスによって異なります。 +- `output` 配列の最初の項目にアクセスし、それがモデルによって生成された + コンテンツを含む `assistant` メッセージであると想定する代わりに、 + SDK でサポートされている場合は `output_text` プロパティの使用を + 検討してください。 + + + + SDK 専用の便利なプロパティで、`output` 配列内のすべての `output_text` 項目に含まれるテキスト出力を集約したものです(存在する場合)。 +Python SDK と JavaScript SDK でサポートされています。 + + + + モデルがツール呼び出しを並列で実行することを許可するかどうか。 + + + + これまでのテキスト内に出現するかどうかに基づいて、新しいトークンにペナルティを課します。 + + + + 類似したリクエストのレスポンスをキャッシュし、キャッシュヒット率を最適化するために OpenAI が使用します。`user` フィールドを置き換えます。 + + + + プロンプトキャッシュの保持ポリシー(例: `in_memory`、`24h`)。 + + + + OpenAI の利用ポリシーに違反している可能性のあるアプリケーションユーザーの検出に役立てるために使用される安定した識別子。 + + + + リクエストの処理に使用される処理階層(例: `auto`、`default`、`flex`、`scale`、`priority`)。 + + + + レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれかです。 + + 可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + + + + レスポンスを後で API 経由で取得できるように保存するかどうか。 + + + + 組み込みツールごとに分類されたトークンとリクエストの使用量。 + + + + 画像生成ツールのトークン使用量。 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Web 検索ツールの使用量。 + + + + + + + + 各トークン位置で返す、最も確率の高いトークンの最大数。それぞれに対数確率が付属します。 + + + + 入力トークン、出力トークン、出力トークンの内訳、および使用された合計トークンを含むトークン使用量の詳細を表します。 + + + + 入力トークン数。 + + + + 入力トークンの詳細な内訳。 + + + + キャッシュに書き込まれた入力トークン数。 + + + + キャッシュ書き込みをキャッシュの有効期間別に分割したものです。2つのカウントの合計が `cache_write_tokens` になります。 + + + + 12時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30分の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + キャッシュから取得されたトークン数。 +[プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 + + + + 出力トークン数。 + + + + 出力トークンの詳細な内訳。 + + + + 推論トークン数。 + + + + 使用されたトークンの総数。 + + + + エンドユーザーの非推奨の識別子。`safety_identifier` と `prompt_cache_key` に置き換え済みです。 + + +## 例 + +### 入力 + +```json +{ + "input": "Reply with the single word: ok", + "max_output_tokens": 1024 +} +``` + +### 出力 + +```json +{ + "completed_at": 1767225601, + "created_at": 1767225600, + "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", + "object": "response", + "output": [ + { + "content": [ + { + "annotations": [], + "text": "ok", + "type": "output_text" + } + ], + "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", + "role": "assistant", + "status": "completed", + "type": "message" + } + ], + "output_text": "ok", + "status": "completed", + "usage": { + "input_tokens": 14, + "input_tokens_details": { + "cached_tokens": 0 + }, + "output_tokens": 2, + "output_tokens_details": { + "reasoning_tokens": 0 + }, + "total_tokens": 16 + } +} +``` + + diff --git a/ja/development/comfy-router/models/openai/gpt-6-astra/code.mdx b/ja/development/comfy-router/models/openai/gpt-6-astra/code.mdx index 5a5b6f3140..d912778353 100644 --- a/ja/development/comfy-router/models/openai/gpt-6-astra/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-6-astra/code.mdx @@ -2,18 +2,15 @@ title: "Comfy Router で GPT 6 Astra を使用する" description: "Comfy Router 経由で openai/gpt-6-astra を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 6 Astra" -translationSourceHash: b6fe51cd +translationSourceHash: dc53fcc4 translationFrom: development/comfy-router/models/openai/gpt-6-astra/code.mdx translationBlockHashes: "_intro": f5ed3b66 "Quick start": 2154b82d - "Schema": 5304e7bd + "Schema": cdd4d7a5 "Examples": 67e6c8f1 --- - - - {/* GENERATED FILE. Generated from router-schemas/openai/gpt-6-astra.json by `pnpm code-pages:gen`. */} import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; @@ -526,6 +523,18 @@ Python および JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-6-luna/code.mdx b/ja/development/comfy-router/models/openai/gpt-6-luna/code.mdx index d538694d11..4346f33c77 100644 --- a/ja/development/comfy-router/models/openai/gpt-6-luna/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-6-luna/code.mdx @@ -1,13 +1,13 @@ --- title: "Comfy Router で GPT 6 Luna を使う" -description: "Comfy Router 経由で openai/gpt-6-luna を呼び出す: endpoint、request の形状、Router が返す response。" +description: "Comfy Router 経由で openai/gpt-6-luna を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンス。" sidebarTitle: "GPT 6 Luna" -translationSourceHash: 016a3493 +translationSourceHash: e436b4b8 translationFrom: development/comfy-router/models/openai/gpt-6-luna/code.mdx translationBlockHashes: "_intro": ae1e4a72 "Quick start": 7c4cfbcd - "Schema": 1198c1c7 + "Schema": af3ef2c5 "Examples": 67e6c8f1 --- @@ -517,6 +517,18 @@ Router が `GET /v2/models/openai/gpt-6-luna/openapi.json` で提供するスキ キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークンの数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-6-sol/code.mdx b/ja/development/comfy-router/models/openai/gpt-6-sol/code.mdx index 823cbc671e..b1234f4d9d 100644 --- a/ja/development/comfy-router/models/openai/gpt-6-sol/code.mdx +++ b/ja/development/comfy-router/models/openai/gpt-6-sol/code.mdx @@ -2,12 +2,12 @@ title: "GPT 6 Sol を Comfy Router で使用する" description: "Comfy Router 経由で openai/gpt-6-sol を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "GPT 6 Sol" -translationSourceHash: 7b6ad6e8 +translationSourceHash: fd9a0f66 translationFrom: development/comfy-router/models/openai/gpt-6-sol/code.mdx translationBlockHashes: "_intro": eeaf1fd1 "Quick start": 231cae97 - "Schema": 808c67cd + "Schema": 302da76c "Examples": 67e6c8f1 --- @@ -523,6 +523,18 @@ Python SDK と JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークンの数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/gpt-image-1/code.mdx b/ja/development/comfy-router/models/openai/gpt-image-1/code.mdx deleted file mode 100644 index 769d768207..0000000000 --- a/ja/development/comfy-router/models/openai/gpt-image-1/code.mdx +++ /dev/null @@ -1,361 +0,0 @@ ---- -title: "Comfy Router で GPT Image 1 を使用する" -description: "Comfy Router 経由で openai/gpt-image-1 を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" -sidebarTitle: "GPT Image 1" -translationSourceHash: 02331b72 -translationFrom: development/comfy-router/models/openai/gpt-image-1/code.mdx -translationBlockHashes: - "_intro": 410036c3 - "Quick start": b83102e7 - "Schema": 8be561c9 - "Examples": c73859ec ---- - - - - - - -{/* 生成済みファイル。`pnpm code-pages:gen` により router-schemas/openai/gpt-image-1.json から生成されました。 */} - -import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; - -`openai/gpt-image-1` の API リファレンス。OpenAI から Comfy Router が提供します。 - -**入力:** テキスト, 画像 · **出力:** 画像 - -## クイックスタート - -[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL スニペットは、同じ呼び出しを生の HTTP で行うものです。 - -**モデル ID:** `openai/gpt-image-1` - -**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/gpt-image-1` - - - - -```python Python -from comfy_sdk import Comfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。 -with Comfy() as client: - result = client.models.run( - "openai/gpt-image-1", - { - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。 -const { data } = await comfy.models.run("openai/gpt-image-1", { - prompt: "a rocketship on a launchpad", - quality: "low", - size: "1024x1024", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/gpt-image-1 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" -``` - - - -同じボディを `POST https://api.comfy.org/v2/models/openai/gpt-image-1/requests` に送信します。Router は実行が受け付けられるとすぐに `request_id` とともに `201` を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから収集されます。[キューの配信](/ja/development/comfy-router/queue)では、ステータス、キャンセル、収集について説明します。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/gpt-image-1", - { - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024", - }, - ) - print("request_id:", handle.request_id) # モデル ID と合わせて、別のプロセスが必要とする情報はこれだけです - - # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。 - # 失敗またはキャンセルされたリクエストは、ここで型付きの Router エラーを発生させます。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -const handle = await comfy.models.submit("openai/gpt-image-1", { - prompt: "a rocketship on a launchpad", - quality: "low", - size: "1024x1024", -}); -console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスが必要とする情報はこれだけです - -// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After だけ待機します。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run() が返すのと同じ結果です。失敗またはキャンセルされたリクエストはここで reject されます。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 送信します。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。 -curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" - -# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 収集します。モデルのネイティブ出力とともに 200、まだ実行中の場合はステータス本文とともに 202 を返します。 -curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## スキーマ - -### 入力 - - - 背景の透明性。`auto` はモデルに選択させます。 - - 指定可能な値: `transparent`、`opaque`、`auto` - - - - 編集するソース画像。このフィールドの有無が編集操作を選択します。テキストから画像への生成では完全に省略してください。 -モデルが公開している例はこのフィールドを省略した生成呼び出しです。`image` を追加することが 2 つのモードの違いのすべてです。同じエンドポイント、同じモデル id ですが、編集用のプロンプトはシーンではなく望む変更を記述するため、構造的に新しいのはこのフィールドだけであるにもかかわらず、以下の編集用ボディは生成の例とは異なって見えます。 -これは記載どおりにそのままコピーできます: `{"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}`。ペイロードは省略形ではなく完全な 1x1 PNG であり、このボディは Router 自身のリクエスト検証テストで受け入れられるケースとしてピン留めされています。ご自身の画像のバイト列に差し替えてください。 -1 枚の画像またはその配列を受け付けます。gpt-image-1 以降は最大 16 枚で、Router はディスパッチ前にこのスキーマに基づいてそれを強制します。 - - - - 1 枚の画像を、Router が呼び出し元に代わって取得する https URL、またはバイト列をインラインで含む `data:image/;base64,` URI のいずれかの形式で指定します。受け付ける画像タイプは png、webp、jpeg で、このセットはプロバイダーに委ねるのではなく解決時に強制されます。svg、gif、avif、tiff はここで拒否され、送信した画像を名指しします。原因から 2 ホップ離れたパートナーのエラーになることはありません。 -URL 形式を推奨します。base64 ペイロードはおよそ 4/3 に膨張し、リクエストボディ全体は 100 MiB に制限されるため、インライン形式ではソース画像が約 75 MB で上限に達します。URL ならこれを完全に回避できます。この説明の最後に示す画像ごとおよびリクエストごとのメディア上限はボディの上限よりも厳しいため、実際のサイズの画像ではまずこちらに突き当たります。 -URL は認証情報なしで解決できなければなりません。Router はサーバー側でこれを取得し、リクエストに呼び出し元の認証情報を付けません。したがって、署名がクエリ文字列にあるような署名付き URL(presigned URL)がサポートされる形式です。`/api/assets/{id}/content` のような認証が必要なエンドポイントは、画像ではなく Router に 401 を返します。その URL はご自身でリクエストし、リダイレクト先の署名付き URL を渡してください。 -取得は開かれたインターネットではなく、名前を挙げたホストの集合に限定され、同じリストが送信した URL だけでなくすべてのリダイレクトホップにも再適用されます。したがって、他のホストの URL や、リスト外へリダイレクトする URL は、どのプロバイダーにも接続する前に拒否されます。現在、そのリストは Comfy 自身のアセット配信のみです。Comfy のアセットバケット配下の署名付き `storage.googleapis.com` URL で、これは `/api/assets/{id}/content` がリダイレクトする形式です。パートナーの CDN や通常の https ホストはリストにありません。 -2 つの拡張が展開中で、どちらも本日時点ではデフォルトで無効です。これらは 1 つの切り替えの背後で提供され、同時に有効になります。したがって、以下はすべて今後に予定されているものとして扱い、まだ依存して実装する対象とはしないでください。どちらかに依存する前に確認してください。 -1 つ目は、`POST /customers/storage` がアップロード先として署名するバケットです。展開がお使いの環境に到達するまで、そのエンドポイントからのアップロード URL は、バケットが Comfy 自身のものでホストも同じであっても、ここで拒否されます。つまり「Comfy にアップロードしてから URL を渡す」という方法はまだ機能せず、機能するのは `/api/assets/{id}/content` がリダイレクトする署名付き URL の形式です。 -2 つ目は、全員に一度にではなくアカウントごとに有効化されます。これらのホストの背後にあるバケットは当社ではなくお客様のものだからです。上記の切り替えがオンになっていても、サードパーティの受信メディアが有効化されていないアカウントは拒否され、ホストがサポート対象外だと言われるのではなく、その旨の文言で伝えられます。お使いのアカウントで有効化するよう Comfy の担当者に依頼してください。さらに、次のサードパーティのオブジェクトストレージホストを許可します。ここではバケットはお客様のものであり、Router はその所有権を主張しません: Cloudflare R2(`.r2.cloudflarestorage.com`、`pub-.r2.dev`)、Amazon S3(`s3.amazonaws.com` および `s3..amazonaws.com`、パス形式または `.` を前置する形式のいずれか)、Azure Blob Storage(`.blob.core.windows.net`)、Alibaba Cloud OSS(`.oss-.aliyuncs.com`、`oss-accelerate` エンドポイントを含む)。これらは特にオブジェクトストレージのエンドポイントです。同じプロバイダーのドメイン上の汎用エンドポイント、たとえば Alibaba Function Compute のトリガーはリストになく、拒否されます。 -一致するのはプロバイダーではなくホスト名の形式です。したがって、上に挙げたプロバイダー名は、そのプロバイダーが発行しうるすべての URL が受け入れられることを意味しません。また、呼び出し元がそれぞれの形式で到達するのは妥当なことなので、3 つの近いはずれは明記しておく価値があります。R2 のカスタムドメイン(`cdn.example.com`)は受け入れられません。Cloudflare は `pub-.r2.dev` をレート制限付きのデバッグ用ホスト名として文書化し、本番トラフィックは代わりにカスタムドメインに向けるよう案内していますが、カスタムドメインのホスト名にはそれが R2 であると識別する情報が何もないため、Router は他のホストと区別できず拒否します。`.r2.cloudflarestorage.com` エンドポイントに署名するか、`pub-.r2.dev` 形式を使用してください。S3 の IPv6 dualstack エンドポイント(`s3.dualstack..amazonaws.com`)も受け入れられません。通常のリージョナルエンドポイントを使用してください。Azure Blob の代替 DNS ゾーン(`.z.blob.storage.azure.net`)も同様です。`.blob.core.windows.net` を使用してください。返される拒否メッセージにはこれら同じ形式が記載されているので、それらを読むためにここへ来る必要はありません。 -上記の `` と `pub-` プレースホルダーは、通常そのままの形で到達する形式を示しているだけで、深さの制限ではありません。マッチングはオブジェクトストレージのドメインサフィックスに対して行われるため、同じネームスペース配下のより深い名前(`a.b.pub-.r2.dev`)も受け入れられます。ただし、これによってネームスペース自体が広げられるわけではありません。サフィックスは依然として列挙されているもののいずれかである必要があります。 -以下の例は形状のみを示しています。実際の値には署名クエリパラメータも含まれますが、ここでは意図的に省略しています。公開された例はスペックに永久に残り、実際の署名は漏洩した認証情報であると同時に、機能しなくなるリンクでもあるためです。 -各画像は 25 MiB、1 つのリクエストの画像は合計 64 MiB に制限されています。 - - - - 実行する gpt-image モデル。Router がアドレス指定されたモデル id を挿入するため、/v2/models/openai/gpt-image-2 をアドレス指定する呼び出し元はこれを送信しません。 - - - - コンテンツモデレーション設定 - - 指定可能な値: `low`, `auto` - - - - 生成する画像の数(1〜10)。 - - 範囲: `1` ~ `10` - - - - JPEG または WebP の圧縮レベル(0〜100) - - 範囲: `0` ~ `100` - - - - 出力画像の形式 - - 指定可能な値: `png`, `webp`, `jpeg` - - - - ライブストリームと併用する場合にのみ意味を持ちますが、このサーフェスはそれを提供できません。`stream` を送信しても `false` に確定されます。生成時には、`0` または `null` 以外の値は、リクエストが `stream: true` も送信しているかどうかに関わらず、400 で拒否されます。`image` を含むリクエストでは、このフィールドは転送されずに破棄されます。省略してください。 - - 範囲: `0` ~ `3` - - - - 生成する画像、または `image` に行う編集のテキスト記述。 - - - - 生成または編集された画像の品質。`xhigh` と `max` は gpt-image-2.5-flare と gpt-image-2.5-sunburst が追加された 2 つのティアです。`standard` と `hd` は dall-e 時代の表記であり、受け入れられているどのモデルも読み取りません。 - - 指定可能な値: `auto`, `low`, `medium`, `high`, `xhigh`, `max`, `standard`, `hd` - - - - 画像のサイズ(例: 1024x1024、1536x1024、auto) - - - - 送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは INERT です。Router はディスパッチ前にこれを `false` に SETTLE します。これは `text/event-stream` を中継するのではなくプロバイダーのレスポンスをキャプチャするためです(`image` を含むリクエストでは、編集がそれを付けずに再エンコードされるため、代わりにこのフィールドが破棄されます)。gpt-image の partial-image ストリーミングを提供する Comfy サーフェスはありません。v1 の `POST /proxy/openai/images/generations` イングレスは `stream: true` を 400 で拒否し、リクエストを上流に転送することはありません。そのためこのフィールドは省略し、完了したレスポンスを 1 つの JSON ボディとして読み取ってください。ストリームが開かないため、`stream: true` と 1 より大きい `n` の組み合わせに対する OpenAI の制限はここでは適用されません。`n` は送信されたまま転送されます。 - - - - エンドユーザーの監視用の一意の識別子 - - -`GET /v2/models/openai/gpt-image-1/openapi.json` で Router が提供するスキーマ、つまりリクエストがプロバイダーに到達する前に呼び出しを検証する際に対象とする同じドキュメントから生成されています。 - -### 出力 - - - - - - - Base64 でエンコードされた画像データ - - - - 修正されたプロンプト - - - - 画像の URL - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 生成された画像の背景が `opaque` か `transparent` か、OpenAI がこの生成に対して解決したとおりに示します。リクエストパラメータのデフォルトは `auto` なので、これをピン留めしなかった呼び出し元は、ここでどちらが生成されたかを知ることができます。 - - - - 生成が完了した時刻の Unix タイムスタンプ(秒)。OpenAI が画像生成レスポンスで REQUIRED として宣言している唯一のメンバーであり、OpenAI が生成元である場合は必ず存在します。alt ベースの id で fal、pika、wavespeed、runware が処理したレスポンスでは、他の 4 つの解決済みパラメータのメンバーと同様に、これは完全に省略されます。`int64` と宣言されているのは、現在のエポック値が 2^31 に十分近く、フォーマットされていない `integer` では多くの SDK ジェネレータで 32 ビットフィールドが生成されてしまうためです。 - - 形式: `int64` - - - - `data[].b64_json` 内のバイト列のエンコーディング: `png`、`webp`、`jpeg` のいずれかです。これは OpenAI が実際にエンコードした形式であり、リクエストで `output_format` を送信した場合はそれが、送信しなかった場合は `png` になります。そのためデコーダは、リクエストから形式を再導出するのではなく、これをもとに処理できます。 - - - - この生成が実際に実行された品質ティアです。OpenAI は `low`、`medium`、`high`、`xhigh`、`max` のいずれかを報告します。これは解決済みのティアであり、リクエストのエコーではありません。リクエスト自体の `quality` はデフォルトで `auto` になります。 - - - - この生成が実際に実行されたピクセル寸法を `x` として示します。これは解決済みのサイズです。リクエストの `size` はデフォルトで `auto` になり、明示的に `auto` を受け付けるため、実際に使用された寸法が報告されるのはここだけです。 - - -## 例 - -### 入力 - -```json -{ - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024" -} -``` - -### 出力 - -```json -{ - "created": 1767225600, - "data": [ - { - "b64_json": "PGJhc2U2ND4=" - } - ], - "usage": { - "input_tokens": 12, - "input_tokens_details": { - "image_tokens": 0, - "text_tokens": 12 - }, - "output_tokens": 1056, - "total_tokens": 1068 - } -} -``` - - diff --git a/ja/development/comfy-router/models/openai/o1-pro/code.mdx b/ja/development/comfy-router/models/openai/o1-pro/code.mdx deleted file mode 100644 index dbec1e4fc1..0000000000 --- a/ja/development/comfy-router/models/openai/o1-pro/code.mdx +++ /dev/null @@ -1,622 +0,0 @@ ---- -title: "Comfy Router で o1-pro を使う" -description: "Comfy Router 経由で openai/o1-pro を呼び出します: エンドポイント、リクエスト形状、Router が返すレスポンスについて説明します。" -sidebarTitle: "o1-pro" -translationSourceHash: f672098e -translationFrom: development/comfy-router/models/openai/o1-pro/code.mdx -translationBlockHashes: - "_intro": a236f94d - "Quick start": f09ba6ce - "Schema": 4d31797d - "Examples": 67e6c8f1 ---- - - - -{/* GENERATED FILE. Generated from router-schemas/openai/o1-pro.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; - -`openai/o1-pro` の API リファレンス。OpenAI から Comfy Router 経由で提供されます。 - -**入力:** テキスト, 画像 · **出力:** テキスト - -## クイックスタート - -[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL のスニペットは、生の HTTP で同じ呼び出しを行います。 - -**モデル ID:** `openai/o1-pro` - -**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/o1-pro` - - - - -```python Python -from comfy_sdk import Comfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。 -with Comfy() as client: - result = client.models.run( - "openai/o1-pro", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。 -const { data } = await comfy.models.run("openai/o1-pro", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/o1-pro \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -同じボディを `POST https://api.comfy.org/v2/models/openai/o1-pro/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得については [キュー配信](/ja/development/comfy-router/queue) を参照してください。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動リトライのために再利用します。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/o1-pro", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # モデル ID とともに、別のプロセスが必要とするすべての情報 - - # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の間待機します。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # プロバイダー自身のペイロードで、models.run() が返す値と同じです。 - # 失敗またはキャンセル済みのリクエストはここで型付きの Router エラーを発生させます。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// 各 submit() 呼び出しは独自の Idempotency-Key を生成し、自動リトライのために再利用します。 -const handle = await comfy.models.submit("openai/o1-pro", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // モデル ID とともに、別のプロセスが必要とするすべての情報 - -// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の間待機します。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストはここで拒否されます。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。 -curl https://api.comfy.org/v2/models/openai/o1-pro/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒待機します。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 取得。モデルのネイティブ出力とともに 200、まだ実行中の場合はステータスボディとともに 202 を返します。 -curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## スキーマ - -### 入力 - - - モデル応答に含める追加の出力データ。 - - - - モデルへのテキスト、画像、ファイル入力。応答の生成に使用されます。この契約で Router が提供できない唯一のフィールドであり、以下の `required` にある唯一の項目です。 - - - - モデルのコンテキストの最初の項目として、システム (または開発者) メッセージを挿入します。 - - - - 応答のために生成されるトークン数の上限。可視出力トークンと推論トークンを含みます。推論 ID では、この上限は隠れた推論トークンと共有されるため、小さな値では可視テキストが現れる前に予算全体を消費してしまいます。そのため、推論のスモークケースでは 1024 を送信し、チャットのケースでは 16 を送信します。 - - 範囲: `1` から `…` - - - - OpenAI モデル識別子。Comfy Router ではこのフィールドは任意であり、Router が `{model}` パスセグメントから補います。明示的な `null` も同様に置き換えられます。パスと一致しない値を送信すると拒否されます。 - - - - モデルがツール呼び出しを並列で実行することを許可するかどうか。 - - - - マルチターン会話のための、前の応答の ID。 - - - - 推論層専用。推論モデル向けの設定。例: `{"effort": "medium"}`。そのまま転送されます。受け入れられるキーについては OpenAI の推論ガイドを参照してください。チャット層の ID では無視されます。 - - - - OpenAI が生成済み応答を後で取得できるように保存するかどうか。 - - - - 送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは不活性です: Router はディスパッチ前にこれを `false` に確定します。`text/event-stream` を中継するのではなくプロバイダー応答をキャプチャするためです。`text/event-stream` はデコードできないため、ストリーミング生成は OpenAI に課金されますが、誰にも計量されません。Comfy のどのサーフェスもこのストリームを提供しません: v1 の `POST /proxy/openai/v1/responses` イングレスは `stream: true` を 400 で拒否し、リクエストを上流へ転送しません。したがって、どちらのサーフェスでもこのフィールドを省略するか `false` を送信し、完了した応答を 1 つの JSON ボディとして読み取ってください。 - - - - サンプリング温度。チャット層専用: o シリーズの推論 ID (`o1`、`o1-pro`、`o3`、`o4-mini`) は OpenAI でこのパラメータを拒否します。Router はそれらに対してこれを拒否しません。2 つの層が 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください。そのため、これを送信する推論呼び出しには OpenAI 自身のエラーが返されます。 - - 範囲: `0` から `2` - - - - 出力形式の設定。例: Structured Outputs 用の `{"format": {"type": "json_schema", ...}}`。そのまま転送されます。 - - - - モデルが使用するツールをどのように選択するか。文字列モードまたはツールを指定するオブジェクトのいずれかです。 - - - - モデルが呼び出せるツール定義。Router はツールの分類を絞り込みません。受け入れられる形については OpenAI の Responses API リファレンスを参照してください。 - - - - ニュークリアスサンプリングのカットオフ。チャット層専用で、`temperature` と同じ条件です。 - - 範囲: `0` から `1` - - - - コンテキストがモデルのウィンドウを超える場合の切り捨て戦略。上記の 3 つの語彙とは異なり、ここでは enum が適用されます。これらの 2 つの値が OpenAI の文書化する完全なセットであり、それが増えていないためです。明示的な `null` は、上記のフィールドと同じ条件で引き続き受け入れられます。 - - 可能な値: `auto`、`disabled` - - - - トークン使用量のエンベロープ。v1 オペレーションがリクエストボディでこれを宣言しているため、この契約に存在します。OpenAI はこれを応答で設定するため、呼び出し元が送信する理由はありません。 - - -Router が `GET /v2/models/openai/o1-pro/openapi.json` で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する対象となる同じドキュメントです。 - -### 出力 - - - モデルのコンテキストの最初の項目として system(または developer)メッセージを挿入します。 - -`previous_response_id` と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスで system(または developer)メッセージを簡単に差し替えられます。 - - - - レスポンスで生成できるトークン数の上限。可視出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)を含みます。 - - - - レスポンスの生成に使用されるモデル - - - - レスポンスのランダム性を制御します - - 範囲: `0` から `2` - - - - nucleus サンプリングによるレスポンスの多様性を制御します - - 範囲: `0` から `1` - - - - モデルレスポンスに使用する切り詰め戦略。 -- `auto`: このレスポンスと以前のレスポンスのコンテキストが - モデルのコンテキストウィンドウサイズを超える場合、モデルは - 会話の途中にある入力項目を削除してコンテキストウィンドウに - 収まるようにレスポンスを切り詰めます。 -- `disabled`(デフォルト): モデルレスポンスがモデルのコンテキストウィンドウ - サイズを超える場合、リクエストは 400 エラーで失敗します。 - - 指定可能な値: `auto`, `disabled` - - - - モデルに対する前のレスポンスの一意の ID。これを使用して -マルチターン会話を作成します。 -[conversation state](https://platform.openai.com/docs/guides/conversation-state) の詳細を学びます。 - - - - **o シリーズモデル限定** - -[推論モデル](https://platform.openai.com/docs/guides/reasoning)の構成オプション。 - - - - 後のターンでどの reasoning 項目をモデルに返すかを制御します。例: `auto`、`current_turn`、`all_turns`。 - - - - **o シリーズモデル限定** - -[推論モデル](https://platform.openai.com/docs/guides/reasoning)の推論にかける労力を制約します。 -現在サポートされている値は `low`、`medium`、`high` です。推論の労力を -減らすと、レスポンスが速くなり、レスポンス内で推論に使用される -トークンが少なくなる場合があります。 - - 指定可能な値: `low`, `medium`, `high` - - - - **非推奨:** 代わりに `summary` を使用してください。 - -モデルが実行した推論の要約。デバッグやモデルの推論プロセスの -理解に役立ちます。 -`auto`、`concise`、`detailed` のいずれかです。 - - 指定可能な値: `auto`, `concise`, `detailed` - - - - レスポンスに使用される推論モード。 - - - - モデルが実行した推論の要約。デバッグやモデルの推論プロセスの -理解に役立ちます。 -`auto`、`concise`、`detailed` のいずれかです。 - - 指定可能な値: `auto`, `concise`, `detailed` - - - - - - - - モデルが出力する必要がある形式を指定するオブジェクト。 - -`{ "type": "json_schema" }` を構成すると Structured Outputs が有効になり、 -モデルが指定した JSON schema に一致することが保証されます。詳細は -[Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs)を参照してください。 - -デフォルト形式は `{ "type": "text" }` で、追加オプションはありません。 - -**gpt-4o 以降のモデルには推奨されません:** - -`{ "type": "json_object" }` に設定すると古い JSON モードが有効になり、 -モデルが生成するメッセージが有効な JSON であることが保証されます。対応しているモデルでは -`json_schema` の使用が推奨されます。 - - - - モデルのレスポンスの冗長性を制約します。`low`、`medium`、`high` のいずれかです。 - - - - レスポンスを生成するときに、モデルがどのツール(または複数のツール)を -使用するかを選択する方法。モデルが呼び出せるツールを指定する方法については -`tools` パラメータを参照してください。 - - - - - - - - モデルレスポンスをバックグラウンドで実行するかどうか。 - - - - レスポンスの請求情報。 - - - - レスポンスの支払いを担当する当事者。 - - - - このレスポンスが完了したときの Unix タイムスタンプ(秒)。ステータスが `completed` の場合にのみ存在します。 - - - - このレスポンスが作成されたときの Unix タイムスタンプ(秒)。 - - - - モデルが Response の生成に失敗したときに返されるエラーオブジェクト。 - - - - レスポンスのエラーコード。可能な値: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` - - - - エラーの人間が読める形式の説明。 - - - - これまでのテキスト内での既存の出現頻度に基づいて新しいトークンにペナルティを与えます。 - - - - この Response の一意の識別子。 - - - - レスポンスが不完全である理由の詳細。 - - - - レスポンスが不完全である理由。 - - 可能な値: `max_output_tokens`、`content_filter` - - - - 1 つのレスポンスで処理できる、組み込みツールへの呼び出しの合計最大数。 - - - - レスポンスに付加できるキーと値のペアのセット。 - - - - モデレーションされた完了が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。 - - - - このリソースのオブジェクト種別。常に `response` に設定されます。 - - 可能な値: `response` - - - - モデルによって生成されたコンテンツ項目の配列。 - -- `output` 配列内の項目の長さと順序は、モデルのレスポンスによって異なります。 -- `output` 配列の最初の項目にアクセスして、それがモデルによって生成された - コンテンツを含む `assistant` メッセージであると仮定するよりも、 - SDK でサポートされている場合は `output_text` プロパティの使用を - 検討してください。 - - - - `output` 配列内のすべての `output_text` 項目からの集約されたテキスト出力を含む、 -SDK 専用の便利なプロパティ(存在する場合)。Python SDK と JavaScript SDK で -サポートされています。 - - - - モデルがツール呼び出しを並列で実行することを許可するかどうか。 - - - - これまでのテキスト内に出現するかどうかに基づいて新しいトークンにペナルティを与えます。 - - - - キャッシュヒット率を最適化するために、類似したリクエストに対するレスポンスをキャッシュするために OpenAI が使用します。`user` フィールドを置き換えます。 - - - - プロンプトキャッシュの保持ポリシー(例: `in_memory` または `24h`)。 - - - - OpenAI の利用ポリシーに違反している可能性のある、アプリケーションのユーザーの検出を支援するために使用される安定した識別子。 - - - - リクエストの処理に使用される処理層(例: `auto`、`default`、`flex`、`scale`、`priority`)。 - - - - レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれか。 - - 可能な値: `completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` - - - - レスポンスが API 経由での後での取得のために保存されるかどうか。 - - - - 組み込みツール別に分類されたトークンとリクエストの使用状況。 - - - - 画像生成ツールのトークン使用量。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Web 検索ツールの使用状況。 - - - - - - - - 各トークン位置で返す、関連する対数確率を伴う最も可能性の高いトークンの最大数。 - - - - 入力トークン、出力トークン、出力トークンの内訳、および使用された合計トークンを含む -トークン使用状況の詳細を表します。 - - - - 入力トークンの数。 - - - - 入力トークンの詳細な内訳。 - - - - キャッシュに書き込まれた入力トークンの数。 - - - - キャッシュから取得されたトークン数です。 -[プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 - - - - 出力トークン数です。 - - - - 出力トークンの詳細な内訳です。 - - - - 推論トークン数です。 - - - - 使用されたトークンの合計数です。 - - - - エンドユーザーの非推奨の識別子です。`safety_identifier` と `prompt_cache_key` に置き換えられました。 - - -## 使用例 - -### 入力 - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### 出力 - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/ja/development/comfy-router/models/openai/o1/code.mdx b/ja/development/comfy-router/models/openai/o1/code.mdx deleted file mode 100644 index e34fb13e79..0000000000 --- a/ja/development/comfy-router/models/openai/o1/code.mdx +++ /dev/null @@ -1,597 +0,0 @@ ---- -title: "Comfy Router で o1 を使用する" -description: "Comfy Router 経由で openai/o1 を呼び出す: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" -sidebarTitle: "o1" -translationSourceHash: f0eb94c8 -translationFrom: development/comfy-router/models/openai/o1/code.mdx -translationBlockHashes: - "_intro": 86454249 - "Quick start": 7a99b942 - "Schema": 6de26ff5 - "Examples": 67e6c8f1 ---- - - - -{/* GENERATED FILE. Generated from router-schemas/openai/o1.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; - -OpenAI が提供する `openai/o1` の API リファレンスです。Comfy Router によって配信されます。 - -**入力:** テキスト, 画像 · **出力:** テキスト - -## クイックスタート - -[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` および `npm install @comfyorg/sdk`)を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で行うものです。 - -**モデル ID:** `openai/o1` - -**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/o1` - - - - -```python Python -from comfy_sdk import Comfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。 -with Comfy() as client: - result = client.models.run( - "openai/o1", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// SDK は冪等キーを自動的に作成し、自動リトライのために再利用します。 -const { data } = await comfy.models.run("openai/o1", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/o1 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -同じボディを `POST https://api.comfy.org/v2/models/openai/o1/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得については [キュー配信](/ja/development/comfy-router/queue) で順を追って説明しています。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 環境変数から COMFY_API_KEY を読み取ります。 -# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/o1", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # モデル ID と合わせて、別のプロセスが必要とするのはこれだけです - - # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の秒数だけ待機します。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。 - # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 環境変数から COMFY_API_KEY を読み取ります。 -// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -const handle = await comfy.models.submit("openai/o1", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスが必要とするのはこれだけです - -// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の秒数だけ待機します。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 送信します。Router は request_id、status_url、response_url、cancel_url を伴う 201 を返します。 -curl https://api.comfy.org/v2/models/openai/o1/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After の秒数だけ待機します。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 取得します。まだ実行中はステータスボディを伴う 202、完了するとモデルのネイティブ出力を伴う 200 が返ります。 -curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## スキーマ - -### 入力 - - - モデルの応答に含める追加の出力データ。 - - - - 応答を生成するために使用される、モデルへのテキスト、画像、またはファイルの入力。このコントラクトで Router が提供できない唯一のフィールドであり、以下の `required` にある唯一のエントリです。 - - - - モデルのコンテキストの最初の項目として、システム (または開発者) メッセージを挿入します。 - - - - 応答のために生成されるトークン数の上限。可視の出力トークンと reasoning トークンを含みます。reasoning ID ではこの上限は隠れた reasoning トークンと共有されるため、値が小さいと可視テキストが現れる前に予算を使い切ってしまいます。そのため reasoning のスモークケースは 1024 を送り、chat のスモークケースは 16 を送ります。 - - 範囲: `1` から `…` - - - - OpenAI のモデル識別子。Comfy Router ではこのフィールドは OPTIONAL であり、Router は `{model}` パスセグメントからこれを埋めます。明示的な `null` も同じように置き換えられます。パスと一致しない値を送った場合は拒否されます。 - - - - モデルがツール呼び出しを並列で実行することを許可するかどうか。 - - - - マルチターン会話のための、前の応答の ID。 - - - - REASONING ティア専用。reasoning モデルの設定。例: `{"effort": "medium"}`。そのまま転送されます。受け付けられるキーについては OpenAI の reasoning ガイドを参照してください。chat ティアの ID はこれを無視します。 - - - - OpenAI が生成済みの応答を後で取得できるように保存するかどうか。 - - - - これを送った呼び出し元が拒否されないように宣言されていますが、このサーフェスでは無効です。Router はディスパッチ前にこれを `false` に確定します。Router は `text/event-stream` を中継するのではなくプロバイダーの応答をキャプチャしており、これをデコードできないため、ストリーミングされた生成は OpenAI に課金され、誰にも計測されないことになるからです。Comfy のどのサーフェスもストリームを提供していません。v1 の `POST /proxy/openai/v1/responses` イングレスは `stream: true` を 400 で拒否し、リクエストを上流へ転送しません。したがって、どちらのサーフェスでもこのフィールドを省略するか `false` を送り、完了した応答を 1 つの JSON ボディとして読み取ってください。 - - - - サンプリング温度。CHAT ティア専用です。o シリーズの reasoning ID (`o1`、`o1-pro`、`o3`、`o4-mini`) は OpenAI 側でこのパラメータを拒否します。Router はそれらに対してこれを拒否しません (2 つのティアが 1 つのスキーマを共有する理由については、このコンポーネントの注記を参照してください)。そのため、これを送る reasoning 呼び出しには OpenAI 自身のエラーが返されます。 - - 範囲: `0` から `2` - - - - 出力フォーマットの設定。例: Structured Outputs のための `{"format": {"type": "json_schema", ...}}`。そのまま転送されます。 - - - - モデルが使用するツールをどのように選択すべきか。文字列のモード、またはツールを指定するオブジェクトのいずれかです。 - - - - モデルが呼び出せるツール定義。Router はツールの分類を絞り込みません。受け付けられる形については OpenAI の Responses API リファレンスを参照してください。 - - - - ニュークリアスサンプリングのカットオフ。CHAT ティア専用で、`temperature` と同じ条件です。 - - 範囲: `0` から `1` - - - - コンテキストがモデルのウィンドウを超えたときの切り捨て戦略。上記の 3 つの語彙とは異なり、ここでは enum が適用されます。これらの 2 つの値が OpenAI の文書化する完全な集合であり、それが増えていないためです。明示的な `null` は、上記のフィールドと同じ条件で引き続き受け付けられます。 - - 指定可能な値: `auto`, `disabled` - - - - トークン使用量のエンベロープ。このコントラクトに存在するのは、v1 オペレーションがこれをリクエストボディで宣言しているためです。OpenAI はこれを応答側で設定するので、呼び出し元がこれを送る理由はありません。 - - -Router が `GET /v2/models/openai/o1/openapi.json` で提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に Router が呼び出しを検証する対象となる同じドキュメントです。 - -### 出力 - - - システム(または developer)メッセージを、モデルのコンテキストの最初の項目として挿入します。 - -`previous_response_id` と併用する場合、以前のレスポンスの instructions は次のレスポンスに引き継がれません。そのため、新しいレスポンスでシステム(または developer)メッセージを簡単に差し替えられます。 - - - - レスポンスで生成できるトークン数の上限。表示される出力トークンと [reasoning tokens](https://platform.openai.com/docs/guides/reasoning) が含まれます。 - - - - レスポンスの生成に使用されたモデル - - - - レスポンスのランダム性を制御します - - 範囲: `0` から `2` - - - - ニュークリアスサンプリングによるレスポンスの多様性を制御します - - 範囲: `0` から `1` - - - - モデルのレスポンスに使用する切り捨て戦略。 -- `auto`: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中の入力項目を削除してコンテキストウィンドウにフィットするようにレスポンスを切り捨てます。 -- `disabled`(デフォルト): モデルのレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 - - 指定可能な値: `auto`、`disabled` - - - - モデルへの以前のレスポンスの一意な ID。これを使用してマルチターンの会話を作成します。[会話の状態](https://platform.openai.com/docs/guides/conversation-state) の詳細を学ぶ。 - - - - **o シリーズのモデルのみ** - -[reasoning models](https://platform.openai.com/docs/guides/reasoning) の設定オプション。 - - - - 後のターンでどの reasoning 項目をモデルに返すかを制御します。例: `auto`、`current_turn`、`all_turns`。 - - - - **o シリーズのモデルのみ** - -[reasoning models](https://platform.openai.com/docs/guides/reasoning) の reasoning にかける労力を制約します。現在サポートされている値は `low`、`medium`、`high` です。reasoning の労力を減らすと、レスポンスが高速になり、レスポンスで reasoning に使用されるトークン数も少なくなる場合があります。 - - 指定可能な値: `low`、`medium`、`high` - - - - **非推奨:** 代わりに `summary` を使用してください。 - -モデルが実行した reasoning の要約。これはモデルの reasoning プロセスをデバッグし理解するのに役立ちます。`auto`、`concise`、`detailed` のいずれかです。 - - 指定可能な値: `auto`、`concise`、`detailed` - - - - レスポンスに使用される reasoning モード。 - - - - モデルが実行した reasoning の要約。これはモデルの reasoning プロセスをデバッグし理解するのに役立ちます。`auto`、`concise`、`detailed` のいずれかです。 - - 指定可能な値: `auto`、`concise`、`detailed` - - - - - - - - モデルが出力しなければならない形式を指定するオブジェクト。 - -`{ "type": "json_schema" }` を設定すると Structured Outputs が有効になり、モデルが指定した JSON スキーマに一致することが保証されます。詳細は [Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs) を参照してください。 - -デフォルトの形式は `{ "type": "text" }` で、追加のオプションはありません。 - -**gpt-4o 以降のモデルには推奨されません:** - -`{ "type": "json_object" }` を設定すると、従来の JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。対応しているモデルでは `json_schema` の使用が推奨されます。 - - - - モデルのレスポンスの冗長さを制約します。`low`、`medium`、`high` のいずれかです。 - - - - レスポンスを生成する際に、モデルが使用するツール(複数の場合はツール群)をどのように選択するか。モデルが呼び出せるツールの指定方法については `tools` パラメータを参照してください。 - - - - - - - - モデルのレスポンスをバックグラウンドで実行するかどうか。 - - - - レスポンスの請求情報。 - - - - レスポンスの支払いを担当する当事者。 - - - - この Response が完了したときの Unix タイムスタンプ(秒)。ステータスが `completed` の場合にのみ存在します。 - - - - この Response が作成されたときの Unix タイムスタンプ(秒)。 - - - - モデルが Response の生成に失敗したときに返されるエラーオブジェクト。 - - - - レスポンスのエラーコード。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - エラーの人間が読める形式の説明。 - - - - これまでのテキスト内での出現頻度に基づいて新しいトークンにペナルティを与えます。 - - - - この Response の一意な識別子。 - - - - レスポンスが不完全である理由に関する詳細。 - - - - レスポンスが不完全である理由。 - - 指定可能な値: `max_output_tokens`, `content_filter` - - - - 1 つのレスポンスで処理できる、組み込みツールへの総呼び出し回数の上限。 - - - - レスポンスに付加できるキーと値のペアの集合。 - - - - モデレーションされた補完が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。 - - - - このリソースのオブジェクト型。常に `response` に設定されます。 - - 指定可能な値: `response` - - - - モデルによって生成されたコンテンツ項目の配列。 - -- `output` 配列内の項目の長さと順序は、モデルのレスポンスによって異なります。 -- `output` 配列の最初の項目にアクセスして、それがモデルによって生成されたコンテンツを含む `assistant` メッセージであると決め打ちするのではなく、SDK でサポートされている場合は `output_text` プロパティの使用を検討してください。 - - - - `output` 配列内のすべての `output_text` 項目(存在する場合)からのテキスト出力を集約したものを含む、SDK 専用の便利なプロパティ。Python および JavaScript の SDK でサポートされています。 - - - - モデルがツール呼び出しを並行して実行することを許可するかどうか。 - - - - これまでのテキストに出現するかどうかに基づいて新しいトークンにペナルティを与えます。 - - - - 類似したリクエストのレスポンスをキャッシュしてキャッシュヒット率を最適化するために OpenAI が使用します。`user` フィールドを置き換えます。 - - - - プロンプトキャッシュの保持ポリシー(例: `in_memory` または `24h`)。 - - - - OpenAI の利用ポリシーに違反している可能性のあるアプリケーションのユーザーを検出するために使用される安定した識別子。 - - - - リクエストの処理に使用される処理ティア(例: `auto`、`default`、`flex`、`scale`、または `priority`)。 - - - - レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれか。 - - 指定可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - API 経由で後で取得できるようにレスポンスを保存するかどうか。 - - - - 組み込みツールごとに分類したトークンとリクエストの使用量。 - - - - 画像生成ツールのトークン使用量。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Web 検索ツールの使用量。 - - - - - - - - 各トークン位置で返す、最も可能性の高いトークンの最大数。それぞれに対応する対数確率が付きます。 - - - - 入力トークン、出力トークン、出力トークンの内訳、使用された合計トークンを含むトークン使用量の詳細を表します。 - - - - 入力トークンの数。 - - - - 入力トークンの詳細な内訳。 - - - - キャッシュに書き込まれた入力トークンの数。 - - - - キャッシュから取得されたトークン数です。 -[プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 - - - - 出力トークン数です。 - - - - 出力トークンの詳細な内訳です。 - - - - 推論トークン数です。 - - - - 使用されたトークンの合計数です。 - - - - エンドユーザーの非推奨の識別子です。`safety_identifier` と `prompt_cache_key` に置き換えられました。 - - -## 例 - -### 入力 - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### 出力 - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/ja/development/comfy-router/models/openai/o3/code.mdx b/ja/development/comfy-router/models/openai/o3/code.mdx index 6f35c90536..2fc150623c 100644 --- a/ja/development/comfy-router/models/openai/o3/code.mdx +++ b/ja/development/comfy-router/models/openai/o3/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router で o3 を使用する" description: "Comfy Router 経由で openai/o3 を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" sidebarTitle: "o3" -translationSourceHash: e0b99669 +translationSourceHash: 7e056724 translationFrom: development/comfy-router/models/openai/o3/code.mdx translationBlockHashes: "_intro": a86dcb0c "Quick start": 4064c5a8 - "Schema": 217699a3 + "Schema": d937270a "Examples": 67e6c8f1 --- @@ -239,7 +239,7 @@ Router が `GET /v2/models/openai/o3/openapi.json` で提供するスキーマ - レスポンスで生成できるトークン数の上限。可視出力トークンと [reasoning tokens](https://platform.openai.com/docs/guides/reasoning) が含まれます。 + レスポンスで生成できるトークン数の上限。可視出力トークンと [推論トークン](https://platform.openai.com/docs/guides/reasoning) が含まれます。 @@ -273,13 +273,13 @@ Router が `GET /v2/models/openai/o3/openapi.json` で提供するスキーマ モデルへの前のレスポンスの一意の ID。これを使用して マルチターンの会話を作成します。詳細は -[conversation state](https://platform.openai.com/docs/guides/conversation-state) を参照してください。 +[会話状態](https://platform.openai.com/docs/guides/conversation-state) を参照してください。 **o シリーズモデルのみ** -[reasoning models](https://platform.openai.com/docs/guides/reasoning) の設定オプション。 +[推論モデル](https://platform.openai.com/docs/guides/reasoning) の設定オプション。 @@ -289,7 +289,7 @@ Router が `GET /v2/models/openai/o3/openapi.json` で提供するスキーマ **o シリーズモデルのみ** -[reasoning models](https://platform.openai.com/docs/guides/reasoning) の +[推論モデル](https://platform.openai.com/docs/guides/reasoning) の 推論にかける労力を制約します。 現在サポートされている値は `low`、`medium`、`high` です。reasoning effort を下げると、 レスポンスが速くなり、レスポンス内で reasoning に使用される @@ -329,7 +329,7 @@ Router が `GET /v2/models/openai/o3/openapi.json` で提供するスキーマ `{ "type": "json_schema" }` を設定すると Structured Outputs が有効になり、 モデルが指定した JSON schema に一致することが保証されます。詳細は -[Structured Outputs guide](https://platform.openai.com/docs/guides/structured-outputs) を参照してください。 +[Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs) を参照してください。 デフォルトのフォーマットは `{ "type": "text" }` で、追加オプションはありません。 @@ -542,6 +542,18 @@ Python SDK と JavaScript SDK でサポートされています。 キャッシュに書き込まれた入力トークンの数。 + + キャッシュの有効期間ごとに分割したキャッシュ書き込み。2 つの合計は `cache_write_tokens` になります。 + + + + 12 時間の有効期間でキャッシュに書き込まれた入力トークン数。 + + + + 30 分の有効期間でキャッシュに書き込まれた入力トークン数。 + + キャッシュから取得されたトークン数です。 [プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/ja/development/comfy-router/models/openai/o4-mini/code.mdx b/ja/development/comfy-router/models/openai/o4-mini/code.mdx deleted file mode 100644 index 3d13425696..0000000000 --- a/ja/development/comfy-router/models/openai/o4-mini/code.mdx +++ /dev/null @@ -1,605 +0,0 @@ ---- -title: "Comfy Router で o4-mini を使う" -description: "Comfy Router 経由で openai/o4-mini を呼び出す: エンドポイント、リクエストの形式、Router が返すレスポンスについて説明します。" -sidebarTitle: "o4-mini" -translationSourceHash: b1b02a55 -translationFrom: development/comfy-router/models/openai/o4-mini/code.mdx -translationBlockHashes: - "_intro": 23fc3424 - "Quick start": f63680db - "Schema": fcbeee88 - "Examples": 67e6c8f1 ---- - - - -{/* GENERATED FILE. Generated from router-schemas/openai/o4-mini.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; - -`openai/o4-mini` の API リファレンスです。Comfy Router が OpenAI から提供しています。 - -**入力:** テキスト, 画像 · **出力:** テキスト - -## クイックスタート - -[あなたの Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、それを `COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットでは Comfy SDK(`pip install comfy-sdk` および `npm install @comfyorg/sdk`)を使用します。cURL のスニペットは、生の HTTP で同じ呼び出しを行います。 - -**モデル ID:** `openai/o4-mini` - -**エンドポイント:** `POST https://api.comfy.org/v2/models/openai/o4-mini` - - - - -```python Python -from comfy_sdk import Comfy - -# COMFY_API_KEY を環境変数から読み取ります。 -# SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。 -with Comfy() as client: - result = client.models.run( - "openai/o4-mini", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// COMFY_API_KEY を環境変数から読み取ります。 -// SDK は冪等性キーを自動的に作成し、自動リトライのために再利用します。 -const { data } = await comfy.models.run("openai/o4-mini", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/o4-mini \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -同じボディを `POST https://api.comfy.org/v2/models/openai/o4-mini/requests` に送信します。Router は実行が受け付けられ次第 `201` と `request_id` を返し、結果は準備が整った時点で、このプロセスからでも別のプロセスからでも取得できます。ステータス、キャンセル、結果の取得の詳細は [キュー配信](/ja/development/comfy-router/queue) を参照してください。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# COMFY_API_KEY を環境変数から読み取ります。 -# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/o4-mini", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # モデル ID と組み合わせれば、別のプロセスに必要なものはこれだけです - - # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の秒数だけ待機します。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。 - # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// COMFY_API_KEY を環境変数から読み取ります。 -// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライのために再利用します。 -const handle = await comfy.models.submit("openai/o4-mini", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // モデル ID と組み合わせれば、別のプロセスに必要なものはこれだけです - -// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の秒数だけ待機します。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストは、ここで reject されます。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 送信します。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。 -curl https://api.comfy.org/v2/models/openai/o4-mini/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After 秒だけ待機します。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 取得します。モデルのネイティブ出力とともに 200、まだ実行中の場合はステータスボディとともに 202 を返します。 -curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## スキーマ - -### 入力 - - - モデルの応答に含める追加の出力データ。 - - - - モデルへのテキスト、画像、ファイル入力。応答の生成に使用されます。この契約のうち Router が供給できない唯一のフィールドであり、以下の `required` にある唯一の項目でもあります。 - - - - システム(または開発者)メッセージを、モデルのコンテキストの先頭項目として挿入します。 - - - - 応答のために生成されるトークン数の上限。可視出力トークンと reasoning トークンを含みます。reasoning の id ではこの上限は隠れた reasoning トークンと共有されるため、小さな値では可視テキストが一切出力される前にバジェット全体を消費してしまいます。そのため reasoning のスモークケースでは 1024 を送り、chat のケースでは 16 を送ります。 - - Range: `1` から `…` - - - - OpenAI モデル識別子。Comfy Router ではこのフィールドは任意で、Router が `{model}` パスセグメントからこれを埋めます。明示的な `null` も同じように置き換えられます。パスと一致しない値を送信すると拒否されます。 - - - - モデルがツール呼び出しを並列で実行することを許可するかどうか。 - - - - マルチターン会話のための、以前の応答の ID。 - - - - REASONING 層のみ。reasoning モデルの設定。例: `{"effort": "medium"}`。変更されずに転送されます。受け入れられるキーについては OpenAI の reasoning ガイドを参照してください。chat 層の id はこれを無視します。 - - - - OpenAI が生成された応答を後で取得できるように保存するかどうか。 - - - - これを送信した呼び出し元が拒否されないように宣言されていますが、このサーフェスでは不活性です。Router はディスパッチ前にこれを `false` に確定します。Router は `text/event-stream` を中継するのではなくプロバイダー応答を取得するためであり、その形式をデコードできないので、ストリーミング生成は OpenAI に課金されても誰にもメータリングされないことになります。Comfy のどのサーフェスもこのストリームを提供しません。v1 の `POST /proxy/openai/v1/responses` 入口は `stream: true` を 400 で拒否し、リクエストを上流へ転送することはありません。したがって、いずれのサーフェスでもこのフィールドを省略するか `false` を送信し、完了した応答を 1 つの JSON ボディとして読み取ってください。 - - - - サンプリング温度。CHAT 層のみ。o シリーズの reasoning id(`o1`、`o1-pro`、`o3`、`o4-mini`)は OpenAI 側でこのパラメータを拒否します。Router はそれらに対してこれを拒否しません。理由はこのコンポーネントの、2 つの層が 1 つのスキーマを共有する理由に関する注記を参照してください。そのため、これを送信する reasoning 呼び出しは OpenAI 自身のエラーによって応答されます。 - - Range: `0` から `2` - - - - 出力フォーマットの設定。例: Structured Outputs 用の `{"format": {"type": "json_schema", ...}}`。変更されずに転送されます。 - - - - モデルが使用するツールをどのように選択すべきか。文字列モード、またはツールを指定するオブジェクトのいずれか。 - - - - モデルが呼び出せるツール定義。Router はツールの分類を狭めません。受け入れられる形については OpenAI の Responses API リファレンスを参照してください。 - - - - ニュークラスサンプリングのカットオフ。CHAT 層のみで、`temperature` と同じ条件が適用されます。 - - Range: `0` から `1` - - - - コンテキストがモデルのウィンドウを超えたときの切り詰め戦略。この列挙は、上記の 3 つの語彙とは異なり、ここでは強制されます。これらの 2 つの値は OpenAI が文書化している完全な集合であり、それ以降増えていないためです。明示的な `null` は、その上のフィールドと同じ条件で依然として受け入れられます。 - - Possible values: `auto`, `disabled` - - - - トークン使用量のエンベロープ。v1 オペレーションがリクエストボディでこれを宣言しているため、この契約に存在します。OpenAI はこれを応答側で設定するため、呼び出し元がこれを送る理由はありません。 - - -`GET /v2/models/openai/o4-mini/openapi.json` で Router が提供するスキーマから生成されており、これはリクエストがプロバイダーに到達する前に Router が呼び出しを検証する際に使用するのと同じドキュメントです。 - -### 出力 - - - システム(または developer)メッセージを、モデルのコンテキストの最初の項目として挿入します。 - -`previous_response_id` と併用する場合、前のレスポンスの instructions は次のレスポンスに引き継がれません。これにより、新しいレスポンスでシステム(または developer)メッセージを簡単に差し替えられます。 - - - - レスポンスで生成できるトークン数の上限。表示される出力トークンと[推論トークン](https://platform.openai.com/docs/guides/reasoning)を含みます。 - - - - レスポンスの生成に使用されたモデル - - - - レスポンスのランダム性を制御します - - 範囲: `0` から `2` - - - - ニュークリアスサンプリングによるレスポンスの多様性を制御します - - 範囲: `0` から `1` - - - - モデルレスポンスに使用する切り詰め戦略。 -- `auto`: このレスポンスと以前のレスポンスのコンテキストがモデルのコンテキストウィンドウサイズを超える場合、モデルは会話の途中にある入力項目を削除してコンテキストウィンドウに収まるようにレスポンスを切り詰めます。 -- `disabled`(デフォルト): モデルレスポンスがモデルのコンテキストウィンドウサイズを超える場合、リクエストは 400 エラーで失敗します。 - - 使用可能な値: `auto`、`disabled` - - - - モデルへの前のレスポンスの一意の ID。これを使用してマルチターンの会話を作成します。[会話状態](https://platform.openai.com/docs/guides/conversation-state)の詳細をご覧ください。 - - - - **o シリーズモデル専用** - -[推論モデル](https://platform.openai.com/docs/guides/reasoning)の設定オプション。 - - - - 以降のターンでどの推論項目をモデルに返すかを制御します。例: `auto`、`current_turn`、`all_turns`。 - - - - **o シリーズモデル専用** - -[推論モデル](https://platform.openai.com/docs/guides/reasoning)の推論にかける努力を制約します。現在サポートされている値は `low`、`medium`、`high` です。推論の努力を減らすと、レスポンスが速くなり、レスポンス内の推論に使用されるトークンが少なくなる場合があります。 - - 使用可能な値: `low`、`medium`、`high` - - - - **非推奨:** 代わりに `summary` を使用してください。 - -モデルが実行した推論の要約。これはデバッグや、モデルの推論プロセスの理解に役立ちます。`auto`、`concise`、`detailed` のいずれかです。 - - 使用可能な値: `auto`、`concise`、`detailed` - - - - レスポンスに使用される推論モード。 - - - - モデルが実行した推論の要約。これはデバッグや、モデルの推論プロセスの理解に役立ちます。`auto`、`concise`、`detailed` のいずれかです。 - - 使用可能な値: `auto`、`concise`、`detailed` - - - - - - - - モデルが出力しなければならない形式を指定するオブジェクト。 - -`{ "type": "json_schema" }` を設定すると Structured Outputs が有効になり、モデルが指定した JSON schema に一致することが保証されます。詳細は[Structured Outputs ガイド](https://platform.openai.com/docs/guides/structured-outputs)をご覧ください。 - -デフォルトの形式は `{ "type": "text" }` で、追加のオプションはありません。 - -**gpt-4o 以降のモデルには推奨されません:** - -`{ "type": "json_object" }` に設定すると、古い JSON モードが有効になり、モデルが生成するメッセージが有効な JSON であることが保証されます。サポートしているモデルでは `json_schema` の使用が推奨されます。 - - - - モデルのレスポンスの冗長性を制約します。`low`、`medium`、`high` のいずれかです。 - - - - レスポンスを生成するときにモデルがどのツール(複数可)を選択するか。モデルが呼び出せるツールの指定方法については、`tools` パラメータを参照してください。 - - - - - - - - モデルレスポンスがバックグラウンドで実行されるかどうか。 - - - - レスポンスの課金情報。 - - - - レスポンスの支払いを担当する当事者。 - - - - この Response が完了した時点の Unix タイムスタンプ(秒)。ステータスが `completed` の場合にのみ存在します。 - - - - この Response が作成された時点の Unix タイムスタンプ(秒)。 - - - - モデルが Response の生成に失敗したときに返されるエラーオブジェクト。 - - - - レスポンスのエラーコード。 - -Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - エラーの人間が読める形式の説明。 - - - - これまでのテキスト内での既存の出現頻度に基づいて、新しいトークンにペナルティを課します。 - - - - この Response の一意の識別子。 - - - - レスポンスが不完全である理由の詳細。 - - - - レスポンスが不完全である理由。 - - 指定可能な値: `max_output_tokens`, `content_filter` - - - - 1 つのレスポンスで処理できる、組み込みツールへの総呼び出し回数の最大値。 - - - - レスポンスに添付できるキーと値のペアのセット。 - - - - モデレーション付きの補完が要求された場合の、レスポンスの入力と出力に対するモデレーション結果。 - - - - このリソースのオブジェクトタイプ。常に `response` に設定されます。 - - 指定可能な値: `response` - - - - モデルによって生成されたコンテンツ項目の配列。 - -- `output` 配列内の項目の長さと順序は、モデルの応答によって異なります。 -- `output` 配列の最初の項目にアクセスして、それがモデルによって生成された - コンテンツを含む `assistant` メッセージであると決め打ちするよりも、 - SDK でサポートされている場合は `output_text` プロパティの使用を - 検討するとよいでしょう。 - - - - `output` 配列内のすべての `output_text` 項目からの集約されたテキスト出力を含む - SDK 専用の便利なプロパティ(存在する場合)。 - Python SDK と JavaScript SDK でサポートされています。 - - - - モデルがツール呼び出しを並列で実行することを許可するかどうか。 - - - - これまでのテキストに出現するかどうかに基づいて、新しいトークンにペナルティを課します。 - - - - 類似したリクエストのレスポンスをキャッシュしてキャッシュヒット率を最適化するために OpenAI が使用します。`user` フィールドを置き換えます。 - - - - プロンプトキャッシュの保持ポリシー(例: `in_memory` または `24h`)。 - - - - OpenAI の利用ポリシーに違反している可能性のあるアプリケーションのユーザーを検出するのに役立つ安定した識別子。 - - - - リクエストの処理に使用される処理層(例: `auto`、`default`、`flex`、`scale`、`priority`)。 - - - - レスポンス生成のステータス。`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` のいずれか。 - - 指定可能な値: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - API 経由で後で取得するためにレスポンスを保存するかどうか。 - - - - 組み込みツール別に分類されたトークンとリクエストの使用量。 - - - - 画像生成ツールのトークン使用量。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Web 検索ツールの使用量。 - - - - - - - - 各トークン位置で返す、最も可能性の高いトークンの最大数(それぞれに対数確率が付随します)。 - - - - 入力トークン、出力トークン、出力トークンの内訳、 - および使用された合計トークンを含むトークン使用量の詳細を表します。 - - - - 入力トークンの数。 - - - - 入力トークンの詳細な内訳。 - - - - キャッシュに書き込まれた入力トークンの数。 - - - - キャッシュから取得されたトークン数です。 -[プロンプトキャッシュの詳細](https://platform.openai.com/docs/guides/prompt-caching)。 - - - - 出力トークン数です。 - - - - 出力トークンの詳細な内訳です。 - - - - 推論トークン数です。 - - - - 使用されたトークンの合計数です。 - - - - エンドユーザーの非推奨の識別子。`safety_identifier` と `prompt_cache_key` に置き換えられました。 - - -## 例 - -### 入力 - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### 出力 - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/ja/development/comfy-router/models/pika/pika-music/code.mdx b/ja/development/comfy-router/models/pika/pika-music/code.mdx new file mode 100644 index 0000000000..7c7406ce3e --- /dev/null +++ b/ja/development/comfy-router/models/pika/pika-music/code.mdx @@ -0,0 +1,295 @@ +--- +title: "Comfy Router で Pika Music を使用する" +description: "Comfy Router 経由で pika/pika-music を呼び出します。エンドポイント、リクエストの形状、および Router が返すレスポンスについて説明します。" +sidebarTitle: "Pika Music" +translationSourceHash: 62ef6d01 +translationFrom: development/comfy-router/models/pika/pika-music/code.mdx +translationBlockHashes: + "_intro": d1b9e7b6 + "Quick start": f073a693 + "Schema": 738d1494 + "Examples": a7cf936e +--- + +{/* GENERATED FILE. router-schemas/pika/pika-music.json から `pnpm code-pages:gen` で生成されたファイルです。 */} + +import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; + +`pika/pika-music` の API リファレンスです。Comfy Router から Pika が提供します。 + +**入力:** テキスト、オーディオ · **出力:** オーディオ + +## クイックスタート + +[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL のスニペットは、同じ呼び出しを生の HTTP で行うものです。 + +**モデル ID:** `pika/pika-music` + +**エンドポイント:** `POST https://api.comfy.org/v2/models/pika/pika-music` + + + + +```python Python +from comfy_sdk import Comfy + +# 環境変数から COMFY_API_KEY を読み取ります。 +# SDK は自動的に冪等性キーを作成し、自動リトライ時に再利用します。 +with Comfy() as client: + result = client.models.run( + "pika/pika-music", + { + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境変数から COMFY_API_KEY を読み取ります。 +// SDK は自動的に冪等性キーを作成し、自動リトライ時に再利用します。 +const { data } = await comfy.models.run("pika/pika-music", { + duration: 30, + mode: "text_to_music", + prompt: "warm lo-fi hip hop with soft piano and vinyl crackle", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-music \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}" +``` + + + +同じボディを `POST https://api.comfy.org/v2/models/pika/pika-music/requests` に送信します。Router は実行が受け付けられるとすぐに `request_id` とともに `201` を返し、結果は準備ができ次第、このプロセスまたは別のプロセスから収集します。[キュー配信](/ja/development/comfy-router/queue)では、ステータス、キャンセル、収集の流れを順を追って説明します。 + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 環境変数から COMFY_API_KEY を読み取ります。 +# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライ時に再利用します。 +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-music", + { + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle", + }, + ) + print("request_id:", handle.request_id) # モデル ID と合わせれば、別のプロセスに必要なものはこれだけです + + # リクエストが完了するまでポーリングし、サーバーが示す Retry-After の間待機します。 + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # プロバイダー自身のペイロードで、models.run() が返すのと同じ値です。 + # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを発生させます。 + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境変数から COMFY_API_KEY を読み取ります。 +// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライ時に再利用します。 +const handle = await comfy.models.submit("pika/pika-music", { + duration: 30, + mode: "text_to_music", + prompt: "warm lo-fi hip hop with soft piano and vinyl crackle", +}); +console.log("requestId:", handle.requestId); // モデル ID と合わせれば、別のプロセスに必要なものはこれだけです + +// リクエストが完了するまでポーリングし、サーバーが示す Retry-After の間待機します。 +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストはここで reject されます。 +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 送信。Router は request_id、status_url、response_url、cancel_url を付けて 201 を返します。 +curl https://api.comfy.org/v2/models/pika/pika-music/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}" + +# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが示す Retry-After 秒だけ待機します。 +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 収集。モデル固有の出力とともに 200、実行中はステータス本文とともに 202 を返します。 +curl https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## スキーマ + +### 入力 + + + 使用前に参照オーディオをクリーンアップします。 + + + + 音楽の長さ(秒)、10〜360。 + + 範囲: `10` 〜 `360` + + + + 歌唱する歌詞。 + + + + 生成モード: text_to_music、voice_conditioned_text_to_music、music_cover。 + + 指定可能な値: `text_to_music`、`voice_conditioned_text_to_music`、`music_cover` + + + + 音楽の説明。 + + + + 音声参照の URL。`voice_consent_attested` を true に設定する必要があります。 + + + + 生成前にモデルで短いプロンプトを展開します。 + + + + 再現可能な出力のためのシード、-1〜2147483647。-1 を指定するとランダムなシードが選ばれます。 + + 範囲: `-1` 〜 `2147483647` + + + + `music_cover` 用のソース曲の URL。 + + + + `reference_audio` の音声をクローンする権利を呼び出し元が有していることを証明します。 + + +このスキーマは Router が `GET /v2/models/pika/pika-music/openapi.json` で提供しているドキュメントから生成されており、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使われるのと同じドキュメントです。 + +### 出力 + + + `failed` ジョブで設定されます。 + + + + 機械可読な失敗コード。invalid_input、content_moderation、provider_error など。 + + + + 診断用テキスト。 + + + + ステータスのポーリングに使用するジョブID。 + + + + ジョブが実行した Pika カタログのエントリ。 + + + + 完了したジョブのメディア。`status` が `completed` のときに設定されます。 + + + + 生成済みのメディアファイル1つ。 + + + + ファイルの MIME タイプ。 + + + + 生成済みファイルのダウンロード URL。 + + + + ファイルを格納しているフィールド: video または audio。 + + + + 生成済みのメディアファイル1つ。 + + + + ファイルの MIME タイプ。 + + + + 生成済みファイルのダウンロード URL。 + + + + ジョブのステータス: queued、running、completed、failed。 + + + + ジョブについて Pika が報告した使用量ユニット。 + + +## 例 + +### 入力 + +```json +{ + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle" +} +``` + +### 出力 + +```json +{ + "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44", + "output": { + "audio": { + "content_type": "audio/mpeg", + "url": "https://example.invalid/pika/audio.mp3" + }, + "media_type": "audio" + }, + "status": "completed" +} +``` + + diff --git a/ja/development/comfy-router/models/pika/pika-sfx/code.mdx b/ja/development/comfy-router/models/pika/pika-sfx/code.mdx new file mode 100644 index 0000000000..a6def9794f --- /dev/null +++ b/ja/development/comfy-router/models/pika/pika-sfx/code.mdx @@ -0,0 +1,260 @@ +--- +title: "Pika Sfx を Comfy Router で使用する" +description: "Comfy Router 経由で pika/pika-sfx を呼び出す: エンドポイント、リクエスト形状、Router が返すレスポンス。" +sidebarTitle: "Pika Sfx" +translationSourceHash: 2df41acd +translationFrom: development/comfy-router/models/pika/pika-sfx/code.mdx +translationBlockHashes: + "_intro": f4076086 + "Quick start": e5b7bc82 + "Schema": c9ccd2ee + "Examples": f88686f5 +--- + +{/* GENERATED FILE. Generated from router-schemas/pika/pika-sfx.json by `pnpm code-pages:gen`. */} + +import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; + +`pika/pika-sfx` の API リファレンスです。Comfy Router が Pika から提供しています。 + +**入力:** テキスト · **出力:** オーディオ + +## クイックスタート + +[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL スニペットは、同じ呼び出しを生の HTTP で行うものです。 + +**モデル ID:** `pika/pika-sfx` + +**エンドポイント:** `POST https://api.comfy.org/v2/models/pika/pika-sfx` + + + + +```python Python +from comfy_sdk import Comfy + +# 環境変数から COMFY_API_KEY を読み取ります。 +# SDK は冪等性キーを自動的に作成し、自動リトライ時に再利用します。 +with Comfy() as client: + result = client.models.run( + "pika/pika-sfx", + { + "duration": 2, + "prompt": "a wooden door creaking open", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境変数から COMFY_API_KEY を読み取ります。 +// SDK は冪等性キーを自動的に作成し、自動リトライ時に再利用します。 +const { data } = await comfy.models.run("pika/pika-sfx", { + duration: 2, + prompt: "a wooden door creaking open", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-sfx \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" +``` + + + +同じボディを `POST https://api.comfy.org/v2/models/pika/pika-sfx/requests` に送信します。Router は実行が受け付けられるとすぐに `201` と `request_id` を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも収集できます。[キュー配信](/ja/development/comfy-router/queue)では、ステータス、キャンセル、収集の流れを順を追って説明します。 + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 環境変数から COMFY_API_KEY を読み取ります。 +# 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライ時に再利用します。 +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-sfx", + { + "duration": 2, + "prompt": "a wooden door creaking open", + }, + ) + print("request_id:", handle.request_id) # モデル ID と合わせて、別のプロセスに必要な情報はこれだけです + + # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の間待機します。 + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # プロバイダー自身のペイロードで、models.run() が返す値と同じです。 + # 失敗またはキャンセルされたリクエストは、ここで型付きの Router エラーを発生させます。 + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境変数から COMFY_API_KEY を読み取ります。 +// 各 submit() 呼び出しは独自の Idempotency-Key を発行し、自動リトライ時に再利用します。 +const handle = await comfy.models.submit("pika/pika-sfx", { + duration: 2, + prompt: "a wooden door creaking open", +}); +console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスに必要な情報はこれだけです + +// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の間待機します。 +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// models.run() が返すのと同じ結果です。失敗またはキャンセルされたリクエストは、ここで reject されます。 +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 送信。Router は 201 と request_id、status_url、response_url、cancel_url を返します。 +curl https://api.comfy.org/v2/models/pika/pika-sfx/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" + +# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが示す Retry-After 秒だけ待機します。 +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 収集。200 はモデル固有の出力、実行中は 202 とステータスボディを返します。 +curl https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## スキーマ + +### 入力 + + + サウンドエフェクトの長さ(秒単位)。1〜20。 + + 範囲: `1` から `20` + + + + サウンドエフェクトの説明。 + + + + 再現可能な出力のためのシード。-1 から 2147483647。-1 を指定するとランダムなシードが選ばれます。 + + 範囲: `-1` から `2147483647` + + +`GET /v2/models/pika/pika-sfx/openapi.json` で Router が提供するスキーマから生成されています。これは、リクエストがプロバイダーに到達する前に呼び出しを検証する際に使用されるものと同じドキュメントです。 + +### 出力 + + + `failed` のジョブで設定されます。 + + + + invalid_input、content_moderation、provider_error などの機械可読な失敗コード。 + + + + 診断用のテキスト。 + + + + ステータスのポーリングに使用するジョブID。 + + + + ジョブが実行した Pika カタログエントリ。 + + + + 完了したジョブのメディア。`status` が `completed` のときに設定されます。 + + + + 生成済みのメディアファイル1件。 + + + + ファイルの MIME タイプ。 + + + + 生成されたファイルのダウンロード URL。 + + + + ファイルを格納するフィールド: video または audio。 + + + + 生成済みのメディアファイル1件。 + + + + ファイルの MIME タイプ。 + + + + 生成されたファイルのダウンロード URL。 + + + + ジョブのステータス: queued、running、completed、failed。 + + + + Pika がジョブについて報告したユニット数。 + + +## 例 + +### 入力 + +```json +{ + "duration": 2, + "prompt": "a wooden door creaking open" +} +``` + +### 出力 + +```json +{ + "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44", + "output": { + "audio": { + "content_type": "audio/mpeg", + "url": "https://example.invalid/pika/audio.mp3" + }, + "media_type": "audio" + }, + "status": "completed" +} +``` + + diff --git a/ja/development/comfy-router/models/pika/pika-soundtrack/code.mdx b/ja/development/comfy-router/models/pika/pika-soundtrack/code.mdx new file mode 100644 index 0000000000..520cec0979 --- /dev/null +++ b/ja/development/comfy-router/models/pika/pika-soundtrack/code.mdx @@ -0,0 +1,258 @@ +--- +title: "Comfy Router で Pika Soundtrack を使用する" +description: "Comfy Router 経由で pika/pika-soundtrack を呼び出します: エンドポイント、リクエストの形状、Router が返すレスポンスについて説明します。" +sidebarTitle: "Pika Soundtrack" +translationSourceHash: f897473f +translationFrom: development/comfy-router/models/pika/pika-soundtrack/code.mdx +translationBlockHashes: + "_intro": 51801b91 + "Quick start": f4397b26 + "Schema": 48e8da0c + "Examples": 3da11fda +--- + +{/* GENERATED FILE. Generated from router-schemas/pika/pika-soundtrack.json by `pnpm code-pages:gen`. */} + +import RouterCodeFooter from "/snippets/ja/comfy-router/model-code-footer.mdx"; + +`pika/pika-soundtrack` の API リファレンスです。Comfy Router が Pika から提供します。 + +**入力:** ビデオ、テキスト · **出力:** ビデオ + オーディオ + +## クイックスタート + +[Comfy ワークスペース](https://platform.comfy.org/profile/api-keys?onboarding=router)でキーを作成し、`COMFY_API_KEY` としてエクスポートします。Python と TypeScript のスニペットは Comfy SDK(`pip install comfy-sdk` と `npm install @comfyorg/sdk`)を使用しています。cURL のスニペットは同じ呼び出しを生の HTTP で行うものです。 + +**モデル ID:** `pika/pika-soundtrack` + +**エンドポイント:** `POST https://api.comfy.org/v2/models/pika/pika-soundtrack` + + + + +```python Python +from comfy_sdk import Comfy + +# 環境から COMFY_API_KEY を読み取ります。 +# SDK は自動的に冪等性キーを作成し、自動リトライで再利用します。 +with Comfy() as client: + result = client.models.run( + "pika/pika-soundtrack", + { + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境から COMFY_API_KEY を読み取ります。 +// SDK は自動的に冪等性キーを作成し、自動リトライで再利用します。 +const { data } = await comfy.models.run("pika/pika-soundtrack", { + seed: -1, + video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-soundtrack \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" +``` + + + +同じボディを `POST https://api.comfy.org/v2/models/pika/pika-soundtrack/requests` に送信します。Router は実行が受け付けられるとすぐに `201` と `request_id` を返し、結果は準備ができ次第、このプロセスからでも別のプロセスからでも収集できます。[キュー配信](/ja/development/comfy-router/queue)では、ステータス、キャンセル、収集の流れを順に説明します。 + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 環境から COMFY_API_KEY を読み取ります。 +# submit() を呼び出すたびに独自の Idempotency-Key を発行し、自動リトライで再利用します。 +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-soundtrack", + { + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", + }, + ) + print("request_id:", handle.request_id) # モデル ID と合わせて、別のプロセスに必要なのはこれだけです + + # リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。 + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # プロバイダー自身のペイロードで、models.run() が返す値と同じです。 + # 失敗またはキャンセル済みのリクエストは、ここで型付きの Router エラーを送出します。 + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 環境から COMFY_API_KEY を読み取ります。 +// submit() を呼び出すたびに独自の Idempotency-Key を発行し、自動リトライで再利用します。 +const handle = await comfy.models.submit("pika/pika-soundtrack", { + seed: -1, + video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", +}); +console.log("requestId:", handle.requestId); // モデル ID と合わせて、別のプロセスに必要なのはこれだけです + +// リクエストが完了するまでポーリングし、サーバーが指定する Retry-After の時間だけ待機します。 +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// models.run() が返すのと同じ結果です。失敗またはキャンセル済みのリクエストはここで reject されます。 +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 送信。Router は request_id、status_url、response_url、cancel_url とともに 201 を返します。 +curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" + +# 2. ステータスが COMPLETED になるまでポーリングし、各レスポンスが指定する Retry-After の秒数だけ待機します。 +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 収集。200 ならモデルのネイティブ出力、実行中なら 202 とステータスボディを返します。 +curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## スキーマ + +### 入力 + + + オーディオがどうあるべきか、そしてアクションにどう追従するか。ビデオのみからサウンドデザインを行う場合は省略します。 + + + + -1 から 2147483647 までのシード。-1 を指定するとランダムなシードが選ばれます。 + + 範囲: `-1` から `2147483647` + + + + ソースビデオの URL。H.264 または HEVC、最大 1200 秒、2 GB まで。 + + +Router が `GET /v2/models/pika/pika-soundtrack/openapi.json` で提供するスキーマから生成されており、リクエストがプロバイダーに到達する前に呼び出しを検証するのと同じドキュメントです。 + +### 出力 + + + `failed` ジョブの場合に設定されます。 + + + + 機械可読な失敗コード。invalid_input、content_moderation、provider_error など。 + + + + 診断用テキスト。 + + + + ステータスのポーリングに使用するジョブID。 + + + + ジョブが実行した Pika カタログエントリ。 + + + + 完了したジョブのメディア。`status` が `completed` の場合に設定されます。 + + + + 生成済みメディアファイル 1 件。 + + + + ファイルの MIME タイプ。 + + + + 生成済みファイルのダウンロード URL。 + + + + ファイルを格納するフィールド: video または audio。 + + + + 生成済みメディアファイル 1 件。 + + + + ファイルの MIME タイプ。 + + + + 生成済みファイルのダウンロード URL。 + + + + ジョブのステータス: queued、running、completed、failed。 + + + + Pika がジョブについて報告したユニット数。 + + +## 例 + +### 入力 + +```json +{ + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4" +} +``` + +### 出力 + +```json +{ + "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0", + "output": { + "media_type": "video", + "video": { + "content_type": "video/mp4", + "url": "https://example.invalid/pika/video.mp4" + } + }, + "status": "completed" +} +``` + + diff --git a/ja/development/comfy-router/pricing.mdx b/ja/development/comfy-router/pricing.mdx index 480c065c3f..c47f6f5db5 100644 --- a/ja/development/comfy-router/pricing.mdx +++ b/ja/development/comfy-router/pricing.mdx @@ -131,26 +131,26 @@ Comfy の使用量ベース料金は GPU 秒単位です。実際の料金は GP | [Qwen Image 3.0 Pro](/ja/development/comfy-router/models/qwen/qwen-image-3-0-pro/code) | `qwen/qwen-image-3.0-pro` | 入力画像 · 1K / 2K | 0.9052 / 入力画像 | | [Seedream 5.0 Pro](/ja/development/comfy-router/models/byteplus/seedream-5-0-pro-260628/code) | `byteplus/seedream-5-0-pro-260628` | 2 枚目以降の入力画像 | 0.633 / 入力画像 | -#### Recraft creditあたりの料金 +#### Recraft クレジットあたりの料金 | 名前 | モデル ID | クレジット | | --- | --- | ---: | -| [Recraft V2](/ja/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | 0.3017 / Recraft credit | -| [Recraft V3](/ja/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | 0.3017 / Recraft credit | -| [Recraft V4](/ja/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | 0.3017 / Recraft credit | -| [Recraft V4 Pro](/ja/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | 0.3017 / Recraft credit | -| [Recraft V4 Styles](/ja/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Pro](/ja/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Vector](/ja/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1](/ja/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | 0.3017 / Recraft credit | -| [Recraft V4.1 Pro](/ja/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | 0.3017 / Recraft credit | -| [Recraft V4.1 Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility](/ja/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Pro](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | 0.3017 / Recraft credit | +| [Recraft V2](/ja/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | 0.3017 / Recraft クレジット | +| [Recraft V3](/ja/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | 0.3017 / Recraft クレジット | +| [Recraft V4](/ja/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | 0.3017 / Recraft クレジット | +| [Recraft V4 Pro](/ja/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | 0.3017 / Recraft クレジット | +| [Recraft V4 Styles](/ja/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | 0.3017 / Recraft クレジット | +| [Recraft V4 Styles Pro](/ja/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | 0.3017 / Recraft クレジット | +| [Recraft V4 Styles Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | 0.3017 / Recraft クレジット | +| [Recraft V4 Styles Vector](/ja/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | 0.3017 / Recraft クレジット | +| [Recraft V4.1](/ja/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | 0.3017 / Recraft クレジット | +| [Recraft V4.1 Pro](/ja/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | 0.3017 / Recraft クレジット | +| [Recraft V4.1 Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | 0.3017 / Recraft クレジット | +| [Recraft V4.1 Utility](/ja/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | 0.3017 / Recraft クレジット | +| [Recraft V4.1 Utility Pro](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | 0.3017 / Recraft クレジット | +| [Recraft V4.1 Utility Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | 0.3017 / Recraft クレジット | +| [Recraft V4.1 Utility Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | 0.3017 / Recraft クレジット | +| [Recraft V4.1 Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | 0.3017 / Recraft クレジット | #### 参照画像あたりの料金 @@ -392,7 +392,7 @@ Ray 3.2 の EXR エクスポートはまだ利用できません。HDR リクエ | --- | --- | --- | ---: | | [Aleph 2](/ja/development/comfy-router/models/runway/aleph2/code) | `runway/aleph2` | - | 84.4844 / s | | [Gen 4 Turbo](/ja/development/comfy-router/models/runway/gen4-turbo/code) | `runway/gen4_turbo` | - | 15.0865 / s | -| [Pika Soundtrack](/ja/development/comfy-router/models) | `pika/pika-soundtrack` | Input video | 1.50865 / s | +| [Pika Soundtrack](/ja/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Input video | 1.50865 / s | | [Sync 3](/ja/development/comfy-router/models/synclabs/sync-3/code) | `synclabs/sync-3` | - | 40.1301 / s | | [Erase](/ja/development/comfy-router/models/bria/video-edit-erase/code) | `bria/video-edit-erase` | - | 13.5778 / s | | [Green Screen](/ja/development/comfy-router/models/bria/video-edit-green-screen/code) | `bria/video-edit-green-screen` | - | 10.55 / s | @@ -596,8 +596,8 @@ Comfy の使用量ベース料金は GPU 秒単位です。実際の料金は GP | [Google Gemini](/ja/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-2.5-pro` | - | 音声 / 画像 / テキスト / 動画: 263.75 | テキスト: 2110 | | [Google Gemini](/ja/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.1-pro-preview` | - | 音声 / 画像 / テキスト / 動画: 422 | テキスト / 推論: 2532
画像: 25320 | | [Google Gemini](/ja/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.5-flash` | - | 音声 / 画像 / テキスト / 動画: 316.5 | テキスト / 推論: 1899 | -| [GPT 6.1 Sol](/ja/development/comfy-router/models) | `openai/gpt-6.1-sol` | 読み取り: 30.173
書き込み: 754.325 | テキスト: 603.46 | テキスト: 3017.3 | -| [GPT 6.1 Terra](/ja/development/comfy-router/models) | `openai/gpt-6.1-terra` | 読み取り: 15.0865
書き込み: 377.1625 | テキスト: 301.73 | テキスト: 1508.65 | +| [GPT 6.1 Sol](/ja/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | 読み取り: 30.173
書き込み: 754.325 | テキスト: 603.46 | テキスト: 3017.3 | +| [GPT 6.1 Terra](/ja/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | 読み取り: 15.0865
書き込み: 377.1625 | テキスト: 301.73 | テキスト: 1508.65 | | [GPT 6 Astra](/ja/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | 読み取り: 301.73
書き込み: 3771.625 | テキスト: 3017.3 | テキスト: 15086.5 | | [GPT 6 Luna](/ja/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | 読み取り: 3.0173
書き込み: 37.7162 | テキスト: 30.173 | テキスト: 150.865 | | [GPT 6 Sol](/ja/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | 読み取り: 60.346
書き込み: 754.325 | テキスト: 603.46 | テキスト: 3017.3 | @@ -642,22 +642,22 @@ Comfy の使用量ベース料金は GPU 秒単位です。実際の料金は GP | --- | --- | ---: | | [Clean Audio](/ja/development/comfy-router/models/veed/clean-audio/code) | `veed/clean-audio` | 未公開 | -#### 1K charactersあたりの料金 +#### 1K 文字あたりの料金 | 名前 | モデル ID | オプション | クレジット | | --- | --- | --- | ---: | -| [Eleven Multilingual V2](/ja/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 音声合成 | 50.64 / 1K characters | -| [Eleven V3](/ja/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 対話 / 音声合成 | 21.1 / 1K characters | -| [Eleven V4](/ja/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 対話 | 24.1384 / 1K characters | -| [Eleven V4 Turbo](/ja/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 対話 | 12.0692 / 1K characters | +| [Eleven Multilingual V2](/ja/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 音声合成 | 50.64 / 1K 文字 | +| [Eleven V3](/ja/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 対話 / 音声合成 | 21.1 / 1K 文字 | +| [Eleven V4](/ja/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 対話 | 24.1384 / 1K 文字 | +| [Eleven V4 Turbo](/ja/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 対話 | 12.0692 / 1K 文字 | #### 時間別の料金 | 名前 | モデル ID | クレジット | | --- | --- | ---: | | [Eleven Sfx V2](/ja/development/comfy-router/models/elevenlabs/eleven-sfx-v2/code) | `elevenlabs/eleven_sfx_v2` | 29.54 / 分 | -| [Pika Music](/ja/development/comfy-router/models) | `pika/pika-music` | 4.52595 / 分 | -| [Pika Sfx](/ja/development/comfy-router/models) | `pika/pika-sfx` | 0.060346 / s | +| [Pika Music](/ja/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | 4.52595 / 分 | +| [Pika Sfx](/ja/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | 0.060346 / s | | [Seed Audio 1.0](/ja/development/comfy-router/models/byteplus/seed-audio-1-0/code) | `byteplus/seed-audio-1.0` | 0.7543 / s | | [Seed Audio 1.0 Multilingual](/ja/development/comfy-router/models/byteplus/seed-audio-1-0-multilingual/code) | `byteplus/seed-audio-1.0-multilingual` | 0.7543 / s | | [Starfish](/ja/development/comfy-router/models/heygen/starfish/code) | `heygen/starfish` | 0.2013 / s | @@ -820,26 +820,26 @@ Comfy の使用量ベース料金は GPU 秒単位です。実際の料金は GP | [Qwen Image 3.0 Pro](/ja/development/comfy-router/models/qwen/qwen-image-3-0-pro/code) | `qwen/qwen-image-3.0-pro` | 入力画像 · 1K / 2K | $0.00429 / 入力画像 | | [Seedream 5.0 Pro](/ja/development/comfy-router/models/byteplus/seedream-5-0-pro-260628/code) | `byteplus/seedream-5-0-pro-260628` | 2 枚目以降の入力画像 | $0.003 / 入力画像 | -#### Recraft creditあたりの料金 +#### Recraft クレジットあたりの料金 | 名前 | モデル ID | USD | | --- | --- | ---: | -| [Recraft V2](/ja/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | $0.00143 / Recraft credit | -| [Recraft V3](/ja/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | $0.00143 / Recraft credit | -| [Recraft V4](/ja/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | $0.00143 / Recraft credit | -| [Recraft V4 Pro](/ja/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | $0.00143 / Recraft credit | -| [Recraft V4 Styles](/ja/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Pro](/ja/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Vector](/ja/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1](/ja/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | $0.00143 / Recraft credit | -| [Recraft V4.1 Pro](/ja/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | $0.00143 / Recraft credit | -| [Recraft V4.1 Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility](/ja/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Pro](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | $0.00143 / Recraft credit | +| [Recraft V2](/ja/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | $0.00143 / Recraft クレジット | +| [Recraft V3](/ja/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | $0.00143 / Recraft クレジット | +| [Recraft V4](/ja/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | $0.00143 / Recraft クレジット | +| [Recraft V4 Pro](/ja/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | $0.00143 / Recraft クレジット | +| [Recraft V4 Styles](/ja/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | $0.00143 / Recraft クレジット | +| [Recraft V4 Styles Pro](/ja/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | $0.00143 / Recraft クレジット | +| [Recraft V4 Styles Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | $0.00143 / Recraft クレジット | +| [Recraft V4 Styles Vector](/ja/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | $0.00143 / Recraft クレジット | +| [Recraft V4.1](/ja/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | $0.00143 / Recraft クレジット | +| [Recraft V4.1 Pro](/ja/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | $0.00143 / Recraft クレジット | +| [Recraft V4.1 Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | $0.00143 / Recraft クレジット | +| [Recraft V4.1 Utility](/ja/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | $0.00143 / Recraft クレジット | +| [Recraft V4.1 Utility Pro](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | $0.00143 / Recraft クレジット | +| [Recraft V4.1 Utility Pro Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | $0.00143 / Recraft クレジット | +| [Recraft V4.1 Utility Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | $0.00143 / Recraft クレジット | +| [Recraft V4.1 Vector](/ja/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | $0.00143 / Recraft クレジット | #### 参照画像あたりの料金 @@ -1081,7 +1081,7 @@ Ray 3.2 の EXR エクスポートはまだ利用できません。HDR リクエ | --- | --- | --- | ---: | | [Aleph 2](/ja/development/comfy-router/models/runway/aleph2/code) | `runway/aleph2` | - | $0.4004 / s | | [Gen 4 Turbo](/ja/development/comfy-router/models/runway/gen4-turbo/code) | `runway/gen4_turbo` | - | $0.0715 / s | -| [Pika Soundtrack](/ja/development/comfy-router/models) | `pika/pika-soundtrack` | Input video | $0.00715 / s | +| [Pika Soundtrack](/ja/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Input video | $0.00715 / s | | [Sync 3](/ja/development/comfy-router/models/synclabs/sync-3/code) | `synclabs/sync-3` | - | $0.19019 / s | | [Erase](/ja/development/comfy-router/models/bria/video-edit-erase/code) | `bria/video-edit-erase` | - | $0.06435 / s | | [Green Screen](/ja/development/comfy-router/models/bria/video-edit-green-screen/code) | `bria/video-edit-green-screen` | - | $0.05 / s | @@ -1285,8 +1285,8 @@ Comfy の使用量ベース料金は GPU 秒単位です。実際の料金は GP | [Google Gemini](/ja/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-2.5-pro` | - | 音声 / 画像 / テキスト / 動画: $1.25 | テキスト: $10.00 | | [Google Gemini](/ja/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.1-pro-preview` | - | 音声 / 画像 / テキスト / 動画: $2.00 | テキスト / 推論: $12.00
画像: $120.00 | | [Google Gemini](/ja/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.5-flash` | - | 音声 / 画像 / テキスト / 動画: $1.50 | テキスト / 推論: $9.00 | -| [GPT 6.1 Sol](/ja/development/comfy-router/models) | `openai/gpt-6.1-sol` | 読み取り: $0.143
書き込み: $3.575 | テキスト: $2.86 | テキスト: $14.30 | -| [GPT 6.1 Terra](/ja/development/comfy-router/models) | `openai/gpt-6.1-terra` | 読み取り: $0.0715
書き込み: $1.7875 | テキスト: $1.43 | テキスト: $7.15 | +| [GPT 6.1 Sol](/ja/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | 読み取り: $0.143
書き込み: $3.575 | テキスト: $2.86 | テキスト: $14.30 | +| [GPT 6.1 Terra](/ja/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | 読み取り: $0.0715
書き込み: $1.7875 | テキスト: $1.43 | テキスト: $7.15 | | [GPT 6 Astra](/ja/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | 読み取り: $1.43
書き込み: $17.875 | テキスト: $14.30 | テキスト: $71.50 | | [GPT 6 Luna](/ja/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | 読み取り: $0.0143
書き込み: $0.17875 | テキスト: $0.143 | テキスト: $0.715 | | [GPT 6 Sol](/ja/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | 読み取り: $0.286
書き込み: $3.575 | テキスト: $2.86 | テキスト: $14.30 | @@ -1331,22 +1331,22 @@ Comfy の使用量ベース料金は GPU 秒単位です。実際の料金は GP | --- | --- | ---: | | [Clean Audio](/ja/development/comfy-router/models/veed/clean-audio/code) | `veed/clean-audio` | 未公開 | -#### 1K charactersあたりの料金 +#### 1K 文字あたりの料金 | 名前 | モデル ID | オプション | USD | | --- | --- | --- | ---: | -| [Eleven Multilingual V2](/ja/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 音声合成 | $0.24 / 1K characters | -| [Eleven V3](/ja/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 対話 / 音声合成 | $0.10 / 1K characters | -| [Eleven V4](/ja/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 対話 | $0.1144 / 1K characters | -| [Eleven V4 Turbo](/ja/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 対話 | $0.0572 / 1K characters | +| [Eleven Multilingual V2](/ja/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 音声合成 | $0.24 / 1K 文字 | +| [Eleven V3](/ja/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 対話 / 音声合成 | $0.10 / 1K 文字 | +| [Eleven V4](/ja/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 対話 | $0.1144 / 1K 文字 | +| [Eleven V4 Turbo](/ja/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 対話 | $0.0572 / 1K 文字 | #### 時間別の料金 | 名前 | モデル ID | USD | | --- | --- | ---: | | [Eleven Sfx V2](/ja/development/comfy-router/models/elevenlabs/eleven-sfx-v2/code) | `elevenlabs/eleven_sfx_v2` | $0.14 / 分 | -| [Pika Music](/ja/development/comfy-router/models) | `pika/pika-music` | $0.02145 / 分 | -| [Pika Sfx](/ja/development/comfy-router/models) | `pika/pika-sfx` | $0.000286 / s | +| [Pika Music](/ja/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | $0.02145 / 分 | +| [Pika Sfx](/ja/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | $0.000286 / s | | [Seed Audio 1.0](/ja/development/comfy-router/models/byteplus/seed-audio-1-0/code) | `byteplus/seed-audio-1.0` | $0.003575 / s | | [Seed Audio 1.0 Multilingual](/ja/development/comfy-router/models/byteplus/seed-audio-1-0-multilingual/code) | `byteplus/seed-audio-1.0-multilingual` | $0.003575 / s | | [Starfish](/ja/development/comfy-router/models/heygen/starfish/code) | `heygen/starfish` | $0.000954 / s | diff --git a/ko/custom-nodes/js/canvas-pointer-api.mdx b/ko/custom-nodes/js/canvas-pointer-api.mdx new file mode 100644 index 0000000000..07dd757e85 --- /dev/null +++ b/ko/custom-nodes/js/canvas-pointer-api.mdx @@ -0,0 +1,78 @@ +--- +title: "위젯과 커서를 위한 캔버스 포인터 API" +sidebarTitle: "캔버스 포인터 API" +description: "onPointerDown으로 사용자 정의 캔버스 위젯의 클릭, 더블클릭, 드래그를 처리하고, ComfyUI 프런트엔드 확장에서 캔버스 커서를 제어하는 방법을 설명합니다." +translationSourceHash: 16ea7f38 +translationFrom: custom-nodes/js/canvas-pointer-api.mdx +translationBlockHashes: + "_intro": b1d4c464 + "Default behavior": 27a8751b + "Handle pointer input on a widget": e4fc63fc + "Control the canvas cursor": 9bcc33c8 +--- + +캔버스는 포인터 입력을 `CanvasPointer`를 통해 라우팅합니다. `CanvasPointer`는 누름이 클릭, 더블 클릭 또는 드래그가 되는지를 결정하고, 해당 누름에 대해 할당한 콜백을 실행합니다. 캔버스에 그려진 위젯은 `onPointerDown`을 통해 이를 사용합니다. + +## 기본 동작 + +- 선택된 항목이 여러 개일 때 더 이상 Shift를 누른 채 드래그할 필요가 없습니다. 여러 항목이 선택된 상태에서 하나를 클릭하면 나머지는 여전히 선택 해제됩니다. +- 입력에 연결된 링크를 클릭해도 더 이상 연결이 끊겼다가 다시 연결되지 않습니다. +- 포인터 다운과 포인터 업 사이의 약간의 움직임은 여전히 클릭으로 간주됩니다. 포인터가 클릭 드리프트 한도를 넘어 이동하면 해당 누름은 드래그가 됩니다. 시간은 이 판단에 영향을 주지 않습니다. +- 더블 클릭은 더블 클릭 시간 내에 두 번의 누름이 필요하며, 두 누름은 클릭 드리프트의 최대 세 배 이내로 떨어져 있어야 합니다. `onDoubleClick`을 할당하는 누름만이 더블 클릭을 완료할 수 있습니다. + +사용자는 설정에서 클릭 드리프트와 더블 클릭 시간을 지정합니다 +(`Comfy.Pointer.ClickDrift` 및 `Comfy.Pointer.DoubleClickTime`). + +### 여러 항목 선택 + +- `Ctrl` + 드래그: 다중 선택 시작 +- `Ctrl` + `Shift` + 드래그: 선택 항목에 추가 +- `Ctrl` + 드래그 후 `Shift`: 선택 항목에 추가 +- `Ctrl` + 드래그 후 `Alt`: 선택 항목에서 제거 + +## 위젯에서 포인터 입력 처리하기 + +위젯에 `onPointerDown`을 지정합니다. 이 함수는 포인터를 누를 때 실행되며 포인터, 노드, 캔버스를 인자로 받습니다. 필요한 콜백을 포인터에 지정하면 누름이 확정될 때 캔버스가 알맞은 콜백을 실행합니다. + +```js +widget.onPointerDown = function (pointer, node, canvas) { + const e = pointer.eDown + const offsetFromNode = [e.canvasX - node.pos[0], e.canvasY - node.pos[1]] + + pointer.onClick = (upEvent) => { + console.log(pointer.eDown, pointer.eMove, pointer.eUp) + } + pointer.onDoubleClick = (upEvent) => this.customFunction(upEvent) + + pointer.onDragStart = () => {} + pointer.onDrag = (moveEvent) => {} + pointer.onDragEnd = (upEvent) => {} + pointer.onDragCancel = () => {} + + pointer.finally = () => {} + + return true +} +``` + +- `onClick`과 `onDoubleClick`은 `onDragStart`, `onDragEnd`, `onDragCancel`과 같은 누름에서 실행되지 않습니다. `onDrag`는 클릭으로 끝나는 누름에서도 실행될 수 있습니다. 클릭 드리프트 범위 안의 이동도 전달받기 때문입니다. +- `onDragStart`는 드래그마다 한 번, 포인터가 처음으로 클릭 드리프트 범위를 넘어설 때 실행됩니다. 이동 이벤트가 보고되기 전에 포인터가 범위를 넘어선 상태로 놓이면 `onDragStart`는 놓는 시점에 실행되고 `onDragEnd`가 바로 이어서 실행되며 `onDrag`는 실행되지 않습니다. +- 한 번의 누름에 `onClick`과 `onDoubleClick`을 모두 지정한 경우, 더블클릭의 첫 번째 누름을 놓으면 `onClick`이 실행됩니다. 두 번째 누름에서는 `onClick` 대신 `onDoubleClick`이 실행되므로 `onClick`은 먼저 실행되어도 안전해야 합니다. 첫 번째 클릭이 위젯이 아닌 근처 항목에 떨어질 수도 있으므로 `onClick`이 실행되지 않은 채로 `onDoubleClick`이 실행될 수 있습니다. +- `onDragEnd`는 드래그의 포인터 업 이벤트를 받습니다. 드래그가 중단되면(예: 포인터 캡처 상실) 대신 `onDragCancel`이 실행됩니다. +- `finally`는 누름이 끝날 때 한 번 실행됩니다. `pointer.finally`를 지정하면 교체되는 콜백이 즉시 실행됩니다. `onPointerDown`이 `true`를 반환하지 않으면 캔버스가 자체 `finally`를 지정하므로, 지정한 콜백은 포인터를 누르는 동안 실행됩니다. 정리에 `finally`를 사용한다면 `true`를 반환하세요. +- `pointer.eDown`, `pointer.eMove`, `pointer.eUp`을 통해 모든 콜백이 이벤트 흐름 전체에 접근할 수 있습니다. +- 캔버스가 누름을 직접 처리하지 않게 하려면 `true`를 반환합니다. +- `onPointerDown`을 추가할 때는 기존 `widget.mouse` 핸들러를 제거하세요. `onPointerDown`이 `true`를 반환하면 캔버스는 놓은 뒤에도 위젯을 계속 추적하며 포인터가 이동할 때마다 `widget.mouse`를 계속 호출합니다. + +캔버스가 더블클릭과 드래그를 대신 판정하므로 위젯이 개별 포인터 이벤트의 시간이나 거리를 측정할 필요가 없습니다. 사용자의 클릭 드리프트와 더블클릭 설정도 그대로 따릅니다. + +## 캔버스 커서 제어 + +`canvas.state.hoveringOver`에는 포인터 아래에 있는 항목 유형(예: 노드, 그룹, 경유점, 링크)에 대한 비트 플래그가 저장됩니다. 캔버스가 커서 스타일을 설정하지 않도록 하려면 `canvas.state.shouldSetCursor`를 `false`로 설정한 다음, 직접 커서를 설정하세요: + +```js +canvas.state.shouldSetCursor = false +canvas.canvas.style.cursor = 'pointer' +``` + +노드 크기 조정을 시작하면 `shouldSetCursor`가 `false`인 상태에서도 여전히 크기 조정 커서가 설정됩니다. 크기 조정이 끝난 이후에 커서를 다시 설정하세요. diff --git a/ko/custom-nodes/js/connection-callbacks-migration.mdx b/ko/custom-nodes/js/connection-callbacks-migration.mdx new file mode 100644 index 0000000000..2c379c868b --- /dev/null +++ b/ko/custom-nodes/js/connection-callbacks-migration.mdx @@ -0,0 +1,131 @@ +--- +title: "프론트엔드 확장 프로그램을 위한 연결 콜백 마이그레이션" +sidebarTitle: "연결 콜백 마이그레이션" +description: "onConnectionsChange 및 노드 제거 콜백의 순서, 서브그래프 경계에서의 SubgraphIO, 그리고 ComfyUI 확장 프로그램에서의 graph.events." +translationSourceHash: 06a9ae24 +translationFrom: custom-nodes/js/connection-callbacks-migration.mdx +translationBlockHashes: + "_intro": cd84d91b + "Check for SubgraphIO at subgraph boundaries": c049a9fe + "Subscribe to node lifecycle events with graph.events": 1100692e + "Node removal fires callbacks in this order (partially tested)": 720324f8 + "Workflow load resolves peer nodes before onConnectionsChange runs": 2b775215 + "API prompt import does not reconnect resolved inputs": 619d6b69 + "Reject connections before they are made": b9b94a8e + "Removing a link inside the output callback skips the input callback": 3317def4 + "Replace removed slot events": 5c3ec663 + "Read connection state from callback arguments or node methods": 9da17ab0 +--- + +콜백 시그니처는 변경되지 않았습니다. `onConnectionsChange`, `onConnectInput`, +`onConnectOutput`, `onBeforeConnectInput`은 기존 인자와 타이밍을 그대로 유지합니다. +링크 등록 및 `LinkNetwork` API 변경 사항은 +[링크 등록 마이그레이션](/ko/custom-nodes/js/link-registration-migration)을 참조하세요. + +## 서브그래프 경계에서 SubgraphIO 확인하기 + +서브그래프 경계(`SubgraphInput` 또는 `SubgraphOutput`)에서도 `onConnectionsChange`는 실행되지만, 다섯 번째 인자는 일반적인 `INodeInputSlot`/`INodeOutputSlot`이 아니라 `SubgraphIO`입니다. 해당 인자를 일반 슬롯으로 다루기 전에 먼저 확인하세요. 프런트엔드의 `isSubgraphInput`과 `isSubgraphOutput` 가드는 확장에 노출되지 않으므로, 모든 `SubgraphIO`가 가지고 노드 슬롯은 가지지 않는 `linkIds` 배열과 `parent` 노드를 확인합니다. + +```js +function isSubgraphIO(slot) { + return slot != null && Array.isArray(slot.linkIds) && 'parent' in slot +} + +nodeType.prototype.onConnectionsChange = function ( + type, + index, + isConnected, + link, + slotOrIO +) { + if (isSubgraphIO(slotOrIO)) return + // slotOrIO is INodeInputSlot | INodeOutputSlot +} +``` + +## graph.events로 노드 수명 주기 이벤트 구독하기 + +`graph.events`는 `node:added`, `node:before-removed`, `node:removed`를 전달합니다. 확장의 여러 부분에서 노드가 추가되거나 제거되는 것을 관찰해야 할 때 사용하세요: + +```ts +graph.events.addEventListener('node:added', (e) => { + console.log('added', e.detail.node.id) +}) +``` + +`node.onAdded`, `node.onRemoved`, 그리고 단일 슬롯인 `graph.onNodeAdded`/`graph.onNodeRemoved`도 여전히 동작하지만, `graph.onNodeAdded`에 할당하면 기존 핸들러가 교체됩니다. 즉, 두 번째 구독자가 첫 번째 구독자를 조용히 밀어냅니다. 추가/제거 과정에서 거부하거나 변경해야 하는 경우가 아니라면 `graph.events`를 사용하는 것이 좋습니다. connect/disconnect에 대해서는 다중 구독자에 해당하는 기능이 없으며, `onConnectionsChange`가 여전히 연결별 유일한 훅입니다. + +## 노드 제거 시 콜백은 다음 순서로 발생합니다 (부분적으로 테스트됨) + +노드를 제거하면 다음 순서로 콜백이 발생합니다: + +1. `node:before-removed`: 노드는 여전히 완전히 연결된 상태입니다. +2. 제거되는 노드와 연결된 각 피어에서 `onConnectionsChange(..., false, ...)`가 + 호출되며, 이때 제거되는 노드는 아직 그래프에 남아 있습니다. +3. `node.onRemoved()`: `node.graph`가 여전히 설정되어 있습니다. +4. 노드가 그래프 인덱스와 저장소에서 분리되고, `node.graph`가 + `null`이 됩니다. +5. `onNodeRemoved(node)`, 그다음 `node:removed`가 호출되며, 둘 다 이미 + 분리된 노드를 봅니다. + +테스트는 `node:before-removed → node.onRemoved() → onNodeRemoved(node)`를 +다루고, 별도로 `node:removed`가 분리된 노드를 본다는 점을 검증합니다. 2단계를 +포함한 전체 순서는 소스에서 관찰된 것이며, 하나의 엔드투엔드 테스트로 보장되는 +것은 아닙니다. + +피어의 `onConnectionsChange` 핸들러에서 제거된 노드를 확인하려면 2단계에서 +`graph.getNodeById()`를 통해 확인하세요. `node:removed` 시점에는 노드가 이미 +사라진 뒤입니다. + +## 워크플로 로드 시 onConnectionsChange가 실행되기 전에 피어 노드가 해석됩니다 + +`graph.configure()`는 워크플로의 모든 노드를 생성한 다음 각 노드의 `configure()`가 +실행되면서 복원된 링크에 대해 `onConnectionsChange`를 발생시킵니다. 따라서 로드 중에 +`onConnectionsChange` 콜백이 실행될 때는 모든 피어 노드가 이미 존재하고 해당 링크도 +이미 등록되어 있으므로, 그 콜백 내부에서의 `graph.getNodeById()`와 링크 조회가 +올바르게 해석됩니다. + +## API 프롬프트 가져오기는 확인된 입력을 다시 연결하지 않습니다 + +`app.loadApiJson()`은 두 번째 연결 해제/재연결 패스를 실행하지 않고 확인 가능한 각 입력을 연결합니다. 확장 프로그램은 API 프롬프트 가져오기 중에 복제된 `onConnectionsChange` 알림에 의존해서는 안 됩니다. 각 연결 핸들러가 첫 번째 알림에서 작업을 수행하도록 하고, 가져온 그래프 전체가 필요로 하는 작업은 `afterConfigureGraph` 또는 `afterLoadGraph`로 옮기십시오. + +소스 출력이나 대상 슬롯이 아직 존재하지 않는 입력은 패스가 진행되는 동안 재시도됩니다. 이는 동적 입력 동작을 유지합니다: 성공한 연결이 나중에 대기 중인 연결에 필요한 슬롯을 생성할 수 있습니다. 이미 확인된 연결은 반복되지 않으며, 확장에서 거부된 연결은 엔드포인트를 사용할 수 있게 되어도 재시도되지 않습니다. + +이는 API 프롬프트 가져오기만 변경합니다. 일반 워크플로 로딩은 위에서 설명한 대로 여전히 `graph.configure()`를 사용하며, 연결 콜백 서명은 변경되지 않습니다. + +## 연결이 만들어지기 전에 거부하기 + +연결을 거부하려면 소스 노드의 `onConnectOutput` 또는 대상 노드의 `onConnectInput`에서 `false`를 반환하세요. 두 콜백은 그래프가 무엇이든 변경하기 전에 실행되므로, 대상 입력에 이미 존재하는 링크는 그대로 유지됩니다: + +```js +nodeType.prototype.onConnectOutput = function ( + slot, + type, + input, + targetNode, + targetSlot +) { + return !shouldReject(type, targetNode) +} +``` + +`onConnectionsChange`에서 거부하지 마세요. 이 콜백이 실행될 시점에는 새 링크가 이미 대상 입력이 갖고 있던 링크를 교체한 뒤이므로, 새 링크를 제거하면 입력이 연결 해제된 상태로 남습니다. + +## 출력 콜백 내부에서 링크를 제거하면 입력 콜백이 건너뛰어짐 + +링크를 연결하면 출력 쪽의 `onConnectionsChange`가 먼저 호출되고, 그다음 입력 쪽의 것이 호출됩니다. 출력 쪽 핸들러가 반환하기 전에 같은 링크를 제거하면, 입력 쪽은 제거로 인해 `isConnected === false` 콜백을 받고, 새 링크에 대한 `isConnected === true` 콜백은 건너뜁니다. 양쪽이 항상 연결을 본다고 가정하지 마세요. 핸들러가 그래프에 다시 진입한다면 전달받은 링크가 여전히 연결되어 있는지 확인하세요. 이것은 관찰된 동작이며 테스트된 계약이 아닙니다. 현재 건너뛰기 경로를 실행하는 테스트는 없습니다. + +## 제거된 슬롯 이벤트 교체 + +`node:slot-links:changed`와 `node:slot-errors:changed`가 제거되었으며, 같은 이름의 대체 이벤트는 없습니다. 다음으로 이전(migrate)하세요: + +- 연결 상태를 반응형으로 읽으려면 `node.isInputConnected()`, `node.isOutputConnected()` 또는 + `node.getOutputNodes()`를 사용하거나, +- 슬롯이 연결되거나 연결 해제되는 정확한 시점에 코드를 실행해야 할 때는 + `onConnectionsChange`를 사용하세요. + +## 콜백 인자 또는 노드 메서드에서 연결 상태 읽기 + +`input.link`와 `output.links`는 지원 중단되었으며, 이를 읽으면 현재 그래프와 어긋날 수 있습니다. 쓰기는 링크를 제거만 합니다. `input.link`에 `null`을 할당하면 해당 입력이 연결 해제되고, `output.links`를 할당하거나 변경하면 새 배열에서 누락된 모든 링크가 연결 해제됩니다. 쓰기로 링크를 생성할 수는 없습니다. `node.connect()`, `node.disconnectInput()`, `node.disconnectOutput()`을 사용하세요. 콜백이 이미 받는 `link_info` 인자를 사용하거나, 링크 저장소를 직접 읽는 `LGraphNode` 인스턴스 메서드인 `node.isInputConnected()`, `node.getInputLink()`, `node.isOutputConnected()`, `node.getOutputNodes()`를 사용하세요. `input.link`나 `output.links`를 읽지 마세요. + +이 메서드들 뒤에 있는 저장소 함수들은 내부용이며 확장 API의 일부가 아닙니다. 노드 메서드를 사용하세요. diff --git a/ko/custom-nodes/js/javascript_about_panel_badges.mdx b/ko/custom-nodes/js/javascript_about_panel_badges.mdx index bf175edbf6..a38d52e50c 100644 --- a/ko/custom-nodes/js/javascript_about_panel_badges.mdx +++ b/ko/custom-nodes/js/javascript_about_panel_badges.mdx @@ -52,7 +52,7 @@ app.registerExtension({ 이 클래스는 프론트엔드 빌드 시 생성되므로 프론트엔드 자체에서 사용하는 Lucide 아이콘만 사용할 수 있습니다. 아이콘이 표시되지 않으면 다른 아이콘을 선택하거나, 확장에서 로드하는 스타일시트에 직접 아이콘 클래스를 정의하세요. -`pi pi-file` 같은 PrimeIcons 클래스는 당분간 계속 표시되지만 단계적으로 제거되고 있습니다. 새 코드에서는 사용하지 마세요. [PrimeVue 제거 마이그레이션](/custom-nodes/js/primevue-removal-migration)을 참조하세요. +`pi pi-file` 같은 PrimeIcons 클래스는 당분간 계속 표시되지만 단계적으로 제거되고 있습니다. 새 코드에서는 사용하지 마세요. [PrimeVue 제거 마이그레이션](/ko/custom-nodes/js/primevue-removal-migration)을 참조하세요. ## 예제 diff --git a/ko/custom-nodes/js/javascript_selection_toolbox.mdx b/ko/custom-nodes/js/javascript_selection_toolbox.mdx index 1c766e9257..65862f66f1 100644 --- a/ko/custom-nodes/js/javascript_selection_toolbox.mdx +++ b/ko/custom-nodes/js/javascript_selection_toolbox.mdx @@ -66,7 +66,7 @@ app.registerExtension({ 이 클래스는 프론트엔드 빌드 시 생성되므로 프론트엔드 자체에서 사용하는 Lucide 아이콘만 사용할 수 있습니다. 아이콘이 표시되지 않으면 다른 아이콘을 선택하거나, 확장에서 로드하는 스타일시트에 직접 아이콘 클래스를 정의하세요. -PrimeIcons(`pi pi-*`)와 Material Design Icons(`mdi mdi-*`) 클래스는 당분간 계속 표시되지만 단계적으로 제거되고 있습니다. 새 코드에서는 사용하지 마세요. [PrimeVue 제거 마이그레이션](/custom-nodes/js/primevue-removal-migration)을 참조하세요. +PrimeIcons(`pi pi-*`)와 Material Design Icons(`mdi mdi-*`) 클래스는 당분간 계속 표시되지만 단계적으로 제거되고 있습니다. 새 코드에서는 사용하지 마세요. [PrimeVue 제거 마이그레이션](/ko/custom-nodes/js/primevue-removal-migration)을 참조하세요. ## 동적 명령 표시 여부 diff --git a/ko/custom-nodes/js/javascript_settings.mdx b/ko/custom-nodes/js/javascript_settings.mdx index c1c1430763..a1e5004b31 100644 --- a/ko/custom-nodes/js/javascript_settings.mdx +++ b/ko/custom-nodes/js/javascript_settings.mdx @@ -84,7 +84,7 @@ try { ### 추가 구성 -각 설정 유형은 ComfyUI 프론트엔드의 폼 컴포넌트를 렌더링합니다. `attrs` 필드로 해당 컴포넌트에 추가 속성을 전달할 수 있습니다. 유형별로 지원되는 속성은 아래 각 유형 설명에 나와 있습니다. +각 설정 유형은 ComfyUI 프론트엔드의 폼 컴포넌트를 렌더링합니다. `attrs` 필드로 해당 컴포넌트에 추가 속성을 전달할 수 있습니다. 각 유형이 지원하는 속성은 [유형](#유형)에 나와 있습니다. 예를 들어, 숫자 입력의 범위와 단계를 제한하려면 다음과 같이 작성합니다: @@ -106,7 +106,7 @@ try { ``` -확장에서 `showButtons`, `maxFractionDigits`, `editable`, `filter` 같은 PrimeVue 속성을 전달했다면 [PrimeVue 제거 마이그레이션](/custom-nodes/js/primevue-removal-migration)을 참조하세요. 설정 패널은 더 이상 PrimeVue 컴포넌트를 사용하지 않으므로 해당 속성은 효과가 없습니다. +확장에서 `showButtons`, `maxFractionDigits`, `editable`, `filter` 같은 PrimeVue 속성을 전달했다면 [PrimeVue 제거 마이그레이션](/ko/custom-nodes/js/primevue-removal-migration)을 참조하세요. 설정 패널은 더 이상 PrimeVue 컴포넌트를 사용하지 않으므로 해당 속성은 효과가 없습니다. ## 유형 diff --git a/ko/custom-nodes/js/javascript_sidebar_tabs.mdx b/ko/custom-nodes/js/javascript_sidebar_tabs.mdx index 898f028a4c..fcb6582c23 100644 --- a/ko/custom-nodes/js/javascript_sidebar_tabs.mdx +++ b/ko/custom-nodes/js/javascript_sidebar_tabs.mdx @@ -53,7 +53,7 @@ app.extensionManager.registerSidebarTab({ 이 클래스는 프론트엔드 빌드 시 생성되므로 프론트엔드 자체에서 사용하는 Lucide 아이콘만 사용할 수 있습니다. 아이콘이 표시되지 않으면 다른 아이콘을 선택하거나, 확장에서 로드하는 스타일시트에 직접 아이콘 클래스를 정의하세요. -PrimeIcons(`pi pi-*`)와 Material Design Icons(`mdi mdi-*`) 클래스는 당분간 계속 표시되지만 단계적으로 제거되고 있습니다. 새 코드에서는 사용하지 마세요. [PrimeVue 제거 마이그레이션](/custom-nodes/js/primevue-removal-migration)을 참조하세요. +PrimeIcons(`pi pi-*`)와 Material Design Icons(`mdi mdi-*`) 클래스는 당분간 계속 표시되지만 단계적으로 제거되고 있습니다. 새 코드에서는 사용하지 마세요. [PrimeVue 제거 마이그레이션](/ko/custom-nodes/js/primevue-removal-migration)을 참조하세요. ## 상태 유지 탭 예제 diff --git a/ko/custom-nodes/js/link-registration-migration.mdx b/ko/custom-nodes/js/link-registration-migration.mdx new file mode 100644 index 0000000000..735390a5bf --- /dev/null +++ b/ko/custom-nodes/js/link-registration-migration.mdx @@ -0,0 +1,30 @@ +--- +title: "프런트엔드 확장의 링크 등록 마이그레이션" +sidebarTitle: "링크 등록 마이그레이션" +description: "addFloatingLink가 undefined를 반환하는 경우, 스토어 기반 graph.links 뷰, ComfyUI 프런트엔드 확장의 링크 ID 충돌 처리 방법." +translationSourceHash: 106471af +translationFrom: custom-nodes/js/link-registration-migration.mdx +--- + +`LinkNetwork.addFloatingLink(link)`는 이제 `LLink | undefined`를 반환합니다. + +새 런타임 링크에는 할당되지 않은 링크 ID를 넘기고 반환된 링크를 사용하세요. + +```ts +const registeredLink = graph.addFloatingLink(link) +if (!registeredLink) return +``` + +등록이 성공하면, 또는 같은 링크가 이미 토폴로지 스토어에 있으면 등록은 저장된 링크를 반환합니다. 다른 런타임 링크가 이미 그 ID를 소유하고 있으면 등록은 오류를 기록하고, 전달된 링크를 연결되지 않은 상태로 두고 `undefined`를 반환합니다. 사용 중인 링크를 조용히 교체하거나 전달된 링크에 다른 ID를 부여하지 않습니다. `graph.floatingLinks`는 한쪽 끝만 연결된 링크를 위한 필터링된 호환 뷰로 남습니다. + +`graph.links`와 `graph.floatingLinks`는 독립적인 네이티브 `Map` 저장소가 아니라 소유자로 필터링된 스토어 기반 호환 뷰입니다. 일반적인 `Map` 읽기 메서드는 캐시된 멤버십 스냅샷을 사용합니다. 토폴로지 멤버가 바뀐 뒤에는 기존 이터레이터를 유지하지 말고 새 이터레이터를 얻으세요. 두 뷰 모두 활성 Pinia가 필요하며, 스토어가 없는 상태를 빈 그래프로 표현하지 않습니다. + +네이티브 `Map.set()`처럼 `view.set(id, link)`는 등록 결과가 아니라 뷰를 반환합니다. 등록은 기존 링크를 유지한 채 ID 충돌이나 대상 충돌을 거부할 수 있으므로, 뷰를 통해 삽입하는 확장은 `view.get(link.id) === link`로 성공을 확인해야 합니다. 같은 뷰의 링크와 ID가 충돌한 뒤에는 `has()`가 `true`를 반환하고 `get()`은 기존 링크를 반환합니다. 해당 작업을 처리할 수 있으면 그래프 연결 API와 플로팅 링크 API를 우선 사용하세요. 이 API들이 주변 생명주기를 조율하기 때문입니다. 어느 뷰에도 `Map.prototype` 메서드를 직접 호출하거나 네이티브 `Map`의 내부 저장소에 의존하지 마세요. + +입력 교체는 이전 링크의 연결 해제 콜백보다 먼저 새 링크를 커밋하므로, 콜백 조회는 빈 입력이 아니라 교체된 링크를 봅니다. 일반 연결 콜백이 그 뒤를 따릅니다. + +이전에 반환값을 무시하던 확장은 전달된 링크를 보관, 렌더링, 변경하기 전에 `undefined`를 처리해야 합니다. 새 런타임 링크에 양수 링크 ID를 미리 지정하지 말고 그래프가 생성하게 하세요. + +영속 ID 충돌 복구는 워크플로우 가져오기와 역직렬화의 책임입니다. 직렬화된 토폴로지를 가져오는 확장은 런타임 등록 API를 사용하기 전에 그 경계에서 충돌하는 ID를 정규화해야 합니다. + +루트 `LGraph`를 생성하거나 직렬화된 데이터로 구성하려면 활성 Pinia가 필요합니다. 그래프 토폴로지가 생명주기 전반에 걸쳐 스토어 기반이기 때문입니다. diff --git a/ko/custom-nodes/js/node-geometry-migration.mdx b/ko/custom-nodes/js/node-geometry-migration.mdx new file mode 100644 index 0000000000..8360dc4ef8 --- /dev/null +++ b/ko/custom-nodes/js/node-geometry-migration.mdx @@ -0,0 +1,74 @@ +--- +title: "프런트엔드 확장 프로그램의 노드 지오메트리 마이그레이션" +sidebarTitle: "노드 지오메트리 마이그레이션" +description: "레이아웃 스토어 변경 이후 ComfyUI 프런트엔드 확장 프로그램에서의 노드 크기와 렌더링 경계, applyNodePositions 이름 바꾸기 및 그리기 순서 z-order를 설명합니다." +translationSourceHash: 833ab6fb +translationFrom: custom-nodes/js/node-geometry-migration.mdx +translationBlockHashes: + "Migration checklist": a95abc11 + "What changed": f4ee15bc + "Writes through removed references stay local": ba9b1003 +--- + +## 마이그레이션 체크리스트 + +1. `node.pos`, `node.size`, `boundingRect`, `getBounding()`, + `setPos()`, `setSize()`를 계속 사용하세요: 시그니처 변경은 필요하지 않습니다. +2. `repositionNodesVueMode()` 호출을 `applyNodePositions()`로 바꾸세요. +3. `node.size`가 측정/렌더링된 콘텐츠를 반영한다고 의존했다면 + `getBounding()` / `boundingRect`로 전환하세요. Vue 렌더러에서는 이제 `size`가 + 요청된 값을 엄격하게 반영합니다. 레거시 렌더러는 여전히 위젯에 맞도록 + `size`를 늘립니다. +4. 백킹 스토어가 아니라 노드/그룹 지오메트리 API를 사용하세요. `layoutStore`를 + 가져오거나 내부 형식에 의존하지 마세요. +5. 제거된 참조를 통한 쓰기는 공유 레이아웃 상태가 아닌 분리된 객체를 + 업데이트합니다. + +## 변경 사항 + +`LGraphNode.pos`, `size`, `boundingRect`, `getBounding()`, `setPos()`, `setSize()`는 시그니처가 그대로 유지됩니다. 이러한 호출은 소스 호환성을 유지합니다. 동작은 아래 세 가지 경우에서 변경되었습니다. + +```ts +node.pos = [100, 200] +node.pos[0] += 50 +node.setSize([320, 200]) +node.updateArea() +const box = node.getBounding() +``` + +노드와 그룹의 지오메트리는 이제 인스턴스별 필드가 아니라 공유 레이아웃 저장소에 저장됩니다. 저장소를 직접 사용하지 말고 위의 API를 사용하세요. 저장소는 내부 구현 세부 사항입니다. + +### `size`와 렌더링된 경계 + +`node.size`는 요청한 크기이며, 직렬화되는 값입니다. Vue 렌더러에서는 렌더링이 이 값을 변경하지 않습니다. `getBounding()`과 `boundingRect`는 렌더링된 경계를 반환하며, 위젯 콘텐츠에 더 많은 공간이 필요할 때 `size`보다 클 수 있습니다. 레거시 캔버스 렌더러에서는 노드가 `setSize()`를 호출해 위젯에 맞게 계속 커지므로, 그리기 이후에 `node.size`와 저장된 크기가 변경될 수 있습니다. 노드의 실제 화면상 크기가 필요할 때는 렌더링된 경계를 사용하세요. + +캔버스는 각 프레임이 시작될 때 `getBounding()`과 `boundingRect`를 다시 계산합니다. `pos` 또는 `size`를 변경한 뒤 같은 프레임에서 이 값을 읽으려면 먼저 `node.updateArea()`를 호출하세요. Vue 렌더러에서는 DOM 콘텐츠로 인한 크기 증가가 노드 측정이 끝난 뒤에만 반영됩니다. + +```ts +// 이전: 렌더링된 콘텐츠의 크기 조정이 size를 덮어쓸 수 있어서, 노드를 접었다가 +// 다시 펼치면 원본 크기를 잃었습니다. +node.size // 알 수 없이 렌더링된 크기로 바뀔 수 있었음 + +// 이후 (Vue 렌더러): size는 설정한 값 그대로 유지되며, 렌더링된 경계는 명시적으로 요청합니다. +node.size // 요청한 크기, 렌더링에 의해 변경되지 않음 +node.getBounding() // 실제 렌더링된 경계, 더 클 수 있음 +``` + +### `repositionNodesVueMode()`가 `applyNodePositions()`로 이름 변경됨 + +```ts +// 이전 +canvas.repositionNodesVueMode(newPositions) +// 이후 +canvas.applyNodePositions(newPositions) +``` + +`repositionNodesVueMode()`는 지원 중단된 별칭으로 여전히 호출할 수 있습니다. + +### Z 순서가 이제 모호하지 않습니다 + +Z 순서는 이전에 서로 어긋날 수 있는 두 소스에서 결정되었습니다. 노드 목록에서의 노드 위치와 실행 순서입니다. 이제는 항상 그리기 순서입니다. 확장에서 실행 순서를 바탕으로 쌓임 순서나 히트 테스트 순서를 추론했다면, 그리기 순서로 전환하세요. + +## 제거된 참조를 통한 쓰기는 로컬에 유지됩니다 + +제거 이후, geometry setter는 분리된 노드, 그룹 또는 경유점 객체만 업데이트합니다. 공유 레이아웃 상태나 이제 동일한 ID를 소유하는 다른 엔티티는 업데이트하지 않습니다. diff --git a/ko/custom-nodes/js/node-id-migration.mdx b/ko/custom-nodes/js/node-id-migration.mdx new file mode 100644 index 0000000000..a0e494a9d6 --- /dev/null +++ b/ko/custom-nodes/js/node-id-migration.mdx @@ -0,0 +1,22 @@ +--- +title: "프론트엔드 확장 프로그램의 노드 ID 마이그레이션" +sidebarTitle: "노드 ID 마이그레이션" +description: "ComfyUI 프론트엔드 확장을 브랜드 지정 문자열 노드 ID와 문자열 서브그래프 경계 센티널인 SUBGRAPH_INPUT_ID 및 SUBGRAPH_OUTPUT_ID로 마이그레이션합니다." +translationSourceHash: 168947f8 +translationFrom: custom-nodes/js/node-id-migration.mdx +--- + +ComfyUI 프론트엔드는 이제 내부 경계에서 로컬 노드 ID를 브랜드 지정 `NodeId` 문자열 +유형으로 정규화합니다. 직렬화된 워크플로와 API 페이로드에는 여전히 숫자 ID가 +포함될 수 있지만, litegraph의 노드 ID(예: `node.id`, +`LLink.origin_id`, `LLink.target_id`)는 프론트엔드에 입력된 이후 +문자열로 취급해야 합니다. 링크 ID(`LLink.id`)와 경유점 ID는 계속 숫자입니다. + +확장 프로그램 작성자는 노드 ID에 대한 숫자 비교를 피해야 합니다. 특히 서브그래프 +경계 센티널은 브랜드 지정 문자열 ID로 노출됩니다: + +- `SUBGRAPH_INPUT_ID`는 `-10`에서 직렬화됩니다 +- `SUBGRAPH_OUTPUT_ID`는 `-20`에서 직렬화됩니다 + +문자열 `'-10'` 및 `'-20'`과 비교하거나, 레거시 값을 비교하기 전에 양쪽을 +문자열로 정규화하세요. \ No newline at end of file diff --git a/ko/custom-nodes/js/primevue-removal-migration.mdx b/ko/custom-nodes/js/primevue-removal-migration.mdx new file mode 100644 index 0000000000..e7da129a2c --- /dev/null +++ b/ko/custom-nodes/js/primevue-removal-migration.mdx @@ -0,0 +1,72 @@ +--- +title: "프런트엔드 확장 프로그램을 위한 PrimeVue 제거 마이그레이션" +sidebarTitle: "PrimeVue 제거 마이그레이션" +description: "ComfyUI 프런트엔드가 PrimeVue를 제거한 이후 $primevue, PrimeVue 컴포넌트, --p-* CSS 변수 및 PrimeVue 툴팁 선택자를 교체합니다." +translationSourceHash: ca5e48dd +translationFrom: custom-nodes/js/primevue-removal-migration.mdx +translationBlockHashes: + "_intro": 5bd8432b + "Extensions that render PrimeVue components": e2b1c44c + "Extensions that read `--p-*` variables": d45a77c2 + "Tooltips": 5252984f + "Deprecated variable names": df1d5960 +--- + +ComfyUI 프런트엔드는 더 이상 PrimeVue를 설치하지 않습니다. 호스트 앱은 +`app.use(PrimeVue)`를 호출하지 않으므로, 확장 프로그램은 의존했을 수 있는 세 가지를 잃게 됩니다: + +- 호스트 Vue 앱의 `$primevue` 전역 속성 +- PrimeVue 테마 스타일시트. 따라서 확장 프로그램이 + 호스트 앱 내에서 렌더링하는 PrimeVue 컴포넌트는 스타일 없이 렌더링됩니다. +- `--p-primary-color`, `--p-surface-*`, `--p-text-color`, `--p-content-background`, + `--p-form-field-border-color` 등 모든 전역 `--p-*` CSS 변수 + +## PrimeVue 컴포넌트를 렌더링하는 확장 프로그램 + +호스트 앱의 PrimeVue 인스턴스에 의존하지 마세요. PrimeVue 컴포넌트를 자체 마크업으로 교체하거나, UI용으로 자체 Vue 앱을 생성한 뒤 해당 앱에 PrimeVue와 테마를 설치하세요. + +## `--p-*` 변수를 읽는 확장 프로그램 + +이 변수들을 디자인 시스템 테마 변수로 교체하세요. 디자인 시스템 테마 변수는 활성 라이트 또는 다크 테마와 활성 색상 팔레트를 따릅니다: + +| PrimeVue 변수 | 테마 변수 | +| --------------------------------------------------------- | -------------------- | +| `--p-primary-color` | `--primary` | +| `--p-text-color` | `--foreground` | +| `--p-text-muted-color` | `--muted-foreground` | +| `--p-content-background` | `--background` | +| `--p-surface-*` (패널, 올라온 영역) | `--secondary` | +| `--p-content-border-color`, `--p-form-field-border-color` | `--border` | + +## 툴팁 + +전역 `v-tooltip` 디렉티브가 제거되었으며, 툴팁은 더 이상 PrimeVue DOM을 렌더링하지 않습니다: + +- `.p-tooltip` 및 `.p-tooltip-text` +- `data-pd-tooltip` 속성 +- `$_ptooltip*` 요소 속성 + +이제 열린 툴팁은 `data-slot="tooltip-content"`가 있는 단일 요소를 렌더링하며, +이 요소는 `document.body` 끝으로 포털됩니다. 이 요소는 툴팁이 열려 있는 동안에만 존재합니다. +자체 UI를 표시하는 동안 툴팁을 숨기는 확장 프로그램은 `.p-tooltip` 대신 +`[data-slot="tooltip-content"]`를 대상으로 해야 합니다. + +`--node-component-tooltip*` CSS 변수도 디자인 시스템 스타일시트에서 제거되었습니다. +대신 테마 변수를 사용하세요: +`--background`, `--foreground` 및 `--border`. 이전 이름인 `--base-background`, `--base-foreground` 및 +`--border-default`는 지원 중단되었습니다. [지원 중단된 변수 이름](#지원-중단된-변수-이름)을 참조하세요. + +## 지원 중단된 변수 이름 + +이 문서의 이전 버전에서는 오래된 디자인 시스템 이름을 사용했습니다. 해당 이름들은 여전히 동작하지만 지원 중단되었으며 향후 릴리스에서 제거될 예정입니다. 지금 테마 변수로 옮기세요: + +| 지원 중단된 이름 | 테마 변수 | +| ----------------------------- | -------------- | +| `--base-background` | `--background` | +| `--base-foreground` | `--foreground` | +| `--border-default` | `--border` | +| `--primary-background` | `--primary` | +| `--secondary-background` | `--secondary` | +| `--component-node-background` | `--node` | + +PrimeIcons는 여전히 로드되므로 기존 `pi pi-*` 아이콘 클래스는 계속 동작하지만, 점차 사용이 중단되고 있습니다. 새로운 사용처를 추가하지 마세요. diff --git a/ko/custom-nodes/js/serialization-callbacks-migration.mdx b/ko/custom-nodes/js/serialization-callbacks-migration.mdx new file mode 100644 index 0000000000..792bdc6423 --- /dev/null +++ b/ko/custom-nodes/js/serialization-callbacks-migration.mdx @@ -0,0 +1,66 @@ +--- +title: "프런트엔드 확장 프로그램을 위한 직렬화 콜백 마이그레이션" +sidebarTitle: "직렬화 콜백 마이그레이션" +description: "스토어 기반 그래프에서 onSerialize와 onConfigure가 어떻게 동작하는지, 그리고 ComfyUI 프런트엔드 확장 프로그램이 사용자 지정 데이터를 어디에 보존해야 하는지 설명합니다." +translationSourceHash: de116a13 +translationFrom: custom-nodes/js/serialization-callbacks-migration.mdx +translationBlockHashes: + "_intro": 87be7894 + "Store custom data in properties or extra": 9bd7e443 + "Serialize nodes instead of enumerating properties": f9850471 +--- + + +Configuring a root `LGraph` from serialized data now requires an active +Pinia instance. `LGraph.configure()`는 ECS 스토어를 직접 대상으로 그래프를 비우고 +다시 빌드하므로, 활성 Pinia 없이 `new LGraph(data)` 또는 `graph.configure(data)`를 +호출하는 테스트 하네스, 워커 또는 독립 실행형 LiteGraph 소비자는 이제 조용히 +빈 그래프를 생성하는 대신 즉시 실패합니다. 이는 +[링크 등록 마이그레이션](/ko/custom-nodes/js/link-registration-migration)에 문서화된 것과 +동일한 요구 사항입니다. + +ComfyUI에서 실행되는 확장 프로그램은 애플리케이션의 활성 Pinia 인스턴스를 사용합니다. +확장 코드에서 별도의 Pinia 인스턴스를 생성하거나 활성화하지 마십시오. + +`node.onConfigure`, `node.onSerialize`, `graph.onConfigure`, `graph.onSerialize`는 +기존 시그니처와 실행 순서를 유지합니다. 연결 타이밍 후크는 +[연결 콜백 마이그레이션](/ko/custom-nodes/js/connection-callbacks-migration)을, `node.widgets`와 +위젯 값 저장은 [위젯 시스템 마이그레이션](/ko/custom-nodes/js/widgets-migration)을 +참조하십시오. + +`onConfigure`는 이제 호출자의 객체 자체가 아닌 직렬화된 데이터의 얕은 복사본을 +받습니다. 콜백 인수에서 최상위 키를 추가, 제거 또는 재할당해도 호출자의 워크플로 JSON은 +변경되지 않으며 저장되지도 않습니다. 중첩 객체(예: `inputs`, `pos`, `properties`)는 +여전히 호출자와 공유되므로, 이를 제자리에서 변경하면 여전히 유출됩니다. 두 종류의 +변경에 의존했던 확장 프로그램은 대신 사용자 지정 상태를 `node.properties` 또는 +`graph.extra`에 저장해야 합니다. + +## 사용자 지정 데이터는 properties 또는 extra에 저장하기 + +노드별 확장 데이터에는 `node.properties`를, 그래프별 확장 데이터에는 `graph.extra`를 사용합니다. 이 둘은 영속 데이터를 위한 안정적이고 공식적인 확장 지점입니다. + +`onSerialize`와 `onConfigure`는 `this`가 실제 노드/그래프 객체에 바인딩된 상태로 호출됩니다. 콜백에 전달되는 인자는 직렬화된 데이터 객체(`ISerialisedNode`/`ISerialisedGraph`)이며, 실제 노드/그래프가 아닙니다. `this`가 여전히 실제 객체이므로 훅은 이제 스토어 기반이 된 필드를 포함해 그 객체의 어떤 필드든 변경할 수 있습니다. 이 훅으로 핵심 필드를 덮어쓰지 마세요. `onSerialize`/`onConfigure` 내부에서 `this`를 통해 쓰면 자체적인 스키마, 소유권, 실행 취소 경계 없이 스토어에 바로 반영됩니다. + +`onSerialize`는 프런트엔드가 `graph.extra`와 `node.properties`를 데이터 객체로 복사한 뒤에 실행되므로, 훅이 `this.extra`나 `this.properties`에 추가한 키는 이번 저장에 포함되지 않습니다. `onSerialize` 내부에서는 콜백 인자에 쓰세요. 그래프는 `data.extra`, 노드는 `data.properties`입니다. 그렇지 않다면 직렬화가 시작되기 전에 `graph.extra`나 `node.properties`를 갱신하세요. + +`onSerialize`는 콜백을 하나만 보관하므로, 다른 확장이 이미 설치한 훅은 유지하세요. + +```js +const previous = graph.onSerialize +graph.onSerialize = function (data) { + previous?.call(this, data) + data.extra.myExtension = { version: 1 } +} +``` + +`onSerialize`는 루트 그래프에서만 실행됩니다. 서브그래프 정의는 서브그래프에서 훅을 호출하지 않고 저장되므로, 워크플로우를 저장하기 전에 서브그래프 데이터를 `subgraph.extra`에 저장하세요. + +훅이 `data`에 추가한 사용자 지정 최상위 키는 `LGraph.asSerialisable()`에서도 최상위에 남습니다. 레거시 `LGraph.serialize()` 진입점은 이를 `data.extensions` 아래로 옮기고 JSON 호환되지 않는 값은 제외합니다. 워크플로우를 불러올 때 `onConfigure`는 다시 최상위에서 그 키를 받습니다. `extra` 아래의 키는 두 진입점 모두에서 위치를 유지합니다. + +## 속성을 열거하는 대신 노드를 직렬화 + +확장에서 노드 자체의 속성을 열거하여 노드의 직렬화된 표현이나 디버그 표현을 만든다면, 이를 `node.serialize()`로 전환하세요. + +`id`, `type`, `title`, `flags`, `mode`, `color`, `bgcolor`, `shape`, `showAdvanced`는 이제 노드 인스턴스의 자체 데이터 속성이 아니라 노드 데이터 저장소를 통해 제공되는 접근자 속성입니다. `Object.keys(node)`, `for...in`, `{ ...node }`는 더 이상 이 필드를 드러내지 않지만, 직접 읽고 쓰는 것(`node.title`, `node.mode = ...`)은 변경 없이 그대로 동작합니다. `inputs`, `outputs`, `widgets`는 여전히 자체 열거 가능한 속성이므로, 스프레드/열거에서도 이 세 가지는 계속 포함됩니다. + +워크플로 JSON이 아니라 API 프롬프트 페이로드를 만드는 별도의 직렬화 계층인 위젯 수준의 `serializeValue`에 대해서는 [위젯 시스템 마이그레이션](/ko/custom-nodes/js/widgets-migration)을 참고하세요. diff --git a/ko/custom-nodes/js/widgets-migration.mdx b/ko/custom-nodes/js/widgets-migration.mdx new file mode 100644 index 0000000000..f03eb2290a --- /dev/null +++ b/ko/custom-nodes/js/widgets-migration.mdx @@ -0,0 +1,118 @@ +--- +title: "프론트엔드 확장 프로그램을 위한 위젯 시스템 마이그레이션" +sidebarTitle: "위젯 시스템 마이그레이션" +description: "ComfyUI 프론트엔드의 스토어 기반 위젯 값: 고유한 위젯 이름, undefined node.widgets, 위젯 이름 변경, addCustomWidget 및 Agent setValue 호출." +translationSourceHash: 3011c9c5 +translationFrom: custom-nodes/js/widgets-migration.mdx +translationBlockHashes: + "_intro": 87b853c9 + "Gallery values after the PrimeVue replacement": c6a755f6 + "Widget names must be unique and stable": 5988a23b + "`node.widgets` may be undefined": 7cb43a39 + "Prefer `node.addCustomWidget()` to pushing onto `node.widgets`": 5ee6030c + "Remove widgets with `node.removeWidget()`": 7d19ff02 + "Agent edits call `setValue` without a pointer event": 140c58f6 + "Don't call `useWidgetValueStore()` from extension code": 6c2a5cd3 +--- + +이제 위젯 값은 위젯 인스턴스에 직접 저장되지 않고 Pinia 기반 스토어에 저장됩니다. +위젯 이름은 노드마다 고유해야 하며, 위젯 이름 변경은 새 이름이 +사용 가능할 때만 성공합니다. `node.widgets` 또한 처음 할당되기 +전까지는 `undefined`일 수 있습니다. + +## PrimeVue 교체 이후 갤러리 값 + +Vue `galleria` 위젯은 `GALLERIA` 입력 스키마와 일치하는 이미지 URL 문자열 배열을 받습니다. 이미지가 +여러 개이면 썸네일과 이전/다음 버튼이 표시됩니다. 탐색은 첫 번째와 마지막 이미지에서 +멈춥니다. + +`itemImageSrc` 또는 `thumbnailImageSrc`를 사용하는 PrimeVue 이미지 객체는 더 이상 +지원되지 않습니다. 해당 객체를 URL 문자열로 변환하세요. 위젯은 `showThumbnails`, +`showItemNavigators`, `circular`, `autoPlay`, `transitionInterval`, `showIndicators`, +`numVisible`, `responsiveOptions`와 같은 PrimeVue 옵션을 더 이상 읽지 않습니다. 이러한 +컨트롤이 필요한 확장 프로그램은 자체 갤러리 위젯을 제공해야 합니다. + +## 위젯 이름은 고유하고 안정적이어야 합니다 + +동일한 노드에 있는 두 위젯은 이름을 공유할 수 없습니다. 이미 사용 중인 이름으로 두 번째 위젯을 추가하면, 노드가 그래프에 있을 때 프런트엔드가 `strength#1`과 같은 번호 접미사를 붙여 새 위젯의 이름을 바꿉니다. 원래 이름으로 조회하면 첫 번째 위젯만 찾습니다: + +```js +node.addWidget('number', 'strength', 0, () => {}) +const second = node.addWidget('number', 'strength', 1, () => {}) +second.name // 노드가 그래프에 있으면 'strength#1' +``` + +각 위젯에 고유한 이름을 지정하세요. + +등록된 위젯에 새 `widget.name`을 할당하면 저장된 값이 새 이름으로 옮겨집니다. 노드의 다른 위젯이 이미 그 이름을 사용하고 있으면 할당은 무시되고 `widget.name`은 이전 값을 유지하므로, 할당 후에 `widget.name`을 확인하세요. 이름으로 위젯을 참조하는 입력 슬롯은 업데이트되지 않습니다. 이름을 바꾸려고 위젯을 제거한 뒤 새 위젯을 추가하지 마세요. `removeWidget()`은 저장된 값을 삭제하고 위젯에 직접 바인딩된 입력 슬롯을 지웁니다. 이름으로만 해당 위젯을 참조하는 입력 슬롯은 그 이름을 유지합니다. + +## `node.widgets`가 undefined일 수 있습니다 + +`node.widgets`는 최소 한 번 할당되기 이전까지 `undefined`를 반환합니다. +위젯을 추가하기 이전에 배열을 초기화하세요: + +```ts +export function nodeCreated(node: LGraphNode) { + node.widgets ??= [] + node.widgets.push(myWidget) +} +``` + +읽을 때도 같은 방식으로 방어하세요: + +```ts +const widgetCount = node.widgets?.length ?? 0 +``` + +**`node.widgets = undefined`로 설정하면 해당 값이 지워집니다.** 나중에 읽으면 +`[]`가 아니라 다시 `undefined`를 반환합니다. + +**노드가 그래프에 연결되기 이전에 수행한 변경은 자동으로 반영됩니다.** +생성자나 `onNodeCreated`에서 위젯을 만드는 일반적인 경우에는 +직접 아무것도 호출할 필요가 없습니다. + +`node.widgets`는 `Object.keys(node)`와 `{...node}` 같은 객체 스프레드에 나타납니다. + +## `node.widgets`에 푸시하는 것보다 `node.addCustomWidget()`을 권장합니다 + +`node.addWidget()`, `node.addCustomWidget()` 또는 +`node.addDOMWidget()`로 추가된 위젯은 스토어에 자동으로 등록됩니다. `node.widgets`에 +곧바로 푸시된 일반 객체도 위젯 인스턴스로 변환되고, 노드가 그래프에 포함되면 +등록됩니다. 변환은 보통 제자리에서 이루어지지만, 동결된 객체나 구성 불가능한 +속성이 있는 객체는 별도의 위젯으로 교체됩니다. 따라서 `addCustomWidget()`이 +반환하는 위젯을 보관하거나 `node.widgets`에서 다시 읽어 오세요. `addCustomWidget()`은 +여전히 권장되는 호출입니다. 이 호출은 위젯을 반환하며, 워크플로가 로드될 때 +위젯의 저장된 값을 복원합니다. + +```js +node.addCustomWidget({ + name: 'my_widget', + type: 'custom', + value: '', + options: {}, + draw(ctx, node, width, y, height) {}, + mouse(event, pos, node) {} +}) +``` + +노드가 그래프에 연결되기 전에 `widget.value`를 읽거나 쓰면, 해당 값은 로컬에 +보관되고 연결 시 스토어에 동기화됩니다. 값이 손실되지는 않지만, 스토어 기반 +UI(예: 오른쪽 패널)는 그 전까지 값을 볼 수 없습니다. + +## `node.removeWidget()`로 위젯 제거 + +`node.removeWidget(widget)`를 사용해 위젯을 제거하세요. `node.widgets`를 직접 splice하면 슬롯 정리가 건너뛰어지고, 제거된 위젯의 값은 노드 자체가 그래프에서 제거될 때까지 store에 남습니다. + +## 앱 내 Agent 편집은 포인터 이벤트 없이 `setValue`를 호출합니다 + +앱 내 Agent가 `BaseWidget` 인스턴스인 위젯을 변경하면, 프런트엔드는 `widget.setValue(value, { node, canvas })`를 호출합니다. 사용자 편집이 거치는 것과 같은 메서드입니다. 이전에는 `widget.value`에 직접 값을 할당한 뒤 `callback`과 `onWidgetChanged`를 직접 호출했습니다. `addCustomWidget()`으로 추가했거나 `node.widgets`에 직접 push한 일반 객체도 포함됩니다. 프런트엔드가 이를 `BaseWidget` 인스턴스로 변환하기 때문입니다. DynamicGroup 행 수 컨트롤러와 승격된 서브그래프 호스트 위젯은 여전히 직접 쓰기를 받습니다. + +`setValue`를 재정의한다면 `{ node, e?, canvas? }` 형태의 옵션을 받으세요. 이 호출에서는 `e`가 설정되지 않으며 `canvas`도 없을 수 있습니다. `options.e`나 `options.canvas`는 반드시 확인한 뒤 읽으세요. 값만 넘겨 원래 `setValue`를 호출하는 래퍼는 계속 동작합니다. 옵션은 기본값 `{ node: widget.node }`가 됩니다. + +`callback`과 `onWidgetChanged`는 이제 Agent가 보낸 값이 아니라 위젯이 받아들인 값을 받습니다. 숫자 위젯은 `min`/`max`로 값을 제한하고 숫자 문자열을 숫자로 변환합니다. `callback`에서 `e`는 `undefined`이며, 캔버스가 없으면 `pos`도 `undefined`입니다. + +`setValue`는 숫자 위젯의 제한과 변환을 거친 값이 현재 값과 이미 동일(`===`)하면 변경 없이 반환합니다. 따라서 값이 `5`인 숫자 위젯에 `'5'`를 넣어도 아무 변화가 없습니다. 숫자 위젯이 `Number(value)`가 `NaN`이 되는 값을 받을 때도 반환합니다. `callback`도 `onWidgetChanged`도 실행되지 않고 그래프 버전도 바뀌지 않습니다. `'7'` 같은 숫자 문자열은 변환되어 적용됩니다. + +## 확장 프로그램 코드에서 `useWidgetValueStore()`를 호출하지 마세요 + +확장 프로그램에서 `useWidgetValueStore()`를 호출하지 마세요. 대신 `node.widgets`, `node.addWidget()` / `addCustomWidget()` / `removeWidget()`, 그리고 `widget.value`를 사용하세요. 이 스토어의 내부 키 지정 방식과 Pinia에 대한 의존성은 지원되는 확장 인터페이스가 아닙니다. diff --git a/ko/development/comfy-router/models.mdx b/ko/development/comfy-router/models.mdx index baba59fe6c..4e38a1c84a 100644 --- a/ko/development/comfy-router/models.mdx +++ b/ko/development/comfy-router/models.mdx @@ -2,11 +2,11 @@ title: "Comfy Router 모델" sidebarTitle: "모든 모델" description: "Comfy Router에서 사용할 수 있는 모든 모델을 제공자별로 정리하고, 각 모델의 입력 및 출력 모달리티를 함께 표시합니다." -translationSourceHash: d2265d41 +translationSourceHash: d299c0f0 translationFrom: development/comfy-router/models.mdx translationBlockHashes: "_intro": 2584e428 - "Find by output": 9b1b4039 + "Find by output": 5ddf7991 "Anthropic": de8acc20 "Beeble": b52ea340 "Black Forest Labs": 2934e3eb @@ -28,9 +28,9 @@ translationBlockHashes: "Meshy": 67e26a17 "MiniMax": 87560ab7 "Moonvalley": 9e63fb77 - "OpenAI": a5c1e692 + "OpenAI": 5bbf3b2c "Openrouter": a4f6806b - "Pika": f2b1d797 + "Pika": 8b17ff30 "Pruna": 903d76ee "Qwen": b3ef78a1 "Recraft": 02b7d9cd @@ -54,7 +54,7 @@ translationBlockHashes: ## 출력으로 찾기 - + - [SwitchX](/ko/development/comfy-router/models/beeble/switchx/code): `beeble/switchx` - [FLUX 3 Video](/ko/development/comfy-router/models/black-forest-labs/flux-3-video/code): `bfl/flux-3-video` @@ -96,6 +96,7 @@ translationBlockHashes: - [Video To Video](/ko/development/comfy-router/models/moonvalley/video-to-video/code): `moonvalley/video-to-video` - [Pika 2.5 Image To Video](/ko/development/comfy-router/models/pika/pika-2-5-image-to-video/code): `pika/pika-2.5-image-to-video` - [Pika 2.5 Text To Video](/ko/development/comfy-router/models/pika/pika-2-5-text-to-video/code): `pika/pika-2.5-text-to-video` +- [Pika Soundtrack](/ko/development/comfy-router/models/pika/pika-soundtrack/code): `pika/pika-soundtrack` - [P Video 2](/ko/development/comfy-router/models/pruna/p-video-2/code): `pruna/p-video-2` - [Aleph 2](/ko/development/comfy-router/models/runway/aleph2/code): `runway/aleph2` - [Gen 4 Turbo](/ko/development/comfy-router/models/runway/gen4-turbo/code): `runway/gen4_turbo` @@ -229,7 +230,7 @@ translationBlockHashes: - [Grok Imagine Image](/ko/development/comfy-router/models/xai/grok-imagine-image/code): `xai/grok-imagine-image` - + - [FLUX 3 Video](/ko/development/comfy-router/models/black-forest-labs/flux-3-video/code): `bfl/flux-3-video` - [Dreamina Seedance 2.0 260128](/ko/development/comfy-router/models/byteplus/dreamina-seedance-2-0-260128/code): `byteplus/dreamina-seedance-2-0-260128` @@ -255,6 +256,9 @@ translationBlockHashes: - [LTX 2.5 Fast](/ko/development/comfy-router/models/ltx/ltx-2-5-fast/code): `ltx/ltx-2-5-fast` - [LTX 2.5 Pro](/ko/development/comfy-router/models/ltx/ltx-2-5-pro/code): `ltx/ltx-2-5-pro` - [MiniMax H3](/ko/development/comfy-router/models/minimax/minimax-h3/code): `minimax/minimax-h3` +- [Pika Music](/ko/development/comfy-router/models/pika/pika-music/code): `pika/pika-music` +- [Pika Sfx](/ko/development/comfy-router/models/pika/pika-sfx/code): `pika/pika-sfx` +- [Pika Soundtrack](/ko/development/comfy-router/models/pika/pika-soundtrack/code): `pika/pika-soundtrack` - [P Video 2](/ko/development/comfy-router/models/pruna/p-video-2/code): `pruna/p-video-2` - [Clean Audio Video](/ko/development/comfy-router/models/veed/clean-audio-video/code): `veed/clean-audio-video` - [Clean Audio](/ko/development/comfy-router/models/veed/clean-audio/code): `veed/clean-audio` @@ -288,7 +292,7 @@ translationBlockHashes: - [Hunyuan 3D Uv](/ko/development/comfy-router/models/tencent/hunyuan-3d-uv/code): `tencent/hunyuan-3d-uv` - + - [Claude Fable 5.1](/ko/development/comfy-router/models/anthropic/claude-fable-5-1/code): `anthropic/claude-fable-5-1` - [Claude Fable 5](/ko/development/comfy-router/models/anthropic/claude-fable-5/code): `anthropic/claude-fable-5` @@ -327,6 +331,8 @@ translationBlockHashes: - [GPT 5 Mini](/ko/development/comfy-router/models/openai/gpt-5-mini/code): `openai/gpt-5-mini` - [GPT 5 Nano](/ko/development/comfy-router/models/openai/gpt-5-nano/code): `openai/gpt-5-nano` - [GPT 5](/ko/development/comfy-router/models/openai/gpt-5/code): `openai/gpt-5` +- [GPT 6.1 Sol](/ko/development/comfy-router/models/openai/gpt-6-1-sol/code): `openai/gpt-6.1-sol` +- [GPT 6.1 Terra](/ko/development/comfy-router/models/openai/gpt-6-1-terra/code): `openai/gpt-6.1-terra` - [GPT 6 Astra](/ko/development/comfy-router/models/openai/gpt-6-astra/code): `openai/gpt-6-astra` - [GPT 6 Luna](/ko/development/comfy-router/models/openai/gpt-6-luna/code): `openai/gpt-6-luna` - [GPT 6 Sol](/ko/development/comfy-router/models/openai/gpt-6-sol/code): `openai/gpt-6-sol` @@ -586,6 +592,8 @@ translationBlockHashes: | [GPT 5 Mini](/ko/development/comfy-router/models/openai/gpt-5-mini/code) | `openai/gpt-5-mini` | 텍스트, 이미지 | 텍스트 | | [GPT 5 Nano](/ko/development/comfy-router/models/openai/gpt-5-nano/code) | `openai/gpt-5-nano` | 텍스트, 이미지 | 텍스트 | | [GPT 5](/ko/development/comfy-router/models/openai/gpt-5/code) | `openai/gpt-5` | 텍스트, 이미지 | 텍스트 | +| [GPT 6.1 Sol](/ko/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | 텍스트, 이미지 | 텍스트 | +| [GPT 6.1 Terra](/ko/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | 텍스트, 이미지 | 텍스트 | | [GPT 6 Astra](/ko/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | 텍스트, 이미지 | 텍스트 | | [GPT 6 Luna](/ko/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | 텍스트, 이미지 | 텍스트 | | [GPT 6 Sol](/ko/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | 텍스트, 이미지 | 텍스트 | @@ -607,6 +615,9 @@ translationBlockHashes: | --- | --- | --- | --- | | [Pika 2.5 이미지 기반 비디오 생성](/ko/development/comfy-router/models/pika/pika-2-5-image-to-video/code) | `pika/pika-2.5-image-to-video` | 텍스트, 이미지 | 비디오 | | [Pika 2.5 텍스트 기반 비디오 생성](/ko/development/comfy-router/models/pika/pika-2-5-text-to-video/code) | `pika/pika-2.5-text-to-video` | 텍스트 | 비디오 | +| [Pika Music](/ko/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | 텍스트, 오디오 | 오디오 | +| [Pika Sfx](/ko/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | 텍스트 | 오디오 | +| [Pika Soundtrack](/ko/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | 비디오, 텍스트 | 비디오 + 오디오 | ## Pruna diff --git a/ko/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx b/ko/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx index 70a8b7a1a4..0676b96f3e 100644 --- a/ko/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx +++ b/ko/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx @@ -2,14 +2,14 @@ title: "Comfy Router로 Kling 3.0 Turbo 사용하기" description: "Comfy Router를 통해 kling/kling-3.0-turbo를 호출합니다. 엔드포인트, 요청 형태, Router가 반환하는 응답을 설명합니다." sidebarTitle: "Kling 3.0 Turbo" -translationSourceHash: d03a4ba5 +translationSourceHash: d09b3876 translationFrom: development/comfy-router/models/kling/kling-3-0-turbo/code.mdx translationBlockHashes: "_intro": 5a8c5f4b "Quick start": a2145573 "Serving providers": 7ec93d4f - "Schema": 4ec53894 - "Examples": 0a9a8bbe + "Schema": 992b8da2 + "Examples": 5ce1484a --- @@ -398,7 +398,7 @@ curl https://api.comfy.org/v2/models/kling/kling-3.0-turbo/requests/$REQUEST_ID "duration": "5", "id": "kling-v2-output-2b1a0f9e8d7c", "type": "video", - "url": "https://example.invalid/kling/kling-3.0-turbo/generated.mp4" + "url": "https://example.invalid/kling/v2/generated.mp4" } ], "status": "succeeded", diff --git a/ko/development/comfy-router/models/kling/kling-image-o1/code.mdx b/ko/development/comfy-router/models/kling/kling-image-o1/code.mdx index 38a2b57351..1d86b17c93 100644 --- a/ko/development/comfy-router/models/kling/kling-image-o1/code.mdx +++ b/ko/development/comfy-router/models/kling/kling-image-o1/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router와 함께 Kling Image O1 사용하기" description: "Comfy Router를 통해 kling/kling-image-o1 호출하기: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답." sidebarTitle: "Kling Image O1" -translationSourceHash: 0d76917c +translationSourceHash: ca32c929 translationFrom: development/comfy-router/models/kling/kling-image-o1/code.mdx translationBlockHashes: "_intro": 513c65df "Quick start": 6256a30d - "Schema": 61821697 + "Schema": 60d9f6fd "Examples": 826db173 --- @@ -214,7 +214,7 @@ curl https://api.comfy.org/v2/models/kling/kling-image-o1/requests/$REQUEST_ID \ - 단일 이미지를 생성할지 일련의 이미지를 생성할지 제어합니다. + 단일 이미지를 생성할지 일련의 이미지를 생성할지 제어합니다. series는 kling-image-o1에서 지원되지 않으며(모델 이름이 생략될 때 v1 프록시가 사용하는 값이기도 합니다), 그런 요청은 HTTP 400으로 거부됩니다. 가능한 값: `single`, `series` diff --git a/ko/development/comfy-router/models/luma/ray-2/code.mdx b/ko/development/comfy-router/models/luma/ray-2/code.mdx deleted file mode 100644 index 429b0090af..0000000000 --- a/ko/development/comfy-router/models/luma/ray-2/code.mdx +++ /dev/null @@ -1,298 +0,0 @@ ---- -title: "Comfy Router로 Ray 2 사용하기" -description: "Comfy Router를 통해 luma/ray-2를 호출합니다: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답." -sidebarTitle: "Ray 2" -translationSourceHash: 05a55db0 -translationFrom: development/comfy-router/models/luma/ray-2/code.mdx -translationBlockHashes: - "_intro": 76eb0c5f - "Quick start": 6f46e102 - "Schema": ea1f7cdb - "Examples": 3993fae3 ---- - - -{/* GENERATED FILE. Generated from router-schemas/luma/ray-2.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; - -`luma/ray-2`에 대한 API 레퍼런스이며, Luma에서 제공하고 Comfy Router가 서비스합니다. - -**입력:** 텍스트, 이미지 · **출력:** 비디오 - -## 빠른 시작 - -[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk` 및 `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 순수 HTTP로 수행한 것입니다. - -**모델 ID:** `luma/ray-2` - -**엔드포인트:** `POST https://api.comfy.org/v2/models/luma/ray-2` - - - - -```python Python -from comfy_sdk import Comfy - -# 환경 변수에서 COMFY_API_KEY를 읽습니다. -# SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. -with Comfy() as client: - result = client.models.run( - "luma/ray-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경 변수에서 COMFY_API_KEY를 읽습니다. -// SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. -const { data } = await comfy.models.run("luma/ray-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/luma/ray-2 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" -``` - - - -동일한 본문을 `POST https://api.comfy.org/v2/models/luma/ray-2/requests` 로 보냅니다. Router는 실행이 접수되는 즉시 `201` 과 `request_id` 로 응답하며, 결과는 준비가 되면 이 프로세스나 다른 프로세스에서 수집합니다. 상태, 취소, 수집 방법은 [큐 전송](/ko/development/comfy-router/queue) 를 참고하세요. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 환경 변수에서 COMFY_API_KEY를 읽습니다. -# 각 submit() 호출은 자체적으로 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "luma/ray-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - - # 서버가 지정한 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 공급자의 고유 페이로드로, models.run()이 반환하는 것과 동일한 값입니다. - # 실패하거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경 변수에서 COMFY_API_KEY를 읽습니다. -// 각 submit() 호출은 자체적으로 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. -const handle = await comfy.models.submit("luma/ray-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); -console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - -// 서버가 지정한 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run()이 반환하는 것과 동일한 결과입니다. 실패하거나 취소된 요청은 여기에서 거부됩니다. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 제출. Router는 request_id, status_url, response_url, cancel_url과 함께 201을 응답합니다. -curl https://api.comfy.org/v2/models/luma/ray-2/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" - -# 2. 상태가 COMPLETED가 될 때까지 폴링하며, 각 응답이 지정한 Retry-After 초만큼 기다립니다. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/luma/ray-2/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 수집. 모델의 네이티브 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202. -curl https://api.comfy.org/v2/models/luma/ray-2/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## 스키마 - -### 입력 - - - 생성물의 화면 비율 - - 가능한 값: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `21:9`, `9:21` - - - - 생성의 콜백 URL입니다. 생성이 dreaming, completed 또는 failed 상태가 되면 Generation 객체와 함께 POST 요청이 콜백 URL로 전송됩니다 - - 형식: `uri` - - - - - - - - 가능한 값: `video` - - - - 생성의 키프레임 - - - - 키프레임은 Generation 참조, 이미지 또는 비디오 중 하나일 수 있습니다 - - - - 키프레임은 Generation 참조, 이미지 또는 비디오 중 하나일 수 있습니다 - - - - 비디오를 반복 재생할지 여부 - - - - 생성에 사용되는 비디오 모델입니다. Comfy Router의 `POST /v2/models/luma/{model}` 경로에서는 이 필드가 경로에서 제공되므로 반드시 전송해서는 안 됩니다. v1 `POST /proxy/luma/generations` 경로에서는 필수이며 LumaVideoModel enum(`ray-2`, `ray-flash-2`)으로 제한됩니다. - - - - 생성의 프롬프트 - - - - - - -Router가 `GET /v2/models/luma/ray-2/openapi.json`에서 제공하는 스키마에서 생성되었으며, 이는 요청이 공급자에게 도달하기 전에 Router가 호출을 검증하는 데 사용하는 문서와 동일합니다. - -### 출력 - - - 생성의 에셋 - - - - 이미지의 URL - - 형식: `uri` - - - - 진행 비디오의 URL - - 형식: `uri` - - - - 비디오의 URL - - 형식: `uri` - - - - 생성이 만들어진 날짜와 시간 - - 형식: `date-time` - - - - 생성 상태의 이유 - - - - 가능한 값: `video`, `image` - - - - 생성의 ID - - 형식: `uuid` - - - - 생성에 사용된 모델 - - - - 생성의 요청 - - - - 생성의 상태 - - 가능한 값: `queued`, `dreaming`, `completed`, `failed` - - -## 예시 - -### 입력 - -```json -{ - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p" -} -``` - -### 출력 - -```json -{ - "assets": { - "video": "https://example.invalid/luma/ray-2/generated.mp4" - }, - "created_at": "2027-01-01T00:00:00Z", - "generation_type": "video", - "id": "3f2a7c1e-8b40-4d59-9f6a-1c2d3e4f5a60", - "model": "ray-2", - "state": "completed" -} -``` - - diff --git a/ko/development/comfy-router/models/luma/ray-flash-2/code.mdx b/ko/development/comfy-router/models/luma/ray-flash-2/code.mdx deleted file mode 100644 index e525c79b69..0000000000 --- a/ko/development/comfy-router/models/luma/ray-flash-2/code.mdx +++ /dev/null @@ -1,298 +0,0 @@ ---- -title: "Comfy Router로 Ray Flash 2 사용하기" -description: "Comfy Router를 통해 luma/ray-flash-2를 호출하는 방법을 설명합니다: 엔드포인트, 요청 형태, Router가 반환하는 응답." -sidebarTitle: "Ray Flash 2" -translationSourceHash: 398d8142 -translationFrom: development/comfy-router/models/luma/ray-flash-2/code.mdx -translationBlockHashes: - "_intro": bd0b0053 - "Quick start": c53b2450 - "Schema": 8009af73 - "Examples": cb7953b0 ---- - - -{/* GENERATED FILE. Generated from router-schemas/luma/ray-flash-2.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; - -Luma에서 Comfy Router로 제공하는 `luma/ray-flash-2`의 API 레퍼런스입니다. - -**입력:** 텍스트, 이미지 · **출력:** 비디오 - -## 빠른 시작 - -[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python과 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 순수 HTTP로 수행합니다. - -**모델 ID:** `luma/ray-flash-2` - -**엔드포인트:** `POST https://api.comfy.org/v2/models/luma/ray-flash-2` - - - - -```python Python -from comfy_sdk import Comfy - -# 환경 변수에서 COMFY_API_KEY를 읽습니다. -# SDK는 idempotency key를 자동으로 생성하고 자동 재시도에 재사용합니다. -with Comfy() as client: - result = client.models.run( - "luma/ray-flash-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경 변수에서 COMFY_API_KEY를 읽습니다. -// SDK는 idempotency key를 자동으로 생성하고 자동 재시도에 재사용합니다. -const { data } = await comfy.models.run("luma/ray-flash-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/luma/ray-flash-2 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" -``` - - - -동일한 본문을 `POST https://api.comfy.org/v2/models/luma/ray-flash-2/requests`로 보냅니다. Router는 실행이 접수되는 즉시 `201`과 `request_id`를 응답하며, 결과는 준비되면 이 프로세스나 다른 프로세스에서 수집합니다. 상태, 취소, 수집 방법은 [큐 전송](/ko/development/comfy-router/queue)을 참고하세요. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 환경 변수에서 COMFY_API_KEY를 읽습니다. -# 각 submit() 호출은 자체 Idempotency-Key를 발급하고 자동 재시도에 재사용합니다. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "luma/ray-flash-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - - # 서버가 지정한 Retry-After만큼 대기하면서 요청이 완료될 때까지 폴링합니다. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 공급자의 자체 페이로드이며, models.run()이 반환하는 것과 동일한 값입니다. - # 실패했거나 취소된 요청은 여기서 타입이 지정된 Router 오류를 발생시킵니다. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경 변수에서 COMFY_API_KEY를 읽습니다. -// 각 submit() 호출은 자체 Idempotency-Key를 발급하고 자동 재시도에 재사용합니다. -const handle = await comfy.models.submit("luma/ray-flash-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); -console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - -// 서버가 지정한 Retry-After만큼 대기하면서 요청이 완료될 때까지 폴링합니다. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run()이 반환하는 것과 동일한 결과입니다. 실패했거나 취소된 요청은 여기서 거부됩니다. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 제출. Router는 request_id, status_url, response_url, cancel_url과 함께 201을 응답합니다. -curl https://api.comfy.org/v2/models/luma/ray-flash-2/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" - -# 2. 상태가 COMPLETED가 될 때까지 폴링하면서, 각 응답이 지정한 Retry-After 초만큼 대기합니다. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/luma/ray-flash-2/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 수집. 모델의 네이티브 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202. -curl https://api.comfy.org/v2/models/luma/ray-flash-2/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## 스키마 - -### 입력 - - - 생성의 가로세로 비율 - - 가능한 값: `1:1`, `16:9`, `9:16`, `4:3`, `3:4`, `21:9`, `9:21` - - - - 생성의 콜백 URL입니다. 생성이 dreaming, completed 또는 failed 상태가 되면 Generation 객체를 담은 POST 요청이 콜백 URL로 전송됩니다. - - 형식: `uri` - - - - - - - - 가능한 값: `video` - - - - 생성의 키프레임 - - - - 키프레임은 Generation 참조, 이미지 또는 비디오 중 하나일 수 있습니다 - - - - 키프레임은 Generation 참조, 이미지 또는 비디오 중 하나일 수 있습니다 - - - - 비디오를 반복 재생할지 여부 - - - - 생성에 사용되는 비디오 모델입니다. Comfy Router 경로 `POST /v2/models/luma/{model}`에서는 이 필드가 경로에서 제공되며 전송해서는 안 됩니다(MUST NOT). v1 `POST /proxy/luma/generations` 경로에서는 필수이며 LumaVideoModel enum(`ray-2`, `ray-flash-2`)으로 제한됩니다. - - - - 생성의 프롬프트 - - - - - - -`GET /v2/models/luma/ray-flash-2/openapi.json`에서 Router가 제공하는 스키마에서 생성되었으며, 이는 요청이 공급자에 도달하기 전에 호출을 검증하는 데 사용하는 것과 동일한 문서입니다. - -### 출력 - - - 생성의 에셋 - - - - 이미지의 URL - - 형식: `uri` - - - - 진행 비디오의 URL - - 형식: `uri` - - - - 비디오의 URL - - 형식: `uri` - - - - 생성이 만들어진 날짜와 시간 - - 형식: `date-time` - - - - 생성 상태의 원인 - - - - 가능한 값: `video`, `image` - - - - 생성의 ID - - 형식: `uuid` - - - - 생성에 사용된 모델 - - - - 생성의 요청 - - - - 생성의 상태 - - 가능한 값: `queued`, `dreaming`, `completed`, `failed` - - -## 예시 - -### 입력 - -```json -{ - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p" -} -``` - -### 출력 - -```json -{ - "assets": { - "video": "https://example.invalid/luma/ray-flash-2/generated.mp4" - }, - "created_at": "2027-01-01T00:00:00Z", - "generation_type": "video", - "id": "8c41d0b6-2e7a-4f35-b1d8-9a0e6f3c2b71", - "model": "ray-flash-2", - "state": "completed" -} -``` - - diff --git a/ko/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx b/ko/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx index fb5a3d9146..2fe782edc0 100644 --- a/ko/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router에서 GPT 4.1 Mini 사용하기" description: "Comfy Router를 통해 openai/gpt-4.1-mini 호출하기: endpoint, 요청 형태, 그리고 Router가 반환하는 응답." sidebarTitle: "GPT 4.1 Mini" -translationSourceHash: d34bebbe +translationSourceHash: 4e94ce52 translationFrom: development/comfy-router/models/openai/gpt-4-1-mini/code.mdx translationBlockHashes: "_intro": b8a49e6e "Quick start": bd92ba2a - "Schema": 445b15a8 + "Schema": 80382523 "Examples": 67e6c8f1 --- @@ -359,7 +359,9 @@ Router가 `GET /v2/models/openai/gpt-4.1-mini/openapi.json`에서 제공하는
- 응답에 대한 오류 코드입니다.Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답에 대한 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -381,7 +383,7 @@ Router가 `GET /v2/models/openai/gpt-4.1-mini/openapi.json`에서 제공하는 응답이 불완전한 이유입니다. - Possible values: `max_output_tokens`, `content_filter` + 가능한 값: `max_output_tokens`, `content_filter` @@ -399,7 +401,7 @@ Router가 `GET /v2/models/openai/gpt-4.1-mini/openapi.json`에서 제공하는 이 리소스의 객체 유형이며 항상 `response`로 설정됩니다. - Possible values: `response` + 가능한 값: `response` @@ -446,7 +448,7 @@ Python 및 JavaScript SDK에서 지원됩니다. 응답 생성 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -526,6 +528,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰의 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-4-1/code.mdx b/ko/development/comfy-router/models/openai/gpt-4-1/code.mdx index 4810504903..08fa722403 100644 --- a/ko/development/comfy-router/models/openai/gpt-4-1/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-4-1/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router로 GPT 4.1 사용하기" description: "Comfy Router를 통해 openai/gpt-4.1 호출하기: endpoint, 요청 형태, 그리고 Router가 반환하는 응답." sidebarTitle: "GPT 4.1" -translationSourceHash: 96680ba8 +translationSourceHash: dd1cf710 translationFrom: development/comfy-router/models/openai/gpt-4-1/code.mdx translationBlockHashes: "_intro": d46021bd "Quick start": c2b30778 - "Schema": a12283e7 + "Schema": db0693d7 "Examples": 67e6c8f1 --- @@ -362,7 +362,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1/requests/$REQUEST_ID \ - 응답의 오류 코드입니다.Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답의 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -384,7 +386,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1/requests/$REQUEST_ID \ 응답이 불완전한 이유입니다. - Possible values: `max_output_tokens`, `content_filter` + 가능한 값: `max_output_tokens`, `content_filter` @@ -402,7 +404,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1/requests/$REQUEST_ID \ 이 리소스의 객체 유형이며, 항상 `response`로 설정됩니다. - Possible values: `response` + 가능한 값: `response` @@ -448,7 +450,7 @@ Python 및 JavaScript SDK에서 지원됩니다. 응답 생성 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -527,6 +529,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 가져온 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-4o/code.mdx b/ko/development/comfy-router/models/openai/gpt-4o/code.mdx index cbfaf06bef..41a7f761c9 100644 --- a/ko/development/comfy-router/models/openai/gpt-4o/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-4o/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router와 함께 GPT 4o 사용하기" description: "Comfy Router를 통해 openai/gpt-4o를 호출합니다: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답." sidebarTitle: "GPT 4o" -translationSourceHash: a1049a5c +translationSourceHash: 50b6ccc0 translationFrom: development/comfy-router/models/openai/gpt-4o/code.mdx translationBlockHashes: "_intro": 1091e92b "Quick start": 90bca1e0 - "Schema": 86fcee74 + "Schema": 012a1d42 "Examples": 67e6c8f1 --- @@ -380,7 +380,9 @@ Router가 `GET /v2/models/openai/gpt-4o/openapi.json`에서 제공하는 스키 - 응답의 오류 코드입니다.Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답의 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -540,6 +542,18 @@ Router가 `GET /v2/models/openai/gpt-4o/openapi.json`에서 제공하는 스키 캐시에 기록된 입력 토큰의 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx b/ko/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx index 3159f5fab5..00d809e388 100644 --- a/ko/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router로 GPT 5.5 Pro 사용하기" description: "Comfy Router를 통해 openai/gpt-5.5-pro를 호출합니다: 엔드포인트, 요청 형태, Router가 반환하는 응답입니다." sidebarTitle: "GPT 5.5 Pro" -translationSourceHash: 5ac845f9 +translationSourceHash: 7809e0ac translationFrom: development/comfy-router/models/openai/gpt-5-5-pro/code.mdx translationBlockHashes: "_intro": 38a9f8f3 "Quick start": 1fe98270 - "Schema": b1702eff + "Schema": 11ef4bcf "Examples": 67e6c8f1 --- @@ -380,7 +380,9 @@ Router가 `GET /v2/models/openai/gpt-5.5-pro/openapi.json`에서 제공하는 - 응답의 오류 코드입니다.가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답의 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -541,6 +543,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-5-5/code.mdx b/ko/development/comfy-router/models/openai/gpt-5-5/code.mdx index f82d52588a..c2cd40e055 100644 --- a/ko/development/comfy-router/models/openai/gpt-5-5/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-5-5/code.mdx @@ -2,12 +2,12 @@ title: "GPT 5.5를 Comfy Router와 함께 사용하기" description: "Comfy Router를 통해 openai/gpt-5.5를 호출하는 방법: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답." sidebarTitle: "GPT 5.5" -translationSourceHash: 58c95f4f +translationSourceHash: b6f75b15 translationFrom: development/comfy-router/models/openai/gpt-5-5/code.mdx translationBlockHashes: "_intro": 40d43e07 "Quick start": 1c6f8445 - "Schema": 0324fd46 + "Schema": 7cb284e6 "Examples": 67e6c8f1 --- @@ -539,6 +539,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰의 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 가져온 토큰 수입니다. [prompt 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx b/ko/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx index 70e34ef1b2..2d1781ffbb 100644 --- a/ko/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router로 GPT 5.6 Luna 사용하기" description: "Comfy Router를 통해 openai/gpt-5.6-luna를 호출합니다: endpoint, 요청 형태, 그리고 Router가 반환하는 응답입니다." sidebarTitle: "GPT 5.6 Luna" -translationSourceHash: 3dbd42c0 +translationSourceHash: 60531ced translationFrom: development/comfy-router/models/openai/gpt-5-6-luna/code.mdx translationBlockHashes: "_intro": 13db323c "Quick start": 28d289f6 - "Schema": 9edcb210 + "Schema": 939850da "Examples": 67e6c8f1 --- @@ -360,7 +360,7 @@ Router가 `GET /v2/models/openai/gpt-5.6-luna/openapi.json`에서 제공하는 응답의 오류 코드입니다. -Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` +가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -382,7 +382,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 응답이 불완전한 이유입니다. - Possible values: `max_output_tokens`, `content_filter` + 가능한 값: `max_output_tokens`, `content_filter` @@ -400,7 +400,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 이 리소스의 객체 유형이며, 항상 `response`로 설정됩니다. - Possible values: `response` + 가능한 값: `response` @@ -442,7 +442,7 @@ Python 및 JavaScript SDK에서 지원됩니다. 응답 생성의 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -521,6 +521,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx b/ko/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx index 7528c29892..f00ee9a1e9 100644 --- a/ko/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router와 함께 GPT 5.6 Sol 사용하기" description: "Comfy Router를 통해 openai/gpt-5.6-sol을 호출하는 방법: endpoint, 요청 형태, 그리고 Router가 반환하는 응답입니다." sidebarTitle: "GPT 5.6 Sol" -translationSourceHash: 53c40b5a +translationSourceHash: 946fbb02 translationFrom: development/comfy-router/models/openai/gpt-5-6-sol/code.mdx translationBlockHashes: "_intro": fd209e5e "Quick start": ac41609e - "Schema": d3e5bdbd + "Schema": 74ed2ee6 "Examples": 67e6c8f1 --- @@ -360,7 +360,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ 응답에 대한 오류 코드입니다. -Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` +가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -521,6 +521,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx b/ko/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx index 9230038bad..1fcfc30c22 100644 --- a/ko/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router에서 GPT 5.6 Terra 사용하기" description: "Comfy Router를 통해 openai/gpt-5.6-terra를 호출하세요: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답입니다." sidebarTitle: "GPT 5.6 Terra" -translationSourceHash: b276b982 +translationSourceHash: 7aa80915 translationFrom: development/comfy-router/models/openai/gpt-5-6-terra/code.mdx translationBlockHashes: "_intro": 3d1bd737 "Quick start": f76d67fd - "Schema": e854248f + "Schema": f66cb808 "Examples": 67e6c8f1 --- @@ -361,7 +361,7 @@ Router가 `GET /v2/models/openai/gpt-5.6-terra/openapi.json`에서 제공하는 응답에 대한 오류 코드입니다. - Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -383,7 +383,7 @@ Router가 `GET /v2/models/openai/gpt-5.6-terra/openapi.json`에서 제공하는 응답이 불완전한 이유입니다. - Possible values: `max_output_tokens`, `content_filter` + 가능한 값: `max_output_tokens`, `content_filter` @@ -401,7 +401,7 @@ Router가 `GET /v2/models/openai/gpt-5.6-terra/openapi.json`에서 제공하는 이 리소스의 객체 타입으로, 항상 `response`로 설정됩니다. - Possible values: `response` + 가능한 값: `response` @@ -444,7 +444,7 @@ Python 및 JavaScript SDK에서 지원됩니다. 응답 생성의 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -523,6 +523,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰의 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱 자세히 보기](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-5-mini/code.mdx b/ko/development/comfy-router/models/openai/gpt-5-mini/code.mdx index 0c40cd0d01..85de648441 100644 --- a/ko/development/comfy-router/models/openai/gpt-5-mini/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-5-mini/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router에서 GPT 5 Mini 사용하기" description: "Comfy Router를 통해 openai/gpt-5-mini 호출하기: 엔드포인트, 요청 형태, Router가 반환하는 응답." sidebarTitle: "GPT 5 Mini" -translationSourceHash: 6f93b322 +translationSourceHash: 1fdb782a translationFrom: development/comfy-router/models/openai/gpt-5-mini/code.mdx translationBlockHashes: "_intro": 3a0b2e17 "Quick start": e4ce6833 - "Schema": 426552ef + "Schema": b1c7b0c6 "Examples": 67e6c8f1 --- @@ -538,6 +538,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-5-nano/code.mdx b/ko/development/comfy-router/models/openai/gpt-5-nano/code.mdx index 9fd02fe283..a7b1c2d9bc 100644 --- a/ko/development/comfy-router/models/openai/gpt-5-nano/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-5-nano/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router로 GPT 5 Nano 사용하기" description: "Comfy Router를 통해 openai/gpt-5-nano를 호출합니다: endpoint, 요청 형태, 그리고 Router가 반환하는 응답." sidebarTitle: "GPT 5 Nano" -translationSourceHash: dea6c7dc +translationSourceHash: 608ede54 translationFrom: development/comfy-router/models/openai/gpt-5-nano/code.mdx translationBlockHashes: "_intro": e9be10ab "Quick start": 2ff521ab - "Schema": 3e04e36e + "Schema": d555e85f "Examples": 67e6c8f1 --- @@ -373,7 +373,9 @@ Router가 `GET /v2/models/openai/gpt-5-nano/openapi.json`에서 제공하는 스 - 응답에 대한 오류 코드입니다.가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답에 대한 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -534,6 +536,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 가져온 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-5/code.mdx b/ko/development/comfy-router/models/openai/gpt-5/code.mdx index aadd274ca7..97ec636d21 100644 --- a/ko/development/comfy-router/models/openai/gpt-5/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-5/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router에서 GPT 5 사용하기" description: "Comfy Router를 통해 openai/gpt-5 호출하기: 엔드포인트, 요청 형태, Router가 반환하는 응답." sidebarTitle: "GPT 5" -translationSourceHash: b66e1420 +translationSourceHash: fc79531a translationFrom: development/comfy-router/models/openai/gpt-5/code.mdx translationBlockHashes: "_intro": 1f35e583 "Quick start": b8543ef7 - "Schema": 37e7ebd8 + "Schema": bfb88182 "Examples": 67e6c8f1 --- @@ -249,13 +249,13 @@ curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \ 응답의 무작위성을 제어합니다 - 범위: `0`에서 `2` + 범위: `0`부터 `2`까지 nucleus 샘플링을 통해 응답의 다양성을 제어합니다 - 범위: `0`에서 `1` + 범위: `0`부터 `1`까지 @@ -363,7 +363,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \ - 응답의 오류 코드입니다.가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답의 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -524,6 +526,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱 자세히 보기](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx b/ko/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx similarity index 58% rename from ko/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx rename to ko/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx index 8caa6c6aef..388b00cb02 100644 --- a/ko/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx @@ -1,36 +1,33 @@ --- -title: "Comfy Router에서 GPT 4.1 Nano 사용하기" -description: "Comfy Router를 통해 openai/gpt-4.1-nano 호출하기: endpoint, 요청 형태, 그리고 Router가 반환하는 응답." -sidebarTitle: "GPT 4.1 Nano" -translationSourceHash: cb01a907 -translationFrom: development/comfy-router/models/openai/gpt-4-1-nano/code.mdx +title: "Comfy Router로 GPT 6.1 Sol 사용하기" +description: "Comfy Router를 통해 openai/gpt-6.1-sol을 호출합니다. 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답을 설명합니다." +sidebarTitle: "GPT 6.1 Sol" +translationSourceHash: d4b3ce5f +translationFrom: development/comfy-router/models/openai/gpt-6-1-sol/code.mdx translationBlockHashes: - "_intro": 9543bf7b - "Quick start": 9c5ad598 - "Schema": 4e68a487 + "_intro": 72f9c8de + "Quick start": a04e3ac0 + "Schema": 0e5083e2 "Examples": 67e6c8f1 --- - - - -{/* 생성된 파일. `router-schemas/openai/gpt-4.1-nano.json`에서 `pnpm code-pages:gen`으로 생성되었습니다. */} +{/* 생성된 파일입니다. router-schemas/openai/gpt-6.1-sol.json에서 `pnpm code-pages:gen`으로 생성되었습니다. */} import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; -`openai/gpt-4.1-nano`에 대한 API 레퍼런스이며, OpenAI에서 Comfy Router를 통해 제공됩니다. +OpenAI에서 제공하는 `openai/gpt-6.1-sol`에 대한 API 레퍼런스입니다. 이 모델은 Comfy Router에서 서비스됩니다. **입력:** 텍스트, 이미지 · **출력:** 텍스트 ## 빠른 시작 -[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성한 뒤 `COMFY_API_KEY`로 내보내세요. Python과 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 raw HTTP로 실행합니다. +[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 원시 HTTP로 보낸 것입니다. -**모델 ID:** `openai/gpt-4.1-nano` +**모델 ID:** `openai/gpt-6.1-sol` -**엔드포인트:** `POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano` +**엔드포인트:** `POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol` - + ```python Python from comfy_sdk import Comfy @@ -39,7 +36,7 @@ from comfy_sdk import Comfy # SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. with Comfy() as client: result = client.models.run( - "openai/gpt-4.1-nano", + "openai/gpt-6.1-sol", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -54,7 +51,7 @@ import { comfy } from "@comfyorg/sdk"; // 환경에서 COMFY_API_KEY를 읽습니다. // SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. -const { data } = await comfy.models.run("openai/gpt-4.1-nano", { +const { data } = await comfy.models.run("openai/gpt-6.1-sol", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); @@ -63,7 +60,7 @@ console.log(data); ``` ```bash cURL -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano \ +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ @@ -72,7 +69,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano \ -동일한 본문을 `POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests`로 보냅니다. Router는 실행이 접수되는 즉시 `201`과 `request_id`를 응답하며, 결과는 준비가 되는 대로 이 프로세스나 다른 프로세스에서 수집할 수 있습니다. 상태, 취소, 수집 방법은 [큐 전송](/ko/development/comfy-router/queue)을 참고하세요. +동일한 본문을 `POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests`로 보냅니다. Router는 실행이 접수되는 즉시 `request_id`와 함께 `201`을 응답하며, 결과는 준비가 되면 이 프로세스에서든 다른 프로세스에서든 수집할 수 있습니다. [대기 중 전달](/ko/development/comfy-router/queue)에서 상태, 취소, 수집 과정을 단계별로 설명합니다. ```python Python @@ -80,11 +77,11 @@ import asyncio from comfy_sdk import AsyncComfy # 환경에서 COMFY_API_KEY를 읽습니다. -# 각 submit() 호출은 자체 Idempotency-Key를 발급하고 자동 재시도에 재사용합니다. +# 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. async def main(): async with AsyncComfy() as client: handle = await client.models.submit( - "openai/gpt-4.1-nano", + "openai/gpt-6.1-sol", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -92,11 +89,11 @@ async def main(): ) print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - # 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 대기합니다. + # 서버가 지정한 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. async for update in handle.iter_events(): print(update.status, update.queue_position) - # 공급자 자체의 페이로드로, models.run()이 반환하는 것과 동일한 값입니다. + # 공급자의 원본 페이로드이며, models.run()이 반환하는 것과 동일한 값입니다. # 실패했거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. result = await handle.get() @@ -109,14 +106,14 @@ asyncio.run(main()) import { comfy } from "@comfyorg/sdk"; // 환경에서 COMFY_API_KEY를 읽습니다. -// 각 submit() 호출은 자체 Idempotency-Key를 발급하고 자동 재시도에 재사용합니다. -const handle = await comfy.models.submit("openai/gpt-4.1-nano", { +// 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. +const handle = await comfy.models.submit("openai/gpt-6.1-sol", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 -// 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 대기합니다. +// 서버가 지정한 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } @@ -128,20 +125,20 @@ console.log(result.data); ``` ```bash cURL -# 1. 제출합니다. Router는 request_id, status_url, response_url, cancel_url과 함께 201을 응답합니다. -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests \ +# 1. 제출. Router는 request_id, status_url, response_url, cancel_url과 함께 201을 응답합니다. +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -# 2. 상태가 COMPLETED가 될 때까지 폴링하며, 각 응답이 지정한 Retry-After 초만큼 대기합니다. +# 2. 각 응답이 지정한 Retry-After 초만큼 기다리며 status가 COMPLETED가 될 때까지 폴링합니다. REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID/status \ +curl -i https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" -# 3. 수집합니다. 모델의 네이티브 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202를 반환합니다. -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ +# 3. 수집. 모델의 원본 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202. +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``` @@ -157,7 +154,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - 응답을 생성하는 데 사용되는 모델에 대한 텍스트, 이미지 또는 파일 입력입니다. 이 계약에서 Router가 제공할 수 없는 유일한 필드이며, 아래 `required`에 있는 유일한 항목입니다. + 모델에 대한 텍스트, 이미지 또는 파일 입력으로, 응답을 생성하는 데 사용됩니다. 이 계약에서 Router가 제공할 수 없는 유일한 필드이며, 아래 `required`에 있는 유일한 항목입니다. @@ -165,7 +162,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - 응답을 위해 생성되는 토큰 수의 상한이며, 표시되는 출력 토큰과 추론 토큰을 포함합니다. 추론 id에서는 이 상한을 숨김 추론 토큰과 공유하므로, 값이 작으면 표시되는 텍스트가 나오기 전에 전체 예산을 소진할 수 있습니다. 그래서 추론 스모크 케이스는 1024를 보내고 채팅 케이스는 16을 보냅니다. + 응답을 위해 생성되는 토큰 수의 상한으로, 표시되는 출력 토큰과 추론 토큰을 포함합니다. 추론 id에서는 이 상한이 숨김 추론 토큰과 공유되므로, 값이 작으면 표시되는 텍스트가 나오기 전에 전체 예산을 소진할 수 있습니다. 그래서 추론 스모크 케이스는 채팅 케이스가 16을 보내는 곳에서 1024를 보냅니다. 범위: `1` ~ `…` @@ -179,71 +176,71 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - 다중 턴 대화를 위한 이전 응답의 ID입니다. + 이전 응답의 ID로, 다중 턴 대화에 사용됩니다. - 추론 등급 전용입니다. 추론 모델을 위한 구성입니다. 예: `{"effort": "medium"}`. 변경 없이 전달되며, 허용되는 키는 OpenAI의 추론 가이드를 참조하세요. 채팅 등급 id는 이를 무시합니다. + 추론 티어 전용입니다. 추론 모델을 위한 설정입니다. 예: `{"effort": "medium"}`. 그대로 전달되며, 허용되는 키는 OpenAI의 추론 가이드를 참조하세요. 채팅 티어 id는 이를 무시합니다. - OpenAI가 생성된 응답을 나중에 검색할 수 있도록 저장할지 여부입니다. + OpenAI가 생성된 응답을 나중에 조회할 수 있도록 저장할지 여부입니다. - 이 필드를 보내는 호출자가 거부되지 않도록 선언되어 있지만, 이 표면에서는 아무 효과가 없습니다. Router는 디스패치 이전에 이 값을 `false`로 확정합니다. Router는 `text/event-stream`을 중계하는 대신 공급자 응답을 캡처하기 때문입니다. Router는 이를 디코딩할 수 없으므로, 스트리밍 생성은 OpenAI가 과금하고 아무도 계량하지 않는 결과가 됩니다. 어떤 Comfy 표면도 스트림을 제공하지 않습니다. v1 `POST /proxy/openai/v1/responses` 인그레스는 `stream: true`를 400으로 거부하고 요청을 업스트림으로 전혀 전달하지 않습니다. 따라서 어느 표면에서든 이 필드를 생략하거나 `false`를 보내고, 완료된 응답을 하나의 JSON 본문으로 읽으세요. + 호출자가 보내더라도 거부되지 않도록 선언되어 있지만, 이 표면에서는 무효입니다. Router는 디스패치 이전에 이를 `false`로 확정하는데, `text/event-stream`을 중계하는 대신 공급자 응답을 캡처하기 때문입니다. Router는 이 스트림을 디코딩할 수 없으므로, 스트리밍 생성은 OpenAI가 과금하고 아무도 계량하지 않게 됩니다. 어떤 Comfy 표면도 스트림을 제공하지 않습니다. v1 `POST /proxy/openai/v1/responses` 인그레스는 `stream: true`를 400과 함께 거부하고 요청을 업스트림으로 전혀 전달하지 않으므로, 어느 표면에서든 이 필드를 생략하거나 `false`를 보낸 뒤 완료된 응답을 하나의 JSON 본문으로 읽으세요. - 샘플링 temperature입니다. 채팅 등급 전용입니다. o 시리즈 추론 id(`o1`, `o1-pro`, `o3`, `o4-mini`)는 OpenAI에서 이 파라미터를 거부합니다. Router는 이들을 위해 이를 거부하지 않습니다. 두 등급이 하나의 스키마를 공유하는 이유에 관한 이 컴포넌트의 설명을 참조하세요. 따라서 이를 보내는 추론 호출은 OpenAI 자체 오류로 응답됩니다. + 샘플링 temperature입니다. 채팅 티어 전용입니다. o-시리즈 추론 id(`o1`, `o1-pro`, `o3`, `o4-mini`)는 OpenAI에서 이 매개변수를 거부합니다. Router는 이들에 대해 매개변수를 거부하지 않습니다(두 티어가 하나의 스키마를 공유하는 이유는 이 컴포넌트의 참고 사항을 보세요). 따라서 이를 보내는 추론 호출은 OpenAI 자체의 오류로 응답됩니다. 범위: `0` ~ `2` - 출력 형식 구성입니다. 예를 들어 Structured Outputs의 경우 `{"format": {"type": "json_schema", ...}}`입니다. 변경 없이 전달됩니다. + 출력 형식 구성입니다. 예: Structured Outputs를 위한 `{"format": {"type": "json_schema", ...}}`. 그대로 전달됩니다. - 모델이 사용할 도구를 선택하는 방식입니다. 문자열 모드이거나 도구를 지정하는 객체입니다. + 모델이 사용할 도구를 어떻게 선택할지 지정합니다. 문자열 모드 또는 도구를 지정하는 객체입니다. - 모델이 호출할 수 있는 도구 정의입니다. Router는 도구 분류 체계를 좁히지 않습니다. 허용되는 형태는 OpenAI의 Responses API 레퍼런스를 참조하세요. + 모델이 호출할 수 있는 도구 정의입니다. Router는 도구 분류를 좁히지 않습니다. 허용되는 형태는 OpenAI의 Responses API 레퍼런스를 참조하세요. - 뉴클리어스 샘플링 컷오프입니다. 채팅 등급 전용이며, `temperature`와 동일한 조건입니다. + 뉴클리어스 샘플링 컷오프입니다. 채팅 티어 전용이며 `temperature`와 같은 조건입니다. 범위: `0` ~ `1` - 컨텍스트가 모델의 창을 초과할 때의 절단 전략입니다. 위의 세 어휘와 달리 여기서는 enum이 강제됩니다. 이 두 값이 OpenAI가 문서화한 완전한 집합이며 더 늘어나지 않았기 때문입니다. 명시적 `null`은 위의 필드들과 동일한 조건으로 여전히 허용됩니다. + 컨텍스트가 모델의 창을 초과할 때의 잘라내기 전략입니다. 위의 세 가지 값 목록과 달리 여기서는 enum이 실제로 강제됩니다. 이 두 값이 OpenAI가 문서화한 전체 집합이며 그 뒤로 늘어나지 않았기 때문입니다. 명시적인 `null`은 위 필드들과 같은 조건으로 여전히 허용됩니다. 가능한 값: `auto`, `disabled` - 토큰 사용량 봉투입니다. v1 작업이 요청 본문에 이를 선언하기 때문에 이 계약에 존재합니다. OpenAI는 이를 응답에 채우므로, 호출자가 보낼 이유가 없습니다. + 토큰 사용량 봉투입니다. v1 오퍼레이션이 요청 본문에 이를 선언하기 때문에 이 계약에 존재합니다. OpenAI는 이를 응답에 채우므로 호출자가 보낼 이유가 없습니다. -`GET /v2/models/openai/gpt-4.1-nano/openapi.json`에서 Router가 제공하는 스키마에서 생성되었으며, 요청이 공급자에게 도달하기 전에 Router가 호출을 검증하는 기준이 되는 동일한 문서입니다. +Router가 `GET /v2/models/openai/gpt-6.1-sol/openapi.json`에서 제공하는 스키마에서 생성되었으며, 요청이 공급자에 도달하기 전에 호출을 검증하는 데 사용하는 것과 동일한 문서입니다. ### 출력 - 모델의 컨텍스트 첫 번째 항목으로 시스템(또는 개발자) 메시지를 삽입합니다. + 모델 컨텍스트의 첫 번째 항목으로 시스템(또는 개발자) 메시지를 삽입합니다. `previous_response_id`와 함께 사용할 경우, 이전 응답의 instructions는 다음 응답으로 이어지지 않습니다. 따라서 새 응답에서 시스템(또는 개발자) 메시지를 간단히 교체할 수 있습니다. - 응답에 대해 생성될 수 있는 토큰 수의 상한이며, 표시되는 출력 토큰과 [추론 토큰](https://platform.openai.com/docs/guides/reasoning)을 포함합니다. + 응답에 대해 생성될 수 있는 토큰 수의 상한으로, 표시되는 출력 토큰과 [추론 토큰](https://platform.openai.com/docs/guides/reasoning)을 포함합니다. - 응답을 생성하는 데 사용된 모델 + 응답을 생성하는 데 사용되는 모델 @@ -261,29 +258,29 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ 모델 응답에 사용할 잘라내기 전략입니다. - `auto`: 이 응답과 이전 응답의 컨텍스트가 모델의 컨텍스트 창 크기를 초과하면, 모델은 대화 중간의 입력 항목을 제거하여 컨텍스트 창에 맞도록 응답을 잘라냅니다. -- `disabled` (기본값): 모델 응답이 모델의 컨텍스트 창 크기를 초과하면, 요청은 400 오류로 실패합니다. +- `disabled` (기본값): 모델 응답이 해당 모델의 컨텍스트 창 크기를 초과하면 요청이 400 오류로 실패합니다. 가능한 값: `auto`, `disabled` - 모델에 대한 이전 응답의 고유 ID입니다. 이를 사용하여 다중 턴 대화를 생성합니다. [대화 상태](https://platform.openai.com/docs/guides/conversation-state)에 대해 더 알아보세요. + 모델에 대한 이전 응답의 고유 ID입니다. 이를 사용하여 다중 턴 대화를 생성하세요. [대화 상태](https://platform.openai.com/docs/guides/conversation-state)에 대해 더 알아보세요. **o 시리즈 모델 전용** -[추론 모델](https://platform.openai.com/docs/guides/reasoning)을 위한 구성 옵션입니다. +[추론 모델](https://platform.openai.com/docs/guides/reasoning)에 대한 구성 옵션입니다. - 이후 턴에서 어떤 추론 항목이 모델에 다시 렌더링되는지 제어합니다. 예: `auto`, `current_turn`, `all_turns`. + 이후 턴에서 어떤 추론 항목이 모델로 다시 렌더링될지 제어합니다. 예: `auto`, `current_turn`, `all_turns`. **o 시리즈 모델 전용** -[추론 모델](https://platform.openai.com/docs/guides/reasoning)의 추론 노력을 제한합니다. 현재 지원되는 값은 `low`, `medium`, `high`입니다. 추론 노력을 줄이면 응답이 더 빨라지고 응답의 추론에 사용되는 토큰이 줄어들 수 있습니다. +[추론 모델](https://platform.openai.com/docs/guides/reasoning)의 추론 노력을 제한합니다. 현재 지원되는 값은 `low`, `medium`, `high`입니다. 추론 노력을 줄이면 응답이 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다. 가능한 값: `low`, `medium`, `high` @@ -291,17 +288,17 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ **지원 중단됨:** 대신 `summary`를 사용하세요. -모델이 수행한 추론의 요약입니다. 디버깅과 모델의 추론 과정을 이해하는 데 유용할 수 있습니다. `auto`, `concise`, `detailed` 중 하나입니다. +모델이 수행한 추론의 요약입니다. 디버깅과 모델의 추론 과정 이해에 유용할 수 있습니다. `auto`, `concise`, `detailed` 중 하나입니다. 가능한 값: `auto`, `concise`, `detailed` - 응답에 사용된 추론 모드입니다. + 응답에 사용되는 추론 모드입니다. - 모델이 수행한 추론의 요약입니다. 디버깅과 모델의 추론 과정을 이해하는 데 유용할 수 있습니다. `auto`, `concise`, `detailed` 중 하나입니다. + 모델이 수행한 추론의 요약입니다. 디버깅과 모델의 추론 과정 이해에 유용할 수 있습니다. `auto`, `concise`, `detailed` 중 하나입니다. 가능한 값: `auto`, `concise`, `detailed` @@ -311,9 +308,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - 모델이 반드시 출력해야 하는 형식을 지정하는 객체입니다. + 모델이 출력해야 하는 형식을 지정하는 객체입니다. -`{ "type": "json_schema" }`를 설정하면 Structured Outputs가 활성화되어, 모델이 제공한 JSON 스키마와 일치하도록 보장합니다. 자세한 내용은 [Structured Outputs 가이드](https://platform.openai.com/docs/guides/structured-outputs)에서 더 알아보세요. +`{ "type": "json_schema" }`를 설정하면 Structured Outputs가 활성화되어, 모델이 제공한 JSON 스키마를 따르도록 보장합니다. 자세한 내용은 [Structured Outputs 가이드](https://platform.openai.com/docs/guides/structured-outputs)에서 확인하세요. 기본 형식은 추가 옵션이 없는 `{ "type": "text" }`입니다. @@ -323,11 +320,11 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - 모델 응답의 상세도를 제한합니다. `low`, `medium`, `high` 중 하나입니다. + 모델 응답의 상세 수준을 제한합니다. `low`, `medium`, `high` 중 하나입니다. - 응답을 생성할 때 모델이 어떤 도구를 사용할지 선택하는 방법입니다. 모델이 호출할 수 있는 도구를 지정하는 방법은 `tools` 매개변수를 참고하세요. + 응답을 생성할 때 모델이 어떤 도구(또는 도구들)를 사용할지 선택하는 방법입니다. 모델이 호출할 수 있는 도구를 지정하는 방법은 `tools` 매개변수를 참고하세요. @@ -347,11 +344,11 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - 이 응답이 완료된 시각의 Unix 타임스탬프(초)입니다. 상태가 `completed`일 때만 표시됩니다. + 이 응답이 완료된 시점의 Unix 타임스탬프(초)입니다. 상태가 `completed`일 때만 표시됩니다. - 이 응답이 생성된 시각의 Unix 타임스탬프(초)입니다. + 이 응답이 생성된 시점의 Unix 타임스탬프(초)입니다. @@ -361,7 +358,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ 응답의 오류 코드입니다. -Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -369,11 +366,11 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto - 지금까지의 텍스트에서 기존 빈도를 기준으로 새 토큰에 패널티를 부과합니다. + 지금까지의 텍스트에서 기존 빈도를 기준으로 새 token에 페널티를 부여합니다. - 이 응답의 고유 식별자입니다. + 이 Response의 고유 식별자입니다. @@ -383,11 +380,11 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 응답이 불완전한 이유입니다. - Possible values: `max_output_tokens`, `content_filter` + 가능한 값: `max_output_tokens`, `content_filter` - 응답에서 처리할 수 있는 내장 도구에 대한 최대 총 호출 수입니다. + 하나의 응답에서 처리할 수 있는 내장 도구에 대한 총 호출의 최대 개수입니다. @@ -395,24 +392,24 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto - 검열된 완료가 요청된 경우 응답 입력 및 출력에 대한 검열 결과입니다. + 조정된 완료가 요청된 경우, 응답 입력과 출력에 대한 조정 결과입니다. - 이 리소스의 객체 유형입니다. 항상 `response`로 설정됩니다. + 이 리소스의 객체 유형이며, 항상 `response`로 설정됩니다. - Possible values: `response` + 가능한 값: `response` - 모델에 의해 생성된 콘텐츠 항목의 배열입니다. + 모델이 생성한 콘텐츠 항목의 배열입니다. - `output` 배열에 있는 항목의 길이와 순서는 모델의 응답에 따라 달라집니다. -- `output` 배열의 첫 번째 항목에 접근하여 모델이 생성한 콘텐츠가 포함된 `assistant` 메시지라고 가정하는 대신, SDK에서 지원하는 경우 `output_text` 속성을 사용하는 것을 고려할 수 있습니다. +- `output` 배열의 첫 번째 항목에 접근하여 모델이 생성한 콘텐츠를 담은 `assistant` 메시지라고 가정하기보다는, SDK에서 지원되는 경우 `output_text` 속성을 사용하는 것을 고려하세요. - `output` 배열에 있는 모든 `output_text` 항목의 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성입니다(있는 경우). Python 및 JavaScript SDK에서 지원됩니다. + `output` 배열의 모든 `output_text` 항목에 있는 텍스트 출력을 집계한 값을 포함하는 SDK 전용 편의 속성입니다(항목이 있는 경우). Python 및 JavaScript SDK에서 지원됩니다. @@ -420,41 +417,41 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto - 지금까지의 텍스트에 나타나는지 여부에 따라 새 토큰에 패널티를 부과합니다. + 지금까지의 텍스트에 나타나는지 여부를 기준으로 새 token에 페널티를 부여합니다. - 유사한 요청에 대한 응답을 캐시하여 캐시 적중률을 최적화하기 위해 OpenAI에서 사용합니다. `user` 필드를 대체합니다. + OpenAI가 유사한 요청에 대한 응답을 캐시하여 캐시 적중률을 최적화하는 데 사용됩니다. `user` 필드를 대체합니다. - 프롬프트 캐시의 보존 정책입니다(예: `in_memory` 또는 `24h`). + prompt 캐시의 보존 정책으로, 예를 들면 `in_memory` 또는 `24h`입니다. - OpenAI의 사용 정책을 위반할 수 있는 애플리케이션 사용자를 감지하는 데 사용되는 안정적인 식별자입니다. + OpenAI의 사용 정책을 위반할 가능성이 있는 애플리케이션 사용자를 감지하는 데 사용되는 안정적인 식별자입니다. - 요청을 처리하는 데 사용되는 처리 계층입니다(예: `auto`, `default`, `flex`, `scale` 또는 `priority`). + 요청을 처리하는 데 사용되는 처리 계층으로, 예를 들면 `auto`, `default`, `flex`, `scale` 또는 `priority`입니다. - 응답 생성 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued` 또는 `incomplete` 중 하나입니다. + 응답 생성의 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - 나중에 API를 통해 검색할 수 있도록 응답이 저장되는지 여부입니다. + 나중에 API를 통해 검색할 수 있도록 응답을 저장할지 여부입니다. - 내장 도구별로 분류된 토큰 및 요청 사용량입니다. + 내장 도구별로 구분된 token 및 요청 사용량입니다. - 이미지 생성 도구 토큰 사용량입니다. + 이미지 생성 도구의 token 사용량입니다. @@ -494,7 +491,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto - 웹 검색 도구 사용량입니다. + 검색 도구 사용량입니다. @@ -502,23 +499,35 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto - 각 토큰 위치에서 반환할 가장 가능성이 높은 토큰의 최대 개수이며, 각 토큰에는 관련 로그 확률이 있습니다. + 각 token 위치에서 반환할 가장 가능성이 높은 token의 최대 개수이며, 각 token에는 연관된 log probability가 함께 제공됩니다. - 입력 토큰, 출력 토큰, 출력 토큰의 분석 및 사용된 총 토큰을 포함한 토큰 사용 세부 정보를 나타냅니다. + 입력 token, 출력 token, 출력 token의 세부 분석, 사용된 총 token을 포함한 token 사용량 세부 정보를 나타냅니다. - 입력 토큰 수입니다. + 입력 token의 개수입니다. - 입력 토큰의 세부 분석입니다. + 입력 token에 대한 자세한 분석입니다. - 캐시에 기록된 입력 토큰 수입니다. + 캐시에 기록된 입력 token의 개수입니다. + + + + 캐시 수명별로 분할된 캐시 쓰기입니다. 두 개의 카운트를 합하면 `cache_write_tokens`가 됩니다. + + + + 12시간 수명으로 캐시에 기록된 입력 토큰 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 토큰 수입니다. @@ -531,7 +540,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto - 출력 토큰에 대한 세부 분석입니다. + 출력 토큰의 세부 분석입니다. @@ -543,7 +552,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto - 최종 사용자에 대한 지원 중단된 식별자입니다. `safety_identifier`와 `prompt_cache_key`로 교체되었습니다. + 최종 사용자에 대한 지원 중단된 식별자입니다. `safety_identifier` 및 `prompt_cache_key`로 교체되었습니다. ## 예시 diff --git a/ko/development/comfy-router/models/openai/o4-mini/code.mdx b/ko/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx similarity index 57% rename from ko/development/comfy-router/models/openai/o4-mini/code.mdx rename to ko/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx index 0045410efd..f7bc31421a 100644 --- a/ko/development/comfy-router/models/openai/o4-mini/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx @@ -1,45 +1,42 @@ --- -title: "Comfy Router로 o4-mini 사용하기" -description: "Comfy Router를 통해 openai/o4-mini를 호출합니다: endpoint, 요청 형태, Router가 반환하는 응답을 설명합니다." -sidebarTitle: "o4-mini" -translationSourceHash: b1b02a55 -translationFrom: development/comfy-router/models/openai/o4-mini/code.mdx +title: "Comfy Router와 함께 GPT 6.1 Terra 사용하기" +description: "Comfy Router를 통해 openai/gpt-6.1-terra를 호출합니다: 엔드포인트, 요청 형태 및 Router가 반환하는 응답." +sidebarTitle: "GPT 6.1 Terra" +translationSourceHash: 27d99514 +translationFrom: development/comfy-router/models/openai/gpt-6-1-terra/code.mdx translationBlockHashes: - "_intro": 23fc3424 - "Quick start": f63680db - "Schema": fcbeee88 + "_intro": c31ab629 + "Quick start": 72fe9e32 + "Schema": aa04e432 "Examples": 67e6c8f1 --- - - - -{/* 생성된 파일. `pnpm code-pages:gen`이 router-schemas/openai/o4-mini.json에서 생성했습니다. */} +{/* 생성된 파일. `pnpm code-pages:gen`에 의해 router-schemas/openai/gpt-6.1-terra.json에서 생성되었습니다. */} import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; -OpenAI에서 제공하고 Comfy Router가 서비스하는 `openai/o4-mini`의 API 레퍼런스입니다. +`openai/gpt-6.1-terra`의 API 레퍼런스이며, Comfy Router가 OpenAI에서 제공합니다. **입력:** 텍스트, 이미지 · **출력:** 텍스트 -## 빠른 시작 +## 빠른 시작 {#quick-start} -[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python과 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 원시 HTTP를 통한 동일한 호출입니다. +[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk` 및 `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 원시 HTTP로 보낸 것입니다. -**모델 ID:** `openai/o4-mini` +**모델 ID:** `openai/gpt-6.1-terra` -**엔드포인트:** `POST https://api.comfy.org/v2/models/openai/o4-mini` +**엔드포인트:** `POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra` - + ```python Python from comfy_sdk import Comfy # 환경에서 COMFY_API_KEY를 읽습니다. -# SDK는 자동으로 idempotency key를 생성하고 자동 재시도를 위해 재사용합니다. +# SDK는 자동으로 idempotency 키를 생성하고 자동 재시도에 재사용합니다. with Comfy() as client: result = client.models.run( - "openai/o4-mini", + "openai/gpt-6.1-terra", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -53,8 +50,8 @@ print(result) import { comfy } from "@comfyorg/sdk"; // 환경에서 COMFY_API_KEY를 읽습니다. -// SDK는 자동으로 idempotency key를 생성하고 자동 재시도를 위해 재사용합니다. -const { data } = await comfy.models.run("openai/o4-mini", { +// SDK는 자동으로 idempotency 키를 생성하고 자동 재시도에 재사용합니다. +const { data } = await comfy.models.run("openai/gpt-6.1-terra", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); @@ -63,7 +60,7 @@ console.log(data); ``` ```bash cURL -curl https://api.comfy.org/v2/models/openai/o4-mini \ +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ @@ -71,8 +68,8 @@ curl https://api.comfy.org/v2/models/openai/o4-mini \ ``` - -동일한 본문을 `POST https://api.comfy.org/v2/models/openai/o4-mini/requests`로 보냅니다. Router는 실행이 접수되는 즉시 `201`과 `request_id`를 응답하며, 결과는 준비되는 대로 이 프로세스나 다른 프로세스에서 수집합니다. 상태, 취소, 수집 방법은 [실행 대기열 전송](/ko/development/comfy-router/queue)에서 다룹니다. + +동일한 본문을 `POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests`로 전송합니다. Router는 실행이 접수되는 즉시 `request_id`와 함께 `201`로 응답하며, 결과는 준비되는 대로 이 프로세스 또는 다른 프로세스에서 수집됩니다. [대기 중 전달](/ko/development/comfy-router/queue)에서 상태, 취소, 수집 과정을 단계별로 설명합니다. ```python Python @@ -80,11 +77,11 @@ import asyncio from comfy_sdk import AsyncComfy # 환경에서 COMFY_API_KEY를 읽습니다. -# 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도를 위해 재사용합니다. +# 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. async def main(): async with AsyncComfy() as client: handle = await client.models.submit( - "openai/o4-mini", + "openai/gpt-6.1-terra", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -92,12 +89,12 @@ async def main(): ) print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - # 서버가 지정한 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. + # 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 대기합니다. async for update in handle.iter_events(): print(update.status, update.queue_position) - # 공급자 자체의 페이로드로, models.run()이 반환하는 것과 동일한 값입니다. - # 실패했거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. + # 공급자 자체의 페이로드이며, models.run()이 반환하는 것과 같은 값입니다. + # 실패했거나 취소된 요청은 여기서 타입이 지정된 Router 오류를 발생시킵니다. result = await handle.get() print(result) @@ -109,39 +106,39 @@ asyncio.run(main()) import { comfy } from "@comfyorg/sdk"; // 환경에서 COMFY_API_KEY를 읽습니다. -// 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도를 위해 재사용합니다. -const handle = await comfy.models.submit("openai/o4-mini", { +// 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. +const handle = await comfy.models.submit("openai/gpt-6.1-terra", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 -// 서버가 지정한 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. +// 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 대기합니다. for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } -// models.run()이 반환하는 것과 동일한 결과입니다. 실패했거나 취소된 요청은 여기에서 거부됩니다. +// models.run()이 반환하는 것과 같은 결과입니다. 실패했거나 취소된 요청은 여기서 거부됩니다. const result = await handle.get(); console.log(result.data); ``` ```bash cURL -# 1. 제출합니다. Router는 request_id, status_url, response_url, cancel_url과 함께 201을 응답합니다. -curl https://api.comfy.org/v2/models/openai/o4-mini/requests \ +# 1. 제출. Router는 request_id, status_url, response_url, cancel_url과 함께 201로 응답합니다. +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -# 2. 상태가 COMPLETED가 될 때까지 폴링하며, 각 응답이 지정한 Retry-After 초만큼 기다립니다. +# 2. 상태가 COMPLETED가 될 때까지 폴링하며, 각 응답이 지정한 Retry-After 초만큼 대기합니다. REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID/status \ +curl -i https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" -# 3. 수집합니다. 모델의 네이티브 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202를 반환합니다. -curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ +# 3. 수집. 모델의 네이티브 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202. +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``` @@ -157,7 +154,7 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - 응답을 생성하는 데 사용되는 모델의 텍스트, 이미지 또는 파일 입력입니다. 이 계약에서 Router가 제공할 수 없는 유일한 필드이며, 아래 `required`에 있는 유일한 항목입니다. + 모델에 대한 텍스트, 이미지 또는 파일 입력으로, 응답을 생성하는 데 사용됩니다. 이 계약에서 Router가 대신 채울 수 없는 유일한 필드이며, 아래 `required`에 있는 유일한 항목입니다. @@ -165,13 +162,13 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - 응답을 위해 생성되는 토큰 수의 상한이며, 표시되는 출력 토큰과 추론 토큰을 포함합니다. 추론 id에서는 이 상한을 숨겨진 추론 토큰과 공유하므로, 값이 작으면 표시되는 텍스트가 나오기 전에 전체 예산을 소진할 수 있습니다. 그래서 추론 스모크 케이스는 1024를 보내고, 채팅 스모크 케이스는 16을 보냅니다. + 응답으로 생성되는 토큰 수의 상한이며, 표시되는 출력 토큰과 추론 토큰을 포함합니다. 추론 id에서는 이 상한이 숨김 추론 토큰과 공유되므로, 값이 작으면 표시되는 텍스트가 나오기 전에 예산 전체를 소진할 수 있습니다. 추론 스모크 케이스가 1024를 보내고 채팅 케이스가 16을 보내는 이유가 여기에 있습니다. 범위: `1` ~ `…` - OpenAI 모델 식별자입니다. Comfy Router에서 이 필드는 선택 사항이며, Router가 `{model}` 경로 세그먼트에서 값을 채웁니다. 명시적인 `null`도 같은 방식으로 교체됩니다. 경로와 일치하지 않는 값을 보내면 거부됩니다. + OpenAI 모델 식별자입니다. Comfy Router에서 이 필드는 선택 사항이며 Router가 `{model}` 경로 세그먼트에서 채웁니다. 명시적인 `null`도 같은 방식으로 교체됩니다. 경로와 일치하지 않는 값을 보내면 거부됩니다. @@ -183,25 +180,25 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - 추론 티어 전용입니다. 추론 모델을 위한 구성이며, 예를 들어 `{"effort": "medium"}`입니다. 변경 없이 전달됩니다. 허용되는 키는 OpenAI의 reasoning 가이드를 참조하십시오. 채팅 티어 id는 이를 무시합니다. + 추론 티어 전용입니다. 추론 모델을 위한 설정입니다(예: `{"effort": "medium"}`). 변경 없이 전달됩니다. 허용되는 키는 OpenAI의 추론 가이드를 참고하십시오. 채팅 티어 id는 이를 무시합니다. - OpenAI가 나중에 검색할 수 있도록 생성된 응답을 저장할지 여부입니다. + OpenAI가 생성된 응답을 나중에 검색할 수 있도록 저장할지 여부입니다. - 이 필드를 보내는 호출자가 거부되지 않도록 선언되어 있지만, 이 표면에서는 아무 효과가 없습니다. Router는 디스패치 이전에 이 값을 `false`로 확정합니다. 그 이유는 `text/event-stream`을 중계하는 것이 아니라 공급자 응답을 캡처하기 때문입니다. Router는 이를 디코딩할 수 없으므로, 스트리밍된 생성은 OpenAI가 청구하고 아무도 계량하지 않게 됩니다. 어떤 Comfy 표면도 스트림을 제공하지 않습니다. v1 `POST /proxy/openai/v1/responses` 인그레스는 `stream: true`를 400으로 거부하고 요청을 업스트림으로 전달하지 않으므로, 어느 표면에서든 이 필드를 생략하거나 `false`를 보내고 완료된 응답을 하나의 JSON 본문으로 읽으십시오. + 이 필드를 보내는 호출자가 거부되지 않도록 선언되어 있지만, 이 표면에서는 아무 효과가 없습니다. Router는 디스패치 전에 이 값을 `false`로 확정합니다. Router가 `text/event-stream`을 중계하는 대신 공급자 응답을 캡처하기 때문인데, 이 스트림을 디코딩할 수 없으므로 스트리밍 생성은 OpenAI가 과금하고 아무도 미터링하지 않게 됩니다. 어떤 Comfy 표면도 스트림을 제공하지 않습니다. v1 `POST /proxy/openai/v1/responses` 인그레스는 `stream: true`를 400으로 거부하고 요청을 업스트림으로 전달하지 않으므로, 어느 표면에서든 이 필드를 생략하거나 `false`를 보내고 완료된 응답을 하나의 JSON 본문으로 읽으십시오. - 샘플링 온도입니다. 채팅 티어 전용입니다. o 시리즈 추론 id(`o1`, `o1-pro`, `o3`, `o4-mini`)는 OpenAI에서 이 매개변수를 거부합니다. Router는 이들에 대해 이를 거부하지 않습니다(두 티어가 하나의 스키마를 공유하는 이유는 이 구성 요소의 설명을 참조하십시오). 따라서 이를 보내는 추론 호출은 OpenAI 자체의 오류로 응답됩니다. + 샘플링 온도입니다. 채팅 티어 전용입니다. o 시리즈 추론 id(`o1`, `o1-pro`, `o3`, `o4-mini`)는 OpenAI에서 이 매개변수를 거부합니다. Router는 이들에 대해 이 매개변수를 거부하지 않으므로(두 티어가 하나의 스키마를 공유하는 이유는 이 컴포넌트의 참고 사항 참조), 이 값을 보내는 추론 호출에는 OpenAI 자체의 오류가 응답으로 돌아옵니다. 범위: `0` ~ `2` - 출력 형식 구성이며, 예를 들어 Structured Outputs를 위한 `{"format": {"type": "json_schema", ...}}`입니다. 변경 없이 전달됩니다. + 출력 형식 설정입니다(예: Structured Outputs를 위한 `{"format": {"type": "json_schema", ...}}`). 변경 없이 전달됩니다. @@ -209,93 +206,91 @@ curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - 모델이 호출할 수 있는 도구 정의입니다. Router는 도구 분류를 좁히지 않습니다. 허용되는 형태는 OpenAI의 Responses API 참조를 확인하십시오. + 모델이 호출할 수 있는 도구 정의입니다. Router는 도구 분류를 좁히지 않습니다. 허용되는 형태는 OpenAI의 Responses API 레퍼런스를 참고하십시오. - Nucleus 샘플링 컷오프입니다. `temperature`와 동일한 조건으로 채팅 티어 전용입니다. + 누클리어스 샘플링 컷오프입니다. `temperature`와 같은 조건으로 채팅 티어 전용입니다. 범위: `0` ~ `1` - 컨텍스트가 모델의 창을 초과할 때의 잘림 전략입니다. 위의 세 어휘와 달리, 여기서는 enum이 실제로 강제됩니다. 이 두 값이 OpenAI가 문서화한 완전한 집합이며 그 이후 늘어나지 않았기 때문입니다. 명시적인 `null`은 위에 있는 필드들과 동일한 조건으로 여전히 허용됩니다. + 컨텍스트가 모델의 창(window)을 초과할 때의 잘라내기 전략입니다. 위의 세 어휘 목록과 달리 여기서는 열거형이 실제로 강제됩니다. 이 두 값이 OpenAI가 문서화한 전체 집합이며 그 이후 늘어나지 않았기 때문입니다. 명시적인 `null`은 위 필드들과 같은 조건으로 여전히 허용됩니다. 가능한 값: `auto`, `disabled` - 토큰 사용량 봉투입니다. v1 작업이 요청 본문에 이를 선언하기 때문에 이 계약에 존재합니다. OpenAI는 RESPONSE에 이를 채우므로, 호출자가 보낼 이유가 없습니다. + 토큰 사용량 봉투입니다. v1 오퍼레이션이 요청 본문에 이를 선언하기 때문에 이 계약에 존재합니다. OpenAI는 이를 RESPONSE에 채우므로, 호출자가 보낼 이유가 없습니다. -Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키마에서 생성되었으며, 이는 요청이 공급자에 도달하기 전에 Router가 호출을 검증하는 대상과 동일한 문서입니다. +`GET /v2/models/openai/gpt-6.1-terra/openapi.json`에서 Router가 제공하는 스키마에서 생성되었으며, 요청이 공급자에 도달하기 전에 호출을 검증하는 데 사용하는 것과 동일한 문서입니다. ### 출력 시스템(또는 개발자) 메시지를 모델 컨텍스트의 첫 번째 항목으로 삽입합니다. -`previous_response_id`와 함께 사용할 때, 이전 응답의 instructions는 다음 -응답으로 이어지지 않습니다. 따라서 새 응답에서 시스템(또는 개발자) 메시지를 -간단히 교체할 수 있습니다. +`previous_response_id`와 함께 사용할 경우, 이전 응답의 지침은 +다음 응답으로 이어지지 않습니다. 따라서 새 응답에서 시스템(또는 개발자) +메시지를 간단히 교체할 수 있습니다. - 표시되는 출력 토큰과 [추론 토큰](https://platform.openai.com/docs/guides/reasoning)을 포함하여 -응답에 대해 생성될 수 있는 토큰 수의 상한입니다. + 응답에 대해 생성할 수 있는 토큰 수의 상한으로, 표시되는 출력 토큰과 [추론 토큰](https://platform.openai.com/docs/guides/reasoning)을 포함합니다. - 응답을 생성하는 데 사용되는 모델 + 응답 생성에 사용되는 모델입니다. - 응답의 무작위성을 제어합니다 + 응답의 무작위성을 제어합니다. 범위: `0` ~ `2` - nucleus 샘플링을 통해 응답의 다양성을 제어합니다 + 뉴클리어스 샘플링을 통해 응답의 다양성을 제어합니다. 범위: `0` ~ `1` - 모델 응답에 사용할 잘림 전략입니다. + 모델 응답에 사용할 잘라내기 전략입니다. - `auto`: 이 응답과 이전 응답의 컨텍스트가 모델의 컨텍스트 창 크기를 - 초과하면, 모델은 대화 중간의 입력 항목을 삭제하여 컨텍스트 창에 - 맞도록 응답을 잘라냅니다. -- `disabled` (기본값): 모델 응답이 모델의 컨텍스트 창 크기를 초과할 - 경우, 요청은 400 오류와 함께 실패합니다. + 초과하면, 모델이 대화 중간의 입력 항목을 삭제하여 응답을 컨텍스트 + 창에 맞게 잘라냅니다. +- `disabled` (기본값): 모델 응답이 모델의 컨텍스트 창 크기를 초과하면 + 요청이 400 오류로 실패합니다. 가능한 값: `auto`, `disabled` - 모델에 대한 이전 응답의 고유 ID입니다. 이를 사용하여 여러 턴의 대화를 -생성할 수 있습니다. [대화 상태](https://platform.openai.com/docs/guides/conversation-state)에 -대해 더 알아보세요. + 모델에 대한 이전 응답의 고유 ID입니다. 이를 사용하여 +다중 턴 대화를 생성할 수 있습니다. [대화 상태](https://platform.openai.com/docs/guides/conversation-state)에 대해 +더 알아보세요. - **o-시리즈 모델 전용** + **o 시리즈 모델 전용** -[추론 모델](https://platform.openai.com/docs/guides/reasoning)을 위한 -구성 옵션입니다. +[추론 모델](https://platform.openai.com/docs/guides/reasoning)의 구성 옵션입니다. - 나중 턴에서 어떤 추론 항목이 모델에 다시 렌더링되는지 제어합니다. 예: `auto`, `current_turn`, `all_turns`. + 이후 턴에서 어떤 추론 항목이 모델에 다시 렌더링되는지 제어합니다. 예: `auto`, `current_turn`, `all_turns`. - **o-시리즈 모델 전용** + **o 시리즈 모델 전용** -[추론 모델](https://platform.openai.com/docs/guides/reasoning)의 -추론 노력을 제한합니다. 현재 지원되는 값은 `low`, `medium`, `high`입니다. -추론 노력을 줄이면 응답이 더 빨라지고 응답에서 추론에 사용되는 -토큰이 줄어들 수 있습니다. +[추론 모델](https://platform.openai.com/docs/guides/reasoning)의 추론 노력 수준을 제한합니다. +현재 지원되는 값은 `low`, `medium`, `high`입니다. 추론 노력을 +줄이면 응답이 더 빨라지고 응답에서 추론에 사용되는 토큰 수가 +줄어들 수 있습니다. 가능한 값: `low`, `medium`, `high` @@ -303,9 +298,9 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 **지원 중단됨:** 대신 `summary`를 사용하세요. -모델이 수행한 추론의 요약입니다. 이는 디버깅과 모델의 추론 과정을 -이해하는 데 유용할 수 있습니다. `auto`, `concise`, `detailed` 중 -하나입니다. +모델이 수행한 추론의 요약입니다. 이는 모델의 추론 과정을 +디버깅하고 이해하는 데 유용할 수 있습니다. +`auto`, `concise`, `detailed` 중 하나입니다. 가능한 값: `auto`, `concise`, `detailed` @@ -315,9 +310,9 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 - 모델이 수행한 추론의 요약입니다. 이는 디버깅과 모델의 추론 과정을 -이해하는 데 유용할 수 있습니다. `auto`, `concise`, `detailed` 중 -하나입니다. + 모델이 수행한 추론의 요약입니다. 이는 모델의 추론 과정을 +디버깅하고 이해하는 데 유용할 수 있습니다. +`auto`, `concise`, `detailed` 중 하나입니다. 가능한 값: `auto`, `concise`, `detailed` @@ -329,25 +324,25 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 모델이 출력해야 하는 형식을 지정하는 객체입니다. -`{ "type": "json_schema" }`를 구성하면 Structured Outputs가 활성화되어, -모델이 제공한 JSON 스키마와 일치하도록 보장합니다. [Structured Outputs 가이드](https://platform.openai.com/docs/guides/structured-outputs)에서 -더 알아보세요. +`{ "type": "json_schema" }`를 구성하면 구조화된 출력이 활성화되어, +모델이 제공한 JSON 스키마와 일치하도록 보장합니다. 자세한 내용은 +[구조화된 출력 가이드](https://platform.openai.com/docs/guides/structured-outputs)에서 확인하세요. 기본 형식은 추가 옵션이 없는 `{ "type": "text" }`입니다. -**gpt-4o 및 최신 모델에는 권장되지 않습니다:** +**gpt-4o 및 최신 모델에는 권장되지 않음:** `{ "type": "json_object" }`로 설정하면 이전 JSON 모드가 활성화되어, 모델이 생성하는 메시지가 유효한 JSON임을 보장합니다. 이를 지원하는 -모델에서는 `json_schema`를 사용하는 것이 선호됩니다. +모델에서는 `json_schema` 사용이 선호됩니다. - 모델 응답의 장황함을 제한합니다. `low`, `medium`, `high` 중 하나입니다. + 모델 응답의 상세도를 제한합니다. `low`, `medium`, `high` 중 하나입니다. - 모델이 응답을 생성할 때 어떤 도구를 사용할지 선택하는 방법입니다. + 응답을 생성할 때 모델이 사용할 도구(또는 도구들)를 선택하는 방법입니다. 모델이 호출할 수 있는 도구를 지정하는 방법은 `tools` 매개변수를 참조하세요. @@ -357,11 +352,11 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 - 모델 응답이 배경에서 실행되는지 여부입니다. + 모델 응답이 백그라운드에서 실행되는지 여부입니다. - 응답에 대한 청구 정보입니다. + 응답에 대한 결제 정보입니다. @@ -369,11 +364,11 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 - 이 응답이 완료된 시각의 Unix 타임스탬프(초)입니다. 상태가 `completed`일 때만 존재합니다. + 이 응답이 완료된 시점의 Unix 타임스탬프(초)입니다. 상태가 `completed`일 때만 존재합니다. - 이 응답이 생성된 시각의 Unix 타임스탬프(초)입니다. + 이 응답이 생성된 시점의 Unix 타임스탬프(초)입니다. @@ -387,15 +382,15 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 - 사람이 읽을 수 있는 오류 설명입니다. + 오류에 대한 사람이 읽을 수 있는 설명입니다. - 지금까지의 텍스트에서 기존 빈도를 기준으로 새 토큰에 페널티를 부여합니다. + 지금까지의 텍스트에 등장한 빈도를 기준으로 새 토큰에 페널티를 부여합니다. - 이 Response의 고유 식별자입니다. + 이 응답의 고유 식별자입니다. @@ -409,7 +404,7 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 - 하나의 응답에서 처리할 수 있는 내장 도구 호출의 최대 총 횟수입니다. + 응답에서 처리할 수 있는 내장 도구 총 호출 수의 최댓값입니다. @@ -417,7 +412,7 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 - 모더레이션된 완성이 요청된 경우, 응답 입력과 출력에 대한 모더레이션 결과입니다. + 모더레이션된 완료가 요청된 경우 응답 입력 및 출력에 대한 모더레이션 결과입니다. @@ -429,17 +424,16 @@ Router가 `GET /v2/models/openai/o4-mini/openapi.json`에서 제공하는 스키 모델이 생성한 콘텐츠 항목의 배열입니다. -- `output` 배열에 있는 항목의 길이와 순서는 모델의 응답에 - 따라 달라집니다. -- `output` 배열의 첫 번째 항목에 접근하여 모델이 생성한 - 콘텐츠를 담은 `assistant` 메시지라고 가정하기보다는, - SDK에서 지원하는 경우 `output_text` 속성을 사용하는 것을 - 고려해 보세요. +- `output` 배열에 있는 항목의 길이와 순서는 + 모델의 응답에 따라 달라집니다. +- `output` 배열의 첫 번째 항목에 접근하여 모델이 생성한 콘텐츠가 포함된 + `assistant` 메시지라고 가정하기보다는, SDK에서 지원되는 경우 + `output_text` 속성을 사용하는 것을 고려하세요. - `output` 배열의 모든 `output_text` 항목에 있는 집계된 텍스트 출력을 -포함하는 SDK 전용 편의 속성입니다(항목이 있는 경우). + `output` 배열의 모든 `output_text` 항목에서 집계된 텍스트 출력을 포함하는 +SDK 전용 편의 속성입니다(항목이 있는 경우). Python 및 JavaScript SDK에서 지원됩니다. @@ -452,7 +446,7 @@ Python 및 JavaScript SDK에서 지원됩니다. - OpenAI가 유사한 요청에 대한 응답을 캐시하여 캐시 적중률을 최적화하는 데 사용됩니다. `user` 필드를 대체합니다. + OpenAI가 캐시 적중률을 최적화하기 위해 유사한 요청에 대한 응답을 캐시하는 데 사용합니다. `user` 필드를 대체합니다. @@ -460,11 +454,11 @@ Python 및 JavaScript SDK에서 지원됩니다. - OpenAI의 사용 정책을 위반할 가능성이 있는 애플리케이션 사용자를 감지하는 데 사용되는 안정적인 식별자입니다. + OpenAI의 사용 정책을 위반할 수 있는 애플리케이션 사용자를 탐지하는 데 도움이 되도록 사용되는 안정적인 식별자입니다. - 요청을 처리하는 데 사용되는 처리 등급입니다. 예: `auto`, `default`, `flex`, `scale`, `priority`. + 요청을 처리하는 데 사용되는 처리 등급입니다. 예: `auto`, `default`, `flex`, `scale` 또는 `priority`. @@ -474,11 +468,11 @@ Python 및 JavaScript SDK에서 지원됩니다. - API를 통해 나중에 검색할 수 있도록 응답을 저장할지 여부입니다. + 나중에 API를 통해 조회할 수 있도록 응답이 저장되는지 여부입니다. - 내장 도구별로 분류된 토큰 및 요청 사용량입니다. + 내장 도구별로 분류한 토큰 및 요청 사용량입니다. @@ -530,11 +524,11 @@ Python 및 JavaScript SDK에서 지원됩니다. - 각 토큰 위치에서 반환할 가장 가능성이 높은 토큰의 최대 개수이며, 각 토큰에는 연관된 로그 확률이 있습니다. + 각 토큰 위치에서 반환할 가장 가능성이 높은 토큰의 최대 수이며, 각 토큰에는 관련 로그 확률이 포함됩니다. - 입력 토큰, 출력 토큰, 출력 토큰의 세부 분류, 사용된 총 토큰을 포함한 토큰 사용 세부 정보를 나타냅니다. + 입력 토큰, 출력 토큰, 출력 토큰의 세부 분류, 사용된 총 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다. @@ -549,6 +543,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 구분된 캐시 쓰기 내역입니다. 두 개의 개수는 합쳐서 `cache_write_tokens`가 됩니다. + + + + 12시간 수명으로 캐시에 기록된 입력 토큰 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 토큰 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). @@ -571,7 +577,7 @@ Python 및 JavaScript SDK에서 지원됩니다. - 최종 사용자에 대한 지원 중단된 식별자입니다. `safety_identifier`와 `prompt_cache_key`로 교체되었습니다. + 최종 사용자에 대한 지원 중단된 식별자입니다. `safety_identifier` 및 `prompt_cache_key`로 교체되었습니다. ## 예시 diff --git a/ko/development/comfy-router/models/openai/gpt-6-astra/code.mdx b/ko/development/comfy-router/models/openai/gpt-6-astra/code.mdx index e10c1f692a..3c415d30b9 100644 --- a/ko/development/comfy-router/models/openai/gpt-6-astra/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-6-astra/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router와 함께 GPT 6 Astra 사용하기" description: "Comfy Router를 통해 openai/gpt-6-astra를 호출합니다: endpoint, 요청 형태, 그리고 Router가 반환하는 응답." sidebarTitle: "GPT 6 Astra" -translationSourceHash: b6fe51cd +translationSourceHash: dc53fcc4 translationFrom: development/comfy-router/models/openai/gpt-6-astra/code.mdx translationBlockHashes: "_intro": f5ed3b66 "Quick start": 2154b82d - "Schema": 5304e7bd + "Schema": cdd4d7a5 "Examples": 67e6c8f1 --- @@ -241,7 +241,7 @@ Router가 `GET /v2/models/openai/gpt-6-astra/openapi.json`에서 제공하는 - 응답에 대해 생성될 수 있는 토큰 수의 상한으로, 표시되는 출력 토큰과 [reasoning tokens](https://platform.openai.com/docs/guides/reasoning)를 포함합니다. + 응답에 대해 생성될 수 있는 토큰 수의 상한으로, 표시되는 출력 토큰과 [추론 토큰](https://platform.openai.com/docs/guides/reasoning)를 포함합니다. @@ -270,23 +270,23 @@ Router가 `GET /v2/models/openai/gpt-6-astra/openapi.json`에서 제공하는 모델에 대한 이전 응답의 고유 ID입니다. 이를 사용하여 -여러 턴의 대화를 생성하세요. [conversation state](https://platform.openai.com/docs/guides/conversation-state)에 대해 더 알아보세요. +여러 턴의 대화를 생성하세요. [대화 상태](https://platform.openai.com/docs/guides/conversation-state)에 대해 더 알아보세요. **o-series 모델 전용** -[reasoning models](https://platform.openai.com/docs/guides/reasoning)에 대한 구성 옵션입니다. +[추론 모델](https://platform.openai.com/docs/guides/reasoning)에 대한 구성 옵션입니다. - 이후 턴에서 어떤 reasoning 항목이 모델에 다시 렌더링되는지 제어합니다(예: `auto`, `current_turn`, `all_turns`). + 이후 턴에서 어떤 추론 항목이 모델에 다시 렌더링되는지 제어합니다(예: `auto`, `current_turn`, `all_turns`). **o-series 모델 전용** -[reasoning models](https://platform.openai.com/docs/guides/reasoning)의 추론 노력을 제한합니다. +[추론 모델](https://platform.openai.com/docs/guides/reasoning)의 추론 노력을 제한합니다. 현재 지원되는 값은 `low`, `medium`, `high`입니다. 추론 노력을 줄이면 응답이 더 빨라지고 응답에서 추론에 사용되는 토큰이 줄어들 수 있습니다. @@ -334,7 +334,7 @@ Router가 `GET /v2/models/openai/gpt-6-astra/openapi.json`에서 제공하는 - 모델 응답의 장황함(verbosity)을 제한합니다. `low`, `medium`, `high` 중 하나입니다. + 모델 응답의 장황함을 제한합니다. `low`, `medium`, `high` 중 하나입니다. @@ -371,7 +371,9 @@ Router가 `GET /v2/models/openai/gpt-6-astra/openapi.json`에서 제공하는 - 응답에 대한 오류 코드입니다.Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답에 대한 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -393,7 +395,7 @@ Router가 `GET /v2/models/openai/gpt-6-astra/openapi.json`에서 제공하는 응답이 불완전한 이유입니다. - Possible values: `max_output_tokens`, `content_filter` + 가능한 값: `max_output_tokens`, `content_filter` @@ -405,13 +407,13 @@ Router가 `GET /v2/models/openai/gpt-6-astra/openapi.json`에서 제공하는 - moderation이 적용된 완성을 요청한 경우, 응답 입력과 출력에 대한 moderation 결과입니다. + 모더레이션된 완료가 요청된 경우 응답 입력 및 출력에 대한 모더레이션 결과입니다. 이 리소스의 객체 타입이며, 항상 `response`로 설정됩니다. - Possible values: `response` + 가능한 값: `response` @@ -442,7 +444,7 @@ Python 및 JavaScript SDK에서 지원됩니다. - prompt cache의 보존 정책입니다. 예: `in_memory` 또는 `24h`. + 프롬프트 캐시의 보존 정책입니다. 예: `in_memory` 또는 `24h`. @@ -456,7 +458,7 @@ Python 및 JavaScript SDK에서 지원됩니다. 응답 생성 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -536,6 +538,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 검색된 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-6-luna/code.mdx b/ko/development/comfy-router/models/openai/gpt-6-luna/code.mdx index 760229c402..c7514ea879 100644 --- a/ko/development/comfy-router/models/openai/gpt-6-luna/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-6-luna/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router에서 GPT 6 Luna 사용하기" description: "Comfy Router를 통해 openai/gpt-6-luna를 호출합니다: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답입니다." sidebarTitle: "GPT 6 Luna" -translationSourceHash: 016a3493 +translationSourceHash: e436b4b8 translationFrom: development/comfy-router/models/openai/gpt-6-luna/code.mdx translationBlockHashes: "_intro": ae1e4a72 "Quick start": 7c4cfbcd - "Schema": 1198c1c7 + "Schema": af3ef2c5 "Examples": 67e6c8f1 --- @@ -357,7 +357,9 @@ Router가 `GET /v2/models/openai/gpt-6-luna/openapi.json`에서 제공하는 스 - 응답에 대한 오류 코드입니다.Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답에 대한 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -379,7 +381,7 @@ Router가 `GET /v2/models/openai/gpt-6-luna/openapi.json`에서 제공하는 스 응답이 불완전한 이유입니다. - Possible values: `max_output_tokens`, `content_filter` + 가능한 값: `max_output_tokens`, `content_filter` @@ -397,7 +399,7 @@ Router가 `GET /v2/models/openai/gpt-6-luna/openapi.json`에서 제공하는 스 이 리소스의 객체 유형이며, 항상 `response`로 설정됩니다. - Possible values: `response` + 가능한 값: `response` @@ -439,7 +441,7 @@ Python 및 JavaScript SDK에서 지원됩니다. 응답 생성의 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -518,6 +520,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 가져온 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-6-sol/code.mdx b/ko/development/comfy-router/models/openai/gpt-6-sol/code.mdx index fec897c918..dc18f54924 100644 --- a/ko/development/comfy-router/models/openai/gpt-6-sol/code.mdx +++ b/ko/development/comfy-router/models/openai/gpt-6-sol/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router로 GPT 6 Sol 사용하기" description: "Comfy Router를 통해 openai/gpt-6-sol을 호출합니다: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답입니다." sidebarTitle: "GPT 6 Sol" -translationSourceHash: 7b6ad6e8 +translationSourceHash: fd9a0f66 translationFrom: development/comfy-router/models/openai/gpt-6-sol/code.mdx translationBlockHashes: "_intro": eeaf1fd1 "Quick start": 231cae97 - "Schema": 808c67cd + "Schema": 302da76c "Examples": 67e6c8f1 --- @@ -165,7 +165,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ 응답을 위해 생성되는 토큰 수의 상한이며, 표시되는 출력 토큰과 추론 토큰을 포함합니다. 추론 id에서는 이 상한을 숨김 추론 토큰과 공유하므로, 값이 작으면 표시되는 텍스트가 나오기 전에 전체 예산이 소진될 수 있습니다. 그래서 추론 스모크 케이스는 1024를 보내고 채팅 케이스는 16을 보냅니다. - Range: `1` to `…` + 범위: `1` ~ `…` @@ -195,7 +195,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ 샘플링 온도입니다. 채팅 티어 전용입니다. o 시리즈 추론 id(`o1`, `o1-pro`, `o3`, `o4-mini`)는 OpenAI에서 이 매개변수를 거부합니다. Router는 이들을 위해 이를 거부하지 않습니다. 두 티어가 하나의 스키마를 공유하는 이유에 대해서는 이 컴포넌트의 설명을 참조하세요. 따라서 이 값을 보내는 추론 호출은 OpenAI 자체의 오류로 응답됩니다. - Range: `0` to `2` + 범위: `0` ~ `2` @@ -213,13 +213,13 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ 뉴클리어스 샘플링 컷오프입니다. 채팅 티어 전용이며, `temperature`와 동일한 조건입니다. - Range: `0` to `1` + 범위: `0` ~ `1` 컨텍스트가 모델의 창을 초과할 때의 잘라내기 전략입니다. 위의 세 어휘와 달리 여기서는 이 열거형이 강제됩니다. 이 두 값이 OpenAI가 문서화한 완전한 집합이고 그 이후 늘어나지 않았기 때문입니다. 명시적인 `null`은 위의 필드들과 같은 조건으로 여전히 허용됩니다. - Possible values: `auto`, `disabled` + 가능한 값: `auto`, `disabled` @@ -538,6 +538,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰의 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 가져온 토큰 수입니다. [프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/openai/gpt-image-1/code.mdx b/ko/development/comfy-router/models/openai/gpt-image-1/code.mdx deleted file mode 100644 index 7f151c4a46..0000000000 --- a/ko/development/comfy-router/models/openai/gpt-image-1/code.mdx +++ /dev/null @@ -1,360 +0,0 @@ ---- -title: "Comfy Router에서 GPT Image 1 사용하기" -description: "Comfy Router를 통해 openai/gpt-image-1을 호출합니다: 엔드포인트, 요청 형태, Router가 반환하는 응답을 설명합니다." -sidebarTitle: "GPT Image 1" -translationSourceHash: 02331b72 -translationFrom: development/comfy-router/models/openai/gpt-image-1/code.mdx -translationBlockHashes: - "_intro": 410036c3 - "Quick start": b83102e7 - "Schema": 8be561c9 - "Examples": c73859ec ---- - - - - - -{/* GENERATED FILE. Generated from router-schemas/openai/gpt-image-1.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; - -Comfy Router가 OpenAI로부터 제공하는 `openai/gpt-image-1`의 API 레퍼런스입니다. - -**입력:** 텍스트, 이미지 · **출력:** 이미지 - -## 빠른 시작 - -[내 Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 이를 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`와 `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 원시 HTTP를 통한 동일한 호출입니다. - -**모델 ID:** `openai/gpt-image-1` - -**엔드포인트:** `POST https://api.comfy.org/v2/models/openai/gpt-image-1` - - - - -```python Python -from comfy_sdk import Comfy - -# 환경 변수에서 COMFY_API_KEY를 읽습니다. -# SDK는 자동으로 idempotency key를 생성하고 자동 재시도에 재사용합니다. -with Comfy() as client: - result = client.models.run( - "openai/gpt-image-1", - { - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경 변수에서 COMFY_API_KEY를 읽습니다. -// SDK는 자동으로 idempotency key를 생성하고 자동 재시도에 재사용합니다. -const { data } = await comfy.models.run("openai/gpt-image-1", { - prompt: "a rocketship on a launchpad", - quality: "low", - size: "1024x1024", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/gpt-image-1 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" -``` - - - -동일한 본문을 `POST https://api.comfy.org/v2/models/openai/gpt-image-1/requests`로 전송합니다. Router는 실행이 접수되는 즉시 `request_id`와 함께 `201`로 응답하며, 결과는 준비가 되면 이 프로세스든 다른 프로세스든 상관없이 수집됩니다. [대기 중 전달](/ko/development/comfy-router/queue)에서 상태, 취소, 수집 과정을 자세히 다룹니다. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 환경 변수에서 COMFY_API_KEY를 읽습니다. -# 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/gpt-image-1", - { - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024", - }, - ) - print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - - # 요청이 완료될 때까지 폴링하며, 서버가 알려주는 Retry-After만큼 대기합니다. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 공급자 자체의 페이로드이며, models.run()이 반환하는 것과 동일한 값입니다. - # 실패했거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경 변수에서 COMFY_API_KEY를 읽습니다. -// 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. -const handle = await comfy.models.submit("openai/gpt-image-1", { - prompt: "a rocketship on a launchpad", - quality: "low", - size: "1024x1024", -}); -console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - -// 요청이 완료될 때까지 폴링하며, 서버가 알려주는 Retry-After만큼 대기합니다. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run()이 반환하는 것과 동일한 결과입니다. 실패했거나 취소된 요청은 여기에서 거부됩니다. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 제출. Router는 request_id, status_url, response_url, cancel_url과 함께 201로 응답합니다. -curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" - -# 2. 상태가 COMPLETED가 될 때까지 폴링하며, 각 응답이 알려주는 Retry-After 초만큼 대기합니다. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 수집. 모델의 네이티브 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202를 반환합니다. -curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## 스키마 - -### 입력 - - - 배경 투명도입니다. `auto`는 모델이 선택하도록 합니다. - - 가능한 값: `transparent`, `opaque`, `auto` - - - - 편집할 소스 이미지입니다. 이 필드가 있으면 편집 작업이 선택됩니다. 텍스트 기반 이미지 생성에서는 이 필드를 완전히 생략하세요. -모델이 공개한 예시는 이 필드를 생략하는 생성 호출입니다. `image`를 추가하는 것이 두 모드 사이의 차이 전부입니다(동일한 엔드포인트, 동일한 모델 id). 다만 편집 프롬프트는 장면이 아니라 원하는 변경 사항을 설명하므로, 구조적으로 새로 추가된 필드가 이것 하나뿐인데도 아래의 편집 본문은 생성 예시와 다르게 읽힙니다. -그대로 복사해 사용할 수 있습니다: `{"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}`. 페이로드는 축약이 아니라 완전한 1x1 PNG이며, 이 본문은 Router 자체의 요청 검증 테스트에서 허용되는 사례로 고정되어 있습니다. 자신의 이미지 바이트로 바꿔 넣으세요. -이미지 하나 또는 이미지 배열을 받습니다. gpt-image-1 및 이후 모델은 최대 16개까지 받을 수 있으며, Router는 디스패치 전에 이 스키마를 기준으로 이를 강제합니다. - - - - 이미지 하나로, Router가 호출자를 대신해 가져오는 https URL이거나 바이트를 인라인으로 담은 `data:image/;base64,` URI입니다. 허용되는 이미지 유형은 png, webp, jpeg이며, 이 집합은 공급자에게 맡기지 않고 해석 시점에 강제됩니다. svg, gif, avif, tiff는 원인에서 두 단계 떨어진 파트너 오류가 되는 대신, 보낸 이미지를 지목하며 여기에서 거부됩니다. -URL 형식을 사용하는 것이 좋습니다. base64 페이로드는 약 4/3로 부풀어 오르고 전체 요청 본문은 100 MiB로 제한되므로, 인라인 형식은 약 75 MB 소스 이미지에서 한계에 도달합니다. URL은 이 문제를 완전히 피해 갑니다. 이 설명 끝에 명시된 이미지당 및 요청당 미디어 상한은 본문 상한보다 더 엄격하므로, 어느 정도 실제 크기가 되는 이미지라면 먼저 마주치는 것은 이 상한입니다. -URL은 여러분의 자격 증명 없이 해석되어야 합니다. Router는 이를 서버 측에서 가져오며 요청에 호출자 자격 증명을 함께 보내지 않으므로, 서명이 쿼리 문자열에 있는 presigned URL이 지원되는 형식입니다. `/api/assets/{id}/content` 같은 인증된 엔드포인트는 Router에 이미지 대신 401을 반환합니다. 해당 URL을 직접 요청하고, 리다이렉트되는 서명된 URL을 전달하세요. -가져오기는 개방된 인터넷이 아니라 이름이 지정된 호스트 집합으로 제한되며, 동일한 목록이 보내는 URL뿐 아니라 모든 리다이렉트 홉에도 다시 적용됩니다. 따라서 다른 호스트의 URL이나 목록 밖으로 리다이렉트하는 URL은 어떤 공급자와도 접촉하기 전에 거부됩니다. 현재 이 목록에는 Comfy 자체의 에셋 전송만 포함됩니다. Comfy 에셋 버킷 아래의 서명된 `storage.googleapis.com` URL이며, 이것이 `/api/assets/{id}/content`가 리다이렉트하는 형식입니다. 파트너 CDN이나 일반 https 호스트는 목록에 없습니다. -두 가지 확장이 순차 배포 중이며, 현재 기본적으로 모두 꺼져 있습니다. 이들은 하나의 전환 뒤에 함께 제공되어 동시에 활성화되므로, 아래 내용은 아직 이를 기준으로 개발할 대상이 아니라 예정된 사항으로 취급하세요. 둘 중 하나에 의존하기 전에 문의하세요. -첫 번째는 `POST /customers/storage`가 업로드를 서명해 넣는 버킷입니다. 롤아웃이 여러분의 환경에 도달하기 전까지는 그 엔드포인트에서 나온 업로드 URL이 여기에서 거부됩니다. 버킷이 Comfy 소유이고 호스트도 동일한데도 그렇습니다. 따라서 "Comfy에 업로드한 다음 URL을 전달"하는 방식은 아직 동작하지 않으며, 동작하는 형식은 `/api/assets/{id}/content`가 리다이렉트하는 서명된 URL입니다. -두 번째는 모든 사람에게 한 번에 적용되는 것이 아니라 계정별로 활성화됩니다. 이 호스트들 뒤의 버킷이 우리 것이 아니라 여러분의 것이기 때문입니다. 위 전환이 켜져 있더라도 제3자 인바운드 미디어가 활성화되지 않은 계정은 거부되며, 호스트가 지원되지 않는다는 것이 아니라 바로 그 문구로 그렇게 안내됩니다. Comfy 담당자에게 계정에 대해 활성화를 요청하세요. 이 확장은 다음의 제3자 오브젝트 스토리지 호스트를 추가로 허용하며, 여기서 버킷은 여러분의 것이고 Router는 이에 대한 소유권을 주장하지 않습니다: Cloudflare R2 (`.r2.cloudflarestorage.com`, `pub-.r2.dev`), Amazon S3 (`s3.amazonaws.com` 및 `s3..amazonaws.com`, 경로 스타일 또는 `.` 접두사 형식 모두), Azure Blob Storage (`.blob.core.windows.net`) 그리고 Alibaba Cloud OSS (`.oss-.aliyuncs.com`, `oss-accelerate` 엔드포인트 포함). 이들은 특별히 오브젝트 스토리지 엔드포인트입니다. 같은 공급자 도메인의 범용 엔드포인트, 예를 들어 Alibaba Function Compute 트리거는 목록에 없으며 거부됩니다. -일치되는 것은 공급자가 아니라 호스트 이름 형식입니다. 따라서 위에서 공급자를 언급했다고 해서 그 공급자가 발급할 수 있는 모든 URL이 허용된다는 뜻은 아니며, 호출자가 각각을 합리적으로 사용할 수 있으므로 세 가지 유사 사례를 분명히 밝힐 필요가 있습니다. R2 사용자 지정 도메인(`cdn.example.com`)은 허용되지 않습니다. Cloudflare는 `pub-.r2.dev`를 속도 제한이 있는 디버그 호스트 이름으로 문서화하고 프로덕션 트래픽은 대신 사용자 지정 도메인으로 보내지만, 사용자 지정 도메인은 호스트 이름에 R2임을 나타내는 정보가 없으므로 Router는 이를 다른 호스트와 구별할 수 없어 거부합니다. `.r2.cloudflarestorage.com` 엔드포인트에 presign하거나 `pub-.r2.dev` 형식을 사용하세요. S3의 IPv6 dualstack 엔드포인트(`s3.dualstack..amazonaws.com`) 역시 허용되지 않습니다. 일반 리전 엔드포인트를 사용하세요. Azure Blob의 대체 DNS 영역(`.z.blob.storage.azure.net`)도 마찬가지입니다. `.blob.core.windows.net`을 사용하세요. 돌려받는 거부 메시지에는 이와 동일한 형식이 명시되므로, 이를 읽기 위해 여기까지 올 필요가 없습니다. -위의 `` 및 `pub-` 자리 표시자는 일반적으로 사용하게 될 형태를 보여줄 뿐, 깊이 제한이 아닙니다. 일치는 객체 스토리지 도메인 접미사를 기준으로 하므로, 동일한 네임스페이스 아래의 더 깊은 이름(`a.b.pub-.r2.dev`)도 허용됩니다. 다만 그것으로 인해 넓어지지 않는 것은 네임스페이스 자체입니다. 접미사는 여전히 나열된 것 중 하나여야 합니다. -아래 예시는 형태만 보여줍니다. 실제 값에는 서명 쿼리 파라미터도 함께 포함되는데, 게시된 예시는 스펙에 영원히 남고 실제 서명은 유출된 자격 증명이자 작동을 멈추는 링크이므로 여기서는 의도적으로 생략했습니다. -각 이미지는 25 MiB로 제한되며, 한 요청의 이미지는 총 64 MiB로 제한됩니다. - - - - 실행할 gpt-image 모델입니다. Router가 주소 지정된 모델 id를 끼워 넣으므로, /v2/models/openai/gpt-image-2로 주소를 지정하는 호출자는 이 필드를 보내지 않습니다. - - - - 콘텐츠 검열 설정 - - 가능한 값: `low`, `auto` - - - - 생성할 이미지 수(1-10)입니다. - - 범위: `1` ~ `10` - - - - JPEG 또는 WebP의 압축 수준(0-100)입니다. - - 범위: `0` ~ `100` - - - - 출력 이미지의 형식 - - 가능한 값: `png`, `webp`, `jpeg` - - - - 라이브 스트림과 함께 사용할 때만 의미가 있으며, 이 표면은 라이브 스트림을 제공할 수 없습니다. `stream`을 보내더라도 `false`로 고정됩니다. 생성 시에는 `0` 또는 `null`이 아닌 모든 값이 400으로 거부되며, 요청이 `stream: true`도 함께 보내는지와는 무관합니다. `image`를 포함한 요청에서는 이 필드가 전달되지 않고 버려집니다. 이 필드는 생략하세요. - - 범위: `0` ~ `3` - - - - 생성할 이미지 또는 `image`에 수행할 편집에 대한 텍스트 설명입니다. - - - - 생성되거나 편집된 이미지의 품질입니다. `xhigh`와 `max`는 gpt-image-2.5-flare와 gpt-image-2.5-sunburst가 추가된 두 등급이며, `standard`와 `hd`는 허용된 어떤 모델도 읽지 않는 dall-e 시대의 표기입니다. - - 가능한 값: `auto`, `low`, `medium`, `high`, `xhigh`, `max`, `standard`, `hd` - - - - 이미지의 크기(예: 1024x1024, 1536x1024, auto) - - - - 이 필드를 보내는 호출자가 거부되지 않도록 선언되어 있지만 이 표면에서는 무효입니다. Router는 디스패치 전에 이를 `false`로 고정합니다. Router는 `text/event-stream`을 중계하는 대신 제공자 응답을 캡처하기 때문입니다(`image`를 포함한 요청에서는 편집이 이를 포함하지 않고 다시 인코딩되므로 이 필드가 대신 버려집니다). 어떤 Comfy 표면도 gpt-image 부분 이미지 스트리밍을 제공하지 않습니다. v1 `POST /proxy/openai/images/generations` 진입점은 `stream: true`를 400으로 거부하고 요청을 업스트림으로 전달하지 않습니다. 따라서 이 필드를 생략하고 완료된 응답을 하나의 JSON 본문으로 읽으세요. 스트림이 열리지 않으므로 `stream: true`와 1보다 큰 `n`을 결합하는 것에 대한 OpenAI의 제한은 여기서 적용되지 않습니다. `n`은 보낸 그대로 전달됩니다. - - - - 최종 사용자 모니터링을 위한 고유 식별자 - - -Router가 `GET /v2/models/openai/gpt-image-1/openapi.json`에서 제공하는 스키마에서 생성되었으며, 이는 요청이 공급자에 도달하기 이전에 호출을 검증하는 기준이 되는 동일한 문서입니다. - -### 출력 - - - - - - - Base64로 인코딩된 이미지 데이터 - - - - 수정된 프롬프트 - - - - 이미지의 URL - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 생성된 이미지의 배경이 `opaque`인지 `transparent`인지, OpenAI가 이번 생성에서 확정한 값입니다. 요청 파라미터의 기본값은 `auto`이므로, 이 값을 고정하지 않은 호출자는 여기에서 실제로 어느 쪽이 생성되었는지 알 수 있습니다. - - - - 생성이 완료된 시각의 Unix 타임스탬프(초)입니다. OpenAI가 이미지 생성 응답에서 REQUIRED로 선언하는 유일한 멤버이므로, OpenAI가 생성자인 경우에는 항상 존재합니다. alt 기반 id에서 fal, pika, wavespeed 또는 runware가 응답을 제공하는 경우에는 나머지 네 개의 확정 파라미터 멤버와 마찬가지로 이 필드가 완전히 생략됩니다. 현재 시점의 epoch 값이 2^31에 충분히 가까워서 서식을 지정하지 않은 `integer`가 많은 SDK 생성기에서 32비트 필드를 만들어내기 때문에 `int64`로 선언되었습니다. - - 형식: `int64` - - - - `data[].b64_json`에 담긴 바이트의 인코딩으로, `png`, `webp` 또는 `jpeg`입니다. OpenAI가 실제로 인코딩한 형식이며, 요청에 `output_format`이 포함되었다면 그 값이고 포함되지 않았다면 `png`이므로, 디코더는 요청에서 형식을 다시 도출할 필요 없이 이 값을 기준으로 삼을 수 있습니다. - - - - 생성이 실제로 실행된 품질 등급으로, OpenAI는 `low`, `medium`, `high`, `xhigh` 또는 `max` 중 하나를 보고합니다. 이는 요청을 그대로 되돌려준 값이 아니라 확정된(RESOLVED) 등급이며, 요청 자체의 `quality` 기본값은 `auto`입니다. - - - - 생성이 실제로 실행된 픽셀 크기로, `x` 형식입니다. 이는 확정된(RESOLVED) 크기입니다. 요청의 `size`는 기본값이 `auto`이고 `auto`를 명시적으로 허용하므로, 실제로 사용된 크기가 보고되는 곳은 여기뿐입니다. - - -## 예시 - -### 입력 - -```json -{ - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024" -} -``` - -### 출력 - -```json -{ - "created": 1767225600, - "data": [ - { - "b64_json": "PGJhc2U2ND4=" - } - ], - "usage": { - "input_tokens": 12, - "input_tokens_details": { - "image_tokens": 0, - "text_tokens": 12 - }, - "output_tokens": 1056, - "total_tokens": 1068 - } -} -``` - - diff --git a/ko/development/comfy-router/models/openai/o1-pro/code.mdx b/ko/development/comfy-router/models/openai/o1-pro/code.mdx deleted file mode 100644 index 06162092e8..0000000000 --- a/ko/development/comfy-router/models/openai/o1-pro/code.mdx +++ /dev/null @@ -1,618 +0,0 @@ ---- -title: "Comfy Router에서 o1-pro 사용하기" -description: "Comfy Router를 통해 openai/o1-pro를 호출하는 방법: 엔드포인트, 요청 형태, 그리고 Router가 반환하는 응답." -sidebarTitle: "o1-pro" -translationSourceHash: f672098e -translationFrom: development/comfy-router/models/openai/o1-pro/code.mdx -translationBlockHashes: - "_intro": a236f94d - "Quick start": f09ba6ce - "Schema": 4d31797d - "Examples": 67e6c8f1 ---- - - - -{/* GENERATED FILE. Generated from router-schemas/openai/o1-pro.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; - -OpenAI가 Comfy Router를 통해 제공하는 `openai/o1-pro`의 API 레퍼런스입니다. - -**입력:** 텍스트, 이미지 · **출력:** 텍스트 - -## 빠른 시작 - -[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python과 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 원시 HTTP로 수행한 것입니다. - -**모델 ID:** `openai/o1-pro` - -**엔드포인트:** `POST https://api.comfy.org/v2/models/openai/o1-pro` - - - - -```python Python -from comfy_sdk import Comfy - -# 환경에서 COMFY_API_KEY를 읽습니다. -# SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. -with Comfy() as client: - result = client.models.run( - "openai/o1-pro", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경에서 COMFY_API_KEY를 읽습니다. -// SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. -const { data } = await comfy.models.run("openai/o1-pro", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/o1-pro \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -동일한 본문을 `POST https://api.comfy.org/v2/models/openai/o1-pro/requests` 로 보냅니다. Router는 실행이 접수되는 즉시 `201` 과 `request_id` 를 응답하며, 결과는 준비가 되는 대로 이 프로세스나 다른 프로세스에서 수집할 수 있습니다. 상태, 취소, 수집 방법은 [대기열 전송](/ko/development/comfy-router/queue) 을 참고하세요. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 환경에서 COMFY_API_KEY를 읽습니다. -# 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/o1-pro", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - - # 서버가 알려주는 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 공급자 자체의 페이로드이며, models.run()이 반환하는 것과 동일한 값입니다. - # 실패했거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경에서 COMFY_API_KEY를 읽습니다. -// 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. -const handle = await comfy.models.submit("openai/o1-pro", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - -// 서버가 알려주는 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run()이 반환하는 것과 동일한 결과입니다. 실패했거나 취소된 요청은 여기에서 거부됩니다. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 제출합니다. Router는 request_id, status_url, response_url, cancel_url과 함께 201로 응답합니다. -curl https://api.comfy.org/v2/models/openai/o1-pro/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. 각 응답이 알려주는 Retry-After 초만큼 기다리며 상태가 COMPLETED가 될 때까지 폴링합니다. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 수집합니다. 모델의 기본 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202를 반환합니다. -curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## 스키마 - -### 입력 - - - 모델 응답에 포함할 추가 출력 데이터입니다. - - - - 모델에 전달되는 텍스트, 이미지 또는 파일 입력으로, 응답을 생성하는 데 사용됩니다. 이 계약에서 Router가 제공할 수 없는 유일한 필드이며, 아래 `required`에 있는 유일한 항목입니다. - - - - 모델 컨텍스트의 첫 번째 항목으로 시스템(또는 개발자) 메시지를 삽입합니다. - - - - 응답을 위해 생성되는 토큰 수의 상한으로, 표시되는 출력 토큰과 추론 토큰을 포함합니다. 추론 id에서는 이 상한을 숨겨진 추론 토큰과 공유하므로, 작은 값은 표시되는 텍스트가 나오기 전에 전체 예산을 소진할 수 있습니다. 이것이 추론 스모크 케이스는 1024를 보내고 채팅 스모크 케이스는 16을 보내는 이유입니다. - - 범위: `1`부터 `…`까지 - - - - OpenAI 모델 식별자입니다. Comfy Router에서 이 필드는 선택 사항이며 Router가 `{model}` 경로 세그먼트에서 값을 채웁니다. 명시적인 `null`도 같은 방식으로 교체됩니다. 경로와 일치하지 않는 값을 보내면 거부됩니다. - - - - 모델이 도구 호출을 병렬로 실행하도록 허용할지 여부입니다. - - - - 멀티턴 대화를 위한 이전 응답의 ID입니다. - - - - 추론 티어 전용입니다. 추론 모델을 위한 구성입니다(예: `{"effort": "medium"}`). 변경 없이 전달됩니다. 허용되는 키는 OpenAI의 추론 가이드를 참조하세요. 채팅 티어 id는 이를 무시합니다. - - - - OpenAI가 생성된 응답을 나중에 검색할 수 있도록 저장할지 여부입니다. - - - - 이 필드를 보내는 호출자가 거부되지 않도록 선언되어 있지만, 이 표면에서는 아무 효과가 없습니다. Router는 디스패치 이전에 이를 `false`로 확정합니다. Router가 `text/event-stream`을 중계하는 대신 공급자 응답을 캡처하기 때문이며, 그 스트림은 디코딩할 수 없으므로 스트리밍 생성은 OpenAI가 과금하고 아무도 계량하지 않게 됩니다. 어떤 Comfy 표면도 스트림을 제공하지 않습니다. v1 `POST /proxy/openai/v1/responses` 인그레스는 `stream: true`를 400으로 거부하고 요청을 업스트림으로 전달하지 않습니다. 따라서 어느 표면에서든 이 필드를 생략하거나 `false`를 보내고, 완료된 응답을 하나의 JSON 본문으로 읽으세요. - - - - 샘플링 온도입니다. 채팅 티어 전용입니다. o 시리즈 추론 id(`o1`, `o1-pro`, `o3`, `o4-mini`)는 OpenAI에서 이 매개변수를 거부합니다. Router는 이들을 위해 이 매개변수를 거부하지 않습니다. 두 티어가 하나의 스키마를 공유하는 이유는 이 컴포넌트의 설명을 참조하세요. 따라서 이를 보내는 추론 호출에는 OpenAI 자체의 오류가 응답으로 돌아옵니다. - - 범위: `0`부터 `2`까지 - - - - 출력 형식 구성입니다. 예를 들어 Structured Outputs를 위한 `{"format": {"type": "json_schema", ...}}`입니다. 변경 없이 전달됩니다. - - - - 모델이 사용할 도구를 선택하는 방법입니다. 문자열 모드이거나 도구를 지정하는 객체입니다. - - - - 모델이 호출할 수 있는 도구 정의입니다. Router는 도구 분류를 좁히지 않습니다. 허용되는 형태는 OpenAI의 Responses API 레퍼런스를 참조하세요. - - - - Nucleus 샘플링 컷오프입니다. `temperature`와 동일한 조건으로 채팅 티어 전용입니다. - - 범위: `0`부터 `1`까지 - - - - 컨텍스트가 모델의 창을 초과할 때의 잘라내기 전략입니다. 위의 세 가지 어휘와 달리 여기서는 이 enum이 강제됩니다. 이 두 값이 OpenAI가 문서화한 완전한 집합이며 그 이후 늘어나지 않았기 때문입니다. 명시적인 `null`은 위의 필드들과 동일한 조건으로 여전히 허용됩니다. - - 가능한 값: `auto`, `disabled` - - - - 토큰 사용량 봉투입니다. v1 작업이 요청 본문에 이를 선언하기 때문에 이 계약에 존재합니다. OpenAI는 이를 응답에 채우므로, 호출자가 보낼 이유가 없습니다. - - -`GET /v2/models/openai/o1-pro/openapi.json`에서 Router가 제공하는 스키마에서 생성되었으며, 이는 요청이 공급자에게 도달하기 전에 호출을 검증하는 데 사용하는 동일한 문서입니다. - -### 출력 - - - 시스템(또는 developer) 메시지를 모델 컨텍스트의 첫 번째 항목으로 삽입합니다. - -`previous_response_id`와 함께 사용하면 이전 응답의 instructions는 다음 -응답으로 이어지지 않습니다. 따라서 새 응답에서 시스템(또는 developer) -메시지를 간단히 교체할 수 있습니다. - - - - 응답에 대해 생성될 수 있는 토큰 수의 상한이며, 표시되는 출력 토큰과 [reasoning 토큰](https://platform.openai.com/docs/guides/reasoning)을 포함합니다. - - - - 응답을 생성하는 데 사용된 모델 - - - - 응답의 무작위성을 제어합니다 - - 범위: `0` ~ `2` - - - - nucleus 샘플링을 통해 응답의 다양성을 제어합니다 - - 범위: `0` ~ `1` - - - - 모델 응답에 사용할 잘림 전략입니다. -- `auto`: 이 응답과 이전 응답의 컨텍스트가 모델의 컨텍스트 창 - 크기를 초과하면, 모델은 대화 중간의 입력 항목을 버려 - 컨텍스트 창에 맞도록 응답을 자릅니다. -- `disabled`(기본값): 모델 응답이 모델의 컨텍스트 창 크기를 - 초과하면 요청이 400 오류로 실패합니다. - - 가능한 값: `auto`, `disabled` - - - - 모델에 대한 이전 응답의 고유 ID입니다. 이를 사용하여 -다중 턴 대화를 생성할 수 있습니다. [대화 상태](https://platform.openai.com/docs/guides/conversation-state)에 대해 더 알아보세요. - - - - **o 시리즈 모델 전용** - -[reasoning 모델](https://platform.openai.com/docs/guides/reasoning)의 -구성 옵션입니다. - - - - 나중 턴에서 어떤 reasoning 항목이 모델로 다시 전달되는지 제어합니다. 예: `auto`, `current_turn`, `all_turns`. - - - - **o 시리즈 모델 전용** - -[reasoning 모델](https://platform.openai.com/docs/guides/reasoning)의 -추론 노력을 제한합니다. -현재 지원되는 값은 `low`, `medium`, `high`입니다. 추론 노력을 -줄이면 응답이 더 빨라지고 응답에서 추론에 사용되는 토큰이 -줄어들 수 있습니다. - - 가능한 값: `low`, `medium`, `high` - - - - **지원 중단됨:** 대신 `summary`를 사용하세요. - -모델이 수행한 추론의 요약입니다. 이는 디버깅과 모델의 추론 -과정을 이해하는 데 유용할 수 있습니다. -`auto`, `concise`, `detailed` 중 하나입니다. - - 가능한 값: `auto`, `concise`, `detailed` - - - - 응답에 사용된 reasoning 모드입니다. - - - - 모델이 수행한 추론의 요약입니다. 이는 디버깅과 모델의 추론 -과정을 이해하는 데 유용할 수 있습니다. -`auto`, `concise`, `detailed` 중 하나입니다. - - 가능한 값: `auto`, `concise`, `detailed` - - - - - - - - 모델이 출력해야 하는 형식을 지정하는 객체입니다. - -`{ "type": "json_schema" }`를 구성하면 Structured Outputs가 활성화되어 -모델이 제공한 JSON 스키마와 일치하도록 보장합니다. 자세한 내용은 -[Structured Outputs 가이드](https://platform.openai.com/docs/guides/structured-outputs)를 참고하세요. - -기본 형식은 추가 옵션 없이 `{ "type": "text" }`입니다. - -**gpt-4o 및 최신 모델에는 권장되지 않습니다:** - -`{ "type": "json_object" }`로 설정하면 이전 JSON 모드가 활성화되어 -모델이 생성하는 메시지가 유효한 JSON임을 보장합니다. 이를 지원하는 -모델에는 `json_schema` 사용이 권장됩니다. - - - - 모델 응답의 verbosity(장황함)를 제한합니다. `low`, `medium`, `high` 중 하나입니다. - - - - 응답을 생성할 때 모델이 어떤 도구(또는 도구들)를 사용할지 선택하는 -방법입니다. 모델이 호출할 수 있는 도구를 지정하는 방법은 `tools` -매개변수를 참조하세요. - - - - - - - - 모델 응답이 배경에서 실행되는지 여부입니다. - - - - 응답에 대한 결제 정보입니다. - - - - 응답 비용을 지불하는 주체입니다. - - - - 이 응답이 완료된 시각의 Unix 타임스탬프(초)입니다. status가 `completed`인 경우에만 표시됩니다. - - - - 이 응답이 생성된 시각의 Unix 타임스탬프(초)입니다. - - - - 모델이 응답 생성에 실패했을 때 반환되는 오류 객체입니다. - - - - 응답에 대한 오류 코드입니다.Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - 오류에 대한 사람이 읽을 수 있는 설명입니다. - - - - 지금까지의 텍스트에서 기존 빈도를 기준으로 새 토큰에 페널티를 부여합니다. - - - - 이 Response의 고유 식별자입니다. - - - - 응답이 불완전한 이유에 대한 세부 정보입니다. - - - - 응답이 불완전한 이유입니다. - - Possible values: `max_output_tokens`, `content_filter` - - - - 하나의 응답에서 처리할 수 있는 기본 제공 도구에 대한 총 호출의 최대 개수입니다. - - - - 응답에 첨부할 수 있는 키-값 쌍의 집합입니다. - - - - 검열된 완성을 요청한 경우, 응답 입력과 출력에 대한 검열 결과입니다. - - - - 이 리소스의 객체 유형이며, 항상 `response`로 설정됩니다. - - Possible values: `response` - - - - 모델이 생성한 콘텐츠 항목의 배열입니다. - -- `output` 배열에 있는 항목의 길이와 순서는 모델의 응답에 따라 달라집니다. -- `output` 배열의 첫 번째 항목에 접근하여 모델이 생성한 콘텐츠가 담긴 `assistant` 메시지라고 가정하는 대신, SDK에서 지원되는 경우 `output_text` 속성을 사용하는 것을 고려할 수 있습니다. - - - - `output` 배열의 모든 `output_text` 항목에서 집계된 텍스트 출력을 포함하는 SDK 전용 편의 속성입니다(항목이 있는 경우). Python 및 JavaScript SDK에서 지원됩니다. - - - - 모델이 도구 호출을 병렬로 실행하도록 허용할지 여부입니다. - - - - 지금까지의 텍스트에 등장하는지 여부를 기준으로 새 토큰에 페널티를 부여합니다. - - - - 캐시 적중률을 최적화하기 위해 유사한 요청에 대한 응답을 캐시하는 데 OpenAI가 사용합니다. `user` 필드를 대체합니다. - - - - 프롬프트 캐시의 보존 정책입니다(예: `in_memory` 또는 `24h`). - - - - OpenAI의 사용 정책을 위반할 수 있는 애플리케이션 사용자를 감지하는 데 사용되는 안정적인 식별자입니다. - - - - 요청을 처리하는 데 사용되는 처리 등급입니다(예: `auto`, `default`, `flex`, `scale`, `priority`). - - - - 응답 생성 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - 나중에 API를 통해 가져올 수 있도록 응답을 저장할지 여부입니다. - - - - 기본 제공 도구별로 분류된 토큰 및 요청 사용량입니다. - - - - 이미지 생성 도구의 토큰 사용량입니다. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 웹 검색 도구 사용량입니다. - - - - - - - - 각 토큰 위치에서 반환할 가장 가능성이 높은 토큰의 최대 개수이며, 각 토큰에는 연관된 로그 확률이 있습니다. - - - - 입력 토큰, 출력 토큰, 출력 토큰의 세부 분류, 사용된 총 토큰을 포함한 토큰 사용 세부 정보를 나타냅니다. - - - - 입력 토큰 수입니다. - - - - 입력 토큰의 세부 분류입니다. - - - - 캐시에 기록된 입력 토큰 수입니다. - - - - 캐시에서 가져온 토큰 수입니다. -[프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). - - - - 출력 토큰 수입니다. - - - - 출력 토큰에 대한 상세 분석입니다. - - - - 추론 토큰 수입니다. - - - - 사용된 총 토큰 수입니다. - - - - 최종 사용자에 대한 지원 중단된 식별자입니다. `safety_identifier`와 `prompt_cache_key`로 교체되었습니다. - - -## 예시 - -### 입력 - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### 출력 - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/ko/development/comfy-router/models/openai/o1/code.mdx b/ko/development/comfy-router/models/openai/o1/code.mdx deleted file mode 100644 index b9a928a97a..0000000000 --- a/ko/development/comfy-router/models/openai/o1/code.mdx +++ /dev/null @@ -1,601 +0,0 @@ ---- -title: "Comfy Router에서 o1 사용하기" -description: "Comfy Router를 통해 openai/o1을 호출하는 방법: endpoint, 요청 형태, 그리고 Router가 반환하는 응답을 설명합니다." -sidebarTitle: "o1" -translationSourceHash: f0eb94c8 -translationFrom: development/comfy-router/models/openai/o1/code.mdx -translationBlockHashes: - "_intro": 86454249 - "Quick start": 7a99b942 - "Schema": 6de26ff5 - "Examples": 67e6c8f1 ---- - - - -{/* 생성된 파일. `pnpm code-pages:gen`이 router-schemas/openai/o1.json에서 생성했습니다. */} - -import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; - -Comfy Router가 OpenAI로부터 제공하는 `openai/o1`의 API 레퍼런스입니다. - -**입력:** 텍스트, 이미지 · **출력:** 텍스트 - -## 빠른 시작 - -[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 원시 HTTP로 실행합니다. - -**모델 ID:** `openai/o1` - -**엔드포인트:** `POST https://api.comfy.org/v2/models/openai/o1` - - - - -```python Python -from comfy_sdk import Comfy - -# 환경에서 COMFY_API_KEY를 읽습니다. -# SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. -with Comfy() as client: - result = client.models.run( - "openai/o1", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경에서 COMFY_API_KEY를 읽습니다. -// SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. -const { data } = await comfy.models.run("openai/o1", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/o1 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -동일한 본문을 `POST https://api.comfy.org/v2/models/openai/o1/requests`로 보냅니다. Router는 실행이 접수되는 즉시 `request_id`와 함께 `201`을 응답하며, 결과는 준비되는 대로 이 프로세스나 다른 프로세스에서 수집할 수 있습니다. 상태, 취소, 수집 방법은 [큐 전송](/ko/development/comfy-router/queue)에서 자세히 다룹니다. - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 환경에서 COMFY_API_KEY를 읽습니다. -# 각 submit() 호출은 자체 Idempotency-Key를 발급하고 자동 재시도에 재사용합니다. -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/o1", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - - # 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 기다립니다. - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 공급자의 원본 페이로드이며, models.run()이 반환하는 것과 동일한 값입니다. - # 실패했거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 환경에서 COMFY_API_KEY를 읽습니다. -// 각 submit() 호출은 자체 Idempotency-Key를 발급하고 자동 재시도에 재사용합니다. -const handle = await comfy.models.submit("openai/o1", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 - -// 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 기다립니다. -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// models.run()이 반환하는 것과 동일한 결과입니다. 실패했거나 취소된 요청은 여기에서 reject됩니다. -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 제출합니다. Router는 request_id, status_url, response_url, cancel_url과 함께 201을 응답합니다. -curl https://api.comfy.org/v2/models/openai/o1/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. 상태가 COMPLETED가 될 때까지 폴링하며, 각 응답이 지정한 Retry-After 초만큼 기다립니다. -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 수집합니다. 완료되면 모델의 원본 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202를 반환합니다. -curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## 스키마 - -### 입력 - - - 모델 응답에 포함할 추가 출력 데이터입니다. - - - - 모델에 전달하는 텍스트, 이미지 또는 파일 입력으로, 응답을 생성하는 데 사용됩니다. 이 계약에서 Router가 채울 수 없는 유일한 필드이며, 아래 `required`에 있는 유일한 항목입니다. - - - - 모델의 컨텍스트에서 첫 번째 항목으로 시스템(또는 개발자) 메시지를 삽입합니다. - - - - 응답을 위해 생성되는 토큰 수의 상한으로, 표시되는 출력 토큰과 추론 토큰을 포함합니다. reasoning id에서는 이 상한을 숨겨진 추론 토큰과 공유하므로, 값이 작으면 표시되는 텍스트가 나오기 전에 전체 예산을 소진할 수 있습니다. 그래서 reasoning 스모크 케이스는 1024를 보내고 chat 스모크 케이스는 16을 보냅니다. - - 범위: `1`부터 `…`까지 - - - - OpenAI 모델 식별자입니다. Comfy Router에서 이 필드는 선택 사항(OPTIONAL)이며 Router가 `{model}` 경로 세그먼트에서 값을 채웁니다. 명시적인 `null`도 같은 방식으로 교체됩니다. 경로와 일치하지 않는 값을 보내면 거부됩니다. - - - - 모델이 도구 호출을 병렬로 실행하도록 허용할지 여부입니다. - - - - 다중 턴 대화를 위한 이전 응답의 ID입니다. - - - - reasoning 등급 전용입니다. reasoning 모델을 위한 구성입니다. 예: `{"effort": "medium"}`. 변경 없이 전달됩니다. 허용되는 키는 OpenAI의 reasoning 가이드를 참조하세요. chat 등급 id는 이를 무시합니다. - - - - OpenAI가 생성된 응답을 나중에 검색할 수 있도록 저장할지 여부입니다. - - - - 이 필드를 보내는 호출자가 거부되지 않도록 선언되어 있지만, 이 표면에서는 아무 효과가 없습니다. Router는 디스패치 이전에 이 값을 `false`로 확정합니다. Router는 `text/event-stream`을 중계하는 대신 공급자 응답을 캡처하는데, 이 스트림을 디코딩할 수 없기 때문입니다. 따라서 스트리밍 생성은 OpenAI가 과금하고 아무도 사용량을 측정하지 않게 됩니다. 어떤 Comfy 표면도 스트림을 제공하지 않습니다. v1 `POST /proxy/openai/v1/responses` 인그레스는 `stream: true`를 400으로 거부하고 요청을 업스트림으로 절대 전달하지 않으므로, 어느 표면에서든 이 필드를 생략하거나 `false`를 보내고 완료된 응답을 하나의 JSON 본문으로 읽으세요. - - - - 샘플링 temperature입니다. chat 등급 전용입니다. o 시리즈 reasoning id(`o1`, `o1-pro`, `o3`, `o4-mini`)는 OpenAI에서 이 매개변수를 거부합니다. Router는 이들에 대해 이 매개변수를 거부하지 않습니다. 두 등급이 하나의 스키마를 공유하는 이유는 이 컴포넌트의 설명을 참조하세요. 따라서 이를 보내는 reasoning 호출은 OpenAI 자체 오류로 응답됩니다. - - 범위: `0`부터 `2`까지 - - - - 출력 형식 구성입니다. 예를 들어 Structured Outputs를 위한 `{"format": {"type": "json_schema", ...}}`입니다. 변경 없이 전달됩니다. - - - - 모델이 사용할 도구를 어떻게 선택해야 하는지 지정합니다. 문자열 모드이거나 도구를 지정하는 객체입니다. - - - - 모델이 호출할 수 있는 도구 정의입니다. Router는 도구 분류를 좁히지 않습니다. 허용되는 형태는 OpenAI의 Responses API 레퍼런스를 참조하세요. - - - - nucleus 샘플링 컷오프입니다. chat 등급 전용이며 `temperature`와 동일한 조건입니다. - - 범위: `0`부터 `1`까지 - - - - 컨텍스트가 모델의 창을 초과할 때의 잘림 전략입니다. 위의 세 가지 값 집합과 달리 여기서는 enum이 실제로 강제됩니다. 이 두 값이 OpenAI가 문서화한 전체 집합이며 그 집합이 늘어나지 않았기 때문입니다. 명시적인 `null`은 위의 필드들과 동일한 조건으로 여전히 허용됩니다. - - 가능한 값: `auto`, `disabled` - - - - 토큰 사용량 봉투(envelope)입니다. v1 작업이 요청 본문에 이를 선언하기 때문에 이 계약에 존재합니다. OpenAI는 이를 RESPONSE에 채우므로, 호출자가 보낼 이유가 없습니다. - - -Router가 `GET /v2/models/openai/o1/openapi.json`에서 제공하는 스키마에서 생성되었으며, 이는 요청이 공급자에 도달하기 전에 호출을 검증하는 데 사용하는 동일한 문서입니다. - -### 출력 - - - 시스템(또는 개발자) 메시지를 모델 컨텍스트의 첫 번째 항목으로 삽입합니다. - -`previous_response_id`와 함께 사용하면 이전 응답의 instructions가 다음 응답으로 이어지지 않습니다. 따라서 새 응답에서 시스템(또는 개발자) 메시지를 간단히 교체할 수 있습니다. - - - - 응답에 대해 생성할 수 있는 토큰 수의 상한으로, 표시되는 출력 토큰과 [추론 토큰](https://platform.openai.com/docs/guides/reasoning)을 포함합니다. - - - - 응답을 생성하는 데 사용된 모델 - - - - 응답의 무작위성을 제어합니다 - - 범위: `0`부터 `2`까지 - - - - nucleus 샘플링을 통해 응답의 다양성을 제어합니다 - - 범위: `0`부터 `1`까지 - - - - 모델 응답에 사용할 잘림(truncation) 전략입니다. -- `auto`: 이 응답과 이전 응답들의 컨텍스트가 모델의 컨텍스트 창 크기를 초과하면, 모델은 대화 중간의 입력 항목을 버려서 컨텍스트 창에 맞도록 응답을 잘라냅니다. -- `disabled` (기본값): 모델 응답이 모델의 컨텍스트 창 크기를 초과하면 요청이 400 오류와 함께 실패합니다. - - 가능한 값: `auto`, `disabled` - - - - 모델에 대한 이전 응답의 고유 ID입니다. 이를 사용하여 멀티턴 대화를 생성하세요. [대화 상태](https://platform.openai.com/docs/guides/conversation-state)에 대해 더 알아보세요. - - - - **o-series 모델 전용** - -[추론 모델](https://platform.openai.com/docs/guides/reasoning)에 대한 구성 옵션입니다. - - - - 이후 턴에서 어떤 추론 항목이 모델에 다시 렌더링되는지 제어합니다. 예: `auto`, `current_turn`, `all_turns`. - - - - **o-series 모델 전용** - -[추론 모델](https://platform.openai.com/docs/guides/reasoning)의 추론 노력을 제한합니다. 현재 지원되는 값은 `low`, `medium`, `high`입니다. 추론 노력을 줄이면 응답이 더 빨라지고 응답에서 추론에 사용되는 토큰 수가 줄어들 수 있습니다. - - 가능한 값: `low`, `medium`, `high` - - - - **지원 중단됨:** 대신 `summary`를 사용하세요. - -모델이 수행한 추론의 요약입니다. 디버깅과 모델의 추론 과정을 이해하는 데 유용할 수 있습니다. `auto`, `concise`, `detailed` 중 하나입니다. - - 가능한 값: `auto`, `concise`, `detailed` - - - - 응답에 사용되는 추론 모드입니다. - - - - 모델이 수행한 추론의 요약입니다. 디버깅과 모델의 추론 과정을 이해하는 데 유용할 수 있습니다. `auto`, `concise`, `detailed` 중 하나입니다. - - 가능한 값: `auto`, `concise`, `detailed` - - - - - - - - 모델이 출력해야 하는 형식을 지정하는 객체입니다. - -`{ "type": "json_schema" }`를 구성하면 Structured Outputs가 활성화되어, 모델이 제공한 JSON schema와 일치하도록 보장합니다. [Structured Outputs 가이드](https://platform.openai.com/docs/guides/structured-outputs)에서 더 알아보세요. - -기본 형식은 추가 옵션이 없는 `{ "type": "text" }`입니다. - -**gpt-4o 및 최신 모델에는 권장되지 않습니다:** - -`{ "type": "json_object" }`로 설정하면 이전 JSON 모드가 활성화되어, 모델이 생성하는 메시지가 유효한 JSON임을 보장합니다. 이를 지원하는 모델에서는 `json_schema` 사용이 선호됩니다. - - - - 모델 응답의 장황함을 제한합니다. `low`, `medium`, `high` 중 하나입니다. - - - - 응답을 생성할 때 모델이 어떤 도구를 사용할지 선택하는 방법입니다. 모델이 호출할 수 있는 도구를 지정하는 방법은 `tools` 매개변수를 참조하세요. - - - - - - - - 모델 응답이 배경에서 실행되는지 여부입니다. - - - - 응답에 대한 청구 정보입니다. - - - - 응답 비용을 지불할 책임이 있는 주체입니다. - - - - 이 응답이 완료된 시점의 Unix 타임스탬프(초 단위)입니다. 상태가 `completed`일 때만 표시됩니다. - - - - 이 응답이 생성된 시점의 Unix 타임스탬프(초 단위)입니다. - - - - 모델이 응답 생성에 실패했을 때 반환되는 오류 객체입니다. - - - - 응답에 대한 오류 코드입니다. - -Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - 사람이 읽을 수 있는 오류 설명입니다. - - - - 지금까지의 텍스트에서 기존 빈도를 기준으로 새 토큰에 페널티를 부여합니다. - - - - 이 Response의 고유 식별자입니다. - - - - 응답이 불완전한 이유에 대한 세부 정보입니다. - - - - 응답이 불완전한 이유입니다. - - 가능한 값: `max_output_tokens`, `content_filter` - - - - 하나의 응답에서 처리할 수 있는 내장 도구에 대한 총 호출의 최대 개수입니다. - - - - 응답에 첨부할 수 있는 키-값 쌍의 집합입니다. - - - - 모데레이션된 완성이 요청된 경우, 응답 입력과 출력에 대한 모데레이션 결과입니다. - - - - 이 리소스의 객체 유형이며, 항상 `response`로 설정됩니다. - - 가능한 값: `response` - - - - 모델이 생성한 콘텐츠 항목의 배열입니다. - -- `output` 배열에 있는 항목의 길이와 순서는 모델의 응답에 따라 달라집니다. -- `output` 배열의 첫 번째 항목에 접근하여 그것이 모델이 생성한 콘텐츠를 담은 `assistant` 메시지라고 가정하기보다는, - SDK에서 지원하는 경우 `output_text` 속성을 사용하는 것을 고려해 보세요. - - - - SDK 전용 편의 속성으로, `output` 배열에 있는 모든 `output_text` 항목의 집계된 텍스트 출력을 -포함합니다(항목이 있는 경우). Python 및 JavaScript SDK에서 지원됩니다. - - - - 모델이 도구 호출을 병렬로 실행하도록 허용할지 여부입니다. - - - - 지금까지의 텍스트에 등장하는지 여부를 기준으로 새 토큰에 페널티를 부여합니다. - - - - 유사한 요청에 대한 응답을 캐시하여 캐시 적중률을 최적화하기 위해 OpenAI에서 사용합니다. `user` 필드를 대체합니다. - - - - 프롬프트 캐시의 보존 정책입니다. 예: `in_memory` 또는 `24h`. - - - - OpenAI의 사용 정책을 위반할 가능성이 있는 애플리케이션 사용자를 감지하는 데 사용되는 안정적인 식별자입니다. - - - - 요청을 처리하는 데 사용되는 처리 계층입니다. 예: `auto`, `default`, `flex`, `scale`, `priority`. - - - - 응답 생성의 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - - 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - 응답이 나중에 API를 통해 검색할 수 있도록 저장되는지 여부입니다. - - - - 내장 도구별로 분류된 토큰 및 요청 사용량입니다. - - - - 이미지 생성 도구의 토큰 사용량입니다. - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 웹 검색 도구 사용량입니다. - - - - - - - - 각 토큰 위치에서 반환할 가장 가능성이 높은 토큰의 최대 개수이며, 각 토큰에는 연관된 로그 확률이 함께 제공됩니다. - - - - 입력 토큰, 출력 토큰, 출력 토큰의 세부 내역, 사용된 총 토큰을 포함한 토큰 사용량 세부 정보를 나타냅니다. - - - - 입력 토큰 수입니다. - - - - 입력 토큰의 세부 내역입니다. - - - - 캐시에 기록된 입력 토큰 수입니다. - - - - 캐시에서 검색된 토큰 수입니다. -[프롬프트 캐싱에 대한 자세한 내용](https://platform.openai.com/docs/guides/prompt-caching). - - - - 출력 토큰 수입니다. - - - - 출력 토큰에 대한 상세 분석입니다. - - - - 추론 토큰 수입니다. - - - - 사용된 총 토큰 수입니다. - - - - 최종 사용자에 대한 지원 중단된 식별자입니다. `safety_identifier`와 `prompt_cache_key`로 교체되었습니다. - - -## 예시 - -### 입력 - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### 출력 - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/ko/development/comfy-router/models/openai/o3/code.mdx b/ko/development/comfy-router/models/openai/o3/code.mdx index 02eef9cba5..8af9d530e4 100644 --- a/ko/development/comfy-router/models/openai/o3/code.mdx +++ b/ko/development/comfy-router/models/openai/o3/code.mdx @@ -2,12 +2,12 @@ title: "Comfy Router와 함께 o3 사용하기" description: "Comfy Router를 통해 openai/o3 호출하기: endpoint, 요청 형태, Router가 반환하는 응답." sidebarTitle: "o3" -translationSourceHash: e0b99669 +translationSourceHash: 7e056724 translationFrom: development/comfy-router/models/openai/o3/code.mdx translationBlockHashes: "_intro": a86dcb0c "Quick start": 4064c5a8 - "Schema": 217699a3 + "Schema": d937270a "Examples": 67e6c8f1 --- @@ -359,7 +359,9 @@ curl https://api.comfy.org/v2/models/openai/o3/requests/$REQUEST_ID \ - 응답에 대한 오류 코드입니다.Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 응답에 대한 오류 코드입니다. + + 가능한 값: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -381,7 +383,7 @@ curl https://api.comfy.org/v2/models/openai/o3/requests/$REQUEST_ID \ 응답이 불완전한 이유입니다. - Possible values: `max_output_tokens`, `content_filter` + 가능한 값: `max_output_tokens`, `content_filter` @@ -399,7 +401,7 @@ curl https://api.comfy.org/v2/models/openai/o3/requests/$REQUEST_ID \ 이 리소스의 객체 유형이며, 항상 `response`로 설정됩니다. - Possible values: `response` + 가능한 값: `response` @@ -441,7 +443,7 @@ Python 및 JavaScript SDK에서 지원됩니다. 응답 생성의 상태입니다. `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` 중 하나입니다. - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 가능한 값: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -520,6 +522,18 @@ Python 및 JavaScript SDK에서 지원됩니다. 캐시에 기록된 입력 토큰의 수입니다. + + 캐시 수명별로 나눈 캐시 쓰기입니다. 두 값의 합은 `cache_write_tokens`입니다. + + + + 12시간 수명으로 캐시에 기록된 입력 Token 수입니다. + + + + 30분 수명으로 캐시에 기록된 입력 Token 수입니다. + + 캐시에서 가져온 토큰 수입니다. [프롬프트 캐싱 자세히 보기](https://platform.openai.com/docs/guides/prompt-caching). diff --git a/ko/development/comfy-router/models/pika/pika-music/code.mdx b/ko/development/comfy-router/models/pika/pika-music/code.mdx new file mode 100644 index 0000000000..40129137d0 --- /dev/null +++ b/ko/development/comfy-router/models/pika/pika-music/code.mdx @@ -0,0 +1,295 @@ +--- +title: "Comfy Router에서 Pika Music 사용하기" +description: "Comfy Router를 통해 pika/pika-music을 호출합니다: 엔드포인트, 요청 형태, Router가 반환하는 응답을 설명합니다." +sidebarTitle: "Pika Music" +translationSourceHash: 62ef6d01 +translationFrom: development/comfy-router/models/pika/pika-music/code.mdx +translationBlockHashes: + "_intro": d1b9e7b6 + "Quick start": f073a693 + "Schema": 738d1494 + "Examples": a7cf936e +--- +{/* GENERATED FILE. Generated from router-schemas/pika/pika-music.json by `pnpm code-pages:gen`. */} + +import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; + +`pika/pika-music`의 API 레퍼런스이며, Comfy Router가 Pika에서 제공합니다. + +**입력:** 텍스트, 오디오 · **출력:** 오디오 + +## 빠른 시작 + +[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python과 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk` 및 `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 원시 HTTP로 보낸 것입니다. + +**모델 ID:** `pika/pika-music` + +**엔드포인트:** `POST https://api.comfy.org/v2/models/pika/pika-music` + + + + +```python Python +from comfy_sdk import Comfy + +# 환경 변수에서 COMFY_API_KEY를 읽습니다. +# SDK가 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. +with Comfy() as client: + result = client.models.run( + "pika/pika-music", + { + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 환경 변수에서 COMFY_API_KEY를 읽습니다. +// SDK가 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. +const { data } = await comfy.models.run("pika/pika-music", { + duration: 30, + mode: "text_to_music", + prompt: "warm lo-fi hip hop with soft piano and vinyl crackle", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-music \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}" +``` + + + +동일한 본문을 `POST https://api.comfy.org/v2/models/pika/pika-music/requests`로 보냅니다. Router는 실행이 접수되는 즉시 `request_id`와 함께 `201`로 응답하며, 결과는 준비가 되면 이 프로세스 또는 다른 프로세스에서 수집합니다. [대기 중 전달](/ko/development/comfy-router/queue)에서 상태, 취소, 수집 과정을 안내합니다. + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 환경 변수에서 COMFY_API_KEY를 읽습니다. +# submit() 호출마다 자체 Idempotency-Key를 발급하고 자동 재시도에 재사용합니다. +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-music", + { + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle", + }, + ) + print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다. + + # 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 기다립니다. + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # 공급자의 자체 페이로드이며, models.run()이 반환하는 것과 같은 값입니다. + # 실패했거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 환경 변수에서 COMFY_API_KEY를 읽습니다. +// submit() 호출마다 자체 Idempotency-Key를 발급하고 자동 재시도에 재사용합니다. +const handle = await comfy.models.submit("pika/pika-music", { + duration: 30, + mode: "text_to_music", + prompt: "warm lo-fi hip hop with soft piano and vinyl crackle", +}); +console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다. + +// 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 기다립니다. +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// models.run()이 반환하는 것과 동일한 결과입니다. 실패했거나 취소된 요청은 여기에서 거부됩니다. +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 제출. Router는 request_id, status_url, response_url, cancel_url과 함께 201로 응답합니다. +curl https://api.comfy.org/v2/models/pika/pika-music/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}" + +# 2. 상태가 COMPLETED가 될 때까지 폴링하며, 각 응답이 지정한 Retry-After 초만큼 기다립니다. +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 수집. 모델의 네이티브 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202. +curl https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## 스키마 + +### 입력 + + + 사용하기 전에 참조 오디오를 정리합니다. + + + + 음악 길이(초), 10에서 360까지. + + 범위: `10` ~ `360` + + + + 노래할 가사. + + + + 생성 모드: text_to_music, voice_conditioned_text_to_music 또는 music_cover. + + 가능한 값: `text_to_music`, `voice_conditioned_text_to_music`, `music_cover` + + + + 음악에 대한 설명. + + + + 음성 참조의 URL입니다. `voice_consent_attested`가 true로 설정되어 있어야 합니다. + + + + 생성 전에 모델로 짧은 프롬프트를 확장합니다. + + + + 재현 가능한 출력을 위한 시드, -1에서 2147483647까지. -1은 무작위 시드를 선택합니다. + + 범위: `-1` ~ `2147483647` + + + + `music_cover`의 소스 곡 URL입니다. + + + + 호출자가 `reference_audio`의 음성을 복제할 권리가 있음을 증명합니다. + + +라우터가 `GET /v2/models/pika/pika-music/openapi.json`에서 제공하는 스키마에서 생성되었으며, 요청이 공급자에 도달하기 전에 호출을 검증하는 데 사용하는 것과 동일한 문서입니다. + +### 출력 + + + `failed` 작업에 설정됩니다. + + + + 기계가 읽을 수 있는 실패 코드(예: invalid_input, content_moderation 또는 provider_error). + + + + 진단 텍스트. + + + + 상태를 폴링하는 데 사용하는 작업 ID. + + + + 작업이 실행한 Pika 카탈로그 항목. + + + + 완료된 작업의 미디어로, `status`가 `completed`일 때 설정됩니다. + + + + 생성된 미디어 파일 하나. + + + + 파일의 MIME 타입. + + + + 생성된 파일의 다운로드 URL. + + + + 파일을 담는 필드: video 또는 audio. + + + + 생성된 미디어 파일 하나. + + + + 파일의 MIME 타입. + + + + 생성된 파일의 다운로드 URL. + + + + 작업 상태: queued, running, completed 또는 failed. + + + + Pika가 작업에 대해 보고한 단위. + + +## 예제 + +### 입력 + +```json +{ + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle" +} +``` + +### 출력 + +```json +{ + "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44", + "output": { + "audio": { + "content_type": "audio/mpeg", + "url": "https://example.invalid/pika/audio.mp3" + }, + "media_type": "audio" + }, + "status": "completed" +} +``` + + + diff --git a/ko/development/comfy-router/models/pika/pika-sfx/code.mdx b/ko/development/comfy-router/models/pika/pika-sfx/code.mdx new file mode 100644 index 0000000000..a81ff5cf61 --- /dev/null +++ b/ko/development/comfy-router/models/pika/pika-sfx/code.mdx @@ -0,0 +1,260 @@ +--- +title: "Comfy Router로 Pika Sfx 사용하기" +description: "Comfy Router를 통해 pika/pika-sfx를 호출합니다: endpoint, 요청 형태 및 Router가 반환하는 응답." +sidebarTitle: "Pika Sfx" +translationSourceHash: 2df41acd +translationFrom: development/comfy-router/models/pika/pika-sfx/code.mdx +translationBlockHashes: + "_intro": f4076086 + "Quick start": e5b7bc82 + "Schema": c9ccd2ee + "Examples": f88686f5 +--- +{/* GENERATED FILE. Generated from router-schemas/pika/pika-sfx.json by `pnpm code-pages:gen`. */} + +import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; + +`pika/pika-sfx`의 API 레퍼런스로, Comfy Router가 Pika에서 제공합니다. + +**입력:** 텍스트 · **출력:** 오디오 + +## 빠른 시작 + +[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 원시 HTTP로 보낸 것입니다. + +**모델 ID:** `pika/pika-sfx` + +**엔드포인트:** `POST https://api.comfy.org/v2/models/pika/pika-sfx` + + + + +```python Python +from comfy_sdk import Comfy + +# 환경에서 COMFY_API_KEY를 읽습니다. +# SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. +with Comfy() as client: + result = client.models.run( + "pika/pika-sfx", + { + "duration": 2, + "prompt": "a wooden door creaking open", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 환경에서 COMFY_API_KEY를 읽습니다. +// SDK는 자동으로 멱등성 키를 생성하고 자동 재시도에 재사용합니다. +const { data } = await comfy.models.run("pika/pika-sfx", { + duration: 2, + prompt: "a wooden door creaking open", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-sfx \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" +``` + + + +동일한 본문을 `POST https://api.comfy.org/v2/models/pika/pika-sfx/requests`로 보냅니다. Router는 실행이 접수되는 즉시 `request_id`와 함께 `201`로 응답하며, 결과는 준비되면 이 프로세스 또는 다른 프로세스에서 수집합니다. [대기 중 전달](/ko/development/comfy-router/queue)에서 상태, 취소, 수집 과정을 안내합니다. + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 환경에서 COMFY_API_KEY를 읽습니다. +# 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-sfx", + { + "duration": 2, + "prompt": "a wooden door creaking open", + }, + ) + print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 + + # 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 대기합니다. + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # 공급자 자체의 페이로드이며, models.run()이 반환하는 것과 같은 값입니다. + # 실패했거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 환경에서 COMFY_API_KEY를 읽습니다. +// 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. +const handle = await comfy.models.submit("pika/pika-sfx", { + duration: 2, + prompt: "a wooden door creaking open", +}); +console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 + +// 요청이 완료될 때까지 폴링하며, 서버가 지정한 Retry-After만큼 대기합니다. +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// models.run()이 반환하는 것과 같은 결과입니다. 실패했거나 취소된 요청은 여기에서 거부됩니다. +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 제출합니다. Router는 request_id, status_url, response_url, cancel_url과 함께 201로 응답합니다. +curl https://api.comfy.org/v2/models/pika/pika-sfx/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" + +# 2. 상태가 COMPLETED가 될 때까지 폴링하며, 각 응답이 지정한 Retry-After 초만큼 대기합니다. +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 수집합니다. 모델의 네이티브 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202를 반환합니다. +curl https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## 스키마 + +### 입력 + + + 사운드 효과의 길이(초)이며, 1에서 20 사이입니다. + + 범위: `1` ~ `20` + + + + 사운드 효과에 대한 설명입니다. + + + + 재현 가능한 출력을 위한 시드이며, -1에서 2147483647 사이입니다. -1은 무작위 시드를 선택합니다. + + 범위: `-1` ~ `2147483647` + + +Router가 `GET /v2/models/pika/pika-sfx/openapi.json`에서 제공하는 스키마를 기반으로 생성되며, 이는 요청이 공급자에게 도달하기 이전에 호출을 검증하는 데 사용하는 것과 동일한 문서입니다. + +### 출력 + + + `failed` 작업에서 설정됩니다. + + + + invalid_input, content_moderation, provider_error 같은 기계 판독 가능한 실패 코드입니다. + + + + 진단 텍스트입니다. + + + + 상태를 폴링하는 데 사용하는 작업 ID입니다. + + + + 작업이 실행한 Pika 카탈로그 항목입니다. + + + + 완료된 작업의 미디어이며, `status`가 `completed`일 때 설정됩니다. + + + + 생성된 미디어 파일 하나입니다. + + + + 파일의 MIME 타입입니다. + + + + 생성된 파일의 다운로드 URL입니다. + + + + 파일을 담는 필드: video 또는 audio. + + + + 생성된 미디어 파일 하나입니다. + + + + 파일의 MIME 타입입니다. + + + + 생성된 파일의 다운로드 URL입니다. + + + + 작업 상태: queued, running, completed 또는 failed. + + + + Pika가 작업에 대해 보고한 단위입니다. + + +## 예시 + +### 입력 + +```json +{ + "duration": 2, + "prompt": "a wooden door creaking open" +} +``` + +### 출력 + +```json +{ + "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44", + "output": { + "audio": { + "content_type": "audio/mpeg", + "url": "https://example.invalid/pika/audio.mp3" + }, + "media_type": "audio" + }, + "status": "completed" +} +``` + + + diff --git a/ko/development/comfy-router/models/pika/pika-soundtrack/code.mdx b/ko/development/comfy-router/models/pika/pika-soundtrack/code.mdx new file mode 100644 index 0000000000..e172141d0d --- /dev/null +++ b/ko/development/comfy-router/models/pika/pika-soundtrack/code.mdx @@ -0,0 +1,258 @@ +--- +title: "Comfy Router에서 Pika Soundtrack 사용하기" +description: "Comfy Router를 통해 pika/pika-soundtrack을 호출하는 방법: 엔드포인트, 요청 형태, Router가 반환하는 응답을 설명합니다." +sidebarTitle: "Pika Soundtrack" +translationSourceHash: f897473f +translationFrom: development/comfy-router/models/pika/pika-soundtrack/code.mdx +translationBlockHashes: + "_intro": 51801b91 + "Quick start": f4397b26 + "Schema": 48e8da0c + "Examples": 3da11fda +--- +{/* 생성된 파일. `pnpm code-pages:gen`으로 router-schemas/pika/pika-soundtrack.json에서 생성되었습니다. */} + +import RouterCodeFooter from "/snippets/ko/comfy-router/model-code-footer.mdx"; + +Pika에서 제공하고 Comfy Router가 서비스하는 `pika/pika-soundtrack`의 API 레퍼런스입니다. + +**입력:** 비디오, 텍스트 · **출력:** 비디오 + 오디오 + +## 빠른 시작 + +[Comfy 워크스페이스](https://platform.comfy.org/profile/api-keys?onboarding=router)에서 키를 생성하고 `COMFY_API_KEY`로 내보내세요. Python 및 TypeScript 스니펫은 Comfy SDK(`pip install comfy-sdk`, `npm install @comfyorg/sdk`)를 사용하며, cURL 스니펫은 동일한 호출을 원시 HTTP로 보낸 것입니다. + +**모델 ID:** `pika/pika-soundtrack` + +**엔드포인트:** `POST https://api.comfy.org/v2/models/pika/pika-soundtrack` + + + + +```python Python +from comfy_sdk import Comfy + +# 환경에서 COMFY_API_KEY를 읽습니다. +# SDK는 자동으로 idempotency 키를 생성하고 자동 재시도에 재사용합니다. +with Comfy() as client: + result = client.models.run( + "pika/pika-soundtrack", + { + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 환경에서 COMFY_API_KEY를 읽습니다. +// SDK는 자동으로 idempotency 키를 생성하고 자동 재시도에 재사용합니다. +const { data } = await comfy.models.run("pika/pika-soundtrack", { + seed: -1, + video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-soundtrack \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" +``` + + + +동일한 본문을 `POST https://api.comfy.org/v2/models/pika/pika-soundtrack/requests`로 보냅니다. Router는 실행이 접수되는 즉시 `request_id`와 함께 `201`로 응답하며, 결과는 준비가 되면 이 프로세스에서든 다른 프로세스에서든 수집할 수 있습니다. [대기 중 전달](/ko/development/comfy-router/queue)에서 상태, 취소, 수집 방법을 단계별로 살펴봅니다. + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 환경에서 COMFY_API_KEY를 읽습니다. +# 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-soundtrack", + { + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", + }, + ) + print("request_id:", handle.request_id) # 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 + + # 서버가 지정한 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # 공급자의 원본 페이로드이며, models.run()이 반환하는 것과 동일한 값입니다. + # 실패했거나 취소된 요청은 여기에서 타입이 지정된 Router 오류를 발생시킵니다. + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 환경에서 COMFY_API_KEY를 읽습니다. +// 각 submit() 호출은 자체 Idempotency-Key를 생성하고 자동 재시도에 재사용합니다. +const handle = await comfy.models.submit("pika/pika-soundtrack", { + seed: -1, + video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", +}); +console.log("requestId:", handle.requestId); // 모델 ID와 함께라면 다른 프로세스에 필요한 전부입니다 + +// 서버가 지정한 Retry-After만큼 기다리며 요청이 완료될 때까지 폴링합니다. +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// models.run()이 반환하는 것과 동일한 결과입니다. 실패했거나 취소된 요청은 여기에서 거부됩니다. +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 제출합니다. Router는 request_id, status_url, response_url, cancel_url과 함께 201로 응답합니다. +curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" + +# 2. 각 응답이 지정한 Retry-After 초만큼 기다리며 상태가 COMPLETED가 될 때까지 폴링합니다. +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 수집합니다. 모델의 원본 출력과 함께 200, 아직 실행 중이면 상태 본문과 함께 202를 반환합니다. +curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## 스키마 + +### 입력 + + + 오디오가 무엇이어야 하는지, 그리고 액션을 어떻게 따라가는지. 비디오만으로 사운드 디자인을 하려면 생략합니다. + + + + -1에서 2147483647까지의 시드입니다. -1은 무작위 시드를 선택합니다. + + 범위: `-1` ~ `2147483647` + + + + 소스 비디오의 URL입니다. H.264 또는 HEVC, 최대 1200초 및 2 GB입니다. + + +`GET /v2/models/pika/pika-soundtrack/openapi.json`에서 Router가 제공하는 스키마에서 생성되었으며, 요청이 공급자에 도달하기 전에 호출을 검증하는 데 사용하는 문서와 동일합니다. + +### 출력 + + + `failed` 작업에서 설정됩니다. + + + + 기계가 판독할 수 있는 실패 코드로, invalid_input, content_moderation 또는 provider_error 등이 있습니다. + + + + 진단 텍스트입니다. + + + + 상태를 폴링하는 데 사용하는 작업 ID입니다. + + + + 작업이 실행한 Pika 카탈로그 항목입니다. + + + + 완료된 작업의 미디어로, `status`가 `completed`일 때 설정됩니다. + + + + 생성된 미디어 파일 하나입니다. + + + + 파일의 MIME 유형입니다. + + + + 생성된 파일의 다운로드 URL입니다. + + + + 파일을 담고 있는 필드로, 비디오 또는 오디오입니다. + + + + 생성된 미디어 파일 하나입니다. + + + + 파일의 MIME 유형입니다. + + + + 생성된 파일의 다운로드 URL입니다. + + + + 작업 상태: 대기 중, 실행 중, 완료됨 또는 실패. + + + + 작업에 대해 Pika가 보고한 단위입니다. + + +## 예시 + +### 입력 + +```json +{ + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4" +} +``` + +### 출력 + +```json +{ + "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0", + "output": { + "media_type": "video", + "video": { + "content_type": "video/mp4", + "url": "https://example.invalid/pika/video.mp4" + } + }, + "status": "completed" +} +``` + + + diff --git a/ko/development/comfy-router/pricing.mdx b/ko/development/comfy-router/pricing.mdx index 30f250a064..9e10006c11 100644 --- a/ko/development/comfy-router/pricing.mdx +++ b/ko/development/comfy-router/pricing.mdx @@ -131,26 +131,26 @@ Comfy 사용량 기반 요금은 GPU 초당 요금입니다. 실제 청구액은 | [Qwen Image 3.0 Pro](/ko/development/comfy-router/models/qwen/qwen-image-3-0-pro/code) | `qwen/qwen-image-3.0-pro` | 입력 이미지 · 1K / 2K | 0.9052 / 입력 이미지 | | [Seedream 5.0 Pro](/ko/development/comfy-router/models/byteplus/seedream-5-0-pro-260628/code) | `byteplus/seedream-5-0-pro-260628` | 두 번째부터의 입력 이미지 | 0.633 / 입력 이미지 | -#### Recraft credit당 요금 +#### Recraft 크레딧당 요금 | 이름 | 모델 ID | 크레딧 | | --- | --- | ---: | -| [Recraft V2](/ko/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | 0.3017 / Recraft credit | -| [Recraft V3](/ko/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | 0.3017 / Recraft credit | -| [Recraft V4](/ko/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | 0.3017 / Recraft credit | -| [Recraft V4 Pro](/ko/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | 0.3017 / Recraft credit | -| [Recraft V4 Styles](/ko/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Pro](/ko/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Vector](/ko/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1](/ko/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | 0.3017 / Recraft credit | -| [Recraft V4.1 Pro](/ko/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | 0.3017 / Recraft credit | -| [Recraft V4.1 Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility](/ko/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Pro](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | 0.3017 / Recraft credit | +| [Recraft V2](/ko/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | 0.3017 / Recraft 크레딧 | +| [Recraft V3](/ko/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | 0.3017 / Recraft 크레딧 | +| [Recraft V4](/ko/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | 0.3017 / Recraft 크레딧 | +| [Recraft V4 Pro](/ko/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | 0.3017 / Recraft 크레딧 | +| [Recraft V4 Styles](/ko/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | 0.3017 / Recraft 크레딧 | +| [Recraft V4 Styles Pro](/ko/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | 0.3017 / Recraft 크레딧 | +| [Recraft V4 Styles Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | 0.3017 / Recraft 크레딧 | +| [Recraft V4 Styles Vector](/ko/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | 0.3017 / Recraft 크레딧 | +| [Recraft V4.1](/ko/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | 0.3017 / Recraft 크레딧 | +| [Recraft V4.1 Pro](/ko/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | 0.3017 / Recraft 크레딧 | +| [Recraft V4.1 Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | 0.3017 / Recraft 크레딧 | +| [Recraft V4.1 Utility](/ko/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | 0.3017 / Recraft 크레딧 | +| [Recraft V4.1 Utility Pro](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | 0.3017 / Recraft 크레딧 | +| [Recraft V4.1 Utility Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | 0.3017 / Recraft 크레딧 | +| [Recraft V4.1 Utility Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | 0.3017 / Recraft 크레딧 | +| [Recraft V4.1 Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | 0.3017 / Recraft 크레딧 | #### 참조 이미지당 요금 @@ -392,7 +392,7 @@ Ray 3.2의 EXR 내보내기는 아직 제공되지 않습니다. HDR 요청에 | --- | --- | --- | ---: | | [Aleph 2](/ko/development/comfy-router/models/runway/aleph2/code) | `runway/aleph2` | - | 84.4844 / s | | [Gen 4 Turbo](/ko/development/comfy-router/models/runway/gen4-turbo/code) | `runway/gen4_turbo` | - | 15.0865 / s | -| [Pika Soundtrack](/ko/development/comfy-router/models) | `pika/pika-soundtrack` | Input video | 1.50865 / s | +| [Pika Soundtrack](/ko/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Input video | 1.50865 / s | | [Sync 3](/ko/development/comfy-router/models/synclabs/sync-3/code) | `synclabs/sync-3` | - | 40.1301 / s | | [Erase](/ko/development/comfy-router/models/bria/video-edit-erase/code) | `bria/video-edit-erase` | - | 13.5778 / s | | [Green Screen](/ko/development/comfy-router/models/bria/video-edit-green-screen/code) | `bria/video-edit-green-screen` | - | 10.55 / s | @@ -596,8 +596,8 @@ Comfy 사용량 기반 요금은 GPU 초당 요금입니다. 실제 청구액은 | [Google Gemini](/ko/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-2.5-pro` | - | 오디오 / 이미지 / 텍스트 / 동영상: 263.75 | 텍스트: 2110 | | [Google Gemini](/ko/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.1-pro-preview` | - | 오디오 / 이미지 / 텍스트 / 동영상: 422 | 텍스트 / 추론: 2532
이미지: 25320 | | [Google Gemini](/ko/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.5-flash` | - | 오디오 / 이미지 / 텍스트 / 동영상: 316.5 | 텍스트 / 추론: 1899 | -| [GPT 6.1 Sol](/ko/development/comfy-router/models) | `openai/gpt-6.1-sol` | 읽기: 30.173
쓰기: 754.325 | 텍스트: 603.46 | 텍스트: 3017.3 | -| [GPT 6.1 Terra](/ko/development/comfy-router/models) | `openai/gpt-6.1-terra` | 읽기: 15.0865
쓰기: 377.1625 | 텍스트: 301.73 | 텍스트: 1508.65 | +| [GPT 6.1 Sol](/ko/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | 읽기: 30.173
쓰기: 754.325 | 텍스트: 603.46 | 텍스트: 3017.3 | +| [GPT 6.1 Terra](/ko/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | 읽기: 15.0865
쓰기: 377.1625 | 텍스트: 301.73 | 텍스트: 1508.65 | | [GPT 6 Astra](/ko/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | 읽기: 301.73
쓰기: 3771.625 | 텍스트: 3017.3 | 텍스트: 15086.5 | | [GPT 6 Luna](/ko/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | 읽기: 3.0173
쓰기: 37.7162 | 텍스트: 30.173 | 텍스트: 150.865 | | [GPT 6 Sol](/ko/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | 읽기: 60.346
쓰기: 754.325 | 텍스트: 603.46 | 텍스트: 3017.3 | @@ -642,22 +642,22 @@ Comfy 사용량 기반 요금은 GPU 초당 요금입니다. 실제 청구액은 | --- | --- | ---: | | [Clean Audio](/ko/development/comfy-router/models/veed/clean-audio/code) | `veed/clean-audio` | 게시되지 않음 | -#### 1K characters당 요금 +#### 1K 문자당 요금 | 이름 | 모델 ID | 옵션 | 크레딧 | | --- | --- | --- | ---: | -| [Eleven Multilingual V2](/ko/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 음성 합성 | 50.64 / 1K characters | -| [Eleven V3](/ko/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 대화 / 음성 합성 | 21.1 / 1K characters | -| [Eleven V4](/ko/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 대화 | 24.1384 / 1K characters | -| [Eleven V4 Turbo](/ko/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 대화 | 12.0692 / 1K characters | +| [Eleven Multilingual V2](/ko/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 음성 합성 | 50.64 / 1K 문자 | +| [Eleven V3](/ko/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 대화 / 음성 합성 | 21.1 / 1K 문자 | +| [Eleven V4](/ko/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 대화 | 24.1384 / 1K 문자 | +| [Eleven V4 Turbo](/ko/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 대화 | 12.0692 / 1K 문자 | #### 길이별 요금 | 이름 | 모델 ID | 크레딧 | | --- | --- | ---: | | [Eleven Sfx V2](/ko/development/comfy-router/models/elevenlabs/eleven-sfx-v2/code) | `elevenlabs/eleven_sfx_v2` | 29.54 / 분 | -| [Pika Music](/ko/development/comfy-router/models) | `pika/pika-music` | 4.52595 / 분 | -| [Pika Sfx](/ko/development/comfy-router/models) | `pika/pika-sfx` | 0.060346 / s | +| [Pika Music](/ko/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | 4.52595 / 분 | +| [Pika Sfx](/ko/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | 0.060346 / s | | [Seed Audio 1.0](/ko/development/comfy-router/models/byteplus/seed-audio-1-0/code) | `byteplus/seed-audio-1.0` | 0.7543 / s | | [Seed Audio 1.0 Multilingual](/ko/development/comfy-router/models/byteplus/seed-audio-1-0-multilingual/code) | `byteplus/seed-audio-1.0-multilingual` | 0.7543 / s | | [Starfish](/ko/development/comfy-router/models/heygen/starfish/code) | `heygen/starfish` | 0.2013 / s | @@ -820,26 +820,26 @@ Comfy 사용량 기반 요금은 GPU 초당 요금입니다. 실제 청구액은 | [Qwen Image 3.0 Pro](/ko/development/comfy-router/models/qwen/qwen-image-3-0-pro/code) | `qwen/qwen-image-3.0-pro` | 입력 이미지 · 1K / 2K | $0.00429 / 입력 이미지 | | [Seedream 5.0 Pro](/ko/development/comfy-router/models/byteplus/seedream-5-0-pro-260628/code) | `byteplus/seedream-5-0-pro-260628` | 두 번째부터의 입력 이미지 | $0.003 / 입력 이미지 | -#### Recraft credit당 요금 +#### Recraft 크레딧당 요금 | 이름 | 모델 ID | USD | | --- | --- | ---: | -| [Recraft V2](/ko/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | $0.00143 / Recraft credit | -| [Recraft V3](/ko/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | $0.00143 / Recraft credit | -| [Recraft V4](/ko/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | $0.00143 / Recraft credit | -| [Recraft V4 Pro](/ko/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | $0.00143 / Recraft credit | -| [Recraft V4 Styles](/ko/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Pro](/ko/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Vector](/ko/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1](/ko/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | $0.00143 / Recraft credit | -| [Recraft V4.1 Pro](/ko/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | $0.00143 / Recraft credit | -| [Recraft V4.1 Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility](/ko/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Pro](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | $0.00143 / Recraft credit | +| [Recraft V2](/ko/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | $0.00143 / Recraft 크레딧 | +| [Recraft V3](/ko/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | $0.00143 / Recraft 크레딧 | +| [Recraft V4](/ko/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | $0.00143 / Recraft 크레딧 | +| [Recraft V4 Pro](/ko/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | $0.00143 / Recraft 크레딧 | +| [Recraft V4 Styles](/ko/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | $0.00143 / Recraft 크레딧 | +| [Recraft V4 Styles Pro](/ko/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | $0.00143 / Recraft 크레딧 | +| [Recraft V4 Styles Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | $0.00143 / Recraft 크레딧 | +| [Recraft V4 Styles Vector](/ko/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | $0.00143 / Recraft 크레딧 | +| [Recraft V4.1](/ko/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | $0.00143 / Recraft 크레딧 | +| [Recraft V4.1 Pro](/ko/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | $0.00143 / Recraft 크레딧 | +| [Recraft V4.1 Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | $0.00143 / Recraft 크레딧 | +| [Recraft V4.1 Utility](/ko/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | $0.00143 / Recraft 크레딧 | +| [Recraft V4.1 Utility Pro](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | $0.00143 / Recraft 크레딧 | +| [Recraft V4.1 Utility Pro Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | $0.00143 / Recraft 크레딧 | +| [Recraft V4.1 Utility Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | $0.00143 / Recraft 크레딧 | +| [Recraft V4.1 Vector](/ko/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | $0.00143 / Recraft 크레딧 | #### 참조 이미지당 요금 @@ -1081,7 +1081,7 @@ Ray 3.2의 EXR 내보내기는 아직 제공되지 않습니다. HDR 요청에 | --- | --- | --- | ---: | | [Aleph 2](/ko/development/comfy-router/models/runway/aleph2/code) | `runway/aleph2` | - | $0.4004 / s | | [Gen 4 Turbo](/ko/development/comfy-router/models/runway/gen4-turbo/code) | `runway/gen4_turbo` | - | $0.0715 / s | -| [Pika Soundtrack](/ko/development/comfy-router/models) | `pika/pika-soundtrack` | Input video | $0.00715 / s | +| [Pika Soundtrack](/ko/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Input video | $0.00715 / s | | [Sync 3](/ko/development/comfy-router/models/synclabs/sync-3/code) | `synclabs/sync-3` | - | $0.19019 / s | | [Erase](/ko/development/comfy-router/models/bria/video-edit-erase/code) | `bria/video-edit-erase` | - | $0.06435 / s | | [Green Screen](/ko/development/comfy-router/models/bria/video-edit-green-screen/code) | `bria/video-edit-green-screen` | - | $0.05 / s | @@ -1285,8 +1285,8 @@ Comfy 사용량 기반 요금은 GPU 초당 요금입니다. 실제 청구액은 | [Google Gemini](/ko/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-2.5-pro` | - | 오디오 / 이미지 / 텍스트 / 동영상: $1.25 | 텍스트: $10.00 | | [Google Gemini](/ko/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.1-pro-preview` | - | 오디오 / 이미지 / 텍스트 / 동영상: $2.00 | 텍스트 / 추론: $12.00
이미지: $120.00 | | [Google Gemini](/ko/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.5-flash` | - | 오디오 / 이미지 / 텍스트 / 동영상: $1.50 | 텍스트 / 추론: $9.00 | -| [GPT 6.1 Sol](/ko/development/comfy-router/models) | `openai/gpt-6.1-sol` | 읽기: $0.143
쓰기: $3.575 | 텍스트: $2.86 | 텍스트: $14.30 | -| [GPT 6.1 Terra](/ko/development/comfy-router/models) | `openai/gpt-6.1-terra` | 읽기: $0.0715
쓰기: $1.7875 | 텍스트: $1.43 | 텍스트: $7.15 | +| [GPT 6.1 Sol](/ko/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | 읽기: $0.143
쓰기: $3.575 | 텍스트: $2.86 | 텍스트: $14.30 | +| [GPT 6.1 Terra](/ko/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | 읽기: $0.0715
쓰기: $1.7875 | 텍스트: $1.43 | 텍스트: $7.15 | | [GPT 6 Astra](/ko/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | 읽기: $1.43
쓰기: $17.875 | 텍스트: $14.30 | 텍스트: $71.50 | | [GPT 6 Luna](/ko/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | 읽기: $0.0143
쓰기: $0.17875 | 텍스트: $0.143 | 텍스트: $0.715 | | [GPT 6 Sol](/ko/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | 읽기: $0.286
쓰기: $3.575 | 텍스트: $2.86 | 텍스트: $14.30 | @@ -1331,22 +1331,22 @@ Comfy 사용량 기반 요금은 GPU 초당 요금입니다. 실제 청구액은 | --- | --- | ---: | | [Clean Audio](/ko/development/comfy-router/models/veed/clean-audio/code) | `veed/clean-audio` | 게시되지 않음 | -#### 1K characters당 요금 +#### 1K 문자당 요금 | 이름 | 모델 ID | 옵션 | USD | | --- | --- | --- | ---: | -| [Eleven Multilingual V2](/ko/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 음성 합성 | $0.24 / 1K characters | -| [Eleven V3](/ko/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 대화 / 음성 합성 | $0.10 / 1K characters | -| [Eleven V4](/ko/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 대화 | $0.1144 / 1K characters | -| [Eleven V4 Turbo](/ko/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 대화 | $0.0572 / 1K characters | +| [Eleven Multilingual V2](/ko/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 음성 합성 | $0.24 / 1K 문자 | +| [Eleven V3](/ko/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 대화 / 음성 합성 | $0.10 / 1K 문자 | +| [Eleven V4](/ko/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 대화 | $0.1144 / 1K 문자 | +| [Eleven V4 Turbo](/ko/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 대화 | $0.0572 / 1K 문자 | #### 길이별 요금 | 이름 | 모델 ID | USD | | --- | --- | ---: | | [Eleven Sfx V2](/ko/development/comfy-router/models/elevenlabs/eleven-sfx-v2/code) | `elevenlabs/eleven_sfx_v2` | $0.14 / 분 | -| [Pika Music](/ko/development/comfy-router/models) | `pika/pika-music` | $0.02145 / 분 | -| [Pika Sfx](/ko/development/comfy-router/models) | `pika/pika-sfx` | $0.000286 / s | +| [Pika Music](/ko/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | $0.02145 / 분 | +| [Pika Sfx](/ko/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | $0.000286 / s | | [Seed Audio 1.0](/ko/development/comfy-router/models/byteplus/seed-audio-1-0/code) | `byteplus/seed-audio-1.0` | $0.003575 / s | | [Seed Audio 1.0 Multilingual](/ko/development/comfy-router/models/byteplus/seed-audio-1-0-multilingual/code) | `byteplus/seed-audio-1.0-multilingual` | $0.003575 / s | | [Starfish](/ko/development/comfy-router/models/heygen/starfish/code) | `heygen/starfish` | $0.000954 / s | diff --git a/snippets/es/install/update-requirement.mdx b/snippets/es/install/update-requirement.mdx index a243710c1c..ee4a2e9de7 100644 --- a/snippets/es/install/update-requirement.mdx +++ b/snippets/es/install/update-requirement.mdx @@ -1,33 +1,33 @@ -{/* translationSourceHash: 67d1eacd */} +{/* translationSourceHash: d7705403 */} - - **Método recomendado**: Usa el script de lote `ComfyUI_windows_portable\update\update_comfyui.bat`, que actualizará tanto el código de ComfyUI como todas las dependencias de Python. + + **Método recomendado**: usa el script por lotes `ComfyUI_windows_portable\update\update_comfyui.bat`, que actualiza tanto el código de ComfyUI como todas las dependencias de Python. **Actualización manual de dependencias**: - Si necesitas actualizar las dependencias manualmente, usa el siguiente comando: + Si necesitas actualizar las dependencias a mano, usa el siguiente comando: ```bash - # Abre la línea de comandos en el directorio de la versión portable + # Abre la línea de comandos en el directorio de la versión portátil .\python_embeded\python.exe -m pip install -r ComfyUI\requirements.txt ``` - - Si usas Conda para administrar entornos de Python, activa tu entorno primero: + + Si usas Conda para gestionar entornos de Python, activa tu entorno primero: ```bash conda activate comfyui # o el nombre de otro entorno ``` - - Navega al directorio raíz de ComfyUI y actualiza el código con Git: + + Ve al directorio raíz de ComfyUI y actualiza el código con Git: ``` cd git pull ``` - - Actualiza las dependencias de ComfyUI. Este paso es crucial, especialmente para el `comfyui-frontend-package`: + + Actualiza las dependencias de ComfyUI: este paso es importante, sobre todo para `comfyui-frontend-package`: ``` pip install -r requirements.txt ``` @@ -36,8 +36,8 @@ - - **Instancia de ComfyUI + dependencias de Python:** usa [Administrar → Actualizar](/es/installation/desktop/usage/manage#pestaña-actualizar) (**Stable** o **Latest on GitHub**). Las actualizaciones de dependencias suelen aplicarse dentro de ese flujo. - - **La app Desktop en sí:** usa el menú de la app **Buscar actualizaciones** (es independiente del canal de actualización de ComfyUI). + - **Instancia de ComfyUI y dependencias de Python:** usa [Gestionar → Actualizar](/es/installation/desktop/usage/manage#pestaña-actualizar) (**Stable** o **Latest on GitHub**). Las actualizaciones de dependencias se aplican normalmente como parte de ese flujo. + - **La propia aplicación Desktop:** usa el menú de la aplicación **Check for Updates** (es independiente del canal de actualización de ComfyUI). - Reinstala Desktop solo como último recurso. \ No newline at end of file diff --git a/zh/custom-nodes/js/canvas-pointer-api.mdx b/zh/custom-nodes/js/canvas-pointer-api.mdx new file mode 100644 index 0000000000..fb41f6cb33 --- /dev/null +++ b/zh/custom-nodes/js/canvas-pointer-api.mdx @@ -0,0 +1,77 @@ +--- +title: "用于控件与光标的画布指针 API" +sidebarTitle: "画布指针 API" +description: "使用 onPointerDown 处理自定义画布控件上的单击、双击和拖拽,并从 ComfyUI 前端扩展控制画布光标。" +translationSourceHash: 16ea7f38 +translationFrom: custom-nodes/js/canvas-pointer-api.mdx +translationBlockHashes: + "_intro": b1d4c464 + "Default behavior": 27a8751b + "Handle pointer input on a widget": e4fc63fc + "Control the canvas cursor": 9bcc33c8 +--- + +画布通过 `CanvasPointer` 路由指针输入。由它决定一次按下会成为点击、双击还是拖拽,并运行你为该次按下指定的回调。绘制在画布上的控件通过 `onPointerDown` 使用它。 + +## 默认行为 + +- 拖动多个已选择的项目时不再需要按住 Shift。在已选择多个项目的情况下点击其中一个项目,仍会取消选择其他项目。 +- 点击输入上的已连接连线时,不再断开并重新连接该连线。 +- 指针按下与抬起之间的少量移动仍算作一次点击。一旦指针移动超过点击漂移上限,这次按下就变为拖动。时间不影响该判定。 +- 双击需要在双击时间内完成两次按下,且两次按下的间距最多为点击漂移的三倍。只有分配了 `onDoubleClick` 的按下才能完成双击。 + +用户可在设置中调整点击漂移与双击时间(`Comfy.Pointer.ClickDrift` 和 `Comfy.Pointer.DoubleClickTime`)。 + +### 选择多个项目 + +- `Ctrl` + 拖动:开始多选 +- `Ctrl` + `Shift` + 拖动:添加到选择 +- `Ctrl` + 拖动,然后按 `Shift`:添加到选择 +- `Ctrl` + 拖动,然后按 `Alt`:从选择中移除 + +## 在控件上处理指针输入 + +在控件上设置 `onPointerDown`。它在指针按下时运行,并接收指针、节点和画布。在指针对象上设置你需要的回调,按下操作判定完成后画布会运行对应的回调: + +```js +widget.onPointerDown = function (pointer, node, canvas) { + const e = pointer.eDown + const offsetFromNode = [e.canvasX - node.pos[0], e.canvasY - node.pos[1]] + + pointer.onClick = (upEvent) => { + console.log(pointer.eDown, pointer.eMove, pointer.eUp) + } + pointer.onDoubleClick = (upEvent) => this.customFunction(upEvent) + + pointer.onDragStart = () => {} + pointer.onDrag = (moveEvent) => {} + pointer.onDragEnd = (upEvent) => {} + pointer.onDragCancel = () => {} + + pointer.finally = () => {} + + return true +} +``` + +- `onClick` 与 `onDoubleClick` 不会与 `onDragStart`、`onDragEnd` 或 `onDragCancel` 在同一次按下中运行。`onDrag` 可以在最终判定为点击的按下中运行,因为它也会接收到点击漂移范围内的移动。 +- `onDragStart` 每次拖拽只运行一次,即指针首次越过点击漂移范围时。如果指针在没有任何移动事件上报之前就越界释放,`onDragStart` 会在释放时运行,`onDragEnd` 紧随其后运行,而 `onDrag` 不运行。 +- 当一次按下同时设置了 `onClick` 和 `onDoubleClick` 时,双击的第一下释放会运行 `onClick`。第二次按下改为运行 `onDoubleClick` 而不是 `onClick`,因此请保证 `onClick` 可以先安全运行。第一次点击也可能落在附近的其它项目而不是你的控件上,所以 `onDoubleClick` 可能在你的 `onClick` 尚未运行的情况下运行。 +- `onDragEnd` 接收拖拽的指针抬起事件。拖拽被中断时(例如丢失指针捕获)改为运行 `onDragCancel`。 +- `finally` 在按下结束时运行一次。设置 `pointer.finally` 会立即运行它替换掉的那个回调。如果 `onPointerDown` 没有返回 `true`,画布会设置它自己的 `finally`,于是你的回调会在指针按下期间运行。当你依赖 `finally` 做清理时请返回 `true`。 +- `pointer.eDown`、`pointer.eMove` 和 `pointer.eUp` 让每个回调都能访问完整的事件序列。 +- 返回 `true` 可以阻止画布自行处理这次按下。 +- 添加 `onPointerDown` 时,请移除遗留的 `widget.mouse` 处理器。如果 `onPointerDown` 返回 `true`,画布会在释放后继续跟踪该控件,并在每次指针移动时继续调用 `widget.mouse`。 + +画布会替你判定双击和拖拽,因此控件不再需要为独立的指针事件计时或测量。它也会遵循用户设置的点击漂移和双击偏好。 + +## 控制画布光标 + +`canvas.state.hoveringOver` 保存指针下方项目类型的位标志,例如节点、组、重新路由或连线。将 `canvas.state.shouldSetCursor` 设置为 `false` 以阻止画布设置光标样式,然后自行设置光标: + +```js +canvas.state.shouldSetCursor = false +canvas.canvas.style.cursor = 'pointer' +``` + +当 `shouldSetCursor` 为 `false` 时,开始调整节点大小仍会设置调整大小光标。请在调整大小结束后重新设置你的光标。 diff --git a/zh/custom-nodes/js/connection-callbacks-migration.mdx b/zh/custom-nodes/js/connection-callbacks-migration.mdx new file mode 100644 index 0000000000..182a937790 --- /dev/null +++ b/zh/custom-nodes/js/connection-callbacks-migration.mdx @@ -0,0 +1,114 @@ +--- +title: "前端扩展的连接回调迁移" +sidebarTitle: "连接回调迁移" +description: "onConnectionsChange 与节点移除回调的顺序、子图边界处的 SubgraphIO,以及 ComfyUI 扩展中的 graph.events。" +translationSourceHash: 06a9ae24 +translationFrom: custom-nodes/js/connection-callbacks-migration.mdx +translationBlockHashes: + "_intro": cd84d91b + "Check for SubgraphIO at subgraph boundaries": c049a9fe + "Subscribe to node lifecycle events with graph.events": 1100692e + "Node removal fires callbacks in this order (partially tested)": 720324f8 + "Workflow load resolves peer nodes before onConnectionsChange runs": 2b775215 + "API prompt import does not reconnect resolved inputs": 619d6b69 + "Reject connections before they are made": b9b94a8e + "Removing a link inside the output callback skips the input callback": 3317def4 + "Replace removed slot events": 5c3ec663 + "Read connection state from callback arguments or node methods": 9da17ab0 +--- + +回调签名没有变化。`onConnectionsChange`、`onConnectInput`、`onConnectOutput` 和 `onBeforeConnectInput` 均保留原有参数与调用时机。关于连线注册及 `LinkNetwork` API 的变更,请参阅[连线注册迁移](/zh/custom-nodes/js/link-registration-migration)。 + +## 在子图边界检查 SubgraphIO + +在子图边界(`SubgraphInput` 或 `SubgraphOutput`)处,`onConnectionsChange` 仍会触发,但它的第五个参数是 `SubgraphIO`,而不是通常的 `INodeInputSlot`/`INodeOutputSlot`。在把该参数当作普通槽位处理之前,请先做检查。前端自带的 `isSubgraphInput` 和 `isSubgraphOutput` 守卫没有向扩展暴露,因此请检查每个 `SubgraphIO` 都有、而节点槽位没有的 `linkIds` 数组和 `parent` 节点: + +```js +function isSubgraphIO(slot) { + return slot != null && Array.isArray(slot.linkIds) && 'parent' in slot +} + +nodeType.prototype.onConnectionsChange = function ( + type, + index, + isConnected, + link, + slotOrIO +) { + if (isSubgraphIO(slotOrIO)) return + // slotOrIO is INodeInputSlot | INodeOutputSlot +} +``` + +## 使用 graph.events 订阅节点生命周期事件 + +`graph.events` 会派发 `node:added`、`node:before-removed` 和 `node:removed`。当扩展中有多个部分需要观察节点的添加或移除时,请使用这些事件: + +```ts +graph.events.addEventListener('node:added', (e) => { + console.log('added', e.detail.node.id) +}) +``` + +`node.onAdded`、`node.onRemoved` 以及单槽位的 `graph.onNodeAdded`/`graph.onNodeRemoved` 仍然可用,但给 `graph.onNodeAdded` 赋值会替换掉已有的处理函数:第二个订阅者会静默丢弃第一个。除非你需要在添加/移除过程中进行否决或修改,否则优先使用 `graph.events`。连接/断开没有支持多订阅者的等效机制;`onConnectionsChange` 仍然是唯一的按连接触发的钩子。 + +## 节点移除按以下顺序触发回调(部分测试覆盖) + +移除节点会按以下顺序触发: + +1. `node:before-removed`:此时节点仍完全挂载。 +2. 在被移除的节点以及每个连接式对等节点上触发 `onConnectionsChange(..., false, ...)`,此时被移除的节点仍在图中。 +3. `node.onRemoved()`:`node.graph` 仍有值。 +4. 节点从图索引和存储中分离;`node.graph` 变为 `null`。 +5. `onNodeRemoved(node)`,然后是 `node:removed`,两者看到的都是已分离的节点。 + +测试覆盖 `node:before-removed → node.onRemoved() → onNodeRemoved(node)`,并单独验证 `node:removed` 看到的是已分离的节点。完整顺序(包括第 2 步)是通过来源代码观察到的,而不是由单个端到端测试保证的。 + +要在对等节点的 `onConnectionsChange` 处理程序中获取被移除的节点,请在步骤 2 通过 `graph.getNodeById()` 完成。到 `node:removed` 时,节点已经不存在。 + +## 工作流加载时会在 onConnectionsChange 运行之前解析对等节点 + +`graph.configure()` 会在任何节点自身的 `configure()` 运行之前创建工作流中的每个节点,并为其恢复的连线触发 `onConnectionsChange`。因此,当你的 `onConnectionsChange` 回调在加载期间触发时,每个对等节点都已存在,其连线也已完成注册,所以在该回调内部通过 `graph.getNodeById()` 以及连线查找都能正确解析到目标。 + +## 导入 API prompt 时不会重新连接已解析的输入 + +`app.loadApiJson()` 会逐一连接每个可解析的输入,而不会执行第二次断开/重连流程。扩展不应在导入 API prompt 期间依赖重复的 `onConnectionsChange` 通知。请让每个连接处理程序在第一次通知时就完成其工作;把需要完整已导入画面的工作移到 `afterConfigureGraph` 或 `afterLoadGraph`。 + +对于来源输出或目标槽位尚不存在的输入,会在一轮遍历取得进展时重试。这保留了动态输入行为:一次成功的连接可以创建后续待定连接所需的槽位。已解析的连接不会重复处理,而被扩展拒绝的连接在其端点可用后也不会重试。 + +此变更仅影响 API prompt 导入。常规工作流加载仍如上文所述使用 `graph.configure()`,连接回调的签名保持不变。 + +## 在建立之前拒绝连接 + +若要拒绝某条连接,可在来源节点的 `onConnectOutput` 或目标节点的 `onConnectInput` 中返回 `false`。这两个回调都在画面发生任何改动之前运行,因此目标输入上已有的连线会保持原样: + +```js +nodeType.prototype.onConnectOutput = function ( + slot, + type, + input, + targetNode, + targetSlot +) { + return !shouldReject(type, targetNode) +} +``` + +不要在 `onConnectionsChange` 中执行拒绝。等到它运行时,新的连线已经替换了目标输入原有的连线,因此移除这条新连线只会让该输入处于已断开连接的状态。 + +## 在输出回调中移除连线会跳过输入回调 + +连接一条连线时,会先调用输出侧的 `onConnectionsChange`,然后调用输入侧的 `onConnectionsChange`。如果输出侧的处理函数在返回之前移除了同一条连线,那么输入侧会因这次移除而收到 `isConnected === false` 回调,而它针对新连线应收到的 `isConnected === true` 回调则会被跳过。不要假设两侧总能观察到这次连接;如果你的处理函数会重新进入画面,请检查传入的连线是否仍处于连接状态。这是观察到的行为,并非经过测试的约定:目前没有任何测试覆盖这条跳过路径。 + +## 替换已移除的槽位事件 + +`node:slot-links:changed` 和 `node:slot-errors:changed` 已被移除,且没有同名的替代事件。请迁移到: + +- 使用 `node.isInputConnected()`、`node.isOutputConnected()` 或 `node.getOutputNodes()` 来响应式地读取连接状态,或者 +- 当你需要在槽位连接或断开的确切时刻执行代码时,使用 `onConnectionsChange`。 + +## 从回调参数或节点方法读取连接状态 + +`input.link` 和 `output.links` 已弃用,读取它们可能与当前画面不一致。写入只会移除连线:把 `null` 赋给 `input.link` 会断开该输入,而对 `output.links` 赋值或修改则会断开新数组中缺失的每一条连线。写入永远不会创建连线;请改用 `node.connect()`、`node.disconnectInput()` 或 `node.disconnectOutput()`。请使用回调已经接收到的 `link_info` 参数,或使用以下直接读取连线存储的 `LGraphNode` 实例方法:`node.isInputConnected()`、`node.getInputLink()`、`node.isOutputConnected()` 和 `node.getOutputNodes()`。不要读取 `input.link` 或 `output.links`。 + +这些方法背后的存储函数属于内部实现,不属于扩展 API。请使用节点方法。 diff --git a/zh/custom-nodes/js/javascript_about_panel_badges.mdx b/zh/custom-nodes/js/javascript_about_panel_badges.mdx index 41f733703a..7d77a7c3ba 100644 --- a/zh/custom-nodes/js/javascript_about_panel_badges.mdx +++ b/zh/custom-nodes/js/javascript_about_panel_badges.mdx @@ -52,7 +52,7 @@ app.registerExtension({ 这些类名在前端构建时生成,因此只能使用前端自身用到的 Lucide 图标。如果图标无法显示,请换一个图标,或在扩展加载的样式表中定义自己的图标类名。 -`pi pi-file` 等 PrimeIcons 类名目前仍可显示,但正在逐步淘汰,请勿在新代码中使用。请参阅 [PrimeVue 移除迁移指南](/custom-nodes/js/primevue-removal-migration)。 +`pi pi-file` 等 PrimeIcons 类名目前仍可显示,但正在逐步淘汰,请勿在新代码中使用。请参阅 [PrimeVue 移除迁移指南](/zh/custom-nodes/js/primevue-removal-migration)。 ## 示例 diff --git a/zh/custom-nodes/js/javascript_selection_toolbox.mdx b/zh/custom-nodes/js/javascript_selection_toolbox.mdx index 4dcc447814..1a0913e584 100644 --- a/zh/custom-nodes/js/javascript_selection_toolbox.mdx +++ b/zh/custom-nodes/js/javascript_selection_toolbox.mdx @@ -66,7 +66,7 @@ app.registerExtension({ 这些类名在前端构建时生成,因此只能使用前端自身用到的 Lucide 图标。如果图标无法显示,请换一个图标,或在扩展加载的样式表中定义自己的图标类名。 -PrimeIcons(`pi pi-*`)和 Material Design Icons(`mdi mdi-*`)类名目前仍可显示,但正在逐步淘汰,请勿在新代码中使用。请参阅 [PrimeVue 移除迁移指南](/custom-nodes/js/primevue-removal-migration)。 +PrimeIcons(`pi pi-*`)和 Material Design Icons(`mdi mdi-*`)类名目前仍可显示,但正在逐步淘汰,请勿在新代码中使用。请参阅 [PrimeVue 移除迁移指南](/zh/custom-nodes/js/primevue-removal-migration)。 ## 动态命令可见性 diff --git a/zh/custom-nodes/js/javascript_settings.mdx b/zh/custom-nodes/js/javascript_settings.mdx index eee661a696..abed93dfb9 100644 --- a/zh/custom-nodes/js/javascript_settings.mdx +++ b/zh/custom-nodes/js/javascript_settings.mdx @@ -84,7 +84,7 @@ try { ### 额外配置 -每种设置类型都会渲染一个 ComfyUI 前端表单组件。可以在 `attrs` 字段中为该组件传入额外属性。各类型支持的属性见下文对应类型的说明。 +每种设置类型都会渲染一个 ComfyUI 前端表单组件。可以在 `attrs` 字段中为该组件传入额外属性。各类型支持的属性见[类型](#类型)一节。 例如,下面限制了数字输入框的范围和步长: @@ -106,7 +106,7 @@ try { ``` -如果你的扩展传入了 `showButtons`、`maxFractionDigits`、`editable` 或 `filter` 等 PrimeVue 属性,请参阅 [PrimeVue 移除迁移指南](/custom-nodes/js/primevue-removal-migration)。设置面板已不再使用 PrimeVue 组件,这些属性不会生效。 +如果你的扩展传入了 `showButtons`、`maxFractionDigits`、`editable` 或 `filter` 等 PrimeVue 属性,请参阅 [PrimeVue 移除迁移指南](/zh/custom-nodes/js/primevue-removal-migration)。设置面板已不再使用 PrimeVue 组件,这些属性不会生效。 ## 类型 @@ -265,7 +265,7 @@ try { ### 分类(Categories) -你可以通过 `category` 字段单独指定设置的分类。 +你可以通过 `category` 字段单独指定设置的分类,与 `id` 无关。 这样可以在不更改 `id` 的情况下调整分类和命名,不会丢失用户已设置的值。 ```javascript diff --git a/zh/custom-nodes/js/javascript_sidebar_tabs.mdx b/zh/custom-nodes/js/javascript_sidebar_tabs.mdx index c36d6f85f7..bf8ac3a889 100644 --- a/zh/custom-nodes/js/javascript_sidebar_tabs.mdx +++ b/zh/custom-nodes/js/javascript_sidebar_tabs.mdx @@ -53,7 +53,7 @@ app.extensionManager.registerSidebarTab({ 这些类名在前端构建时生成,因此只能使用前端自身用到的 Lucide 图标。如果图标无法显示,请换一个图标,或在扩展加载的样式表中定义自己的图标类名。 -PrimeIcons(`pi pi-*`)和 Material Design Icons(`mdi mdi-*`)类名目前仍可显示,但正在逐步淘汰,请勿在新代码中使用。请参阅 [PrimeVue 移除迁移指南](/custom-nodes/js/primevue-removal-migration)。 +PrimeIcons(`pi pi-*`)和 Material Design Icons(`mdi mdi-*`)类名目前仍可显示,但正在逐步淘汰,请勿在新代码中使用。请参阅 [PrimeVue 移除迁移指南](/zh/custom-nodes/js/primevue-removal-migration)。 ## 有状态标签页示例 diff --git a/zh/custom-nodes/js/link-registration-migration.mdx b/zh/custom-nodes/js/link-registration-migration.mdx new file mode 100644 index 0000000000..ccbfe729cf --- /dev/null +++ b/zh/custom-nodes/js/link-registration-migration.mdx @@ -0,0 +1,30 @@ +--- +title: "前端扩展的连线注册迁移" +sidebarTitle: "连线注册迁移" +description: "处理 addFloatingLink 返回 undefined、由 store 支撑的 graph.links 视图,以及 ComfyUI 前端扩展中的连线 ID 冲突。" +translationSourceHash: 106471af +translationFrom: custom-nodes/js/link-registration-migration.mdx +--- + +`LinkNetwork.addFloatingLink(link)` 现在返回 `LLink | undefined`。 + +对于新的运行时连线,传入未分配的连线 ID,并使用返回的连线: + +```ts +const registeredLink = graph.addFloatingLink(link) +if (!registeredLink) return +``` + +注册成功时,或者同一条连线已经存在于拓扑 store 中时,注册会返回已存储的连线。如果另一个运行时连线已经占用了该 ID,注册会记录错误,让传入的连线保持未连接状态,并返回 `undefined`。它不会静默替换正在使用的连线,也不会为传入的连线分配另一个身份。`graph.floatingLinks` 仍然是用于单端连线的过滤兼容视图。 + +`graph.links` 和 `graph.floatingLinks` 是按所有者过滤、由 store 支撑的兼容视图,而不是独立的原生 `Map` 存储。它们常规的 `Map` 读取方法使用缓存的成员快照;拓扑成员发生变化后,请获取新的迭代器,不要保留已有的迭代器。这两个视图都需要活动的 Pinia,并且不再把缺失的 store 表示成空图。 + +与原生 `Map.set()` 一样,`view.set(id, link)` 返回视图本身,而不是注册结果。注册可能拒绝 ID 冲突或目标冲突,同时保留原有连线,因此通过视图插入的扩展应使用 `view.get(link.id) === link` 确认成功。与同一视图中的连线发生 ID 冲突后,`has()` 返回 `true`,`get()` 返回原有的那条连线。当图连接 API 和浮动连线 API 能覆盖该操作时优先使用它们,因为这些 API 会协调周边的生命周期。不要直接对任一视图调用 `Map.prototype` 方法,也不要依赖原生 `Map` 的内部存储。 + +输入替换会在旧连线断开回调之前提交新连线,因此回调查询看到的是替换后的连线,而不是空输入。常规的连接回调随后运行。 + +以前忽略返回值的扩展,应在保留、渲染或修改传入连线之前处理 `undefined`。不要为新的运行时连线预选连线 ID,交给图去生成。 + +持久化 ID 的冲突修复属于工作流导入和反序列化的职责。导入序列化拓扑的扩展应在该边界规范化冲突的 ID,然后再使用运行时注册 API。 + +构造根 `LGraph`,或从序列化数据配置一个图对象,都需要活动的 Pinia,因为图拓扑在整个生命周期中都由 store 支撑。 diff --git a/zh/custom-nodes/js/node-geometry-migration.mdx b/zh/custom-nodes/js/node-geometry-migration.mdx new file mode 100644 index 0000000000..de0ee7954f --- /dev/null +++ b/zh/custom-nodes/js/node-geometry-migration.mdx @@ -0,0 +1,75 @@ +--- +title: "前端扩展的节点几何迁移" +sidebarTitle: "节点几何迁移" +description: "节点尺寸与渲染边界的对比、applyNodePositions 的重命名,以及布局存储变更后 ComfyUI 前端扩展的绘制顺序 z-order。" +translationSourceHash: 833ab6fb +translationFrom: custom-nodes/js/node-geometry-migration.mdx +translationBlockHashes: + "Migration checklist": a95abc11 + "What changed": f4ee15bc + "Writes through removed references stay local": ba9b1003 +--- + +## 迁移检查清单 + +1. 继续使用 `node.pos`、`node.size`、`boundingRect`、`getBounding()`、 + `setPos()`、`setSize()`:无需更改签名。 +2. 将 `repositionNodesVueMode()` 调用替换为 `applyNodePositions()`。 +3. 如果你依赖 `node.size` 来反映实测或渲染的内容,请改用 + `getBounding()` / `boundingRect`。在 Vue 渲染器下,`size` 现在 + 严格反映请求的值。传统渲染器仍会增大 `size` 以适应 widgets。 +4. 使用节点/组几何 API,而不是底层存储;不要导入 + `layoutStore`,也不要依赖其内部格式。 +5. 通过已移除的引用进行写入时,更新的是分离的对象,而不是共享的 + 布局状态。 + +## 变更内容 + +`LGraphNode.pos`、`size`、`boundingRect`、`getBounding()`、`setPos()` 和 +`setSize()` 的方法签名保持不变,这些调用在源码层面仍然兼容。 +但行为在以下三种情况下发生了变化。 + +```ts +node.pos = [100, 200] +node.pos[0] += 50 +node.setSize([320, 200]) +node.updateArea() +const box = node.getBounding() +``` + +节点与分组的位置信息现在存放在共享的布局存储中,而不再是每个实例各自的字段。请使用上面列出的 API,不要直接访问该存储:它属于内部实现细节。 + +### `size` 与渲染后的边界 + +`node.size` 是你请求的尺寸,也是被序列化的尺寸。在使用 Vue 渲染器时,渲染过程永远不会改变它。`getBounding()` 和 `boundingRect` 返回的是渲染后的边界,当控件内容需要更多空间时,它可能大于 `size`。在使用传统画布渲染器时,节点仍会通过调用 `setSize()` 来撑开以容纳其控件,因此一次绘制之后 `node.size` 和已保存的尺寸可能会发生变化。当你需要节点在屏幕上的实际占位时,请使用渲染后的边界。 + +画布会在每一帧开始时重新计算 `getBounding()` 和 `boundingRect`。在你修改 `pos` 或 `size` 之后,如果要在同一帧内读取它们,请先调用 `node.updateArea()`。在使用 Vue 渲染器时,由 DOM 内容引起的尺寸增长只有在节点完成测量后才会出现。 + +```ts +// 之前:由渲染内容触发的调整大小可能覆盖 size,因此折叠节点 +// 再重新展开时会丢失原始尺寸。 +node.size // 可能悄悄变成渲染后的占位尺寸 + +// 之后(Vue 渲染器):size 保持为你设置的值;需要渲染后的边界请显式获取。 +node.size // 请求的尺寸,不受渲染影响 +node.getBounding() // 实际渲染后的边界,可能更大 +``` + +### `repositionNodesVueMode()` 已重命名为 `applyNodePositions()` + +```ts +// 之前 +canvas.repositionNodesVueMode(newPositions) +// 之后 +canvas.applyNodePositions(newPositions) +``` + +`repositionNodesVueMode()` 仍可作为弃用的别名调用。 + +### Z 顺序现在含义明确 + +过去 Z 顺序来自两个可能互相冲突的来源:节点在节点列表中的位置,以及它的执行顺序。现在它始终是绘制顺序。如果你的扩展曾根据执行顺序推断层叠顺序或命中测试顺序,请切换到绘制顺序。 + +## 通过已移除引用的写入只停留在本地 + +移除之后,几何设置函数只会更新已分离的节点、组或重新路由对象。它们不会更新共享的布局状态,也不会更新现在拥有同一 ID 的其他实体。 diff --git a/zh/custom-nodes/js/node-id-migration.mdx b/zh/custom-nodes/js/node-id-migration.mdx new file mode 100644 index 0000000000..d9c9896d28 --- /dev/null +++ b/zh/custom-nodes/js/node-id-migration.mdx @@ -0,0 +1,16 @@ +--- +title: "前端扩展的节点 ID 迁移" +sidebarTitle: "节点 ID 迁移" +description: "将 ComfyUI 前端扩展迁移到带品牌标记的字符串节点 ID,以及字符串子图边界哨兵值 SUBGRAPH_INPUT_ID 和 SUBGRAPH_OUTPUT_ID。" +translationSourceHash: 168947f8 +translationFrom: custom-nodes/js/node-id-migration.mdx +--- + +ComfyUI 前端现在会在内部边界将本地节点 ID 规范化为带品牌标记的 `NodeId` 字符串类型。序列化工作流和 API 负载仍可能包含数字 ID,但进入前端后,litegraph(旧版)中的节点 ID(例如 `node.id`、`LLink.origin_id` 和 `LLink.target_id`)应被视为字符串。连线 ID(`LLink.id`)和重新路由 ID 仍为数字。 + +扩展作者应避免对节点 ID 进行数值比较。特别地,子图边界哨兵值以带品牌标记的字符串 ID 的形式暴露: + +- `SUBGRAPH_INPUT_ID` 从 `-10` 序列化而来 +- `SUBGRAPH_OUTPUT_ID` 从 `-20` 序列化而来 + +请与字符串 `'-10'` 和 `'-20'` 进行比较,或者在比较传统值之前将双方都规范化为字符串。 \ No newline at end of file diff --git a/zh/custom-nodes/js/primevue-removal-migration.mdx b/zh/custom-nodes/js/primevue-removal-migration.mdx new file mode 100644 index 0000000000..c815d02ec8 --- /dev/null +++ b/zh/custom-nodes/js/primevue-removal-migration.mdx @@ -0,0 +1,66 @@ +--- +title: "前端扩展的 PrimeVue 移除迁移" +sidebarTitle: "PrimeVue 移除迁移" +description: "在 ComfyUI 前端移除 PrimeVue 之后,替换 $primevue、PrimeVue 组件、--p-* CSS 变量和 PrimeVue 工具提示选择器。" +translationSourceHash: ca5e48dd +translationFrom: custom-nodes/js/primevue-removal-migration.mdx +translationBlockHashes: + "_intro": 5bd8432b + "Extensions that render PrimeVue components": e2b1c44c + "Extensions that read `--p-*` variables": d45a77c2 + "Tooltips": 5252984f + "Deprecated variable names": df1d5960 +--- + +ComfyUI 前端不再安装 PrimeVue。宿主应用不会调用 +`app.use(PrimeVue)`,因此扩展会失去它们可能曾依赖的三项内容: + +- 宿主 Vue 应用上的 `$primevue` 全局属性; +- PrimeVue 主题样式表,因此扩展在宿主应用中渲染的 PrimeVue 组件会呈现为无样式状态;以及 +- 所有全局 `--p-*` CSS 变量,例如 `--p-primary-color`、 + `--p-surface-*`、`--p-text-color`、`--p-content-background` 和 + `--p-form-field-border-color`。 + +## 渲染 PrimeVue 组件的扩展 + +不要依赖宿主应用的 PrimeVue 实例。你可以用自己编写的标记替换 PrimeVue 组件,也可以为你的 UI 创建一个自己的 Vue 应用,并在该应用上安装 PrimeVue 及其主题。 + +## 读取 `--p-*` 变量的扩展 + +请将它们替换为设计系统主题变量,这些变量会随当前的浅色或深色主题以及当前的色彩主题变化: + +| PrimeVue 变量 | 主题变量 | +| --------------------------------------------------------- | -------------------- | +| `--p-primary-color` | `--primary` | +| `--p-text-color` | `--foreground` | +| `--p-text-muted-color` | `--muted-foreground` | +| `--p-content-background` | `--background` | +| `--p-surface-*`(面板、浮层区域) | `--secondary` | +| `--p-content-border-color`、`--p-form-field-border-color` | `--border` | + +## 工具提示 + +全局 `v-tooltip` 指令已被移除,工具提示不再渲染 PrimeVue DOM: + +- `.p-tooltip` 和 `.p-tooltip-text` +- `data-pd-tooltip` 属性 +- `$_ptooltip*` 元素属性 + +处于打开状态的工具提示现在会渲染一个带有 `data-slot="tooltip-content"` 的元素,并通过 portal 挂载到 `document.body` 末尾。它仅在工具提示打开期间存在。如果扩展要在自己的 UI 中隐藏工具提示,应定位 `[data-slot="tooltip-content"]`,而不是 `.p-tooltip`。 + +`--node-component-tooltip*` CSS 变量也已从设计系统样式表中移除。请改用主题变量:`--background`、`--foreground` 和 `--border`。旧名称 `--base-background`、`--base-foreground` 和 `--border-default` 已弃用;请参阅[已弃用的变量名](#弃用的变量名称)。 + +## 弃用的变量名称 + +这些说明的早期版本使用了旧的设计系统名称。它们仍然可用,但已弃用,并将在未来版本中移除。现在请改用以下主题变量: + +| 弃用名称 | 主题变量 | +| ----------------------------- | -------------- | +| `--base-background` | `--background` | +| `--base-foreground` | `--foreground` | +| `--border-default` | `--border` | +| `--primary-background` | `--primary` | +| `--secondary-background` | `--secondary` | +| `--component-node-background` | `--node` | + +PrimeIcons 仍会加载,因此现有的 `pi pi-*` 图标类仍可继续使用,但它们正在被逐步淘汰。请勿新增使用。 diff --git a/zh/custom-nodes/js/serialization-callbacks-migration.mdx b/zh/custom-nodes/js/serialization-callbacks-migration.mdx new file mode 100644 index 0000000000..c89fc8bbe0 --- /dev/null +++ b/zh/custom-nodes/js/serialization-callbacks-migration.mdx @@ -0,0 +1,51 @@ +--- +title: "前端扩展的序列化回调迁移" +sidebarTitle: "序列化回调迁移" +description: "在使用 store 支持的图时,onSerialize 与 onConfigure 的行为方式,以及 ComfyUI 前端扩展应在何处持久化自定义数据。" +translationSourceHash: de116a13 +translationFrom: custom-nodes/js/serialization-callbacks-migration.mdx +translationBlockHashes: + "_intro": 87be7894 + "Store custom data in properties or extra": 9bd7e443 + "Serialize nodes instead of enumerating properties": f9850471 +--- + + +要从序列化数据配置根 `LGraph`,现在需要一个活跃的 Pinia 实例。`LGraph.configure()` 会直接针对 ECS 存储清空并重建图,因此在没有活跃 Pinia 的情况下调用 `new LGraph(data)` 或 `graph.configure(data)` 的测试框架、worker 或独立 LiteGraph 使用方,现在会直接失败,而不再静默生成一个空图。这与[连线注册迁移](/zh/custom-nodes/js/link-registration-migration)中记录的属于同一项要求。 + +在 ComfyUI 中运行的扩展使用应用当前活跃的 Pinia 实例。不要在扩展代码中创建或激活独立的 Pinia 实例。 + +`node.onConfigure`、`node.onSerialize`、`graph.onConfigure` 和 `graph.onSerialize` 保持原有的签名与触发顺序。关于连接时序的钩子,参见[连接回调迁移](/zh/custom-nodes/js/connection-callbacks-migration);关于 `node.widgets` 与 widget 值存储,参见[Widget 系统迁移](/zh/custom-nodes/js/widgets-migration)。 + +`onConfigure` 现在接收的是序列化数据的浅拷贝,而不是调用方自己的对象。在回调参数上添加、删除或重新赋值顶层键,不会改变调用方的工作流 JSON,也不会被持久化。嵌套对象(例如 `inputs`、`pos`、`properties`)仍与调用方共享,因此就地修改依然会外泄;依赖这两种修改方式的扩展,必须改为把自定义状态保存在 `node.properties` 或 `graph.extra` 上。 + +## 将自定义数据存放在 properties 或 extra 中 + +每个节点的扩展数据使用 `node.properties`,每个图的扩展数据使用 `graph.extra`。对于持久化数据,它们仍然是稳定且官方支持的扩展入口。 + +调用 `onSerialize` 和 `onConfigure` 时,`this` 绑定到活动的节点/图对象;传给回调的参数是序列化后的数据对象(`ISerialisedNode`/`ISerialisedGraph`),而不是活动的节点/图。由于 `this` 仍是活动对象,钩子可以改写它上面的任何字段,包括现在由 store 支撑的字段。不要用这些钩子覆盖核心字段:在 `onSerialize`/`onConfigure` 内部通过 `this` 写入会直接落到 store,没有自己的 schema、归属或撤销边界。 + +`onSerialize` 在前端把 `graph.extra` 和 `node.properties` 复制进数据对象之后运行,因此钩子添加到 `this.extra` 或 `this.properties` 的键不会出现在本次保存中。在 `onSerialize` 内部,请改为写入回调参数:图写 `data.extra`,节点写 `data.properties`。否则请在序列化开始之前更新 `graph.extra` 或 `node.properties`。 + +`onSerialize` 只持有一个回调,因此请保留其它扩展已经装好的钩子: + +```js +const previous = graph.onSerialize +graph.onSerialize = function (data) { + previous?.call(this, data) + data.extra.myExtension = { version: 1 } +} +``` + +只有根图会运行 `onSerialize`。子图定义保存时不会在子图上调用钩子,因此请在保存工作流之前把子图数据写入 `subgraph.extra`。 + +钩子添加到 `data` 的自定义顶层键在 `LGraph.asSerialisable()` 中仍留在顶层。旧入口 `LGraph.serialize()` 会把它移到 `data.extensions` 下,并丢弃不是 JSON 兼容的值。工作流加载时,`onConfigure` 会再次在顶层收到该键。`extra` 下的键在两个入口中都保持原位。 + +## 序列化节点,而不是枚举属性 + +如果你的扩展通过枚举节点自身的属性来构建节点的序列化表示或调试表示,请将其切换为 `node.serialize()`。 + +`id`、`type`、`title`、`flags`、`mode`、`color`、`bgcolor`、`shape` 和 `showAdvanced` 现在是指向节点数据存储的访问器属性,不再是节点实例自身的自有数据属性。`Object.keys(node)`、`for...in` 和 `{ ...node }` 不再暴露这些字段,但直接读取和写入(`node.title`、`node.mode = ...`)仍可照常工作。`inputs`、`outputs` 和 `widgets` 仍可被自有枚举,因此展开与枚举仍会取到这三项。 + +关于 widget 级别的 `serializeValue`,它属于一个独立的序列化层,构建的是 API prompt 载荷,而非工作流 JSON,请参阅 +[Widget 系统迁移](/zh/custom-nodes/js/widgets-migration)。 diff --git a/zh/custom-nodes/js/widgets-migration.mdx b/zh/custom-nodes/js/widgets-migration.mdx new file mode 100644 index 0000000000..e010ad759e --- /dev/null +++ b/zh/custom-nodes/js/widgets-migration.mdx @@ -0,0 +1,106 @@ +--- +title: "前端扩展的 Widget 系统迁移" +sidebarTitle: "Widget 系统迁移" +description: "ComfyUI 前端中由存储支持的 widget 值:唯一的 widget 名称、未定义的 node.widgets、widget 重命名、addCustomWidget 以及 Agent 的 setValue 调用。" +translationSourceHash: 3011c9c5 +translationFrom: custom-nodes/js/widgets-migration.mdx +translationBlockHashes: + "_intro": 87b853c9 + "Gallery values after the PrimeVue replacement": c6a755f6 + "Widget names must be unique and stable": 5988a23b + "`node.widgets` may be undefined": 7cb43a39 + "Prefer `node.addCustomWidget()` to pushing onto `node.widgets`": 5ee6030c + "Remove widgets with `node.removeWidget()`": 7d19ff02 + "Agent edits call `setValue` without a pointer event": 140c58f6 + "Don't call `useWidgetValueStore()` from extension code": 6c2a5cd3 +--- + +现在,widget 的值保存在由 Pinia 支持的 store 中,而不再直接存放在 widget 实例上。每个节点内的 widget 名称必须唯一,并且只有当新名称未被占用时,重命名 widget 才会成功。在首次赋值之前,`node.widgets` 也可能为 `undefined`。 + +## PrimeVue 替换之后的图库值 + +Vue 的 `galleria` 组件接受一个由图片网址字符串组成的数组,与 `GALLERIA` 输入 schema 相匹配。存在多张图像时会显示缩略图以及上一个/下一个按钮。导航会在第一张和最后一张图像处停止。 + +不再支持带有 `itemImageSrc` 或 `thumbnailImageSrc` 的 PrimeVue 图像对象,请将其转换为网址字符串。该组件也不再读取 `showThumbnails`、`showItemNavigators`、`circular`、`autoPlay`、`transitionInterval`、`showIndicators`、`numVisible` 或 `responsiveOptions` 等 PrimeVue 选项。需要这些控件的扩展必须自行提供图库组件。 + +## 控件名称必须唯一且稳定 + +同一节点上的两个控件不能同名。如果你添加的第二个控件使用了已经占用的名称,当节点位于画面中时,前端会给新控件加上带编号的后缀(如 `strength#1`)来重命名它。按原始名称查找只会找到第一个控件: + +```js +node.addWidget('number', 'strength', 0, () => {}) +const second = node.addWidget('number', 'strength', 1, () => {}) +second.name // 当节点位于画面中时,为 'strength#1' +``` + +请为每个控件指定唯一的名称。 + +给已注册的控件分配新的 `widget.name`,会将其存储的值移动到新名称下。如果节点上的另一个控件已经使用了该名称,则赋值会被忽略,`widget.name` 会保留其旧值,因此之后要检查 `widget.name`。按名称引用该控件的输入槽不会随之更新。不要通过移除控件再添加新控件的方式来重命名:`removeWidget()` 会删除存储的值,并清除直接绑定到该控件的输入槽。仅按名称引用它的输入槽会保留该名称。 + +## `node.widgets` 可能为 `undefined` + +`node.widgets` 在被赋值至少一次之前会返回 `undefined`。 +请在添加小组件之前先初始化该数组: + +```ts +export function nodeCreated(node: LGraphNode) { + node.widgets ??= [] + node.widgets.push(myWidget) +} +``` + +读取时同样需要做防护: + +```ts +const widgetCount = node.widgets?.length ?? 0 +``` + +**将 `node.widgets` 设为 `undefined` 会清空它。** 之后再次读取会返回 +`undefined`,而不是 `[]`。 + +**在节点挂载到画面之前所做的修改会被自动捕获。** +对于在构造函数或 `onNodeCreated` 中构建小组件这一常见情况,你无需自行调用任何内容。 + +`node.widgets` 会出现在 `Object.keys(node)` 以及 `{...node}` 这类对象展开中。 + +## 优先使用 `node.addCustomWidget()`,而不是将其推送到 `node.widgets` + +通过 `node.addWidget()`、`node.addCustomWidget()` 或 +`node.addDOMWidget()` 添加的控件会自动注册到存储中。直接推送到 `node.widgets` 的普通对象 +也会转换为控件实例,并在节点进入画面后完成注册。转换通常原地进行, +但冻结对象或具有不可配置属性的对象会被替换为另一个独立的控件,因此请保留 `addCustomWidget()` 返回的控件,或 +从 `node.widgets` 中重新读取它。`addCustomWidget()` 仍是推荐的方式: +它会返回控件,并在工作流加载时恢复控件已保存的值。 + +```js +node.addCustomWidget({ + name: 'my_widget', + type: 'custom', + value: '', + options: {}, + draw(ctx, node, width, y, height) {}, + mouse(event, pos, node) {} +}) +``` + +如果在节点附加到画面之前读取或写入 `widget.value`, +该值会保存在本地,并在附加时同步到存储。不会丢失任何值, +但由存储驱动的 UI(例如右侧面板)在此之前不会看到该值。 + +## 使用 `node.removeWidget()` 移除控件 + +使用 `node.removeWidget(widget)` 移除控件。直接对 `node.widgets` 执行 splice 会跳过槽位清理,且被移除控件的值会一直保留在存储中,直到节点本身从画面中移除。 + +## 应用内 Agent 编辑时会调用 `setValue` 而不带指针事件 + +当应用内 Agent 修改一个 `BaseWidget` 实例的控件时,前端会调用 `widget.setValue(value, { node, canvas })`,这与用户编辑走的是同一个方法。此前,它直接赋值 `widget.value`,然后自己调用 `callback` 和 `onWidgetChanged`。这包括用 `addCustomWidget()` 添加或直接推入 `node.widgets` 的普通对象,因为前端会把它们转换成 `BaseWidget` 实例。DynamicGroup 行数控制器与提升后的子图宿主控件仍然走直接写入。 + +如果你重写了 `setValue`,请接受形如 `{ node, e?, canvas? }` 的选项:这些调用永远不会设置 `e`,`canvas` 也可能缺失。不要在未检查的情况下读取 `options.e` 或 `options.canvas`。只带值调用原始 `setValue` 的包装器仍然可用:选项默认为 `{ node: widget.node }`。 + +`callback` 和 `onWidgetChanged` 现在收到的是控件实际接受的值,而不是 Agent 发送的值。数字控件会按 `min`/`max` 夹取,并把数字字符串转换成数字。在 `callback` 中,`e` 是 `undefined`,没有画布时 `pos` 也是 `undefined`。 + +当值在数字控件夹取和转换之后已经与当前值完全相同(`===`)时,`setValue` 会直接返回而不产生变化,因此数字控件在值为 `5` 时收到 `'5'` 不会有任何变化。当数字控件收到的值使 `Number(value)` 为 `NaN` 时也会直接返回。此时 `callback` 和 `onWidgetChanged` 都不会触发,图版本也不会变。像 `'7'` 这样的数字字符串会被转换并应用。 + +## 不要从扩展代码中调用 `useWidgetValueStore()` + +不要在扩展中调用 `useWidgetValueStore()`。请改用 `node.widgets`、`node.addWidget()` / `addCustomWidget()` / `removeWidget()` 以及 `widget.value`。该 store 内部的键机制及其对 Pinia 的依赖,并不属于受支持的扩展接口。 diff --git a/zh/development/comfy-router/models.mdx b/zh/development/comfy-router/models.mdx index fe1d3ddb5f..98e66d9f10 100644 --- a/zh/development/comfy-router/models.mdx +++ b/zh/development/comfy-router/models.mdx @@ -2,11 +2,11 @@ title: "Comfy Router 模型" sidebarTitle: "所有模型" description: "Comfy Router 提供的全部模型,按提供方分组,并列出每个模型的输入和输出模态。" -translationSourceHash: d2265d41 +translationSourceHash: d299c0f0 translationFrom: development/comfy-router/models.mdx translationBlockHashes: "_intro": 2584e428 - "Find by output": 9b1b4039 + "Find by output": 5ddf7991 "Anthropic": de8acc20 "Beeble": b52ea340 "Black Forest Labs": 2934e3eb @@ -28,9 +28,9 @@ translationBlockHashes: "Meshy": 67e26a17 "MiniMax": 87560ab7 "Moonvalley": 9e63fb77 - "OpenAI": a5c1e692 + "OpenAI": 5bbf3b2c "Openrouter": a4f6806b - "Pika": f2b1d797 + "Pika": 8b17ff30 "Pruna": 903d76ee "Qwen": b3ef78a1 "Recraft": 02b7d9cd @@ -54,7 +54,7 @@ translationBlockHashes: ## 按输出查找 - + - [SwitchX](/zh/development/comfy-router/models/beeble/switchx/code):`beeble/switchx` - [FLUX 3 Video](/zh/development/comfy-router/models/black-forest-labs/flux-3-video/code):`bfl/flux-3-video` @@ -96,6 +96,7 @@ translationBlockHashes: - [Video To Video](/zh/development/comfy-router/models/moonvalley/video-to-video/code):`moonvalley/video-to-video` - [Pika 2.5 Image To Video](/zh/development/comfy-router/models/pika/pika-2-5-image-to-video/code):`pika/pika-2.5-image-to-video` - [Pika 2.5 Text To Video](/zh/development/comfy-router/models/pika/pika-2-5-text-to-video/code):`pika/pika-2.5-text-to-video` +- [Pika Soundtrack](/zh/development/comfy-router/models/pika/pika-soundtrack/code):`pika/pika-soundtrack` - [P Video 2](/zh/development/comfy-router/models/pruna/p-video-2/code):`pruna/p-video-2` - [Aleph 2](/zh/development/comfy-router/models/runway/aleph2/code):`runway/aleph2` - [Gen 4 Turbo](/zh/development/comfy-router/models/runway/gen4-turbo/code):`runway/gen4_turbo` @@ -160,6 +161,7 @@ translationBlockHashes: - [图像编辑:引导式移除背景](/zh/development/comfy-router/models/bria/image-edit-remove-background-guided/code):`bria/image-edit-remove-background-guided` - [图像编辑:移除背景](/zh/development/comfy-router/models/bria/image-edit-remove-background/code):`bria/image-edit-remove-background` - [图像编辑:替换背景](/zh/development/comfy-router/models/bria/image-edit-replace-background/code):`bria/image-edit-replace-background` +- [图像编辑:按文本替换对象](/zh/development/comfy-router/models/bria/image-edit-replace-object-by-text/code):`bria/image-edit-replace-object-by-text` - [图像编辑:Reseason](/zh/development/comfy-router/models/bria/image-edit-reseason/code):`bria/image-edit-reseason` - [图像编辑:修复](/zh/development/comfy-router/models/bria/image-edit-restore/code):`bria/image-edit-restore` - [图像](/zh/development/comfy-router/models/bria/image/code):`bria/image` @@ -211,6 +213,7 @@ translationBlockHashes: - [Recraft V4.1 Utility](/zh/development/comfy-router/models/recraft/recraftv4-1-utility/code):`recraft/recraftv4_1_utility` - [Recraft V4.1 Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-vector/code):`recraft/recraftv4_1_vector` - [Recraft V4.1](/zh/development/comfy-router/models/recraft/recraftv4-1/code):`recraft/recraftv4_1` +- [Recraft V4 Pro](/zh/development/comfy-router/models/recraft/recraftv4-pro/code):`recraft/recraftv4_pro` - [Recraft V4 Styles Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code):`recraft/recraftv4_styles_pro_vector` - [Recraft V4 Styles Pro](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro/code):`recraft/recraftv4_styles_pro` - [Recraft V4 Styles Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-vector/code):`recraft/recraftv4_styles_vector` @@ -227,7 +230,7 @@ translationBlockHashes: - [Grok Imagine Image](/zh/development/comfy-router/models/xai/grok-imagine-image/code):`xai/grok-imagine-image` - + - [FLUX 3 Video](/zh/development/comfy-router/models/black-forest-labs/flux-3-video/code):`bfl/flux-3-video` - [Dreamina Seedance 2.0 260128](/zh/development/comfy-router/models/byteplus/dreamina-seedance-2-0-260128/code):`byteplus/dreamina-seedance-2-0-260128` @@ -253,6 +256,9 @@ translationBlockHashes: - [LTX 2.5 Fast](/zh/development/comfy-router/models/ltx/ltx-2-5-fast/code):`ltx/ltx-2-5-fast` - [LTX 2.5 Pro](/zh/development/comfy-router/models/ltx/ltx-2-5-pro/code):`ltx/ltx-2-5-pro` - [MiniMax H3](/zh/development/comfy-router/models/minimax/minimax-h3/code):`minimax/minimax-h3` +- [Pika Music](/zh/development/comfy-router/models/pika/pika-music/code):`pika/pika-music` +- [Pika Sfx](/zh/development/comfy-router/models/pika/pika-sfx/code):`pika/pika-sfx` +- [Pika Soundtrack](/zh/development/comfy-router/models/pika/pika-soundtrack/code):`pika/pika-soundtrack` - [P Video 2](/zh/development/comfy-router/models/pruna/p-video-2/code):`pruna/p-video-2` - [Clean Audio Video](/zh/development/comfy-router/models/veed/clean-audio-video/code):`veed/clean-audio-video` - [Clean Audio](/zh/development/comfy-router/models/veed/clean-audio/code):`veed/clean-audio` @@ -287,7 +293,7 @@ translationBlockHashes: - [Hunyuan 3D Uv](/zh/development/comfy-router/models/tencent/hunyuan-3d-uv/code):`tencent/hunyuan-3d-uv` - + - [Claude Fable 5.1](/zh/development/comfy-router/models/anthropic/claude-fable-5-1/code):`anthropic/claude-fable-5-1` - [Claude Fable 5](/zh/development/comfy-router/models/anthropic/claude-fable-5/code):`anthropic/claude-fable-5` @@ -326,6 +332,8 @@ translationBlockHashes: - [GPT 5 Mini](/zh/development/comfy-router/models/openai/gpt-5-mini/code):`openai/gpt-5-mini` - [GPT 5 Nano](/zh/development/comfy-router/models/openai/gpt-5-nano/code):`openai/gpt-5-nano` - [GPT 5](/zh/development/comfy-router/models/openai/gpt-5/code):`openai/gpt-5` +- [GPT 6.1 Sol](/zh/development/comfy-router/models/openai/gpt-6-1-sol/code):`openai/gpt-6.1-sol` +- [GPT 6.1 Terra](/zh/development/comfy-router/models/openai/gpt-6-1-terra/code):`openai/gpt-6.1-terra` - [GPT 6 Astra](/zh/development/comfy-router/models/openai/gpt-6-astra/code):`openai/gpt-6-astra` - [GPT 6 Luna](/zh/development/comfy-router/models/openai/gpt-6-luna/code):`openai/gpt-6-luna` - [GPT 6 Sol](/zh/development/comfy-router/models/openai/gpt-6-sol/code):`openai/gpt-6-sol` @@ -585,6 +593,8 @@ translationBlockHashes: | [GPT 5 Mini](/zh/development/comfy-router/models/openai/gpt-5-mini/code) | `openai/gpt-5-mini` | 文本,图像 | 文本 | | [GPT 5 Nano](/zh/development/comfy-router/models/openai/gpt-5-nano/code) | `openai/gpt-5-nano` | 文本,图像 | 文本 | | [GPT 5](/zh/development/comfy-router/models/openai/gpt-5/code) | `openai/gpt-5` | 文本,图像 | 文本 | +| [GPT 6.1 Sol](/zh/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | 文本,图像 | 文本 | +| [GPT 6.1 Terra](/zh/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | 文本,图像 | 文本 | | [GPT 6 Astra](/zh/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | 文本,图像 | 文本 | | [GPT 6 Luna](/zh/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | 文本,图像 | 文本 | | [GPT 6 Sol](/zh/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | 文本,图像 | 文本 | @@ -606,6 +616,9 @@ translationBlockHashes: | --- | --- | --- | --- | | [Pika 2.5 图生视频](/zh/development/comfy-router/models/pika/pika-2-5-image-to-video/code) | `pika/pika-2.5-image-to-video` | 文本、图像 | 视频 | | [Pika 2.5 文生视频](/zh/development/comfy-router/models/pika/pika-2-5-text-to-video/code) | `pika/pika-2.5-text-to-video` | 文本 | 视频 | +| [Pika Music](/zh/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | 文本、音频 | 音频 | +| [Pika Sfx](/zh/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | 文本 | 音频 | +| [Pika Soundtrack](/zh/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | 视频、文本 | 视频 + 音频 | ## Pruna diff --git a/zh/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx b/zh/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx index 0606396725..2f2bbcf397 100644 --- a/zh/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx +++ b/zh/development/comfy-router/models/kling/kling-3-0-turbo/code.mdx @@ -1,15 +1,15 @@ --- title: "通过 Comfy Router 使用 Kling 3.0 Turbo" -description: "通过 Comfy Router 调用 kling/kling-3.0-turbo:endpoint、请求结构以及 Router 返回的响应。" +description: "通过 Comfy Router 调用 kling/kling-3.0-turbo:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "Kling 3.0 Turbo" -translationSourceHash: d03a4ba5 +translationSourceHash: d09b3876 translationFrom: development/comfy-router/models/kling/kling-3-0-turbo/code.mdx translationBlockHashes: "_intro": 5a8c5f4b "Quick start": a2145573 "Serving providers": 7ec93d4f - "Schema": 4ec53894 - "Examples": 0a9a8bbe + "Schema": 992b8da2 + "Examples": 5ce1484a --- @@ -26,9 +26,9 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原始 HTTP 执行的同一调用。 -**模型 ID:** `kling/kling-3.0-turbo` +**模型 ID:**`kling/kling-3.0-turbo` -**端点:** `POST https://api.comfy.org/v2/models/kling/kling-3.0-turbo` +**端点:**`POST https://api.comfy.org/v2/models/kling/kling-3.0-turbo` @@ -181,13 +181,13 @@ curl https://api.comfy.org/v2/models/kling/kling-3.0-turbo/requests/$REQUEST_ID 视频宽高比 - 可选值: `16:9`, `9:16`, `1:1` + 可选值:`16:9`, `9:16`, `1:1` 视频长度,以秒为单位 - 可选值: `3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15` + 可选值:`3`, `4`, `5`, `6`, `7`, `8`, `9`, `10`, `11`, `12`, `13`, `14`, `15` @@ -221,19 +221,19 @@ curl https://api.comfy.org/v2/models/kling/kling-3.0-turbo/requests/$REQUEST_ID 已生成画面的宽高比(width:height)。取值为 "16:9"、"9:16" 或 "1:1" 之一。默认 "16:9"。 - 可选值: `16:9`, `9:16`, `1:1` + 可选值:`16:9`, `9:16`, `1:1` 视频长度,以秒为单位。支持的取值为 3 到 15。默认 5。 - 范围: `3` 到 `15` + 范围:`3` 到 `15` 已生成视频的清晰度。取值为 "720p" 或 "1080p" 之一。默认 "720p"。 - 可选值: `720p`, `1080p` + 可选值:`720p`, `1080p` 由 Router 在 `GET /v2/models/kling/kling-3.0-turbo/openapi.json` 提供的 schema 生成,与它在请求到达提供商之前用于校验调用的文档相同。 @@ -398,7 +398,7 @@ curl https://api.comfy.org/v2/models/kling/kling-3.0-turbo/requests/$REQUEST_ID "duration": "5", "id": "kling-v2-output-2b1a0f9e8d7c", "type": "video", - "url": "https://example.invalid/kling/kling-3.0-turbo/generated.mp4" + "url": "https://example.invalid/kling/v2/generated.mp4" } ], "status": "succeeded", diff --git a/zh/development/comfy-router/models/kling/kling-image-o1/code.mdx b/zh/development/comfy-router/models/kling/kling-image-o1/code.mdx index 0e827348ac..3e85374b55 100644 --- a/zh/development/comfy-router/models/kling/kling-image-o1/code.mdx +++ b/zh/development/comfy-router/models/kling/kling-image-o1/code.mdx @@ -2,12 +2,12 @@ title: "使用 Comfy Router 调用 Kling Image O1" description: "通过 Comfy Router 调用 kling/kling-image-o1:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "Kling Image O1" -translationSourceHash: 0d76917c +translationSourceHash: ca32c929 translationFrom: development/comfy-router/models/kling/kling-image-o1/code.mdx translationBlockHashes: "_intro": 513c65df "Quick start": 6256a30d - "Schema": 61821697 + "Schema": 60d9f6fd "Examples": 826db173 --- @@ -24,9 +24,9 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原始 HTTP 发起的相同调用。 -**模型 ID:** `kling/kling-image-o1` +**模型 ID:**`kling/kling-image-o1` -**端点:** `POST https://api.comfy.org/v2/models/kling/kling-image-o1` +**端点:**`POST https://api.comfy.org/v2/models/kling/kling-image-o1` @@ -214,7 +214,7 @@ curl https://api.comfy.org/v2/models/kling/kling-image-o1/requests/$REQUEST_ID \ - 控制生成单张图像还是组图。 + 控制生成单张图像还是组图。series 在 kling-image-o1 上不受支持(当省略 model_name 时,v1 代理使用的也是该值);此类请求会以 HTTP 400 被拒绝。 可选值:`single`、`series` diff --git a/zh/development/comfy-router/models/luma/ray-2/code.mdx b/zh/development/comfy-router/models/luma/ray-2/code.mdx deleted file mode 100644 index 29fd74c07a..0000000000 --- a/zh/development/comfy-router/models/luma/ray-2/code.mdx +++ /dev/null @@ -1,298 +0,0 @@ ---- -title: "将 Ray 2 与 Comfy Router 配合使用" -description: "通过 Comfy Router 调用 luma/ray-2:endpoint、请求 shape 以及 Router 返回的响应。" -sidebarTitle: "Ray 2" -translationSourceHash: 05a55db0 -translationFrom: development/comfy-router/models/luma/ray-2/code.mdx -translationBlockHashes: - "_intro": 76eb0c5f - "Quick start": 6f46e102 - "Schema": ea1f7cdb - "Examples": 3993fae3 ---- - - -{/* 已生成的文件。由 `pnpm code-pages:gen` 从 router-schemas/luma/ray-2.json 生成。 */} - -import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; - -`luma/ray-2` 的 API 参考,由 Comfy Router 从 Luma 提供。 - -**输入:** 文本, 图像 · **输出:** 视频 - -## 快速开始 - -在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原始 HTTP 发起的同一调用。 - -**模型 ID:** `luma/ray-2` - -**端点:** `POST https://api.comfy.org/v2/models/luma/ray-2` - - - - -```python Python -from comfy_sdk import Comfy - -# 从环境变量中读取 COMFY_API_KEY。 -# SDK 会自动创建幂等键,并在自动重试时复用它。 -with Comfy() as client: - result = client.models.run( - "luma/ray-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量中读取 COMFY_API_KEY。 -// SDK 会自动创建幂等键,并在自动重试时复用它。 -const { data } = await comfy.models.run("luma/ray-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/luma/ray-2 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" -``` - - - -将相同的请求体发送到 `POST https://api.comfy.org/v2/models/luma/ray-2/requests`。运行被受理后,Router 会立即返回 `201` 和 `request_id`;结果就绪后,可以从本进程或其他进程收集。状态、取消与收集的细节见 [队列投递](/zh/development/comfy-router/queue)。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 从环境变量读取 COMFY_API_KEY。 -# 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "luma/ray-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - print("request_id:", handle.request_id) # 加上模型 ID,就是另一个进程所需的全部信息 - - # 轮询直到请求完成,每次等待服务器给出的 Retry-After。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 提供商自己的载荷,与 models.run() 返回的值相同。 - # 失败或已取消的请求会在这里抛出带类型的 Router 错误。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量读取 COMFY_API_KEY。 -// 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -const handle = await comfy.models.submit("luma/ray-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); -console.log("requestId:", handle.requestId); // 加上模型 ID,就是另一个进程所需的全部信息 - -// 轮询直到请求完成,每次等待服务器给出的 Retry-After。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// 与 models.run() 返回的结果相同。失败或已取消的请求会在这里被拒绝。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 提交。Router 返回 201,以及 request_id、status_url、response_url 和 cancel_url。 -curl https://api.comfy.org/v2/models/luma/ray-2/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" - -# 2. 轮询直到 status 为 COMPLETED,每次响应都会给出需要等待的 Retry-After 秒数。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/luma/ray-2/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 收集。返回 200 和模型的原始输出;仍在运行时返回 202 和状态正文。 -curl https://api.comfy.org/v2/models/luma/ray-2/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Schema - -### 输入 - - - 生成内容的宽高比 - - 可选值:`1:1`、`16:9`、`9:16`、`4:3`、`3:4`、`21:9`、`9:21` - - - - 生成内容的回调 URL。当生成处于 dreaming、已完成或失败状态时,会向该回调 URL 发送一个携带 Generation 对象的 POST 请求 - - 格式:`uri` - - - - - - - - 可选值:`video` - - - - 生成内容的关键帧 - - - - 关键帧可以是 Generation 引用、图像或视频 - - - - 关键帧可以是 Generation 引用、图像或视频 - - - - 是否循环播放视频 - - - - 用于生成内容的视频模型。在 Comfy Router 的 `POST /v2/models/luma/{model}` 路由上,该字段由路径提供,因此不得发送;在 v1 的 `POST /proxy/luma/generations` 路由上,该字段为必填,且被限制为 LumaVideoModel 枚举(`ray-2`、`ray-flash-2`)。 - - - - 生成内容的提示词 - - - - - - -该文档由 Router 在 `GET /v2/models/luma/ray-2/openapi.json` 处提供的 schema 生成,同时也是它在请求到达提供商之前用于校验调用的同一份文档。 - -### 输出 - - - 生成内容的资产 - - - - 图像的 URL - - 格式:`uri` - - - - 进度视频的 URL - - 格式:`uri` - - - - 视频的 URL - - 格式:`uri` - - - - 生成内容的创建日期和时间 - - 格式:`date-time` - - - - 生成内容处于该状态的原因 - - - - 可选值:`video`、`image` - - - - 生成内容的 ID - - 格式:`uuid` - - - - 用于生成内容的模型 - - - - 生成内容的请求 - - - - 生成内容的状态 - - 可选值:`queued`、`dreaming`、`completed`、`failed` - - -## 示例 - -### 输入 - -```json -{ - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p" -} -``` - -### 输出 - -```json -{ - "assets": { - "video": "https://example.invalid/luma/ray-2/generated.mp4" - }, - "created_at": "2027-01-01T00:00:00Z", - "generation_type": "video", - "id": "3f2a7c1e-8b40-4d59-9f6a-1c2d3e4f5a60", - "model": "ray-2", - "state": "completed" -} -``` - - diff --git a/zh/development/comfy-router/models/luma/ray-flash-2/code.mdx b/zh/development/comfy-router/models/luma/ray-flash-2/code.mdx deleted file mode 100644 index 1d55709f57..0000000000 --- a/zh/development/comfy-router/models/luma/ray-flash-2/code.mdx +++ /dev/null @@ -1,298 +0,0 @@ ---- -title: "在 Comfy Router 中使用 Ray Flash 2" -description: "通过 Comfy Router 调用 luma/ray-flash-2:端点、请求形状以及 Router 返回的响应。" -sidebarTitle: "Ray Flash 2" -translationSourceHash: 398d8142 -translationFrom: development/comfy-router/models/luma/ray-flash-2/code.mdx -translationBlockHashes: - "_intro": bd0b0053 - "Quick start": c53b2450 - "Schema": 8009af73 - "Examples": cb7953b0 ---- - - -{/* GENERATED FILE. Generated from router-schemas/luma/ray-flash-2.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; - -`luma/ray-flash-2` 的 API 参考,由 Comfy Router 从 Luma 提供。 - -**输入:** 文本, 图像 · **输出:** 视频 - -## 快速开始 - -在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 片段则是通过原始 HTTP 发出的同一调用。 - -**模型 ID:** `luma/ray-flash-2` - -**端点:** `POST https://api.comfy.org/v2/models/luma/ray-flash-2` - - - - -```python Python -from comfy_sdk import Comfy - -# 从环境变量中读取 COMFY_API_KEY。 -# SDK 会自动创建一个幂等键,并在自动重试时复用它。 -with Comfy() as client: - result = client.models.run( - "luma/ray-flash-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量中读取 COMFY_API_KEY。 -// SDK 会自动创建一个幂等键,并在自动重试时复用它。 -const { data } = await comfy.models.run("luma/ray-flash-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/luma/ray-flash-2 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" -``` - - - -将相同的请求体发送到 `POST https://api.comfy.org/v2/models/luma/ray-flash-2/requests`。运行被受理后,Router 会立即返回 `201` 和 `request_id`;结果就绪后,可以从本进程或其他进程收集。状态、取消与收集的细节见 [队列投递](/zh/development/comfy-router/queue)。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 从环境变量中读取 COMFY_API_KEY。 -# 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "luma/ray-flash-2", - { - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p", - }, - ) - print("request_id:", handle.request_id) # 加上模型 ID,就是另一个进程所需的全部信息 - - # 轮询直到请求完成,按服务器给出的 Retry-After 等待。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 提供商的原始响应载荷,与 models.run() 返回的值相同。 - # 失败或已取消的请求会在此处抛出带类型的 Router 错误。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量中读取 COMFY_API_KEY。 -// 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -const handle = await comfy.models.submit("luma/ray-flash-2", { - aspect_ratio: "16:9", - duration: "5s", - prompt: "a single red maple leaf resting on a plain white background", - resolution: "540p", -}); -console.log("requestId:", handle.requestId); // 加上模型 ID,就是另一个进程所需的全部信息 - -// 轮询直到请求完成,按服务器给出的 Retry-After 等待。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// 与 models.run() 返回的结果相同。失败或已取消的请求会在此处被拒绝。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 提交。Router 返回 201,以及 request_id、status_url、response_url 和 cancel_url。 -curl https://api.comfy.org/v2/models/luma/ray-flash-2/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"aspect_ratio\": \"16:9\", \"duration\": \"5s\", \"prompt\": \"a single red maple leaf resting on a plain white background\", \"resolution\": \"540p\"}" - -# 2. 轮询直到状态为 COMPLETED,按每个响应给出的 Retry-After 秒数等待。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/luma/ray-flash-2/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 收集。返回 200 及模型的原始输出;仍在运行时返回 202 及状态响应体。 -curl https://api.comfy.org/v2/models/luma/ray-flash-2/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Schema - -### 输入 - - - 生成任务的宽高比 - - 可能的值:`1:1`、`16:9`、`9:16`、`4:3`、`3:4`、`21:9`、`9:21` - - - - 生成任务的回调 URL。当生成任务处于 dreaming、已完成或失败状态时,会向该回调 URL 发送一个携带 Generation 对象的 POST 请求 - - 格式:`uri` - - - - - - - - 可能的值:`video` - - - - 生成任务的关键帧 - - - - 关键帧可以是 Generation 引用、Image 或 Video - - - - 关键帧可以是 Generation 引用、Image 或 Video - - - - 是否循环播放视频 - - - - 用于生成任务的视频模型。在 Comfy Router 路由 `POST /v2/models/luma/{model}` 上,该字段由路径提供,且不得发送;在 v1 的 `POST /proxy/luma/generations` 路由上,该字段为必填,且被限制为 LumaVideoModel 枚举(`ray-2`、`ray-flash-2`)。 - - - - 生成任务的提示词 - - - - - - -由 Router 在 `GET /v2/models/luma/ray-flash-2/openapi.json` 提供的 schema 生成,这也是请求到达提供商之前 Router 用来校验调用的同一份文档。 - -### 输出 - - - 生成任务的资产 - - - - 图像的 URL - - 格式:`uri` - - - - 进度视频的 URL - - 格式:`uri` - - - - 视频的 URL - - 格式:`uri` - - - - 生成任务的创建日期和时间 - - 格式:`date-time` - - - - 生成任务所处状态的原因 - - - - 可能的值:`video`、`image` - - - - 生成任务的 ID - - 格式:`uuid` - - - - 用于生成任务的模型 - - - - 生成任务的请求 - - - - 生成任务的状态 - - 可能的值:`queued`、`dreaming`、`completed`、`failed` - - -## 示例 - -### 输入 - -```json -{ - "aspect_ratio": "16:9", - "duration": "5s", - "prompt": "a single red maple leaf resting on a plain white background", - "resolution": "540p" -} -``` - -### 输出 - -```json -{ - "assets": { - "video": "https://example.invalid/luma/ray-flash-2/generated.mp4" - }, - "created_at": "2027-01-01T00:00:00Z", - "generation_type": "video", - "id": "8c41d0b6-2e7a-4f35-b1d8-9a0e6f3c2b71", - "model": "ray-flash-2", - "state": "completed" -} -``` - - diff --git a/zh/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx b/zh/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx index e8770f7932..c72358c5f0 100644 --- a/zh/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-4-1-mini/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 4.1 Mini 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/gpt-4.1-mini:端点、请求格式以及 Router 返回的响应。" sidebarTitle: "GPT 4.1 Mini" -translationSourceHash: d34bebbe +translationSourceHash: 4e94ce52 translationFrom: development/comfy-router/models/openai/gpt-4-1-mini/code.mdx translationBlockHashes: "_intro": b8a49e6e "Quick start": bd92ba2a - "Schema": 445b15a8 + "Schema": 80382523 "Examples": 67e6c8f1 --- @@ -25,9 +25,9 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; 在 [你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router) 中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段是通过原始 HTTP 进行的同一调用。 -**模型 ID:** `openai/gpt-4.1-mini` +**模型 ID:**`openai/gpt-4.1-mini` -**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-4.1-mini` +**端点:**`POST https://api.comfy.org/v2/models/openai/gpt-4.1-mini` @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ 当上下文超过模型窗口时使用的截断策略。与上面三个词表不同,此处的枚举会被强制执行,因为这两个值是 OpenAI 文档给出的完整集合,且至今没有增加。显式的 `null` 仍然会被接受,条件与上面的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -268,7 +268,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ - `disabled`(默认):如果模型响应将超过该模型的上下文窗口 大小,请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled`
@@ -297,7 +297,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ 推理投入程度可以使响应更快,并在响应中 用于推理的 token 更少。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -307,7 +307,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ 调试和理解模型的推理过程很有用。 取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -319,7 +319,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ 调试和理解模型的推理过程很有用。 取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -381,7 +381,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ - 该响应的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 该响应的错误代码。 + + 可选值:`server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -403,7 +405,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ 响应未完成的原因。 - Possible values: `max_output_tokens`, `content_filter` + 可选值:`max_output_tokens`, `content_filter` @@ -421,7 +423,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ 此资源的对象类型,始终为 `response`。 - Possible values: `response` + 可选值:`response` @@ -463,7 +465,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ 响应生成的状态。取值为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可选值:`completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -543,6 +545,18 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1-mini/requests/$REQUEST_ID \ 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [关于提示缓存的更多内容](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx b/zh/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx deleted file mode 100644 index 428cc77283..0000000000 --- a/zh/development/comfy-router/models/openai/gpt-4-1-nano/code.mdx +++ /dev/null @@ -1,598 +0,0 @@ ---- -title: "使用 GPT 4.1 Nano 与 Comfy Router" -description: "通过 Comfy Router 调用 openai/gpt-4.1-nano:端点、请求结构以及 Router 返回的响应。" -sidebarTitle: "GPT 4.1 Nano" -translationSourceHash: cb01a907 -translationFrom: development/comfy-router/models/openai/gpt-4-1-nano/code.mdx -translationBlockHashes: - "_intro": 9543bf7b - "Quick start": 9c5ad598 - "Schema": 4e68a487 - "Examples": 67e6c8f1 ---- - - - -{/* GENERATED FILE. Generated from router-schemas/openai/gpt-4.1-nano.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; - -`openai/gpt-4.1-nano` 的 API 参考文档,该模型由 Comfy Router 从 OpenAI 提供。 - -**输入:** 文本, 图像 · **输出:** 文本 - -## 快速开始 - -在 [你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router) 中创建密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原始 HTTP 发出的同一调用。 - -**模型 ID:** `openai/gpt-4.1-nano` - -**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano` - - - - -```python Python -from comfy_sdk import Comfy - -# 从环境变量中读取 COMFY_API_KEY。 -# SDK 会自动创建幂等键,并在自动重试时复用它。 -with Comfy() as client: - result = client.models.run( - "openai/gpt-4.1-nano", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量中读取 COMFY_API_KEY。 -// SDK 会自动创建幂等键,并在自动重试时复用它。 -const { data } = await comfy.models.run("openai/gpt-4.1-nano", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -将相同的请求体发送到 `POST https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests`。只要运行被受理,Router 就会立即返回 `201` 和 `request_id`;结果就绪后,即可从本进程或其他进程收集。[排队投递](/zh/development/comfy-router/queue) 介绍了状态查询、取消和结果收集。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 从环境变量中读取 COMFY_API_KEY。 -# 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/gpt-4.1-nano", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # 有了它和模型 ID,另一个进程就具备了所需的全部信息 - - # 轮询直到请求完成,每次都按服务器给出的 Retry-After 等待。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 提供商自己的响应负载,与 models.run() 返回的值相同。 - # 失败或已取消的请求会在此处抛出类型化的 Router 错误。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量中读取 COMFY_API_KEY。 -// 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -const handle = await comfy.models.submit("openai/gpt-4.1-nano", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // 有了它和模型 ID,另一个进程就具备了所需的全部信息 - -// 轮询直到请求完成,每次都按服务器给出的 Retry-After 等待。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// 与 models.run() 返回的结果相同。失败或已取消的请求会在此处 reject。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 提交。Router 会返回 201,以及 request_id、status_url、response_url 和 cancel_url。 -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. 轮询直到状态为 COMPLETED,每次都按每个响应给出的 Retry-After 秒数等待。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 收集结果。返回 200 时附带模型的原生输出,任务仍在运行时返回 202 和状态响应体。 -curl https://api.comfy.org/v2/models/openai/gpt-4.1-nano/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Schema - -### 输入 - - - 要在模型响应中包含的附加输出数据。 - - - - 提供给模型的文本、图像或文件输入,用于生成响应。这是本契约中 Router 唯一无法提供的字段,也是下方 `required` 中唯一的条目。 - - - - 在模型上下文的开头插入一条 system(或 developer)消息。 - - - - 为一次响应生成的 token 数量上限,包括可见输出 token 和推理 token。对于推理类 id,该上限与隐藏的推理 token 共享,因此较小的值可能在出现任何可见文本之前就耗尽整个预算,这也是推理冒烟用例发送 1024 而对话用例发送 16 的原因。 - - 范围:`1` 到 `…` - - - - OpenAI 模型标识符。在 Comfy Router 上该字段为可选,Router 会从 `{model}` 路径段填充它;显式的 `null` 也会以同样方式被替换。发送与路径不一致的值会被拒绝。 - - - - 是否允许模型并行运行工具调用。 - - - - 上一个响应的 ID,用于多轮对话。 - - - - 仅限推理层级。推理模型的配置,例如 `{"effort": "medium"}`。原样转发;可接受的键请参阅 OpenAI 的推理指南。对话层级的 id 会忽略它。 - - - - OpenAI 是否存储已生成的响应以供日后检索。 - - - - 声明该字段是为了让发送它的调用方不被拒绝,但它在当前接口上是无效的:Router 会在派发之前将其判定为 `false`,因为它捕获的是提供商响应,而不是转发 `text/event-stream`,而后者它无法解码,因此流式生成会被 OpenAI 计费却无人计量。没有任何 Comfy 接口提供该流:v1 `POST /proxy/openai/v1/responses` 入口会以 400 拒绝 `stream: true`,并且绝不会将请求转发到上游,因此在任一接口上都应省略该字段或发送 `false`,并把已完成的响应作为一个 JSON 响应体读取。 - - - - 采样温度。仅限对话层级:在 OpenAI 处,o 系列推理 id(`o1`、`o1-pro`、`o3`、`o4-mini`)会拒绝该参数。Router 不会替它们拒绝,关于这两个层级为何共用一个 schema,请参阅本组件的说明,因此发送该参数的推理调用会由 OpenAI 自身的错误来回应。 - - 范围:`0` 到 `2` - - - - 输出格式配置,例如用于结构化输出的 `{"format": {"type": "json_schema", ...}}`。原样转发。 - - - - 模型应如何选择要使用的工具。可以是字符串模式,也可以是指定某个工具的对象。 - - - - 模型可以调用的工具定义。Router 不会收窄工具分类;可接受的形状请参阅 OpenAI 的 Responses API 参考文档。 - - - - 核采样截止值。仅限对话层级,条件与 `temperature` 相同。 - - 范围:`0` 到 `1` - - - - 当上下文超出模型窗口时采用的截断策略。与上面三个词表不同,此处的枚举确实会被强制校验,因为这两个值就是 OpenAI 文档记载的完整集合,且至今没有增加。显式传入 `null` 仍会被接受,条件与其上方的字段相同。 - - 可能的值:`auto`、`disabled` - - - - token 用量封装。它出现在本契约中,是因为 v1 操作在请求体上声明了该字段;OpenAI 会在响应中填充它,因此调用方没有理由发送它。 - - -根据 Router 在 `GET /v2/models/openai/gpt-4.1-nano/openapi.json` 提供的 schema 生成,这也是它在请求到达提供商之前用于校验调用的同一份文档。 - -### 输出 - - - 将一条系统(或开发者)消息插入为模型上下文中的第一项。 - -与 `previous_response_id` 一起使用时,上一个响应中的指令不会延续到下一个响应。这使得在新的响应中替换系统(或开发者)消息变得很简单。 - - - - 响应可生成的 token 数量上限,包括可见的输出 token 和[推理 token](https://platform.openai.com/docs/guides/reasoning)。 - - - - 用于生成响应的模型 - - - - 控制响应的随机性 - - 范围:`0` 到 `2` - - - - 通过核采样控制响应的多样性 - - 范围:`0` 到 `1` - - - - 用于模型响应的截断策略。 -- `auto`:如果此响应及此前响应的上下文超出模型的上下文窗口大小,模型将截断响应以适应上下文窗口,方式是丢弃对话中间的输入项。 -- `disabled`(默认):如果模型响应将超出模型的上下文窗口大小,请求将失败并返回 400 错误。 - - 可选值:`auto`、`disabled` - - - - 模型上一个响应的唯一 ID。使用它可创建多轮对话。了解更多关于[对话状态](https://platform.openai.com/docs/guides/conversation-state)的信息。 - - - - **仅限 o 系列模型** - -[推理模型](https://platform.openai.com/docs/guides/reasoning)的配置选项。 - - - - 控制后续轮次中哪些推理项会被回传给模型,例如 `auto`、`current_turn` 或 `all_turns`。 - - - - **仅限 o 系列模型** - -约束[推理模型](https://platform.openai.com/docs/guides/reasoning)在推理上投入的力度。当前支持的值为 `low`、`medium` 和 `high`。降低推理力度可以让响应更快,并减少响应中用于推理的 token 数量。 - - 可选值:`low`、`medium`、`high` - - - - **已弃用:** 请改用 `summary`。 - -模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 - - 可选值:`auto`、`concise`、`detailed` - - - - 用于该响应的推理模式。 - - - - 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 - - 可选值:`auto`、`concise`、`detailed` - - - - - - - - 一个对象,用于指定模型必须输出的格式。 - -配置 `{ "type": "json_schema" }` 会启用结构化输出,确保模型匹配你提供的 JSON schema。在[结构化输出指南](https://platform.openai.com/docs/guides/structured-outputs)中了解更多。 - -默认格式为 `{ "type": "text" }`,不带任何额外选项。 - -**不建议用于 gpt-4o 及更新的模型:** - -设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,该模式确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,优先使用 `json_schema`。 - - - - 约束模型响应的详细程度。取值为 `low`、`medium` 或 `high` 之一。 - - - - 模型在生成响应时应如何选择要使用的一个或多个工具。有关如何指定模型可以调用的工具,请参阅 `tools` 参数。 - - - - - - - - 模型响应是否在后台运行。 - - - - 该响应的计费信息。 - - - - 负责为该响应付费的一方。 - - - - 此 Response 完成时的 Unix 时间戳(秒)。仅在状态为 `completed` 时出现。 - - - - 此 Response 创建时的 Unix 时间戳(秒)。 - - - - 模型无法生成 Response 时返回的错误对象。 - - - - 该响应的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - 人类可读的错误描述。 - - - - 根据新 token 在目前文本中已有的出现频率对新 token 进行惩罚。 - - - - 此 Response 的唯一标识符。 - - - - 关于响应为何不完整的详情。 - - - - 响应不完整的原因。 - - Possible values: `max_output_tokens`, `content_filter` - - - - 单次响应中可处理的内置工具调用总次数上限。 - - - - 可附加到响应上的键值对集合。 - - - - 如果请求了经过审核的补全,则为响应的输入和输出提供的审核结果。 - - - - 此资源的对象类型,始终设置为 `response`。 - - Possible values: `response` - - - - 由模型生成的内容条目数组。 - -- `output` 数组中条目的长度和顺序取决于模型的响应。 -- 与其访问 `output` 数组中的第一个条目,并假定它是包含模型生成内容的 `assistant` 消息,不如考虑使用 SDK 中受支持的 `output_text` 属性。 - - - - 仅 SDK 提供的便捷属性,包含 `output` 数组中所有 `output_text` 条目聚合而成的文本输出(如果有的话)。 -Python 和 JavaScript SDK 均支持。 - - - - 是否允许模型并行运行工具调用。 - - - - 根据新 token 是否已在目前文本中出现来对新 token 进行惩罚。 - - - - OpenAI 用其为相似请求缓存响应,以优化缓存命中率。替代 `user` 字段。 - - - - prompt 缓存的保留策略,例如 `in_memory` 或 `24h`。 - - - - 一个稳定的标识符,用于帮助检测可能违反 OpenAI 使用政策的应用程序用户。 - - - - 用于处理请求的处理层级,例如 `auto`、`default`、`flex`、`scale` 或 `priority`。 - - - - 响应生成的状态。取值为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - 响应是否会被存储,以便日后通过 API 检索。 - - - - 按内置工具细分的 token 和请求用量。 - - - - 图像生成工具的 token 用量。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 网页搜索工具的用量。 - - - - - - - - 在每个 token 位置上返回的最可能 token 的最大数量,每个 token 都带有对应的对数概率。 - - - - 表示 token 用量详情,包括输入 token、输出 token、输出 token 的细分以及使用的总 token 数。 - - - - 输入 token 的数量。 - - - - 输入 token 的详细细分。 - - - - 写入缓存的输入 token 数量。 - - - - 从缓存中检索到的 token 数量。 -[关于提示缓存(prompt caching)的更多内容](https://platform.openai.com/docs/guides/prompt-caching)。 - - - - 输出 token 的数量。 - - - - 输出 token 的详细明细。 - - - - 推理 token 的数量。 - - - - 使用的 token 总数。 - - - - 已弃用的终端用户标识符。已替换为 `safety_identifier` 和 `prompt_cache_key`。 - - -## 示例 - -### 输入 - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### 输出 - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/zh/development/comfy-router/models/openai/gpt-4-1/code.mdx b/zh/development/comfy-router/models/openai/gpt-4-1/code.mdx index eb2ac1e0e9..b421f063c5 100644 --- a/zh/development/comfy-router/models/openai/gpt-4-1/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-4-1/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 4.1 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/gpt-4.1:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "GPT 4.1" -translationSourceHash: 96680ba8 +translationSourceHash: dd1cf710 translationFrom: development/comfy-router/models/openai/gpt-4-1/code.mdx translationBlockHashes: "_intro": d46021bd "Quick start": c2b30778 - "Schema": a12283e7 + "Schema": db0693d7 "Examples": 67e6c8f1 --- @@ -25,9 +25,9 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原始 HTTP 发起同样的调用。 -**模型 ID:** `openai/gpt-4.1` +**模型 ID:**`openai/gpt-4.1` -**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-4.1` +**端点:**`POST https://api.comfy.org/v2/models/openai/gpt-4.1` @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1/requests/$REQUEST_ID \ 上下文超出模型窗口时的截断策略。与上面的三种词汇表不同,这里的枚举确实会被强制执行,因为这两个值就是 OpenAI 记载的完整集合,且至今没有增加。显式的 `null` 仍会被接受,适用条款与它上面的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -360,7 +360,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4.1/requests/$REQUEST_ID \ 该响应的错误代码。 -Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` +可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` @@ -382,7 +382,7 @@ Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`ve 响应不完整的原因。 - Possible values: `max_output_tokens`、`content_filter` + 可选值:`max_output_tokens`、`content_filter` @@ -400,7 +400,7 @@ Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`ve 此资源的对象类型,始终设置为 `response`。 - Possible values: `response` + 可选值:`response` @@ -442,7 +442,7 @@ Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`ve 响应生成的状态。为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - Possible values: `completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` @@ -522,6 +522,18 @@ Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`ve 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索的 token 数量。 [关于提示词缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-4o/code.mdx b/zh/development/comfy-router/models/openai/gpt-4o/code.mdx index df20b8f1b3..07bf7e2440 100644 --- a/zh/development/comfy-router/models/openai/gpt-4o/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-4o/code.mdx @@ -1,13 +1,13 @@ --- title: "将 GPT 4o 与 Comfy Router 配合使用" -description: "通过 Comfy Router 调用 openai/gpt-4o:endpoint、请求形状以及 Router 返回的响应。" +description: "通过 Comfy Router 调用 openai/gpt-4o:端点、请求形状以及 Router 返回的响应。" sidebarTitle: "GPT 4o" -translationSourceHash: a1049a5c +translationSourceHash: 50b6ccc0 translationFrom: development/comfy-router/models/openai/gpt-4o/code.mdx translationBlockHashes: "_intro": 1091e92b "Quick start": 90bca1e0 - "Schema": 86fcee74 + "Schema": 012a1d42 "Examples": 67e6c8f1 --- @@ -25,9 +25,9 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则通过原始 HTTP 发起同样的调用。 -**模型 ID:** `openai/gpt-4o` +**模型 ID:**`openai/gpt-4o` -**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-4o` +**端点:**`POST https://api.comfy.org/v2/models/openai/gpt-4o` @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-4o/requests/$REQUEST_ID \ 上下文超出模型窗口时的截断策略。与上面三个词表不同,这里的枚举确实会被强制校验,因为这两个值就是 OpenAI 文档中记载的完整集合,且一直没有增加。显式的 `null` 仍会被接受,条件与它上面的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -523,6 +523,18 @@ Python 和 JavaScript SDK 均支持。 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [关于提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx b/zh/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx index 9bb43f8b72..c83010473b 100644 --- a/zh/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-5-5-pro/code.mdx @@ -2,12 +2,12 @@ title: "使用 GPT 5.5 Pro 搭配 Comfy Router" description: "通过 Comfy Router 调用 openai/gpt-5.5-pro:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "GPT 5.5 Pro" -translationSourceHash: 5ac845f9 +translationSourceHash: 7809e0ac translationFrom: development/comfy-router/models/openai/gpt-5-5-pro/code.mdx translationBlockHashes: "_intro": 38a9f8f3 "Quick start": 1fe98270 - "Schema": b1702eff + "Schema": 11ef4bcf "Examples": 67e6c8f1 --- @@ -25,9 +25,9 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段是通过原始 HTTP 发起的同一调用。 -**模型 ID:** `openai/gpt-5.5-pro` +**模型 ID:** `openai/gpt-5.5-pro` -**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-5.5-pro` +**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-5.5-pro` @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5-pro/requests/$REQUEST_ID \ 当上下文超出模型窗口时的截断策略。此处强制实施枚举,与上述三个词汇表不同,因为这两个值是 OpenAI 记录的完整集合,且未增长。显式的 `null` 仍然被接受,条件与其上方的字段相同。 - 可能的值:`auto`,`disabled` + 可选值:`auto`、`disabled` @@ -359,7 +359,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5-pro/requests/$REQUEST_ID \ - 响应的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 响应的错误代码。 + + 可选值:`server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -520,6 +522,18 @@ Python 和 JavaScript SDK 支持该属性。 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [关于提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-5-5/code.mdx b/zh/development/comfy-router/models/openai/gpt-5-5/code.mdx index d27fde741c..752efa90ff 100644 --- a/zh/development/comfy-router/models/openai/gpt-5-5/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-5-5/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 5.5 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/gpt-5.5:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "GPT 5.5" -translationSourceHash: 58c95f4f +translationSourceHash: b6f75b15 translationFrom: development/comfy-router/models/openai/gpt-5-5/code.mdx translationBlockHashes: "_intro": 40d43e07 "Quick start": 1c6f8445 - "Schema": 0324fd46 + "Schema": 7cb284e6 "Examples": 67e6c8f1 --- @@ -25,9 +25,9 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原生 HTTP 发起相同的调用。 -**模型 ID:** `openai/gpt-5.5` +**模型 ID:**`openai/gpt-5.5` -**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-5.5` +**端点:**`POST https://api.comfy.org/v2/models/openai/gpt-5.5` @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5/requests/$REQUEST_ID \ 当上下文超过模型窗口时的截断策略。与上面三个词汇表不同,此处的枚举确实会被强制执行,因为这两个值是 OpenAI 所记录的完整集合,且并未增长。显式的 `null` 仍然被接受,条件与其上方的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -263,7 +263,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5/requests/$REQUEST_ID \ - `auto`:如果本次响应和之前响应的上下文超出模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,以适应该上下文窗口。 - `disabled`(默认):如果模型响应会超出该模型的上下文窗口大小,请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -285,7 +285,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5/requests/$REQUEST_ID \ 约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理投入程度。当前支持的值为 `low`、`medium` 和 `high`。降低推理投入可以加快响应速度,并减少响应中用于推理的 token 数量。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -293,7 +293,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有帮助。取值为 `auto`、`concise` 或 `detailed`。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -303,7 +303,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有帮助。取值为 `auto`、`concise` 或 `detailed`。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -319,7 +319,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5/requests/$REQUEST_ID \ **不推荐用于 gpt-4o 及更新的模型:** -设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,它可确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,优先使用 `json_schema`。 +设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,它可确保模型生成的消息是有效的 JSON。对于支持它的模型,优先使用 `json_schema`。 @@ -361,7 +361,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.5/requests/$REQUEST_ID \ 该响应的错误代码。 -Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` +可选值:`server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -383,7 +383,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 响应不完整的原因。 - Possible values: `max_output_tokens`, `content_filter` + 可选值:`max_output_tokens`, `content_filter` @@ -401,7 +401,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 此资源的对象类型,始终为 `response`。 - Possible values: `response` + 可选值:`response` @@ -442,7 +442,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 响应生成的状态。取值为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete`。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可选值:`completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -521,6 +521,18 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 已写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索的 token 数量。 [关于提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx b/zh/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx index e3409401fe..49dfb0d713 100644 --- a/zh/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-5-6-luna/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 5.6 Luna 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/gpt-5.6-luna:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "GPT 5.6 Luna" -translationSourceHash: 3dbd42c0 +translationSourceHash: 60531ced translationFrom: development/comfy-router/models/openai/gpt-5-6-luna/code.mdx translationBlockHashes: "_intro": 13db323c "Quick start": 28d289f6 - "Schema": 9edcb210 + "Schema": 939850da "Examples": 67e6c8f1 --- @@ -25,9 +25,9 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; 在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段是通过原始 HTTP 发起的同一调用。 -**模型 ID:** `openai/gpt-5.6-luna` +**模型 ID:**`openai/gpt-5.6-luna` -**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-5.6-luna` +**端点:**`POST https://api.comfy.org/v2/models/openai/gpt-5.6-luna` @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ 上下文超出模型窗口时的截断策略。与上面三种词汇表不同,这里的枚举确实会被强制执行,因为这两个值就是 OpenAI 记载的完整集合,且尚未增加。显式的 `null` 仍会被接受,条件与它上面的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -263,7 +263,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ - `auto`:如果此响应及先前响应的上下文超过模型的上下文窗口大小,模型会通过丢弃对话中间的输入项来截断响应,以适应上下文窗口。 - `disabled`(默认):如果模型响应会超出模型的上下文窗口大小,请求将以 400 错误失败。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -285,7 +285,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ 约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理强度。当前支持的值为 `low`、`medium` 和 `high`。降低推理强度可以带来更快的响应,并减少响应中用于推理的 token 数量。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -293,7 +293,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。可为 `auto`、`concise` 或 `detailed`。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -303,7 +303,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。可为 `auto`、`concise` 或 `detailed`。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -319,7 +319,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ **不推荐用于 gpt-4o 及更新的模型:** -设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,建议使用 `json_schema`。 +设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,确保模型生成的消息是有效的 JSON。对于支持它的模型,建议使用 `json_schema`。 @@ -359,7 +359,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ - 该响应的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 该响应的错误代码。 + + 可选值:`server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -381,7 +383,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ 响应不完整的原因。 - Possible values: `max_output_tokens`, `content_filter` + 可选值:`max_output_tokens`, `content_filter` @@ -399,7 +401,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ 此资源的对象类型,始终设置为 `response`。 - Possible values: `response` + 可选值:`response` @@ -441,7 +443,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ 响应生成的状态。为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可选值:`completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` @@ -520,6 +522,18 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-luna/requests/$REQUEST_ID \ 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [有关提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx b/zh/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx index 9d0670019c..32dfcf1e4e 100644 --- a/zh/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-5-6-sol/code.mdx @@ -2,12 +2,12 @@ title: "通过 Comfy Router 使用 GPT 5.6 Sol" description: "通过 Comfy Router 调用 openai/gpt-5.6-sol:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "GPT 5.6 Sol" -translationSourceHash: 53c40b5a +translationSourceHash: 946fbb02 translationFrom: development/comfy-router/models/openai/gpt-5-6-sol/code.mdx translationBlockHashes: "_intro": fd209e5e "Quick start": ac41609e - "Schema": d3e5bdbd + "Schema": 74ed2ee6 "Examples": 67e6c8f1 --- @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ 当上下文超出模型窗口时的截断策略。与上面三个词表不同,这里的枚举确实会被强制校验,因为这两个值是 OpenAI 记录在案的完整集合,且未曾增加。显式的 `null` 仍然被接受,条件与其上方的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -263,7 +263,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ - `auto`:如果此响应及之前响应的上下文超过模型的上下文窗口大小,模型将截断响应以适应上下文窗口,具体做法是丢弃对话中间位置的输入条目。 - `disabled`(默认):如果模型响应将超过模型的上下文窗口大小,请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -287,7 +287,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ 约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理投入程度。 目前支持的值为 `low`、`medium` 和 `high`。降低推理投入可以带来更快的响应,并在响应中减少用于推理的 token。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -296,7 +296,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。 取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -307,7 +307,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。 取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -364,7 +364,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ - 该响应的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 该响应的错误代码。 + + 可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` @@ -386,7 +388,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ 响应不完整的原因。 - Possible values: `max_output_tokens`, `content_filter` + 可选值:`max_output_tokens`、`content_filter` @@ -404,7 +406,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-sol/requests/$REQUEST_ID \ 此资源的对象类型,始终设置为 `response`。 - Possible values: `response` + 可选值:`response` @@ -447,7 +449,7 @@ Python 和 JavaScript SDK 支持此属性。 响应生成的状态。取值为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` @@ -527,6 +529,18 @@ Python 和 JavaScript SDK 支持此属性。 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [关于提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx b/zh/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx index ae8ecc2a56..c570406eee 100644 --- a/zh/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-5-6-terra/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 5.6 Terra 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/gpt-5.6-terra:端点、请求形状以及 Router 返回的响应。" sidebarTitle: "GPT 5.6 Terra" -translationSourceHash: b276b982 +translationSourceHash: 7aa80915 translationFrom: development/comfy-router/models/openai/gpt-5-6-terra/code.mdx translationBlockHashes: "_intro": 3d1bd737 "Quick start": f76d67fd - "Schema": e854248f + "Schema": f66cb808 "Examples": 67e6c8f1 --- @@ -167,7 +167,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ 响应所生成的 token 数量上限,包括可见的输出 token 和推理 token。在推理 id 上,该上限与隐藏的推理 token 共享,因此较小的值可能在出现任何可见文本之前就耗尽整个预算,这也是推理冒烟用例发送 1024 而聊天用例发送 16 的原因。 - Range: `1` 到 `…` + 范围:`1` 到 `…` @@ -197,7 +197,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ 采样温度。仅聊天层级:o 系列的推理 id(`o1`、`o1-pro`、`o3`、`o4-mini`)在 OpenAI 会拒绝该参数。Router 不会代它们拒绝,原因见本组件关于两个层级为何共用同一 schema 的说明,因此发送该参数的推理调用会得到 OpenAI 自身的错误响应。 - Range: `0` 到 `2` + 范围:`0` 到 `2` @@ -215,13 +215,13 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ 核采样截断值。仅聊天层级,条款与 `temperature` 相同。 - Range: `0` 到 `1` + 范围:`0` 到 `1` 当上下文超出模型窗口时采用的截断策略。与上面三个词汇表不同,这里的枚举确实会被强制执行,因为这两个值是 OpenAI 文档记载的完整集合,且此后未再扩充。显式的 `null` 仍然被接受,条款与其上方的字段相同。 - Possible values: `auto`, `disabled` + 可选值:`auto`、`disabled` @@ -263,7 +263,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ - `auto`:如果本次响应及之前响应的上下文超出模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,以适应该上下文窗口。 - `disabled`(默认):如果模型响应将超出该模型的上下文窗口大小,请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -285,7 +285,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ 约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理努力程度。当前支持的值为 `low`、`medium` 和 `high`。降低推理努力程度可以加快响应速度,并减少响应中用于推理的 token 数量。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -293,7 +293,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -303,7 +303,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -361,7 +361,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5.6-terra/requests/$REQUEST_ID \ 该响应的错误代码。 -Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` +可选值:`server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` @@ -383,7 +383,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 响应不完整的原因。 - Possible values: `max_output_tokens`, `content_filter` + 可选值:`max_output_tokens`、`content_filter` @@ -401,7 +401,7 @@ Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vecto 此资源的对象类型,始终设置为 `response`。 - Possible values: `response` + 可选值:`response` @@ -448,7 +448,7 @@ Python 和 JavaScript SDK 支持该属性。 响应生成的状态。取值为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` @@ -528,6 +528,18 @@ Python 和 JavaScript SDK 支持该属性。 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [提示缓存详情](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-5-mini/code.mdx b/zh/development/comfy-router/models/openai/gpt-5-mini/code.mdx index 43771aed16..527d30fffa 100644 --- a/zh/development/comfy-router/models/openai/gpt-5-mini/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-5-mini/code.mdx @@ -2,12 +2,12 @@ title: "在 Comfy Router 中使用 GPT 5 Mini" description: "通过 Comfy Router 调用 openai/gpt-5-mini:端点、请求结构及 Router 返回的响应。" sidebarTitle: "GPT 5 Mini" -translationSourceHash: 6f93b322 +translationSourceHash: 1fdb782a translationFrom: development/comfy-router/models/openai/gpt-5-mini/code.mdx translationBlockHashes: "_intro": 3a0b2e17 "Quick start": e4ce6833 - "Schema": 426552ef + "Schema": b1c7b0c6 "Examples": 67e6c8f1 --- @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ 当上下文超过模型窗口时的截断策略。此处确实会强制执行枚举,这与上面的三个词汇表不同,因为这两个值是 OpenAI 文档中的完整集合,而且没有增长。显式 `null` 仍然被接受,条件与其上方的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -263,7 +263,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ - `auto`:如果此响应和上一个响应的上下文超过模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,以适应上下文窗口。 - `disabled`(默认):如果模型响应将超过模型的上下文窗口大小,请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -286,7 +286,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ 限制[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理努力程度。当前支持的值有 `low`、`medium` 和 `high`。降低推理努力程度可以加快响应速度,并减少响应中用于推理的 token 数量。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -294,7 +294,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。可以是 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -304,7 +304,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。可以是 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -320,7 +320,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ **不推荐用于 gpt-4o 及更新模型:** -设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,首选使用 `json_schema`。 +设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,首选使用它。 @@ -360,7 +360,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ - 响应的错误代码。可能的值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` + 响应的错误代码。 + + 可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` @@ -382,7 +384,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ 响应不完整的原因。 - 可能的值:`max_output_tokens`、`content_filter` + 可选值:`max_output_tokens`、`content_filter` @@ -400,7 +402,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ 此资源的对象类型,始终设置为 `response`。 - 可能的值:`response` + 可选值:`response` @@ -441,7 +443,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ 响应生成的状态。为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - 可能的值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` @@ -520,6 +522,18 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-mini/requests/$REQUEST_ID \ 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [关于 prompt caching 的更多内容](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-5-nano/code.mdx b/zh/development/comfy-router/models/openai/gpt-5-nano/code.mdx index fb6d3f31a1..62e78a1a1a 100644 --- a/zh/development/comfy-router/models/openai/gpt-5-nano/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-5-nano/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 5 Nano 与 Comfy Router 结合使用" description: "通过 Comfy Router 调用 openai/gpt-5-nano:端点、请求格式以及 Router 返回的响应。" sidebarTitle: "GPT 5 Nano" -translationSourceHash: dea6c7dc +translationSourceHash: 608ede54 translationFrom: development/comfy-router/models/openai/gpt-5-nano/code.mdx translationBlockHashes: "_intro": e9be10ab "Quick start": 2ff521ab - "Schema": 3e04e36e + "Schema": d555e85f "Examples": 67e6c8f1 --- @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 当上下文超出模型窗口时采用的截断策略。与上面的三个词表不同,这里的枚举确实会被强制执行,因为这两个值是 OpenAI 文档中记录的全部取值,且至今未增加。显式的 `null` 仍然会被接受,条件与其上方的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -263,7 +263,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ - `auto`:如果本次 response 及之前 response 的上下文超过模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断 response,使其适应上下文窗口。 - `disabled`(默认):如果模型 response 将超过模型的上下文窗口大小,请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -287,7 +287,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理强度。 目前支持的值为 `low`、`medium` 和 `high`。降低推理强度可以加快 response 速度,并减少 response 中用于推理的 token 数量。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -296,7 +296,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。 取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -307,7 +307,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。 取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -327,7 +327,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,它 确保模型生成的消息是有效的 JSON。对于支持 `json_schema` -的模型,优先使用 `json_schema`。 +的模型,优先使用它。 @@ -369,7 +369,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ response 的错误代码。 - 可能的值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` + 可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` @@ -391,7 +391,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 响应不完整的原因。 - 可能的值:`max_output_tokens`、`content_filter` + 可选值:`max_output_tokens`、`content_filter` @@ -409,7 +409,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 此资源的对象类型,始终为 `response`。 - 可能的值:`response` + 可选值:`response` @@ -454,7 +454,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 响应生成的状态。可为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete`。 - 可能的值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` @@ -534,6 +534,18 @@ curl https://api.comfy.org/v2/models/openai/gpt-5-nano/requests/$REQUEST_ID \ 写入缓存的输入 token 数。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [有关提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-5/code.mdx b/zh/development/comfy-router/models/openai/gpt-5/code.mdx index 3c78533bbd..057313e144 100644 --- a/zh/development/comfy-router/models/openai/gpt-5/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-5/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 5 与 Comfy Router 搭配使用" description: "通过 Comfy Router 调用 openai/gpt-5:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "GPT 5" -translationSourceHash: b66e1420 +translationSourceHash: fc79531a translationFrom: development/comfy-router/models/openai/gpt-5/code.mdx translationBlockHashes: "_intro": 1f35e583 "Quick start": b8543ef7 - "Schema": 37e7ebd8 + "Schema": bfb88182 "Examples": 67e6c8f1 --- @@ -221,7 +221,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \ 上下文超出模型窗口时的截断策略。此处枚举确实会被强制执行,与上述三种词汇表不同,因为这两个值是 OpenAI 文档记载的完整集合,且至今未增加。显式的 `null` 仍会被接受,条款与其上方的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -369,7 +369,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \ 该响应的错误代码。 -可能的值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` +可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` @@ -391,7 +391,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \ 响应不完整的原因。 - 可能的值:`max_output_tokens`、`content_filter` + 可选值:`max_output_tokens`、`content_filter` @@ -409,7 +409,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \ 此资源的对象类型:始终为 `response`。 - 可能的值:`response` + 可选值:`response` @@ -453,7 +453,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \ 响应生成的状态。取值为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - 可能的值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` @@ -533,6 +533,18 @@ curl https://api.comfy.org/v2/models/openai/gpt-5/requests/$REQUEST_ID \ 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [有关提示缓存(prompt caching)的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/o1/code.mdx b/zh/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx similarity index 56% rename from zh/development/comfy-router/models/openai/o1/code.mdx rename to zh/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx index 43b33ae491..b5a5cd2c1d 100644 --- a/zh/development/comfy-router/models/openai/o1/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-6-1-sol/code.mdx @@ -1,33 +1,31 @@ --- -title: "搭配 Comfy Router 使用 o1" -description: "通过 Comfy Router 调用 openai/o1:端点、请求形状以及 Router 返回的响应。" -sidebarTitle: "o1" -translationSourceHash: f0eb94c8 -translationFrom: development/comfy-router/models/openai/o1/code.mdx +title: "使用 GPT 6.1 Sol 与 Comfy Router" +description: "通过 Comfy Router 调用 openai/gpt-6.1-sol:端点、请求结构以及 Router 返回的响应。" +sidebarTitle: "GPT 6.1 Sol" +translationSourceHash: d4b3ce5f +translationFrom: development/comfy-router/models/openai/gpt-6-1-sol/code.mdx translationBlockHashes: - "_intro": 86454249 - "Quick start": 7a99b942 - "Schema": 6de26ff5 + "_intro": 72f9c8de + "Quick start": a04e3ac0 + "Schema": 0e5083e2 "Examples": 67e6c8f1 --- - - -{/* 已生成文件。由 `pnpm code-pages:gen` 从 router-schemas/openai/o1.json 生成。 */} +{/* 已生成文件。由 `pnpm code-pages:gen` 从 router-schemas/openai/gpt-6.1-sol.json 生成。 */} import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; -`openai/o1` 的 API 参考文档,由 Comfy Router 从 OpenAI 提供。 +`openai/gpt-6.1-sol` 的 API 参考,该模型由 Comfy Router 从 OpenAI 提供。 -**输入:** 文本, 图像 · **输出:** 文本 +**输入:** 文本、图像 · **输出:** 文本 ## 快速开始 -在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原始 HTTP 发起相同的调用。 +在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段是同一调用通过原始 HTTP 发送的版本。 -**模型 ID:** `openai/o1` +**模型 ID:** `openai/gpt-6.1-sol` -**端点:** `POST https://api.comfy.org/v2/models/openai/o1` +**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol` @@ -36,10 +34,10 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; from comfy_sdk import Comfy # 从环境中读取 COMFY_API_KEY。 -# SDK 会自动创建幂等键,并在自动重试时复用它。 +# SDK 会自动创建一个幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( - "openai/o1", + "openai/gpt-6.1-sol", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -53,8 +51,8 @@ print(result) import { comfy } from "@comfyorg/sdk"; // 从环境中读取 COMFY_API_KEY。 -// SDK 会自动创建幂等键,并在自动重试时复用它。 -const { data } = await comfy.models.run("openai/o1", { +// SDK 会自动创建一个幂等键,并在自动重试时复用它。 +const { data } = await comfy.models.run("openai/gpt-6.1-sol", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); @@ -63,7 +61,7 @@ console.log(data); ``` ```bash cURL -curl https://api.comfy.org/v2/models/openai/o1 \ +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ @@ -71,8 +69,8 @@ curl https://api.comfy.org/v2/models/openai/o1 \ ``` - -将相同的请求体发送到 `POST https://api.comfy.org/v2/models/openai/o1/requests`。运行被受理后,Router 会立即返回 `201` 和 `request_id`;结果就绪后,可以从本进程或其他进程收集。状态、取消与收集的细节见 [队列投递](/zh/development/comfy-router/queue)。 + +相同的请求体,发送到 `POST https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests`。运行一经接纳,Router 就会返回 `201` 和 `request_id`,结果准备就绪后即可收集,无论从当前进程还是另一个进程。 [队列投递](/zh/development/comfy-router/queue) 会介绍状态、取消和收集。 ```python Python @@ -80,24 +78,24 @@ import asyncio from comfy_sdk import AsyncComfy # 从环境中读取 COMFY_API_KEY。 -# 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 +# 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 async def main(): async with AsyncComfy() as client: handle = await client.models.submit( - "openai/o1", + "openai/gpt-6.1-sol", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, }, ) - print("request_id:", handle.request_id) # 带上模型 ID,另一个进程所需的一切 + print("request_id:", handle.request_id) # 配合模型 ID,另一个进程所需的信息就这些 - # 轮询直到请求完成,等待服务器指定的 Retry-After 时间。 + # 轮询直到请求完成,等待服务器指定的 Retry-After。 async for update in handle.iter_events(): print(update.status, update.queue_position) - # 提供商自己的载荷,与 models.run() 返回的值相同。 - # 失败或已取消的请求会在此处抛出类型化的 Router 错误。 + # 提供商自身的负载,与 models.run() 返回的值相同。 + # 失败或已取消的请求会在这里抛出类型化的 Router 错误。 result = await handle.get() print(result) @@ -109,39 +107,39 @@ asyncio.run(main()) import { comfy } from "@comfyorg/sdk"; // 从环境中读取 COMFY_API_KEY。 -// 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -const handle = await comfy.models.submit("openai/o1", { +// 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 +const handle = await comfy.models.submit("openai/gpt-6.1-sol", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); -console.log("requestId:", handle.requestId); // 带上模型 ID,另一个进程所需的一切 +console.log("requestId:", handle.requestId); // 配合模型 ID,另一个进程所需的信息就这些 -// 轮询直到请求完成,等待服务器指定的 Retry-After 时间。 +// 轮询直到请求完成,等待服务器指定的 Retry-After。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } -// 与 models.run() 返回相同的结果。失败或已取消的请求会在此处被拒绝。 +// 与 models.run() 返回的结果相同。失败或已取消的请求会在这里被拒绝。 const result = await handle.get(); console.log(result.data); ``` ```bash cURL -# 1. 提交。Router 返回 201,以及 request_id、status_url、response_url 和 cancel_url。 -curl https://api.comfy.org/v2/models/openai/o1/requests \ +# 1. 提交。Router 返回 201,并带有 request_id、status_url、response_url 和 cancel_url。 +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -# 2. 轮询直到状态为 COMPLETED,每次响应都会指定需要等待的 Retry-After 秒数。 +# 2. 轮询直到状态为 COMPLETED,每次响应都会给出需要等待的 Retry-After 秒数。 REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID/status \ +curl -i https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" -# 3. 收集。返回 200 时带有模型原生输出;仍在运行时返回 202 和状态正文。 -curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ +# 3. 收集。200 返回模型的原始输出,202 在仍在运行时返回状态响应体。 +curl https://api.comfy.org/v2/models/openai/gpt-6.1-sol/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``` @@ -157,7 +155,7 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 提供给模型的文本、图像或文件输入,用于生成响应。这是 Router 无法提供的唯一字段,也是下方 `required` 中的唯一条目。 + 提供给模型的文本、图像或文件输入,用于生成响应。这是本约定中 Router 无法提供的唯一字段,也是下方 `required` 中唯一的条目。 @@ -165,17 +163,17 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 为响应生成的 token 数量上限,包括可见输出 token 和推理 token。在推理 id 上,这个上限与隐藏的推理 token 共享,因此较小的值可能在产生任何可见文本之前就耗尽整个预算,这就是推理冒烟用例发送 1024 而对话用例发送 16 的原因。 + 为响应生成的 token 数量上限,包括可见输出 token 和推理 token。对于推理 id,此上限与隐藏的推理 token 共享,因此较小的值可能在产生任何可见文本之前就耗尽整个预算,这就是推理冒烟测试用例发送 1024 而聊天用例发送 16 的原因。 - Range: `1` to `…` + 范围:`1` 到 `…` - OpenAI 模型标识符。在 Comfy Router 上该字段为可选,Router 会从 `{model}` 路径段填充它;显式的 `null` 也以同样方式替换。发送与路径不一致的值会被拒绝。 + OpenAI 模型标识符。在 Comfy Router 上,此字段是可选的,Router 会从 `{model}` 路径段填充它;显式的 `null` 也会以相同方式被替换。发送与路径不一致的值会被拒绝。 - 是否允许模型并行执行工具调用。 + 是否允许模型并行运行工具调用。 @@ -183,21 +181,21 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 仅限推理层级。推理模型的配置,例如 `{"effort": "medium"}`。原样转发;关于可接受的键,请参阅 OpenAI 的推理指南。对话层级的 id 会忽略它。 + 仅限推理层级。推理模型的配置,例如 `{"effort": "medium"}`。原样转发;有关接受的键,请参阅 OpenAI 的推理指南。聊天层级的 id 会忽略它。 - OpenAI 是否存储已生成的响应以供稍后检索。 + OpenAI 是否存储生成的响应以供后续检索。 - 声明该字段只是为了让发送它的调用方不被拒绝,但它在当前接口上是无效的:Router 会在派发之前把它固定为 `false`,因为它捕获的是提供商响应,而不是转发 `text/event-stream`,后者它无法解码,所以流式生成会被 OpenAI 计费却无人计量。没有任何 Comfy 接口提供流式响应:v1 的 `POST /proxy/openai/v1/responses` 入口会以 400 拒绝 `stream: true`,并且从不把请求转发到上游,因此在任一接口上都请省略该字段或发送 `false`,并把已完成的响应当作单个 JSON 正文读取。 + 声明该字段是为了让发送它的调用方不被拒绝,但它在当前接口上不起作用:Router 会在派发前将其固定为 `false`,因为 Router 捕获的是提供商响应,而不是转发 `text/event-stream`,后者它无法解码;因此流式生成会被 OpenAI 计费,却无人计量。没有任何 Comfy 接口提供该流:v1 的 `POST /proxy/openai/v1/responses` 入口会以 400 拒绝 `stream: true`,并且从不将请求转发到上游,因此请省略该字段,或者在任一接口上发送 `false`,并将已完成的响应作为单个 JSON 主体读取。 - 采样温度。仅限对话层级:o 系列推理 id(`o1`、`o1-pro`、`o3`、`o4-mini`)在 OpenAI 处会拒绝此参数。Router 不会替它们拒绝它(关于两个层级为何共用同一个 schema,请见本组件的说明),因此发送该参数的推理调用会得到 OpenAI 自己返回的错误。 + 采样温度。仅限聊天层级:o 系列推理 id(`o1`、`o1-pro`、`o3`、`o4-mini`)在 OpenAI 会拒绝此参数。Router 不会替它们拒绝此参数,参见本组件关于两个层级为何共用同一 schema 的说明,因此发送该参数的推理调用会由 OpenAI 自身的错误来响应。 - Range: `0` to `2` + 范围:`0` 到 `2` @@ -205,45 +203,45 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 模型应如何选择使用哪个工具。可以是字符串模式,也可以是命名某个工具的对象。 + 模型应如何选择使用哪个工具。可以是字符串模式,也可以是指定工具的对象。 - 模型可以调用的工具定义。Router 不会缩小工具分类范围;关于可接受的形状,请参阅 OpenAI 的 Responses API 参考。 + 模型可以调用的工具定义。Router 不会收窄工具分类;有关可接受的形状,请参阅 OpenAI 的 Responses API 参考。 - 核采样截断值。仅限对话层级,条件与 `temperature` 相同。 + 核采样截止值。仅限聊天层级,其条件与 `temperature` 相同。 - Range: `0` to `1` + 范围:`0` 到 `1` - 当上下文超出模型窗口时采用的截断策略。与上面三个词汇表不同,这里的枚举是会被强制校验的,因为这两个值就是 OpenAI 文档记录的全部取值,且从未增加。显式的 `null` 仍然会被接受,条件与上面的字段相同。 + 当上下文超过模型窗口时的截断策略。此处的枚举确实会被强制执行,与上面的三个词汇表不同,因为这两个值是 OpenAI 文档中列出的完整集合,而且没有扩展过。显式的 `null` 仍被接受,其条件与其上方的字段相同。 - Possible values: `auto`, `disabled` + 可选值:`auto`、`disabled` - token 用量封装。之所以出现在此契约中,是因为 v1 操作在请求体上声明了它;OpenAI 在响应中填充它,因此调用方没有理由发送它。 + token 使用量封装结构。此约定中出现该字段,是因为 v1 操作在请求体上声明了它;OpenAI 会在响应中填充它,因此调用方没有理由发送它。 -由 Router 在 `GET /v2/models/openai/o1/openapi.json` 提供的 schema 生成,这也是请求到达提供商之前它用来校验调用的同一份文档。 +根据 Router 在 `GET /v2/models/openai/gpt-6.1-sol/openapi.json` 提供的 schema 生成,这也是它在请求到达提供商之前用于校验调用的同一份文档。 ### 输出 - 将一条系统(或开发者)消息插入为模型上下文中的第一项。 + 将一条 system(或 developer)消息插入到模型上下文的第一项。 -当与 `previous_response_id` 一起使用时,上一个响应的指令不会延续到下一个响应。这样可以轻松地在新响应中替换系统(或开发者)消息。 +当与 `previous_response_id` 一起使用时,上一个响应中的 instructions 不会延续到下一个响应。这使得在新的响应中替换 system(或 developer)消息变得简单。 - 响应可生成的 token 数量上限,包括可见输出 token 和[推理 token](https://platform.openai.com/docs/guides/reasoning)。 + 一个响应可生成的 token 数量上限,包括可见输出 token 和[推理 token](https://platform.openai.com/docs/guides/reasoning)。 - 用于生成该响应的模型 + 用于生成响应的模型 @@ -260,14 +258,14 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ 用于模型响应的截断策略。 -- `auto`:如果此响应及之前响应的上下文超过模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,以适应该上下文窗口。 -- `disabled`(默认):如果模型响应将超过模型的上下文窗口大小,请求将失败并返回 400 错误。 +- `auto`:如果此响应以及之前响应的上下文超出模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,使其适应上下文窗口。 +- `disabled`(默认):如果模型响应将超出该模型的上下文窗口大小,请求将失败并返回 400 错误。 可选值:`auto`、`disabled` - 模型上一个响应的唯一 ID。可用它来创建多轮对话。了解关于[对话状态](https://platform.openai.com/docs/guides/conversation-state)的更多信息。 + 模型上一个响应的唯一 ID。使用它来创建多轮对话。了解更多关于[对话状态](https://platform.openai.com/docs/guides/conversation-state)的信息。 @@ -277,14 +275,13 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 控制在后续轮次中会向模型回传哪些推理项,例如 `auto`、`current_turn` 或 `all_turns`。 + 控制在后续轮次中将哪些推理项渲染回模型,例如 `auto`、`current_turn` 或 `all_turns`。 **仅 o 系列模型** -约束[推理模型](https://platform.openai.com/docs/guides/reasoning)在推理上的投入程度。 -当前支持的值为 `low`、`medium` 和 `high`。降低推理投入可以加快响应速度,并减少响应中用于推理的 token 数量。 +约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理投入程度。目前支持的值为 `low`、`medium` 和 `high`。降低推理投入可以加快响应速度,并减少响应中用于推理的 token 数量。 可选值:`low`、`medium`、`high` @@ -292,19 +289,17 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ **弃用:** 请改用 `summary`。 -模型所执行推理的摘要。这对调试和理解模型的推理过程很有用。 -取值为 `auto`、`concise` 或 `detailed` 之一。 +模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 可选值:`auto`、`concise`、`detailed` - 用于该响应的推理模式。 + 用于响应的推理模式。 - 模型所执行推理的摘要。这对调试和理解模型的推理过程很有用。 -取值为 `auto`、`concise` 或 `detailed` 之一。 + 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 可选值:`auto`、`concise`、`detailed` @@ -314,19 +309,15 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 一个指定模型必须输出的格式的对象。 + 一个对象,用于指定模型必须输出的格式。 -配置 `{ "type": "json_schema" }` 会启用结构化输出(Structured Outputs), -确保模型匹配你提供的 JSON schema。请参阅 -[结构化输出指南](https://platform.openai.com/docs/guides/structured-outputs)了解更多。 +配置 `{ "type": "json_schema" }` 会启用结构化输出(Structured Outputs),确保模型符合你提供的 JSON Schema。在[结构化输出指南](https://platform.openai.com/docs/guides/structured-outputs)中了解更多。 -默认格式为 `{ "type": "text" }`,不带其他选项。 +默认格式为 `{ "type": "text" }`,不带任何额外选项。 **不建议用于 gpt-4o 及更新的模型:** -设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,它 -确保模型生成的消息是有效的 JSON。对于支持 `json_schema` -的模型,优先使用 `json_schema`。 +将其设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,可确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,优先使用它。 @@ -334,8 +325,7 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 模型在生成响应时应如何选择要使用的工具(一个或多个)。请参阅 `tools` 参数,了解如何指定模型 -可以调用的工具。 + 模型在生成响应时应如何选择使用哪个(或哪些)工具。请参阅 `tools` 参数,了解如何指定模型可以调用的工具。 @@ -343,11 +333,11 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 模型响应是否在后台运行。 + 模型响应是否在背景中运行。 - 该响应的计费信息。 + 响应的计费信息。 @@ -355,7 +345,7 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 此响应完成时的 Unix 时间戳(以秒为单位)。仅当状态为 `completed` 时存在。 + 此响应完成时的 Unix 时间戳(以秒为单位)。仅在状态为 `completed` 时出现。 @@ -367,61 +357,60 @@ curl https://api.comfy.org/v2/models/openai/o1/requests/$REQUEST_ID \ - 该响应的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 响应的错误代码。 + + 可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` - 人类可读的错误描述。 + 错误的可读描述。 - 根据新 token 截至目前在文本中已出现的频率对其进行惩罚。 + 根据新 token 目前在文本中出现的频率对其进行惩罚。 - 此 Response 的唯一标识符。 + 此响应的唯一标识符。 - 关于响应为何不完整的详情。 + 关于响应不完整原因的详情。 响应不完整的原因。 - Possible values: `max_output_tokens`, `content_filter` + 可选值:`max_output_tokens`、`content_filter` - 一次响应中可处理的内置工具调用总数上限。 + 一个响应中可处理的内置工具调用总次数上限。 - 可附加到响应的键值对集合。 + 可附加到响应的一组键值对。 - 响应输入和输出的审核结果,前提是请求了经过审核的补全。 + 如果请求了审核补全,则为响应输入和输出的审核结果。 - 此资源的对象类型,始终设置为 `response`。 + 此资源的对象类型:始终设置为 `response`。 - Possible values: `response` + 可选值:`response` 由模型生成的内容项数组。 -- `output` 数组中各项的数量和顺序取决于模型的响应。 -- 与其访问 `output` 数组中的第一项并假定它是包含模型生成内容的 - `assistant` 消息,不妨在 SDK 支持的情况下使用 `output_text` 属性。 +- `output` 数组中各项的长度和顺序取决于模型的响应。 +- 与其访问 `output` 数组中的第一项并假定它是包含模型生成内容的 `assistant` 消息,不如考虑使用 SDK 中支持的 `output_text` 属性。 - 仅 SDK 提供的便捷属性,包含 `output` 数组中所有 `output_text` 项聚合的 -文本输出(如果存在)。 -Python 和 JavaScript SDK 支持。 + 仅 SDK 提供的便捷属性,包含 `output` 数组中所有 `output_text` 项(如果存在)的聚合文本输出。支持 Python 和 JavaScript SDK。 @@ -429,11 +418,11 @@ Python 和 JavaScript SDK 支持。 - 根据新 token 是否已出现在截至目前文本中对其进行惩罚。 + 根据新 token 是否已出现在目前文本中对其进行惩罚。 - OpenAI 用它缓存相似请求的响应,以优化缓存命中率。替代 `user` 字段。 + OpenAI 使用它缓存相似请求的响应,以优化缓存命中率。取代 `user` 字段。 @@ -441,7 +430,7 @@ Python 和 JavaScript SDK 支持。 - 一个稳定的标识符,用于帮助检测可能违反 OpenAI 使用政策的应用程序用户。 + 用于帮助检测可能违反 OpenAI 使用政策的应用程序用户的稳定标识符。 @@ -451,11 +440,11 @@ Python 和 JavaScript SDK 支持。 响应生成的状态。为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` - 是否存储响应,以便之后通过 API 检索。 + 响应是否会被存储以便之后通过 API 检索。 @@ -503,7 +492,7 @@ Python 和 JavaScript SDK 支持。 - 搜索工具的用量。 + 网络搜索工具用量。 @@ -511,12 +500,11 @@ Python 和 JavaScript SDK 支持。 - 在每个 token 位置返回的最可能 token 的最大数量,每个都附带相应的对数概率。 + 在每个 token 位置返回的最可能 token 的最大数量,每个都带有相关的对数概率。 - 表示 token 用量详情,包括输入 token、输出 token、 -输出 token 的细分以及使用的总 token 数。 + 表示 token 用量详情,包括输入 token、输出 token、输出 token 明细以及使用的总 token 数。 @@ -524,13 +512,25 @@ Python 和 JavaScript SDK 支持。 - 输入 token 的详细细分。 + 输入 token 的详细明细。 写入缓存的输入 token 数量。 + + 按缓存有效期拆分的缓存写入量。两项计数之和等于 `cache_write_tokens`。 + + + + 写入缓存且有效期为 12 小时的输入 token 数量。 + + + + 写入缓存且有效期为 30 分钟的输入 token 数量。 + + 从缓存中检索到的 token 数量。 [关于提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 @@ -541,7 +541,7 @@ Python 和 JavaScript SDK 支持。 - 输出 token 的详细明细。 + 输出 token 的详细拆分。 @@ -553,7 +553,7 @@ Python 和 JavaScript SDK 支持。 - 已弃用的最终用户标识符。已替换为 `safety_identifier` 和 `prompt_cache_key`。 + 已弃用的最终用户标识符。已被 `safety_identifier` 和 `prompt_cache_key` 取代。 ## 示例 diff --git a/zh/development/comfy-router/models/openai/o1-pro/code.mdx b/zh/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx similarity index 53% rename from zh/development/comfy-router/models/openai/o1-pro/code.mdx rename to zh/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx index 9b390b9ded..ee7e8ed35f 100644 --- a/zh/development/comfy-router/models/openai/o1-pro/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-6-1-terra/code.mdx @@ -1,33 +1,31 @@ --- -title: "将 o1-pro 与 Comfy Router 配合使用" -description: "通过 Comfy Router 调用 openai/o1-pro:端点、请求形状以及 Router 返回的响应。" -sidebarTitle: "o1-pro" -translationSourceHash: f672098e -translationFrom: development/comfy-router/models/openai/o1-pro/code.mdx +title: "使用 GPT 6.1 Terra 搭配 Comfy Router" +description: "通过 Comfy Router 调用 openai/gpt-6.1-terra:端点、请求结构以及 Router 返回的响应。" +sidebarTitle: "GPT 6.1 Terra" +translationSourceHash: 27d99514 +translationFrom: development/comfy-router/models/openai/gpt-6-1-terra/code.mdx translationBlockHashes: - "_intro": a236f94d - "Quick start": f09ba6ce - "Schema": 4d31797d + "_intro": c31ab629 + "Quick start": 72fe9e32 + "Schema": aa04e432 "Examples": 67e6c8f1 --- - - -{/* GENERATED FILE. Generated from router-schemas/openai/o1-pro.json by `pnpm code-pages:gen`. */} +{/* GENERATED FILE. Generated from router-schemas/openai/gpt-6.1-terra.json by `pnpm code-pages:gen`. */} import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; -`openai/o1-pro` 的 API 参考文档,由 Comfy Router 从 OpenAI 提供。 +`openai/gpt-6.1-terra` 的 API 参考,由 Comfy Router 从 OpenAI 提供。 -**输入:** 文本, 图像 · **输出:** 文本 +**输入:** 文本、图像 · **输出:** 文本 ## 快速开始 -在 [你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router) 中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是在原始 HTTP 上执行同样的调用。 +在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 片段则是同样的调用,通过原始 HTTP 发送。 -**模型 ID:** `openai/o1-pro` +**模型 ID:** `openai/gpt-6.1-terra` -**端点:** `POST https://api.comfy.org/v2/models/openai/o1-pro` +**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra` @@ -35,11 +33,11 @@ import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; ```python Python from comfy_sdk import Comfy -# 从环境变量中读取 COMFY_API_KEY。 +# 从环境变量读取 COMFY_API_KEY。 # SDK 会自动创建幂等键,并在自动重试时复用它。 with Comfy() as client: result = client.models.run( - "openai/o1-pro", + "openai/gpt-6.1-terra", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, @@ -52,9 +50,9 @@ print(result) ```typescript TypeScript import { comfy } from "@comfyorg/sdk"; -// 从环境变量中读取 COMFY_API_KEY。 +// 从环境变量读取 COMFY_API_KEY。 // SDK 会自动创建幂等键,并在自动重试时复用它。 -const { data } = await comfy.models.run("openai/o1-pro", { +const { data } = await comfy.models.run("openai/gpt-6.1-terra", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); @@ -63,7 +61,7 @@ console.log(data); ``` ```bash cURL -curl https://api.comfy.org/v2/models/openai/o1-pro \ +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ @@ -71,33 +69,33 @@ curl https://api.comfy.org/v2/models/openai/o1-pro \ ``` - -将相同的请求体发送到 `POST https://api.comfy.org/v2/models/openai/o1-pro/requests`。运行一经受理,Router 会立即以 `201` 和 `request_id` 应答;结果就绪后,即可从本进程或其他进程收集。[队列投递](/zh/development/comfy-router/queue) 介绍了状态、取消与收集的流程。 + +同样的请求体,发送到 `POST https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests`。运行一旦被受理,Router 就会返回 `201` 和一个 `request_id`;结果就绪后即可收取,无论是在本进程还是其他进程中。[队列投递](/zh/development/comfy-router/queue)详细介绍了状态、取消和收取的流程。 ```python Python import asyncio from comfy_sdk import AsyncComfy -# 从环境变量中读取 COMFY_API_KEY。 -# 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 +# 从环境变量读取 COMFY_API_KEY。 +# 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 async def main(): async with AsyncComfy() as client: handle = await client.models.submit( - "openai/o1-pro", + "openai/gpt-6.1-terra", { "input": "Reply with the single word: ok", "max_output_tokens": 1024, }, ) - print("request_id:", handle.request_id) # 加上模型 ID,就是其他进程所需的全部信息 + print("request_id:", handle.request_id) # 配合模型 ID,就是另一个进程所需的全部信息 - # 轮询直到请求完成,每次等待服务器指定的 Retry-After 秒数。 + # 轮询直到请求完成,每次等待服务器给出的 Retry-After 时长。 async for update in handle.iter_events(): print(update.status, update.queue_position) - # 提供商自身的响应载荷,与 models.run() 返回的值相同。 - # 失败或已取消的请求会在此处抛出类型化的 Router 错误。 + # 提供商自己的载荷,与 models.run() 返回的值相同。 + # 失败或已取消的请求会在此抛出带类型的 Router 错误。 result = await handle.get() print(result) @@ -108,20 +106,20 @@ asyncio.run(main()) ```typescript TypeScript import { comfy } from "@comfyorg/sdk"; -// 从环境变量中读取 COMFY_API_KEY。 -// 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -const handle = await comfy.models.submit("openai/o1-pro", { +// 从环境变量读取 COMFY_API_KEY。 +// 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用它。 +const handle = await comfy.models.submit("openai/gpt-6.1-terra", { input: "Reply with the single word: ok", max_output_tokens: 1024, }); -console.log("requestId:", handle.requestId); // 加上模型 ID,就是其他进程所需的全部信息 +console.log("requestId:", handle.requestId); // 配合模型 ID,就是另一个进程所需的全部信息 -// 轮询直到请求完成,每次等待服务器指定的 Retry-After 秒数。 +// 轮询直到请求完成,每次等待服务器给出的 Retry-After 时长。 for await (const update of handle.events()) { console.log(update.status, update.queuePosition); } -// 与 models.run() 返回的结果相同。失败或已取消的请求会在此处被拒绝。 +// 与 models.run() 返回的结果相同。失败或已取消的请求会在此被拒绝。 const result = await handle.get(); console.log(result.data); @@ -129,19 +127,19 @@ console.log(result.data); ```bash cURL # 1. 提交。Router 返回 201,并带有 request_id、status_url、response_url 和 cancel_url。 -curl https://api.comfy.org/v2/models/openai/o1-pro/requests \ +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests \ -H "X-API-Key: $COMFY_API_KEY" \ -H "Idempotency-Key: $(uuidgen)" \ -H "Content-Type: application/json" \ -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -# 2. 轮询直到状态为 COMPLETED,每次等待响应中指定的 Retry-After 秒数。 +# 2. 轮询直到状态为 COMPLETED,每次响应都会指明需要等待的 Retry-After 秒数。 REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID/status \ +curl -i https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests/$REQUEST_ID/status \ -H "X-API-Key: $COMFY_API_KEY" -# 3. 收集结果。完成时返回 200 和模型的原始输出,仍在运行时返回 202 和状态响应体。 -curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ +# 3. 收取。返回 200 和模型的原生输出,仍在运行时则返回 202 和状态正文。 +curl https://api.comfy.org/v2/models/openai/gpt-6.1-terra/requests/$REQUEST_ID \ -H "X-API-Key: $COMFY_API_KEY" ``` @@ -153,29 +151,29 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ ### 输入 - 要在模型响应中额外包含的输出数据。 + 要在模型响应中包含的额外输出数据。 - 提供给模型的文本、图像或文件输入,用于生成响应。这是 Router 无法为此契约提供的唯一字段,也是下方 `required` 中的唯一条目。 + 发送给模型的文本、图像或文件输入,用于生成响应。这是此合约中 Router 无法提供的唯一字段,也是下方 `required` 中的唯一条目。 - 将一条 system(或 developer)消息插入为模型上下文中的第一项。 + 将系统(或开发者)消息作为模型上下文的第一项插入。 - 为一次响应生成的 token 数量上限,包括可见的输出 token 和推理 token。在推理 id 上,这个上限与隐藏的推理 token 共用,因此一个较小的值可能在产生任何可见文本之前就耗尽整个预算,这也是推理冒烟用例发送 1024、而对话用例发送 16 的原因。 + 为响应生成的 token 数量的上限,包括可见输出 token 和推理 token。对于推理 id,此上限与隐藏的推理 token 共用,因此较小值可能在任何可见文本出现之前就耗尽整个预算;这就是推理冒烟测试用例发送 1024,而聊天用例发送 16 的原因。 - 范围:`1` 至 `…` + 范围:`1` 到 `…` - OpenAI 模型标识符。在 Comfy Router 上此字段为 OPTIONAL,Router 会从 `{model}` 路径段填充它;显式的 `null` 也会以同样方式被替换。发送与路径不一致的值会被拒绝。 + OpenAI 模型标识符。在 Comfy Router 上,此字段为可选,Router 会从 `{model}` 路径段中填充它;显式传入的 `null` 也会以相同方式被替换。发送与路径不一致的值会被拒绝。 - 是否允许模型并行执行工具调用。 + 是否允许模型并行运行工具调用。 @@ -183,21 +181,21 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 仅限推理层级。推理模型的配置,例如 `{"effort": "medium"}`。原样转发;关于可接受的键,请参阅 OpenAI 的推理指南。对话层级的 id 会忽略它。 + 仅限 REASONING 层级。推理模型的配置,例如 `{"effort": "medium"}`。原样转发;有关可接受的键,请参阅 OpenAI 的推理指南。chat 层级的 id 会忽略它。 - OpenAI 是否存储已生成的响应以供之后检索。 + OpenAI 是否存储已生成的响应以便稍后检索。 - 声明此字段是为了让发送它的调用方不被拒绝,但它在当前接口上无效:Router 会在分发之前将其固定为 `false`,因为它捕获的是提供商响应,而不是转发 `text/event-stream`,而后者它无法解码,所以流式生成会被 OpenAI 计费,却没有任何一方计量。没有任何 Comfy 接口提供流式服务:v1 的 `POST /proxy/openai/v1/responses` 入口会以 400 拒绝 `stream: true`,并且绝不会把请求转发到上游。因此在任一接口上都请省略该字段或发送 `false`,并把已完成的响应作为单个 JSON 主体读取。 + 声明此字段,是为了让发送它的调用方不会被拒绝,但它在当前接口上不起作用:Router 会在分发前将其固定为 `false`,因为它捕获的是提供商响应,而不是转发 `text/event-stream`;Router 无法解码该流,所以流式生成会被 OpenAI 计费,却不会被任何人计量。没有任何 Comfy 接口会提供该流:v1 `POST /proxy/openai/v1/responses` 入口会以 400 拒绝 `stream: true`,并且绝不会将请求转发到上游,因此在任一接口上省略该字段或发送 `false`,然后将已完成的响应作为一个 JSON 主体读取。 - 采样温度。仅限对话层级:o 系列推理 id(`o1`、`o1-pro`、`o3`、`o4-mini`)在 OpenAI 会拒绝此参数。Router 不会代它们拒绝该参数,关于两个层级为何共用同一 schema,请参阅本组件的说明。因此发送该参数的推理调用会由 OpenAI 自身返回错误来回应。 + 采样温度。仅限 CHAT 层级:在 OpenAI 上,o 系列推理 id(`o1`、`o1-pro`、`o3`、`o4-mini`)会拒绝此参数。Router 不会替它们拒绝该参数(关于这两个层级为何共用同一 schema 的说明,请参阅此组件的注释),因此发送该参数的推理调用将由 OpenAI 自身的错误来回应。 - 范围:`0` 至 `2` + 范围:`0` 到 `2` @@ -205,41 +203,41 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 模型应如何选择使用哪个工具。可以是字符串模式,也可以是指定某个工具的对象。 + 模型应如何选择要使用的工具。可以是字符串模式,也可以是指定工具的对象。 - 模型可以调用的工具定义。Router 不会收窄工具分类;关于可接受的形状,请参阅 OpenAI 的 Responses API 参考。 + 模型可以调用的工具定义。Router 不会缩小工具分类的范围;有关可接受的形状,请参阅 OpenAI 的 Responses API 参考。 - 核采样截断值。仅限对话层级,条件与 `temperature` 相同。 + 核采样截止值。仅限 CHAT 层级,条件与 `temperature` 相同。 - 范围:`0` 至 `1` + 范围:`0` 到 `1` - 当上下文超出模型窗口时采用的截断策略。与上面三个词汇表不同,这里的枚举会被强制校验,因为这两个值是 OpenAI 文档记载的完整集合,并且至今没有增加。显式的 `null` 仍会被接受,条件与其上方的字段相同。 + 当上下文超出模型窗口时的截断策略。与上面的三个词汇表不同,此处的枚举确实会被强制执行,因为这两个值是 OpenAI 记录的完整集合,且该集合没有增加。显式传入的 `null` 仍会被接受,条件与上方字段相同。 可选值:`auto`、`disabled` - Token 用量封装。它出现在此契约中,是因为 v1 操作在请求体上声明了它;OpenAI 会在响应中填充它,所以调用方没有理由发送它。 + Token 用量封装。它出现在此合约中,是因为 v1 操作在请求体上声明了它;OpenAI 会在响应中填充它,因此调用方没有理由发送它。 -本页根据 Router 在 `GET /v2/models/openai/o1-pro/openapi.json` 提供的 schema 生成,这也是请求到达提供商之前 Router 用来校验调用的同一份文档。 +根据 Router 在 `GET /v2/models/openai/gpt-6.1-terra/openapi.json` 提供的 schema 生成,该文档与 Router 在请求到达提供商之前用于验证调用的文档相同。 ### 输出 - 将一条 system(或 developer)消息作为模型上下文中的第一项插入。 + 将一条系统(或开发者)消息插入模型上下文的第一个位置。 -与 `previous_response_id` 一起使用时,上一个响应的 instructions 不会延续到下一个响应。这使得在新的响应中替换 system(或 developer)消息变得简单。 +与 `previous_response_id` 一起使用时,上一个响应中的指令不会延续到下一个响应。这样可以轻松地在新的响应中替换系统(或开发者)消息。 - 响应可生成的 token 数量上限,包括可见输出 token 和[推理 token](https://platform.openai.com/docs/guides/reasoning)。 + 为响应可生成的 token 数量设置上限,包括可见的输出 token 和[推理 token](https://platform.openai.com/docs/guides/reasoning)。 @@ -260,14 +258,14 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ 用于模型响应的截断策略。 -- `auto`:如果本次响应及之前响应的上下文超过模型的上下文窗口大小,模型将通过丢弃对话中间部分的输入项来截断响应,以适应上下文窗口。 -- `disabled`(默认):如果模型响应将超过模型的上下文窗口大小,请求将失败并返回 400 错误。 +- `auto`:如果此响应及之前响应的上下文超出模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,以适应上下文窗口。 +- `disabled`(默认):如果模型响应将超出模型的上下文窗口大小,请求将失败并返回 400 错误。 可选值:`auto`、`disabled` - 模型上一个响应的唯一 ID。用它来创建多轮对话。了解更多关于[对话状态](https://platform.openai.com/docs/guides/conversation-state)的信息。 + 模型上一个响应的唯一 ID。使用它来创建多轮对话。了解更多关于[对话状态](https://platform.openai.com/docs/guides/conversation-state)的信息。 @@ -277,19 +275,19 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 控制在后续轮次中哪些推理项会呈现回模型,例如 `auto`、`current_turn` 或 `all_turns`。 + 控制后续轮次中哪些推理项会回传给模型,例如 `auto`、`current_turn` 或 `all_turns`。 **仅限 o 系列模型** -约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理力度。目前支持的值为 `low`、`medium` 和 `high`。降低推理力度可以加快响应速度,并减少响应中用于推理的 token 数量。 +限制[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理力度。当前支持的值为 `low`、`medium` 和 `high`。降低推理力度可以带来更快的响应,并减少响应中用于推理的 token 数量。 可选值:`low`、`medium`、`high` - **弃用:** 请改用 `summary`。 + **已弃用:** 请改用 `summary`。 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 @@ -297,7 +295,7 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 用于该响应的推理模式。 + 用于响应的推理模式。 @@ -311,15 +309,15 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 一个指定模型必须输出格式的对象。 + 一个对象,用于指定模型必须输出的格式。 -配置 `{ "type": "json_schema" }` 会启用结构化输出,它确保模型会匹配你提供的 JSON schema。在[结构化输出指南](https://platform.openai.com/docs/guides/structured-outputs)中了解更多。 +配置 `{ "type": "json_schema" }` 会启用结构化输出,确保模型与提供的 JSON schema 匹配。在[结构化输出指南](https://platform.openai.com/docs/guides/structured-outputs)中了解更多。 -默认格式为 `{ "type": "text" }`,不带任何其他选项。 +默认格式为 `{ "type": "text" }`,不附加其他选项。 -**不建议用于 gpt-4o 及更新的模型:** +**不推荐用于 gpt-4o 及更新模型:** -设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,它确保模型生成的消息是有效的 JSON。对于支持它的模型,推荐使用 `json_schema`。 +设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,推荐使用它。 @@ -327,7 +325,7 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 模型在生成响应时应如何选择要使用的一个或多个工具。参见 `tools` 参数,了解如何指定模型可以调用的工具。 + 模型在生成响应时应如何选择使用哪个(或哪些)工具。请参阅 `tools` 参数,了解如何指定模型可以调用的工具。 @@ -339,19 +337,19 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 该响应的计费信息。 + 响应的计费信息。 - 负责为该响应付费的一方。 + 负责支付响应费用的一方。 - 该响应完成时的 Unix 时间戳(以秒为单位)。仅在状态为 `completed` 时出现。 + 此响应完成时的 Unix 时间戳(以秒为单位)。仅在状态为 `completed` 时存在。 - 该响应创建时的 Unix 时间戳(以秒为单位)。 + 此响应创建时的 Unix 时间戳(以秒为单位)。 @@ -359,19 +357,21 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 该响应的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 响应的错误代码。 + + 可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` - 错误的人类可读描述。 + 错误的可读描述。 - 根据 token 在目前为止的文本中已出现的频率,对新 token 进行惩罚。 + 根据新 token 在目前为止文本中已有的出现频率对其进行惩罚。 - 此 Response 的唯一标识符。 + 此响应的唯一标识符。 @@ -381,11 +381,11 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ 响应不完整的原因。 - 可能的值:`max_output_tokens`、`content_filter` + 可选值:`max_output_tokens`、`content_filter` - 一次响应中可以处理的内置工具调用总次数上限。 + 单个响应中可处理的内置工具调用总次数的上限。 @@ -397,34 +397,33 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 此资源的对象类型,始终为 `response`。 + 此资源的对象类型,始终设置为 `response`。 - 可能的值:`response` + 可选值:`response` - 模型生成的内容项数组。 + 由模型生成的内容项数组。 - `output` 数组中各项的长度和顺序取决于模型的响应。 -- 与其访问 `output` 数组中的第一项并假定它是包含模型生成内容的 `assistant` 消息, - 不如考虑在 SDK 支持的情况下使用 `output_text` 属性。 +- 与其访问 `output` 数组中的第一项并假定它是包含模型生成内容的 `assistant` 消息,不如在 SDK 支持的情况下考虑使用 `output_text` 属性。 - 仅限 SDK 使用的便捷属性,包含 `output` 数组中所有 `output_text` 项的聚合文本输出(如果存在)。 + 仅 SDK 提供的便捷属性,包含 `output` 数组中所有 `output_text` 项聚合后的文本输出(如果存在)。 在 Python 和 JavaScript SDK 中受支持。 - 是否允许模型并行运行工具调用。 + 是否允许模型并行执行工具调用。 - 根据 token 是否已在目前为止的文本中出现,对新 token 进行惩罚。 + 根据新 token 是否已出现在目前为止的文本中对其进行惩罚。 - OpenAI 用它来缓存相似请求的响应,以优化缓存命中率。取代 `user` 字段。 + 由 OpenAI 用于缓存相似请求的响应,以优化缓存命中率。替代 `user` 字段。 @@ -432,7 +431,7 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 一个稳定的标识符,用于帮助检测可能违反 OpenAI 使用政策的应用程序用户。 + 用于帮助检测可能违反 OpenAI 使用政策的应用程序用户的稳定标识符。 @@ -440,13 +439,13 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 响应生成的状态。取值为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 + 响应生成的状态。取值为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete`。 - 可能的值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` - 响应是否会被存储,以便之后通过 API 检索。 + 是否存储响应以便之后通过 API 检索。 @@ -502,12 +501,12 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 在每个 token 位置返回的最可能 token 的最大数量,每个 token 都附带一个关联的对数概率。 + 在每个 token 位置返回的最可能 token 的最大数量,每个都带有相应的对数概率。 - 表示 token 用量详情,包括输入 token、输出 token、 -输出 token 的细分以及使用的 token 总数。 + 表示 token 用量详情,包括输入 token 数、输出 token 数、 +输出 token 的细分以及所使用的 token 总数。 @@ -522,9 +521,21 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ 写入缓存的输入 token 数量。 + + 按缓存生命周期拆分的缓存写入量。两项计数之和等于 `cache_write_tokens`。 + + + + 写入缓存且生命周期为 12 小时的输入 token 数量。 + + + + 写入缓存且生命周期为 30 分钟的输入 token 数量。 + + - 从缓存中检索到的 token 数量。 -[有关提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 + 从缓存中取回的 token 数量。 +[关于提示词缓存的更多说明](https://platform.openai.com/docs/guides/prompt-caching)。 @@ -532,7 +543,7 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 输出 token 的详细细分。 + 输出 token 的详细明细。 @@ -544,7 +555,7 @@ curl https://api.comfy.org/v2/models/openai/o1-pro/requests/$REQUEST_ID \ - 已弃用的最终用户标识符。已替换为 `safety_identifier` 和 `prompt_cache_key`。 + 已弃用的最终用户标识符。已由 `safety_identifier` 和 `prompt_cache_key` 替换。 ## 示例 diff --git a/zh/development/comfy-router/models/openai/gpt-6-astra/code.mdx b/zh/development/comfy-router/models/openai/gpt-6-astra/code.mdx index a2193185b3..490b9152a5 100644 --- a/zh/development/comfy-router/models/openai/gpt-6-astra/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-6-astra/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 6 Astra 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/gpt-6-astra:端点、请求结构,以及 Router 返回的响应。" sidebarTitle: "GPT 6 Astra" -translationSourceHash: b6fe51cd +translationSourceHash: dc53fcc4 translationFrom: development/comfy-router/models/openai/gpt-6-astra/code.mdx translationBlockHashes: "_intro": f5ed3b66 "Quick start": 2154b82d - "Schema": 5304e7bd + "Schema": cdd4d7a5 "Examples": 67e6c8f1 --- @@ -222,7 +222,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ 当上下文超出模型窗口时采用的截断策略。与上面三个词表不同,这里的枚举确实会被强制执行,因为这两个值就是 OpenAI 文档所记载的完整集合,且至今没有扩充。显式的 `null` 仍然被接受,条件与其上方的各字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -264,7 +264,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ - `auto`:如果此响应及先前响应的上下文超过模型的上下文窗口大小,模型将通过丢弃对话中间部分的输入项来截断响应,以适应上下文窗口。 - `disabled`(默认):如果模型响应将超过模型的上下文窗口大小,请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -288,7 +288,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ 限制[推理模型](https://platform.openai.com/docs/guides/reasoning)在推理上的投入程度。 目前支持的值为 `low`、`medium` 和 `high`。减少推理投入可以带来更快的响应,并减少响应中用于推理的 token 数量。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -297,7 +297,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。 可以是 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -308,7 +308,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。 可以是 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -364,7 +364,9 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ - 该响应的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + 该响应的错误代码。 + + 可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` @@ -386,7 +388,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ 响应不完整的原因。 - Possible values: `max_output_tokens`, `content_filter` + 可选值:`max_output_tokens`、`content_filter` @@ -404,7 +406,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ 此资源的对象类型,始终设置为 `response`。 - Possible values: `response` + 可选值:`response` @@ -447,7 +449,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ 响应生成的状态。为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - Possible values: `completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` @@ -527,6 +529,18 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-astra/requests/$REQUEST_ID \ 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [有关提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-6-luna/code.mdx b/zh/development/comfy-router/models/openai/gpt-6-luna/code.mdx index f142938911..92cb78d074 100644 --- a/zh/development/comfy-router/models/openai/gpt-6-luna/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-6-luna/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 6 Luna 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/gpt-6-luna:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "GPT 6 Luna" -translationSourceHash: 016a3493 +translationSourceHash: e436b4b8 translationFrom: development/comfy-router/models/openai/gpt-6-luna/code.mdx translationBlockHashes: "_intro": ae1e4a72 "Quick start": 7c4cfbcd - "Schema": 1198c1c7 + "Schema": af3ef2c5 "Examples": 67e6c8f1 --- @@ -219,7 +219,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-luna/requests/$REQUEST_ID \ 当上下文超出模型窗口时采用的截断策略。与上面的三个词汇表不同,这里的枚举会被强制执行,因为这两个值是 OpenAI 记录在案的完整集合,且一直未增加。显式的 `null` 仍然会被接受,条款与上面的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -261,7 +261,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-luna/requests/$REQUEST_ID \ - `auto`:如果本次响应及之前响应的上下文超过模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,使其适应上下文窗口。 - `disabled`(默认):如果模型响应将超过模型的上下文窗口大小,该请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -288,7 +288,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-luna/requests/$REQUEST_ID \ 推理投入程度可以带来更快的响应,以及响应中用于 推理的 token 更少。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -298,7 +298,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-luna/requests/$REQUEST_ID \ 调试和理解模型的推理过程很有用。 取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -310,7 +310,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-luna/requests/$REQUEST_ID \ 调试和理解模型的推理过程很有用。 取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -534,6 +534,18 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-luna/requests/$REQUEST_ID \ 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [有关提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-6-sol/code.mdx b/zh/development/comfy-router/models/openai/gpt-6-sol/code.mdx index ece9012fbf..92b20901f0 100644 --- a/zh/development/comfy-router/models/openai/gpt-6-sol/code.mdx +++ b/zh/development/comfy-router/models/openai/gpt-6-sol/code.mdx @@ -2,12 +2,12 @@ title: "将 GPT 6 Sol 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/gpt-6-sol:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "GPT 6 Sol" -translationSourceHash: 7b6ad6e8 +translationSourceHash: fd9a0f66 translationFrom: development/comfy-router/models/openai/gpt-6-sol/code.mdx translationBlockHashes: "_intro": eeaf1fd1 "Quick start": 231cae97 - "Schema": 808c67cd + "Schema": 302da76c "Examples": 67e6c8f1 --- @@ -219,7 +219,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ 当上下文超出模型窗口时采用的截断策略。与上面三组词汇不同,这里的枚举是被强制校验的,因为这两个值就是 OpenAI 文档记载的完整集合,并且它一直没有增长。显式的 `null` 仍会被接受,条款与它上面的字段相同。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -261,7 +261,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ - `auto`:如果此响应以及之前响应的上下文超出模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,以适应上下文窗口。 - `disabled`(默认):如果模型响应将超出模型的上下文窗口大小,请求将失败并返回 400 错误。 - 可能的值:`auto`、`disabled` + 可选值:`auto`、`disabled` @@ -283,7 +283,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ 约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理投入程度。目前支持的值为 `low`、`medium` 和 `high`。降低推理投入程度可以加快响应速度,并减少响应中用于推理的 token 数量。 - 可能的值:`low`、`medium`、`high` + 可选值:`low`、`medium`、`high` @@ -291,7 +291,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和了解模型的推理过程很有帮助。取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -301,7 +301,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ 模型所执行推理的摘要。这对于调试和了解模型的推理过程很有帮助。取值为 `auto`、`concise` 或 `detailed` 之一。 - 可能的值:`auto`、`concise`、`detailed` + 可选值:`auto`、`concise`、`detailed` @@ -317,7 +317,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ **不建议用于 gpt-4o 及更新的模型:** -设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,该模式确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,推荐使用 `json_schema`。 +设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,该模式确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,推荐使用它。 @@ -359,7 +359,7 @@ curl https://api.comfy.org/v2/models/openai/gpt-6-sol/requests/$REQUEST_ID \ 该响应的错误代码。 -Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` +可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` @@ -381,7 +381,7 @@ Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`ve 响应不完整的原因。 - Possible values: `max_output_tokens`、`content_filter` + 可选值:`max_output_tokens`、`content_filter` @@ -399,7 +399,7 @@ Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`ve 此资源的对象类型,始终设置为 `response`。 - Possible values: `response` + 可选值:`response` @@ -440,7 +440,7 @@ Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`ve 响应生成的状态。为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - Possible values: `completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` + 可选值:`completed`、`failed`、`in_progress`、`cancelled`、`queued`、`incomplete` @@ -519,6 +519,18 @@ Possible values: `server_error`、`rate_limit_exceeded`、`invalid_prompt`、`ve 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [了解有关提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/gpt-image-1/code.mdx b/zh/development/comfy-router/models/openai/gpt-image-1/code.mdx deleted file mode 100644 index b5028a3538..0000000000 --- a/zh/development/comfy-router/models/openai/gpt-image-1/code.mdx +++ /dev/null @@ -1,360 +0,0 @@ ---- -title: "将 GPT Image 1 与 Comfy Router 配合使用" -description: "通过 Comfy Router 调用 openai/gpt-image-1:端点、请求形状以及 Router 返回的响应。" -sidebarTitle: "GPT Image 1" -translationSourceHash: 02331b72 -translationFrom: development/comfy-router/models/openai/gpt-image-1/code.mdx -translationBlockHashes: - "_intro": 410036c3 - "Quick start": b83102e7 - "Schema": 8be561c9 - "Examples": c73859ec ---- - - - - - -{/* GENERATED FILE. Generated from router-schemas/openai/gpt-image-1.json by `pnpm code-pages:gen`. */} - -import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; - -`openai/gpt-image-1` 的 API 参考,由 Comfy Router 提供,模型源自 OpenAI。 - -**输入:** 文本, 图像 · **输出:** 图像 - -## 快速开始 - -在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段是通过原生 HTTP 进行的相同调用。 - -**模型 ID:** `openai/gpt-image-1` - -**端点:** `POST https://api.comfy.org/v2/models/openai/gpt-image-1` - - - - -```python Python -from comfy_sdk import Comfy - -# 从环境变量中读取 COMFY_API_KEY。 -# SDK 会自动创建幂等键,并在自动重试时复用它。 -with Comfy() as client: - result = client.models.run( - "openai/gpt-image-1", - { - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024", - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量中读取 COMFY_API_KEY。 -// SDK 会自动创建幂等键,并在自动重试时复用它。 -const { data } = await comfy.models.run("openai/gpt-image-1", { - prompt: "a rocketship on a launchpad", - quality: "low", - size: "1024x1024", -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/gpt-image-1 \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" -``` - - - -将同样的请求体发送到 `POST https://api.comfy.org/v2/models/openai/gpt-image-1/requests`。只要运行被接纳,Router 就会立即返回 `201` 和一个 `request_id`,结果在就绪后再收集,可以由当前进程或另一个进程完成。[排队投递](/zh/development/comfy-router/queue) 详细介绍了状态、取消和收集。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 从环境变量中读取 COMFY_API_KEY。 -# 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/gpt-image-1", - { - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024", - }, - ) - print("request_id:", handle.request_id) # 配合模型 ID,就是另一个进程所需的全部信息 - - # 轮询直到请求完成,按服务器指定的 Retry-After 等待。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 提供商自己的载荷,与 models.run() 返回的值相同。 - # 失败或已取消的请求会在此处抛出类型化的 Router 错误。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量中读取 COMFY_API_KEY。 -// 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -const handle = await comfy.models.submit("openai/gpt-image-1", { - prompt: "a rocketship on a launchpad", - quality: "low", - size: "1024x1024", -}); -console.log("requestId:", handle.requestId); // 配合模型 ID,就是另一个进程所需的全部信息 - -// 轮询直到请求完成,按服务器指定的 Retry-After 等待。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// 与 models.run() 返回的结果相同。失败或已取消的请求会在此处被拒绝。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 提交。Router 返回 201,并附带 request_id、status_url、response_url 和 cancel_url。 -curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"prompt\": \"a rocketship on a launchpad\", \"quality\": \"low\", \"size\": \"1024x1024\"}" - -# 2. 轮询直到状态为 COMPLETED,按每个响应中给出的 Retry-After 秒数等待。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 收集。返回 200 和模型的原生输出;如果请求仍在运行,则返回 202 和状态正文。 -curl https://api.comfy.org/v2/models/openai/gpt-image-1/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Schema - -### 输入 - - - 背景透明度。`auto` 让模型自行选择。 - - 可选值:`transparent`、`opaque`、`auto` - - - - 待编辑的来源图像。该字段的存在即选定编辑操作,若要文生图生成则完全省略它。 -模型公布的示例是 GENERATION 调用,它省略了该字段。添加 `image` 就是两种模式之间的全部差异:相同的端点、相同的模型 ID,区别只在于编辑提示词描述的是你想要的改变,而不是场景,因此下面的编辑请求体读起来与生成示例不同,尽管结构上新增的只有这一个字段。 -它可以按原样照抄:`{"prompt": "give the rocketship rainbow coloring", "image": ["data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mP8z8BQDwAEhQGAhKmMIQAAAABJRU5ErkJggg=="], "size": "1024x1024"}`:其中的 payload 是一个完整的 1x1 PNG,并非缩写,而且该请求体在 Router 自身的请求验证测试中已顶固为可接受用例。请替换为你自己图像的字节。 -接受一张图像或图像数组;gpt-image-1 及更高版本最多接受 16 张,Router 会在派发之前依据此 schema 强制执行该限制。 - - - - 一张图像,可以是 Router 代调用方抓取的 https URL,也可以是内联携带字节的 `data:image/;base64,` URI。接受的图像类型为 png、webp 和 jpeg,并且该集合在解析时就被强制执行,而不是留给提供商处理:svg、gif、avif 或 tiff 会在此处被拒绝,并指明你发送的是哪张图像,而不会变成距离根因两跳之外的合作伙伴错误。 -优先使用 URL 形式。base64 payload 大约会膨胀 4/3,而整个请求体上限为 100 MiB,因此内联形式大约在 75 MB 的来源图像处达到上限;URL 则完全绕开这一点。本描述末尾给出的单张图像和单次请求媒体上限比请求体上限更严格,所以对于任何真实尺寸的图像,你首先遇到的是它们。 -该 URL 必须在不携带你的凭据的情况下可解析。Router 在服务器端抓取它,且请求中不发送任何调用方凭据,因此受支持的形式是预签名 URL,即签名位于查询字符串中的 URL。诸如 `/api/assets/{id}/content` 这类需要认证的端点会向 Router 返回 401 而不是图像;请自行请求该 URL,并传入它重定向到的已签名 URL。 -抓取被限制在一组具名主机之内,而不是开放的互联网,并且同一份列表会同时应用于你发送的 URL 以及每一次重定向跳转:因此位于任何其他主机上的 URL,或重定向到列表之外的 URL,都会在联系任何提供商之前被拒绝。目前该列表仅包含 Comfy 自家的资产分发:Comfy 资产桶下的已签名 `storage.googleapis.com` URL,这正是 `/api/assets/{id}/content` 重定向你到的形式。合作伙伴 CDN 或普通 https 主机不在列表内。 -有两项放宽正在逐步推出,且目前均默认关闭。它们位于同一个切换开关之后并一同启用,因此请把下面所有内容视为即将推出,而不是现在就赖以构建的功能:在依赖其中任何一项之前请先咨询。 -第一项是 `POST /customers/storage` 为你的上传签名所指向的桶。在推出覆盖到你的环境之前,来自该端点的上传 URL 会在此处被拒绝,即便该桶是 Comfy 自家的、主机也是同一个:因此“上传到 Comfy,再传入该 URL”目前并不可行,可行的形式是 `/api/assets/{id}/content` 重定向到的已签名 URL。 -第二项是按账号启用的,而不是一次性对所有人开放,因为这些主机背后的桶是你自己的,而不是我们的:即便上面的切换开关已打开,未启用第三方入站媒体的账号仍会被拒绝,并且反馈给你的就是这句话,而不是告知该主机不受支持。请联系你的 Comfy 对接人,为你的账号启用它。它还额外接纳以下第三方对象存储主机,这些桶归你所有,Router 不主张任何所属权:Cloudflare R2(`.r2.cloudflarestorage.com`、`pub-.r2.dev`)、Amazon S3(`s3.amazonaws.com` 与 `s3..amazonaws.com`,路径式或带 `.` 前缀的形式均可)、Azure Blob Storage(`.blob.core.windows.net`)以及阿里云 OSS(`.oss-.aliyuncs.com`,包括 `oss-accelerate` 端点)。这些特指对象存储端点:同一提供商域名上的常规端点,例如阿里云函数计算的触发器,不在列表内并会被拒绝。 -匹配的是主机名形式,而不是提供商:因此上面点名某个提供商并不意味着该提供商能签发的每个 URL 都会被接受,有三种近似但不符合的形式值得直接说明,因为调用方很可能正好带着它们而来。R2 的自定义域名(`cdn.example.com`)不被接受:Cloudflare 将 `pub-.r2.dev` 记录为受速率限制的调试主机名,并把生产流量导向自定义域名,但自定义域名的主机名中没有任何内容标识它是 R2,因此 Router 无法将其与其他主机区分开来并会拒绝它:请对 `.r2.cloudflarestorage.com` 端点做预签名,或使用 `pub-.r2.dev` 形式。S3 的 IPv6 双栈端点(`s3.dualstack..amazonaws.com`)也不被接受;请使用普通的区域端点。Azure Blob 的备用 DNS 区域(`.z.blob.storage.azure.net`)同样不被接受;请使用 `.blob.core.windows.net`。你收到的拒绝信息会点明这些形式,因此你不必特意来这里查阅。 -上面的 `` 和 `pub-` 占位符展示的是你通常会提交的形式;它们并不是层级限制。匹配针对的是对象存储域名后缀,因此同一命名空间下更深层的名称(`a.b.pub-.r2.dev`)同样会被接受。这并不会放宽命名空间本身:后缀仍然必须是所列出的其中之一。 -下面的示例只展示形状:真实值还会带有签名查询参数,这里特意省略了它们,因为公开的示例会永远留在规范中,而真实的签名既是泄露的凭据,也是一个会失效的链接。 -每张图像上限为 25 MiB,单个请求的图像总计上限为 64 MiB。 - - - - 要运行的 gpt-image 模型。Router 会把所寻址的模型 id 拼接进去,因此寻址 /v2/models/openai/gpt-image-2 的调用方不会发送该字段。 - - - - 内容审核设置 - - 可能的值:`low`、`auto` - - - - 要生成的图像数量(1-10)。 - - 范围:`1` 到 `10` - - - - JPEG 或 WebP 的压缩级别(0-100) - - 范围:`0` 到 `100` - - - - 输出图像的格式 - - 可能的值:`png`、`webp`、`jpeg` - - - - 仅在与实时流配合使用时才有意义,而本接口无法提供实时流:即使你发送 `stream`,它也会被固定为 `false`。在生成请求中,任何不是 `0` 或 `null` 的值都会被以 400 拒绝,无论该请求是否同时发送 `stream: true`;在携带 `image` 的请求中,该字段会被丢弃而不是转发。请省略它。 - - 范围:`0` 到 `3` - - - - 对要生成的图像的文字描述,或要对 `image` 所做的编辑的描述。 - - - - 生成或编辑后图像的质量。`xhigh` 和 `max` 是 gpt-image-2.5-flare 与 gpt-image-2.5-sunburst 专门新增的两个档位;`standard` 和 `hd` 是 dall-e 时代的写法,任何已接纳的模型都不会读取它们。 - - 可能的值:`auto`、`low`、`medium`、`high`、`xhigh`、`max`、`standard`、`hd` - - - - 图像的大小(例如 1024x1024、1536x1024、auto) - - - - 声明该字段是为了让发送它的调用方不被拒绝,但它在本次接口上不起作用:Router 会在派发之前将其固定为 `false`,因为它捕获的是提供商响应,而不是中继 `text/event-stream`(携带 `image` 的请求则会丢弃该字段,因为编辑结果会在没有该字段的情况下重新编码)。没有任何 Comfy 接口提供 gpt-image 的部分图像流式传输:v1 的 `POST /proxy/openai/images/generations` 入口会以 400 拒绝 `stream: true`,并且绝不会把请求转发到上游,因此请省略该字段,并把已完成的响应作为单个 JSON 体读取。由于流从未打开,OpenAI 关于将 `stream: true` 与大于 1 的 `n` 组合使用的限制在这里并不适用;`n` 会按发送时的原样转发。 - - - - 用于最终用户监控的唯一标识符 - - -由 Router 在 `GET /v2/models/openai/gpt-image-1/openapi.json` 提供的 schema 生成,它与 Router 在请求到达提供商之前用于校验调用的文档是同一份。 - -### 输出 - - - - - - - Base64 编码的图像数据 - - - - 修订后的提示词 - - - - 图像的 URL - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 已生成图像的背景是 `opaque` 还是 `transparent`,即 OpenAI 为本次生成所判定的结果。请求参数默认为 `auto`,因此未将其固定的调用方可以在这里得知实际生成的是哪一种。 - - - - 生成完成时的 Unix 时间戳,单位为秒。它是 OpenAI 在图像生成响应中声明为 REQUIRED 的唯一成员,因此只要由 OpenAI 生成就会存在;而在任何由 alt 支持的 id 上,由 fal、pika、wavespeed 或 runware 提供的响应会完全省略它,就像其他四个已解析参数成员一样。之所以声明为 `int64`,是因为当下的 epoch 值已接近 2^31,未格式化的 `integer` 在许多 SDK 生成器中会生成 32 位字段。 - - 格式:`int64` - - - - `data[].b64_json` 中字节的编码:`png`、`webp` 或 `jpeg`。它是 OpenAI 实际编码使用的格式,即发送了请求的 `output_format` 时取该值,未发送时取 `png`,因此解码器可以据此判断,而不必从请求中重新推导格式。 - - - - 本次生成实际使用的质量档位:OpenAI 会报告 `low`、`medium`、`high`、`xhigh` 或 `max` 之一。它是已解析的档位,而不是对请求的回显,因为请求自身的 `quality` 默认为 `auto`。 - - - - 本次生成实际使用的像素尺寸,格式为 `x`。它是已解析的尺寸:请求的 `size` 默认为 `auto` 且明确接受 `auto`,因此这里是唯一报告实际所用尺寸的地方。 - - -## 示例 - -### 输入 - -```json -{ - "prompt": "a rocketship on a launchpad", - "quality": "low", - "size": "1024x1024" -} -``` - -### 输出 - -```json -{ - "created": 1767225600, - "data": [ - { - "b64_json": "PGJhc2U2ND4=" - } - ], - "usage": { - "input_tokens": 12, - "input_tokens_details": { - "image_tokens": 0, - "text_tokens": 12 - }, - "output_tokens": 1056, - "total_tokens": 1068 - } -} -``` - - diff --git a/zh/development/comfy-router/models/openai/o3/code.mdx b/zh/development/comfy-router/models/openai/o3/code.mdx index a3efb655bc..d5a2697e0a 100644 --- a/zh/development/comfy-router/models/openai/o3/code.mdx +++ b/zh/development/comfy-router/models/openai/o3/code.mdx @@ -2,12 +2,12 @@ title: "将 o3 与 Comfy Router 配合使用" description: "通过 Comfy Router 调用 openai/o3:端点、请求结构以及 Router 返回的响应。" sidebarTitle: "o3" -translationSourceHash: e0b99669 +translationSourceHash: 7e056724 translationFrom: development/comfy-router/models/openai/o3/code.mdx translationBlockHashes: "_intro": a86dcb0c "Quick start": 4064c5a8 - "Schema": 217699a3 + "Schema": d937270a "Examples": 67e6c8f1 --- @@ -167,7 +167,7 @@ curl https://api.comfy.org/v2/models/openai/o3/requests/$REQUEST_ID \ 一次响应所生成 token 数量的上限,包括可见输出 token 与推理 token。在推理类 id 上,该上限与隐藏的推理 token 共享,因此一个较小的值可能在产生任何可见文本之前就耗尽整个预算,这也是推理类冒烟用例发送 1024 而聊天类用例发送 16 的原因。 - Range: `1` to `…` + 范围:`1` 到 `…` @@ -197,7 +197,7 @@ curl https://api.comfy.org/v2/models/openai/o3/requests/$REQUEST_ID \ 采样温度。仅限聊天层级:o 系列推理 id(`o1`、`o1-pro`、`o3`、`o4-mini`)会在 OpenAI 处拒绝该参数。Router 不会替它们拒绝它(原因见本组件关于两个层级共用同一 schema 的说明),因此发送该参数的推理调用会得到 OpenAI 自身错误的回应。 - Range: `0` to `2` + 范围:`0` 到 `2` @@ -215,13 +215,13 @@ curl https://api.comfy.org/v2/models/openai/o3/requests/$REQUEST_ID \ 核采样截断值。仅限聊天层级,条件与 `temperature` 相同。 - Range: `0` to `1` + 范围:`0` 到 `1` 上下文超出模型窗口时的截断策略。与上面的三个词表不同,这里的枚举是被强制校验的,因为这两个值就是 OpenAI 文档所载的完整集合,且至今没有扩展。显式的 `null` 仍然可接受,条件与其上方的字段相同。 - Possible values: `auto`, `disabled` + 可选值:`auto`、`disabled` @@ -380,7 +380,9 @@ reasoning 投入程度可以加快响应速度,并减少 response 中 - response 的错误代码。Possible values: `server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` + response 的错误代码。 + + 可选值:`server_error`、`rate_limit_exceeded`、`invalid_prompt`、`vector_store_timeout`、`invalid_image`、`invalid_image_format`、`invalid_base64_image`、`invalid_image_url`、`image_too_large`、`image_too_small`、`image_parse_error`、`image_content_policy_violation`、`invalid_image_mode`、`image_file_too_large`、`unsupported_image_media_type`、`empty_image_file`、`failed_to_download_image`、`image_file_not_found` @@ -545,6 +547,18 @@ reasoning 投入程度可以加快响应速度,并减少 response 中 写入缓存的输入 token 数量。 + + 按缓存存活时间拆分的缓存写入。两个计数之和等于 `cache_write_tokens`。 + + + + 以 12 小时存活时间写入缓存的输入 Token 数。 + + + + 以 30 分钟存活时间写入缓存的输入 Token 数。 + + 从缓存中检索到的 token 数量。 [了解关于提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 diff --git a/zh/development/comfy-router/models/openai/o4-mini/code.mdx b/zh/development/comfy-router/models/openai/o4-mini/code.mdx deleted file mode 100644 index df12ebe441..0000000000 --- a/zh/development/comfy-router/models/openai/o4-mini/code.mdx +++ /dev/null @@ -1,605 +0,0 @@ ---- -title: "搭配 Comfy Router 使用 o4-mini" -description: "通过 Comfy Router 调用 openai/o4-mini:端点、请求结构以及 Router 返回的响应。" -sidebarTitle: "o4-mini" -translationSourceHash: b1b02a55 -translationFrom: development/comfy-router/models/openai/o4-mini/code.mdx -translationBlockHashes: - "_intro": 23fc3424 - "Quick start": f63680db - "Schema": fcbeee88 - "Examples": 67e6c8f1 ---- - - - -{/* 已生成文件。由 `pnpm code-pages:gen` 从 router-schemas/openai/o4-mini.json 生成。 */} - -import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; - -`openai/o4-mini` 的 API 参考,由 Comfy Router 从 OpenAI 提供。 - -**输入:** 文本, 图像 · **输出:** 文本 - -## 快速开始 - -在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段是通过原始 HTTP 发起的同一调用。 - -**模型 ID:** `openai/o4-mini` - -**端点:** `POST https://api.comfy.org/v2/models/openai/o4-mini` - - - - -```python Python -from comfy_sdk import Comfy - -# 从环境变量读取 COMFY_API_KEY。 -# SDK 会自动创建幂等键,并在自动重试时复用它。 -with Comfy() as client: - result = client.models.run( - "openai/o4-mini", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - -print(result) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量读取 COMFY_API_KEY。 -// SDK 会自动创建幂等键,并在自动重试时复用它。 -const { data } = await comfy.models.run("openai/o4-mini", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); - -console.log(data); -``` - -```bash cURL -curl https://api.comfy.org/v2/models/openai/o4-mini \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" -``` - - - -将相同的请求体发送到 `POST https://api.comfy.org/v2/models/openai/o4-mini/requests`。运行一旦被受理,Router 就会返回 `201` 和 `request_id`;结果就绪后,可从本进程或其他进程收集。[队列投递](/zh/development/comfy-router/queue) 介绍了状态、取消与收集。 - - -```python Python -import asyncio -from comfy_sdk import AsyncComfy - -# 从环境变量读取 COMFY_API_KEY。 -# 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -async def main(): - async with AsyncComfy() as client: - handle = await client.models.submit( - "openai/o4-mini", - { - "input": "Reply with the single word: ok", - "max_output_tokens": 1024, - }, - ) - print("request_id:", handle.request_id) # 配合模型 ID,就是另一个进程所需的全部 - - # 轮询直到请求完成,等待服务器给出的 Retry-After 时长。 - async for update in handle.iter_events(): - print(update.status, update.queue_position) - - # 提供商自身的负载,与 models.run() 返回的值相同。 - # 失败或已取消的请求会在此处抛出类型化的 Router 错误。 - result = await handle.get() - - print(result) - -asyncio.run(main()) -``` - -```typescript TypeScript -import { comfy } from "@comfyorg/sdk"; - -// 从环境变量读取 COMFY_API_KEY。 -// 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 -const handle = await comfy.models.submit("openai/o4-mini", { - input: "Reply with the single word: ok", - max_output_tokens: 1024, -}); -console.log("requestId:", handle.requestId); // 配合模型 ID,就是另一个进程所需的全部 - -// 轮询直到请求完成,等待服务器给出的 Retry-After 时长。 -for await (const update of handle.events()) { - console.log(update.status, update.queuePosition); -} - -// 与 models.run() 返回的结果相同。失败或已取消的请求会在此处拒绝。 -const result = await handle.get(); - -console.log(result.data); -``` - -```bash cURL -# 1. 提交。Router 返回 201,并给出 request_id、status_url、response_url 和 cancel_url。 -curl https://api.comfy.org/v2/models/openai/o4-mini/requests \ - -H "X-API-Key: $COMFY_API_KEY" \ - -H "Idempotency-Key: $(uuidgen)" \ - -H "Content-Type: application/json" \ - -d "{\"input\": \"Reply with the single word: ok\", \"max_output_tokens\": 1024}" - -# 2. 轮询直到状态为 COMPLETED,每次响应都会给出需要等待的 Retry-After 秒数。 -REQUEST_ID="" -curl -i https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID/status \ - -H "X-API-Key: $COMFY_API_KEY" - -# 3. 收集。仍在运行时返回带状态正文的 202,完成后返回模型原生输出的 200。 -curl https://api.comfy.org/v2/models/openai/o4-mini/requests/$REQUEST_ID \ - -H "X-API-Key: $COMFY_API_KEY" -``` - - - - -## Schema - -### 输入 - - - 要包含在模型响应中的额外输出数据。 - - - - 发送给模型的文本、图像或文件输入,用于生成响应。这是本契约中 Router 无法提供的唯一字段,也是下面 `required` 中唯一的条目。 - - - - 将一条 system(或 developer)消息插入模型上下文的第一个位置。 - - - - 一次响应所生成 token 数量的上限,包括可见的输出 token 和推理 token。对于推理类 id,这个上限与隐藏的推理 token 共享,因此较小的值可能在产生任何可见文本之前就耗尽整个预算,这也是推理冒烟用例发送 1024、而对话用例发送 16 的原因。 - - 范围:`1` 至 `…` - - - - OpenAI 模型标识符。在 Comfy Router 上,此字段为可选,Router 会从 `{model}` 路径段填充它;显式的 `null` 也会以同样的方式被替换。发送与路径不一致的值会被拒绝。 - - - - 是否允许模型并行执行工具调用。 - - - - 上一个响应的 ID,用于多轮对话。 - - - - 仅限推理层级。推理模型的配置,例如 `{"effort": "medium"}`。原样转发;可接受的键请参见 OpenAI 的推理指南。对话层级的 id 会忽略它。 - - - - OpenAI 是否存储已生成的响应以便日后检索。 - - - - 声明该字段是为了让发送它的调用方不被拒绝,但它在此接口上是无效的:Router 会在派发之前将其确定为 `false`,因为 Router 捕获的是提供商的响应,而不是转发 `text/event-stream`,而后者它无法解码,因此流式的生成会被 OpenAI 计费,却不会被任何人计量。没有任何 Comfy 接口提供流式传输:v1 的 `POST /proxy/openai/v1/responses` 入口会以 400 拒绝 `stream: true`,并且从不上游转发该请求,因此在任一接口上都应省略该字段或发送 `false`,并将已完成的响应作为单个 JSON 主体读取。 - - - - 采样温度。仅限对话层级:o 系列推理 id(`o1`、`o1-pro`、`o3`、`o4-mini`)在 OpenAI 处会拒绝此参数。Router 不会替它们拒绝该参数(关于两个层级为何共用同一 schema,请参见本组件的说明),因此发送该参数的推理调用会由 OpenAI 自身的错误来回应。 - - 范围:`0` 至 `2` - - - - 输出格式配置,例如用于 Structured Outputs 的 `{"format": {"type": "json_schema", ...}}`。原样转发。 - - - - 模型应如何选择要使用的工具。可以是字符串模式,也可以是指定某个工具的对象。 - - - - 模型可以调用的工具定义。Router 不会收窄工具分类;可接受的形状请参见 OpenAI 的 Responses API 参考。 - - - - 核采样截断值。仅限对话层级,条件与 `temperature` 相同。 - - 范围:`0` 至 `1` - - - - 当上下文超出模型窗口时采用的截断策略。与上面三个词表不同,这里的枚举是会被强制校验的,因为这两个值是 OpenAI 文档中记载的完整集合,且没有增加过。显式的 `null` 仍会被接受,条件与其上方的字段相同。 - - 可能的值:`auto`、`disabled` - - - - Token 用量封装。该字段出现在本契约中,是因为 v1 操作在请求体上声明了它;OpenAI 会在响应中填充它,因此调用方没有理由发送它。 - - -由 Router 在 `GET /v2/models/openai/o4-mini/openapi.json` 提供的 schema 生成,也是在请求到达提供商之前用于校验调用的同一份文档。 - -### 输出 - - - 将一条 system(或 developer)消息插入到模型上下文的第一个位置。 - -与 `previous_response_id` 一起使用时,上一个响应的 instructions 不会延续到下一个响应。这样在新的响应中替换 system(或 developer)消息就非常简单。 - - - - 响应可生成的 token 数量上限,包括可见的输出 token 和[推理 token](https://platform.openai.com/docs/guides/reasoning)。 - - - - 用于生成该响应的模型 - - - - 控制响应的随机性 - - 范围:`0` 到 `2` - - - - 通过核采样控制响应的多样性 - - 范围:`0` 到 `1` - - - - 用于模型响应的截断策略。 -- `auto`:如果本次响应及此前响应的上下文超过模型的上下文窗口大小,模型将通过丢弃对话中间的输入项来截断响应,以适应上下文窗口。 -- `disabled`(默认):如果模型响应将超过模型的上下文窗口大小,请求将失败并返回 400 错误。 - - 可能的值:`auto`、`disabled` - - - - 模型上一个响应的唯一 ID。用它来创建多轮对话。了解更多关于[对话状态](https://platform.openai.com/docs/guides/conversation-state)的信息。 - - - - **仅适用于 o 系列模型** - -[推理模型](https://platform.openai.com/docs/guides/reasoning)的配置选项。 - - - - 控制后续轮次中哪些推理项会被渲染回模型,例如 `auto`、`current_turn` 或 `all_turns`。 - - - - **仅适用于 o 系列模型** - -约束[推理模型](https://platform.openai.com/docs/guides/reasoning)的推理强度。目前支持的值为 `low`、`medium` 和 `high`。降低推理强度可以加快响应速度,并减少响应中用于推理的 token 数量。 - - 可能的值:`low`、`medium`、`high` - - - - **已弃用:** 请改用 `summary`。 - -模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 - - 可能的值:`auto`、`concise`、`detailed` - - - - 该响应所使用的推理模式。 - - - - 模型所执行推理的摘要。这对于调试和理解模型的推理过程很有用。取值为 `auto`、`concise` 或 `detailed` 之一。 - - 可能的值:`auto`、`concise`、`detailed` - - - - - - - - 一个对象,用于指定模型必须输出的格式。 - -配置 `{ "type": "json_schema" }` 会启用结构化输出,它确保模型会匹配你提供的 JSON schema。更多信息请参阅[结构化输出指南](https://platform.openai.com/docs/guides/structured-outputs)。 - -默认格式为 `{ "type": "text" }`,不带任何附加选项。 - -**不建议用于 gpt-4o 及更新的模型:** - -设置为 `{ "type": "json_object" }` 会启用较旧的 JSON 模式,它确保模型生成的消息是有效的 JSON。对于支持 `json_schema` 的模型,优先使用 `json_schema`。 - - - - 约束模型响应的详细程度。取值为 `low`、`medium` 或 `high` 之一。 - - - - 模型在生成响应时应如何选择要使用的工具(一个或多个)。请参阅 `tools` 参数,了解如何指定模型可以调用的工具。 - - - - - - - - 模型响应是否在后台运行。 - - - - 该响应的计费信息。 - - - - 负责为该响应付费的一方。 - - - - 该响应完成时的 Unix 时间戳(以秒为单位)。仅当状态为 `completed` 时才会出现。 - - - - 该响应创建时的 Unix 时间戳(以秒为单位)。 - - - - 当模型生成响应失败时返回的错误对象。 - - - - 该响应的错误代码。 - - 可能的值:`server_error`, `rate_limit_exceeded`, `invalid_prompt`, `vector_store_timeout`, `invalid_image`, `invalid_image_format`, `invalid_base64_image`, `invalid_image_url`, `image_too_large`, `image_too_small`, `image_parse_error`, `image_content_policy_violation`, `invalid_image_mode`, `image_file_too_large`, `unsupported_image_media_type`, `empty_image_file`, `failed_to_download_image`, `image_file_not_found` - - - - 错误的人类可读描述。 - - - - 根据 token 在目前文本中已有的出现频率,对新 token 进行惩罚。 - - - - 此 Response 的唯一标识符。 - - - - 关于响应为何不完整的详情。 - - - - 响应不完整的原因。 - - 可能的值:`max_output_tokens`, `content_filter` - - - - 一次响应中可处理的内置工具调用总次数上限。 - - - - 可附加到响应上的键值对集合。 - - - - 响应输入和输出的审核结果(如果请求了经审核的补全)。 - - - - 此资源的对象类型,始终设置为 `response`。 - - 可能的值:`response` - - - - 由模型生成的内容项数组。 - -- `output` 数组中各项的长度和顺序取决于 - 模型的响应。 -- 与其访问 `output` 数组中的第一项,并 - 假设它是包含模型生成内容的 `assistant` 消息, - 不如考虑使用 SDK 中受支持的 `output_text` 属性。 - - - - 仅 SDK 提供的便捷属性,包含来自 `output` 数组中 -所有 `output_text` 项的聚合文本输出(如果有)。 -在 Python 和 JavaScript SDK 中受支持。 - - - - 是否允许模型并行运行工具调用。 - - - - 根据 token 是否已出现在截至目前文本中,对新 token 进行惩罚。 - - - - 由 OpenAI 用于缓存相似请求的响应,以优化缓存命中率。替代 `user` 字段。 - - - - prompt 缓存的保留策略,例如 `in_memory` 或 `24h`。 - - - - 一个稳定的标识符,用于帮助检测可能违反 OpenAI 使用政策的应用用户。 - - - - 用于处理请求的处理层级,例如 `auto`、`default`、`flex`、`scale` 或 `priority`。 - - - - 响应生成的状态。为 `completed`、`failed`、`in_progress`、`cancelled`、`queued` 或 `incomplete` 之一。 - - 可能的值:`completed`, `failed`, `in_progress`, `cancelled`, `queued`, `incomplete` - - - - 是否将响应存储起来,以便之后通过 API 检索。 - - - - 按内置工具细分的 token 和请求用量。 - - - - 图像生成工具的 token 用量。 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - Web 搜索工具用量。 - - - - - - - - 在每个 token 位置上返回的最可能 token 的最大数量,每个 token 都带有关联的对数概率。 - - - - 表示 token 用量详情,包括输入 token、输出 token、 -输出 token 的细分以及使用的总 token 数。 - - - - 输入 token 的数量。 - - - - 输入 token 的详细细分。 - - - - 写入缓存的输入 token 数量。 - - - - 从缓存中检索到的 token 数量。 - [关于提示缓存的更多信息](https://platform.openai.com/docs/guides/prompt-caching)。 - - - - 输出 token 的数量。 - - - - 输出 token 的详细拆分。 - - - - 推理 token 的数量。 - - - - 使用的 token 总数。 - - - - 已弃用的最终用户标识符。已替换为 `safety_identifier` 和 `prompt_cache_key`。 - - -## 示例 - -### 输入 - -```json -{ - "input": "Reply with the single word: ok", - "max_output_tokens": 1024 -} -``` - -### 输出 - -```json -{ - "completed_at": 1767225601, - "created_at": 1767225600, - "id": "resp_0a1b2c3d4e5f6a7b8c9d0e1f", - "object": "response", - "output": [ - { - "content": [ - { - "annotations": [], - "text": "ok", - "type": "output_text" - } - ], - "id": "msg_0a1b2c3d4e5f6a7b8c9d0e1f", - "role": "assistant", - "status": "completed", - "type": "message" - } - ], - "output_text": "ok", - "status": "completed", - "usage": { - "input_tokens": 14, - "input_tokens_details": { - "cached_tokens": 0 - }, - "output_tokens": 2, - "output_tokens_details": { - "reasoning_tokens": 0 - }, - "total_tokens": 16 - } -} -``` - - diff --git a/zh/development/comfy-router/models/pika/pika-music/code.mdx b/zh/development/comfy-router/models/pika/pika-music/code.mdx new file mode 100644 index 0000000000..4ebb2e5ba8 --- /dev/null +++ b/zh/development/comfy-router/models/pika/pika-music/code.mdx @@ -0,0 +1,295 @@ +--- +title: "通过 Comfy Router 使用 Pika Music" +description: "通过 Comfy Router 调用 pika/pika-music:端点、请求形状以及 Router 返回的响应。" +sidebarTitle: "Pika Music" +translationSourceHash: 62ef6d01 +translationFrom: development/comfy-router/models/pika/pika-music/code.mdx +translationBlockHashes: + "_intro": d1b9e7b6 + "Quick start": f073a693 + "Schema": 738d1494 + "Examples": a7cf936e +--- + +{/* 已生成文件。由 `pnpm code-pages:gen` 从 router-schemas/pika/pika-music.json 生成。 */} + +import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; + +`pika/pika-music` 的 API 参考,由 Comfy Router 从 Pika 提供。 + +**输入:** 文本、音频 · **输出:** 音频 + +## 快速开始 + +在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建一个密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段是通过原始 HTTP 发起的同一个调用。 + +**模型 ID:** `pika/pika-music` + +**端点:** `POST https://api.comfy.org/v2/models/pika/pika-music` + + + + +```python Python +from comfy_sdk import Comfy + +# 从环境变量读取 COMFY_API_KEY。 +# SDK 会自动创建幂等键,并在自动重试时复用它。 +with Comfy() as client: + result = client.models.run( + "pika/pika-music", + { + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 从环境变量读取 COMFY_API_KEY。 +// SDK 会自动创建幂等键,并在自动重试时复用它。 +const { data } = await comfy.models.run("pika/pika-music", { + duration: 30, + mode: "text_to_music", + prompt: "warm lo-fi hip hop with soft piano and vinyl crackle", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-music \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}" +``` + + + +相同的请求体,发送到 `POST https://api.comfy.org/v2/models/pika/pika-music/requests`。运行一旦被接纳,Router 就会返回 `201` 和 `request_id`;结果准备就绪后即可收集,可以在本进程中收集,也可以在另一个进程中收集。[队列交付](/zh/development/comfy-router/queue) 详细介绍了状态、取消和结果收集。 + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 从环境变量读取 COMFY_API_KEY。 +# 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-music", + { + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle", + }, + ) + print("request_id:", handle.request_id) # 配合模型 ID,就是另一个进程所需的全部信息 + + # 轮询直到请求完成,每次按服务器给出的 Retry-After 等待。 + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # 提供商自身的负载,与 models.run() 返回的值相同。 + # 失败或已取消的请求会在此处抛出带类型的 Router 错误。 + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 从环境变量读取 COMFY_API_KEY。 +// 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 +const handle = await comfy.models.submit("pika/pika-music", { + duration: 30, + mode: "text_to_music", + prompt: "warm lo-fi hip hop with soft piano and vinyl crackle", +}); +console.log("requestId:", handle.requestId); // 配合模型 ID,就是另一个进程所需的全部信息 + +// 轮询直到请求完成,每次按服务器给出的 Retry-After 等待。 +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// 与 models.run() 返回的结果相同。失败或已取消的请求会在此处被拒绝。 +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 提交。Router 返回 201,并带有 request_id、status_url、response_url 和 cancel_url。 +curl https://api.comfy.org/v2/models/pika/pika-music/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 30, \"mode\": \"text_to_music\", \"prompt\": \"warm lo-fi hip hop with soft piano and vinyl crackle\"}" + +# 2. 轮询直到状态为 COMPLETED,每次按响应中给出的 Retry-After 秒数等待。 +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 收集。200 返回模型的原始输出;仍在运行时则返回 202 和状态正文。 +curl https://api.comfy.org/v2/models/pika/pika-music/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## Schema + +### 输入 + + + 使用前清理参考音频。 + + + + 音乐时长,以秒为单位,10 到 360。 + + 范围:`10` 到 `360` + + + + 要演唱的歌词。 + + + + 生成模式:text_to_music、voice_conditioned_text_to_music 或 music_cover。 + + 可选值:`text_to_music`、`voice_conditioned_text_to_music`、`music_cover` + + + + 音乐的描述。 + + + + 声音参考的 URL。需要将 `voice_consent_attested` 设为 true。 + + + + 生成前用模型展开简短的提示词。 + + + + 用于可复现输出的种子,-1 到 2147483647。-1 表示随机选取种子。 + + 范围:`-1` 到 `2147483647` + + + + `music_cover` 的源歌曲 URL。 + + + + 声明调用方拥有克隆 `reference_audio` 中声音的权利。 + + +根据 Router 在 `GET /v2/models/pika/pika-music/openapi.json` 提供的 schema 生成,Router 在请求到达提供商之前校验调用时所用的正是这份文档。 + +### 输出 + + + 在 `failed` 任务上设置。 + + + + 机器可读的失败代码,例如 invalid_input、content_moderation 或 provider_error。 + + + + 诊断文本。 + + + + 用于轮询状态的任务ID。 + + + + 该任务运行的 Pika 目录条目。 + + + + 已完成任务的媒体,当 `status` 为 `completed` 时设置。 + + + + 一个已生成的媒体文件。 + + + + 文件的 MIME 类型。 + + + + 已生成文件的下载 URL。 + + + + 哪个字段承载文件:video 或 audio。 + + + + 一个已生成的媒体文件。 + + + + 文件的 MIME 类型。 + + + + 已生成文件的下载 URL。 + + + + 任务状态:queued、running、completed 或 failed。 + + + + Pika 为该任务上报的用量单位。 + + +## 示例 + +### 输入 + +```json +{ + "duration": 30, + "mode": "text_to_music", + "prompt": "warm lo-fi hip hop with soft piano and vinyl crackle" +} +``` + +### 输出 + +```json +{ + "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44", + "output": { + "audio": { + "content_type": "audio/mpeg", + "url": "https://example.invalid/pika/audio.mp3" + }, + "media_type": "audio" + }, + "status": "completed" +} +``` + + diff --git a/zh/development/comfy-router/models/pika/pika-sfx/code.mdx b/zh/development/comfy-router/models/pika/pika-sfx/code.mdx new file mode 100644 index 0000000000..fe33dda1e5 --- /dev/null +++ b/zh/development/comfy-router/models/pika/pika-sfx/code.mdx @@ -0,0 +1,261 @@ +--- +title: "通过 Comfy Router 使用 Pika Sfx" +description: "通过 Comfy Router 调用 pika/pika-sfx:端点、请求形状以及 Router 返回的响应。" +sidebarTitle: "Pika Sfx" +translationSourceHash: 2df41acd +translationFrom: development/comfy-router/models/pika/pika-sfx/code.mdx +translationBlockHashes: + "_intro": f4076086 + "Quick start": e5b7bc82 + "Schema": c9ccd2ee + "Examples": f88686f5 +--- + +{/* 已生成文件。由 `pnpm code-pages:gen` 从 router-schemas/pika/pika-sfx.json 生成。 */} + +import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; + +`pika/pika-sfx` 的 API 参考文档,由 Comfy Router 从 Pika 提供。 + +**输入:** 文本 · **输出:** 音频 + +## 快速开始 + +在[你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router)中创建密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原始 HTTP 发出的同一调用。 + +**模型 ID:** `pika/pika-sfx` + +**端点:** `POST https://api.comfy.org/v2/models/pika/pika-sfx` + + + + +```python Python +from comfy_sdk import Comfy + +# 从环境变量中读取 COMFY_API_KEY。 +# SDK 会自动创建幂等键,并在自动重试时复用它。 +with Comfy() as client: + result = client.models.run( + "pika/pika-sfx", + { + "duration": 2, + "prompt": "a wooden door creaking open", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 从环境变量中读取 COMFY_API_KEY。 +// SDK 会自动创建幂等键,并在自动重试时复用它。 +const { data } = await comfy.models.run("pika/pika-sfx", { + duration: 2, + prompt: "a wooden door creaking open", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-sfx \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" +``` + + + +相同的请求体,发送到 `POST https://api.comfy.org/v2/models/pika/pika-sfx/requests`。运行一旦被接纳,Router 就会返回 `201` 和 `request_id`;结果就绪后即可收集,无论是从当前进程还是另一个进程。[排队投递](/zh/development/comfy-router/queue)介绍了状态、取消和结果收集。 + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 从环境变量中读取 COMFY_API_KEY。 +# 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-sfx", + { + "duration": 2, + "prompt": "a wooden door creaking open", + }, + ) + print("request_id:", handle.request_id) # 加上模型 ID,就是另一个进程所需的全部信息 + + # 轮询直到请求完成,每次都等待服务器指定的 Retry-After 时间。 + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # 提供商自身的载荷,与 models.run() 返回的值相同。 + # 请求失败或被取消时,这里会抛出带类型的 Router 错误。 + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 从环境变量中读取 COMFY_API_KEY。 +// 每次 submit() 调用都会生成自己的 Idempotency-Key,并在自动重试时复用它。 +const handle = await comfy.models.submit("pika/pika-sfx", { + duration: 2, + prompt: "a wooden door creaking open", +}); +console.log("requestId:", handle.requestId); // 加上模型 ID,就是另一个进程所需的全部信息 + +// 轮询直到请求完成,每次都等待服务器指定的 Retry-After 时间。 +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// 与 models.run() 返回的结果相同。请求失败或被取消时,这里会拒绝。 +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 提交。Router 返回 201,以及 request_id、status_url、response_url 和 cancel_url。 +curl https://api.comfy.org/v2/models/pika/pika-sfx/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"duration\": 2, \"prompt\": \"a wooden door creaking open\"}" + +# 2. 轮询直到状态为 COMPLETED,每次响应指定的 Retry-After 秒数都要等待。 +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 收集结果。已完成时返回 200 和模型的原始输出,仍在运行时返回 202 和状态正文。 +curl https://api.comfy.org/v2/models/pika/pika-sfx/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## Schema + +### 输入 + + + 声音效果的时长,单位为秒,范围为 1 到 20。 + + 范围:`1` 到 `20` + + + + 声音效果的描述。 + + + + 用于可复现输出的种子,范围为 -1 到 2147483647。-1 表示随机选择种子。 + + 范围:`-1` 到 `2147483647` + + +根据 Router 在 `GET /v2/models/pika/pika-sfx/openapi.json` 提供的 schema 生成,与请求到达提供商之前用于校验调用的文档相同。 + +### 输出 + + + 在 `failed` 状态的任务上设置。 + + + + 机器可读的失败代码,例如 invalid_input、content_moderation 或 provider_error。 + + + + 诊断文本。 + + + + 用于轮询状态的任务ID。 + + + + 该任务运行的 Pika 目录条目。 + + + + 已完成任务的媒体,在 `status` 为 `completed` 时设置。 + + + + 一个已生成的媒体文件。 + + + + 文件的 MIME 类型。 + + + + 已生成文件的下载 URL。 + + + + 承载文件的字段:video 或 audio。 + + + + 一个已生成的媒体文件。 + + + + 文件的 MIME 类型。 + + + + 已生成文件的下载 URL。 + + + + 任务状态:queued、running、completed 或 failed。 + + + + Pika 针对该任务报告的用量单位。 + + +## 示例 + +### 输入 + +```json +{ + "duration": 2, + "prompt": "a wooden door creaking open" +} +``` + +### 输出 + +```json +{ + "id": "media_2d8e4b71-9c05-4f3a-b6d2-81e7a5c09f44", + "output": { + "audio": { + "content_type": "audio/mpeg", + "url": "https://example.invalid/pika/audio.mp3" + }, + "media_type": "audio" + }, + "status": "completed" +} +``` + + + diff --git a/zh/development/comfy-router/models/pika/pika-soundtrack/code.mdx b/zh/development/comfy-router/models/pika/pika-soundtrack/code.mdx new file mode 100644 index 0000000000..c6ed649aa2 --- /dev/null +++ b/zh/development/comfy-router/models/pika/pika-soundtrack/code.mdx @@ -0,0 +1,258 @@ +--- +title: "使用 Comfy Router 调用 Pika Soundtrack" +description: "通过 Comfy Router 调用 pika/pika-soundtrack:端点、请求结构以及 Router 返回的响应。" +sidebarTitle: "Pika Soundtrack" +translationSourceHash: f897473f +translationFrom: development/comfy-router/models/pika/pika-soundtrack/code.mdx +translationBlockHashes: + "_intro": 51801b91 + "Quick start": f4397b26 + "Schema": 48e8da0c + "Examples": 3da11fda +--- + +{/* GENERATED FILE. Generated from router-schemas/pika/pika-soundtrack.json by `pnpm code-pages:gen`. */} + +import RouterCodeFooter from "/snippets/zh/comfy-router/model-code-footer.mdx"; + +`pika/pika-soundtrack` 的 API 参考,由 Pika 通过 Comfy Router 提供。 + +**输入:** 视频、文本 · **输出:** 视频 + 音频 + +## 快速开始 + +在 [你的 Comfy 工作区](https://platform.comfy.org/profile/api-keys?onboarding=router) 中创建密钥,并将其导出为 `COMFY_API_KEY`。Python 和 TypeScript 代码片段使用 Comfy SDK(`pip install comfy-sdk` 和 `npm install @comfyorg/sdk`);cURL 代码片段则是通过原始 HTTP 发起的同一个调用。 + +**模型 ID:** `pika/pika-soundtrack` + +**端点:** `POST https://api.comfy.org/v2/models/pika/pika-soundtrack` + + + + +```python Python +from comfy_sdk import Comfy + +# 从环境变量读取 COMFY_API_KEY。 +# SDK 会自动创建幂等键,并在自动重试时复用该键。 +with Comfy() as client: + result = client.models.run( + "pika/pika-soundtrack", + { + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", + }, + ) + +print(result) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 从环境变量读取 COMFY_API_KEY。 +// SDK 会自动创建幂等键,并在自动重试时复用该键。 +const { data } = await comfy.models.run("pika/pika-soundtrack", { + seed: -1, + video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", +}); + +console.log(data); +``` + +```bash cURL +curl https://api.comfy.org/v2/models/pika/pika-soundtrack \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" +``` + + + +相同的请求体,发送到 `POST https://api.comfy.org/v2/models/pika/pika-soundtrack/requests`。运行一旦被接纳,Router 就会返回 `201` 和 `request_id`,结果就绪后即可从当前进程或其他进程收集。[队列投递](/zh/development/comfy-router/queue) 介绍了状态、取消和收集的流程。 + + +```python Python +import asyncio +from comfy_sdk import AsyncComfy + +# 从环境变量读取 COMFY_API_KEY。 +# 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用该键。 +async def main(): + async with AsyncComfy() as client: + handle = await client.models.submit( + "pika/pika-soundtrack", + { + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", + }, + ) + print("request_id:", handle.request_id) # 加上模型 ID,就是另一个进程所需的全部信息 + + # 轮询直到请求完成,按服务器给出的 Retry-After 等待。 + async for update in handle.iter_events(): + print(update.status, update.queue_position) + + # 提供商自己的响应载荷,与 models.run() 返回的值相同。 + # 失败或已取消的请求会在这里抛出 Router 的类型化错误。 + result = await handle.get() + + print(result) + +asyncio.run(main()) +``` + +```typescript TypeScript +import { comfy } from "@comfyorg/sdk"; + +// 从环境变量读取 COMFY_API_KEY。 +// 每次调用 submit() 都会生成自己的 Idempotency-Key,并在自动重试时复用该键。 +const handle = await comfy.models.submit("pika/pika-soundtrack", { + seed: -1, + video: "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4", +}); +console.log("requestId:", handle.requestId); // 加上模型 ID,就是另一个进程所需的全部信息 + +// 轮询直到请求完成,按服务器给出的 Retry-After 等待。 +for await (const update of handle.events()) { + console.log(update.status, update.queuePosition); +} + +// 与 models.run() 返回的结果相同。失败或已取消的请求会在这里被拒绝。 +const result = await handle.get(); + +console.log(result.data); +``` + +```bash cURL +# 1. 提交。Router 返回 201,以及 request_id、status_url、response_url 和 cancel_url。 +curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests \ + -H "X-API-Key: $COMFY_API_KEY" \ + -H "Idempotency-Key: $(uuidgen)" \ + -H "Content-Type: application/json" \ + -d "{\"seed\": -1, \"video\": \"https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4\"}" + +# 2. 轮询直到状态为 COMPLETED,每次响应中给出的 Retry-After 秒数都需要等待。 +REQUEST_ID="" +curl -i https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID/status \ + -H "X-API-Key: $COMFY_API_KEY" + +# 3. 收集。返回 200 时带有模型的原生输出,仍在运行时则返回 202 和状态响应体。 +curl https://api.comfy.org/v2/models/pika/pika-soundtrack/requests/$REQUEST_ID \ + -H "X-API-Key: $COMFY_API_KEY" +``` + + + + +## Schema + +### 输入 + + + 音频应该是什么,以及它如何跟随动作。若只想依据视频本身进行声音设计,可省略此项。 + + + + 种子,取值从 -1 到 2147483647。-1 表示随机选取一个种子。 + + 范围:`-1` 到 `2147483647` + + + + 来源视频的 URL,H.264 或 HEVC 编码,最长 1200 秒,最大 2 GB。 + + +本文档生成自 Router 在 `GET /v2/models/pika/pika-soundtrack/openapi.json` 提供的 schema,这也是它在请求到达提供商之前校验调用时所使用的同一份文档。 + +### 输出 + + + 在 `failed` 任务上设置。 + + + + 机器可读的失败代码,例如 invalid_input、content_moderation 或 provider_error。 + + + + 诊断文本。 + + + + 用于轮询状态的任务ID。 + + + + 该任务所运行的 Pika 目录条目。 + + + + 已完成任务的媒体,在 `status` 为 `completed` 时设置。 + + + + 一个已生成的媒体文件。 + + + + 文件的 MIME 类型。 + + + + 已生成文件的下载 URL。 + + + + 承载文件的字段:video 或 audio。 + + + + 一个已生成的媒体文件。 + + + + 文件的 MIME 类型。 + + + + 已生成文件的下载 URL。 + + + + 任务状态:排队中、运行中、已完成或失败。 + + + + Pika 为该任务上报的单位数。 + + +## 示例 + +### 输入 + +```json +{ + "seed": -1, + "video": "https://cdn.pika.art/v2/media/uploads/a7112d4d-62ed-4a11-8dee-74e89c2ec037/ae79aabfd458427495cf462f49e1cecc.mp4" +} +``` + +### 输出 + +```json +{ + "id": "media_8f3a2c91-5b7d-4e0a-9c26-31d4f2a8e6b0", + "output": { + "media_type": "video", + "video": { + "content_type": "video/mp4", + "url": "https://example.invalid/pika/video.mp4" + } + }, + "status": "completed" +} +``` + + diff --git a/zh/development/comfy-router/pricing.mdx b/zh/development/comfy-router/pricing.mdx index d449844f6b..2ff9103dc6 100644 --- a/zh/development/comfy-router/pricing.mdx +++ b/zh/development/comfy-router/pricing.mdx @@ -131,26 +131,26 @@ Comfy 的按用量计费费率按 GPU 秒计算。实际费用取决于 GPU 运 | [Qwen Image 3.0 Pro](/zh/development/comfy-router/models/qwen/qwen-image-3-0-pro/code) | `qwen/qwen-image-3.0-pro` | 输入图像 · 1K / 2K | 0.9052 / 输入图像 | | [Seedream 5.0 Pro](/zh/development/comfy-router/models/byteplus/seedream-5-0-pro-260628/code) | `byteplus/seedream-5-0-pro-260628` | 首张之后的输入图像 | 0.633 / 输入图像 | -#### 每 Recraft credit费率 +#### 每 Recraft 积分费率 | 名称 | 模型 ID | 积分 | | --- | --- | ---: | -| [Recraft V2](/zh/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | 0.3017 / Recraft credit | -| [Recraft V3](/zh/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | 0.3017 / Recraft credit | -| [Recraft V4](/zh/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | 0.3017 / Recraft credit | -| [Recraft V4 Pro](/zh/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | 0.3017 / Recraft credit | -| [Recraft V4 Styles](/zh/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Pro](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4 Styles Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1](/zh/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | 0.3017 / Recraft credit | -| [Recraft V4.1 Pro](/zh/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | 0.3017 / Recraft credit | -| [Recraft V4.1 Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility](/zh/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Pro](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Utility Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | 0.3017 / Recraft credit | -| [Recraft V4.1 Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | 0.3017 / Recraft credit | +| [Recraft V2](/zh/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | 0.3017 / Recraft 积分 | +| [Recraft V3](/zh/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | 0.3017 / Recraft 积分 | +| [Recraft V4](/zh/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | 0.3017 / Recraft 积分 | +| [Recraft V4 Pro](/zh/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | 0.3017 / Recraft 积分 | +| [Recraft V4 Styles](/zh/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | 0.3017 / Recraft 积分 | +| [Recraft V4 Styles Pro](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | 0.3017 / Recraft 积分 | +| [Recraft V4 Styles Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | 0.3017 / Recraft 积分 | +| [Recraft V4 Styles Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | 0.3017 / Recraft 积分 | +| [Recraft V4.1](/zh/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | 0.3017 / Recraft 积分 | +| [Recraft V4.1 Pro](/zh/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | 0.3017 / Recraft 积分 | +| [Recraft V4.1 Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | 0.3017 / Recraft 积分 | +| [Recraft V4.1 Utility](/zh/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | 0.3017 / Recraft 积分 | +| [Recraft V4.1 Utility Pro](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | 0.3017 / Recraft 积分 | +| [Recraft V4.1 Utility Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | 0.3017 / Recraft 积分 | +| [Recraft V4.1 Utility Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | 0.3017 / Recraft 积分 | +| [Recraft V4.1 Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | 0.3017 / Recraft 积分 | #### 每参考图像费率 @@ -392,7 +392,7 @@ Ray 3.2 的 EXR 导出暂不可用。HDR 请求请勿启用 `exr_export`。HDR | --- | --- | --- | ---: | | [Aleph 2](/zh/development/comfy-router/models/runway/aleph2/code) | `runway/aleph2` | - | 84.4844 / s | | [Gen 4 Turbo](/zh/development/comfy-router/models/runway/gen4-turbo/code) | `runway/gen4_turbo` | - | 15.0865 / s | -| [Pika Soundtrack](/zh/development/comfy-router/models) | `pika/pika-soundtrack` | Input video | 1.50865 / s | +| [Pika Soundtrack](/zh/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Input video | 1.50865 / s | | [Sync 3](/zh/development/comfy-router/models/synclabs/sync-3/code) | `synclabs/sync-3` | - | 40.1301 / s | | [Erase](/zh/development/comfy-router/models/bria/video-edit-erase/code) | `bria/video-edit-erase` | - | 13.5778 / s | | [Green Screen](/zh/development/comfy-router/models/bria/video-edit-green-screen/code) | `bria/video-edit-green-screen` | - | 10.55 / s | @@ -596,8 +596,8 @@ Comfy 的按用量计费费率按 GPU 秒计算。实际费用取决于 GPU 运 | [Google Gemini](/zh/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-2.5-pro` | - | 音频 / 图像 / 文本 / 视频: 263.75 | 文本: 2110 | | [Google Gemini](/zh/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.1-pro-preview` | - | 音频 / 图像 / 文本 / 视频: 422 | 文本 / 推理: 2532
图像: 25320 | | [Google Gemini](/zh/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.5-flash` | - | 音频 / 图像 / 文本 / 视频: 316.5 | 文本 / 推理: 1899 | -| [GPT 6.1 Sol](/zh/development/comfy-router/models) | `openai/gpt-6.1-sol` | 读取: 30.173
写入: 754.325 | 文本: 603.46 | 文本: 3017.3 | -| [GPT 6.1 Terra](/zh/development/comfy-router/models) | `openai/gpt-6.1-terra` | 读取: 15.0865
写入: 377.1625 | 文本: 301.73 | 文本: 1508.65 | +| [GPT 6.1 Sol](/zh/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | 读取: 30.173
写入: 754.325 | 文本: 603.46 | 文本: 3017.3 | +| [GPT 6.1 Terra](/zh/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | 读取: 15.0865
写入: 377.1625 | 文本: 301.73 | 文本: 1508.65 | | [GPT 6 Astra](/zh/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | 读取: 301.73
写入: 3771.625 | 文本: 3017.3 | 文本: 15086.5 | | [GPT 6 Luna](/zh/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | 读取: 3.0173
写入: 37.7162 | 文本: 30.173 | 文本: 150.865 | | [GPT 6 Sol](/zh/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | 读取: 60.346
写入: 754.325 | 文本: 603.46 | 文本: 3017.3 | @@ -642,22 +642,22 @@ Comfy 的按用量计费费率按 GPU 秒计算。实际费用取决于 GPU 运 | --- | --- | ---: | | [Clean Audio](/zh/development/comfy-router/models/veed/clean-audio/code) | `veed/clean-audio` | 未发布 | -#### 每1K characters费率 +#### 每1K 字符费率 | 名称 | 模型 ID | 选项 | 积分 | | --- | --- | --- | ---: | -| [Eleven Multilingual V2](/zh/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 语音合成 | 50.64 / 1K characters | -| [Eleven V3](/zh/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 对话 / 语音合成 | 21.1 / 1K characters | -| [Eleven V4](/zh/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 对话 | 24.1384 / 1K characters | -| [Eleven V4 Turbo](/zh/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 对话 | 12.0692 / 1K characters | +| [Eleven Multilingual V2](/zh/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 语音合成 | 50.64 / 1K 字符 | +| [Eleven V3](/zh/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 对话 / 语音合成 | 21.1 / 1K 字符 | +| [Eleven V4](/zh/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 对话 | 24.1384 / 1K 字符 | +| [Eleven V4 Turbo](/zh/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 对话 | 12.0692 / 1K 字符 | #### 按时长计费 | 名称 | 模型 ID | 积分 | | --- | --- | ---: | | [Eleven Sfx V2](/zh/development/comfy-router/models/elevenlabs/eleven-sfx-v2/code) | `elevenlabs/eleven_sfx_v2` | 29.54 / 分钟 | -| [Pika Music](/zh/development/comfy-router/models) | `pika/pika-music` | 4.52595 / 分钟 | -| [Pika Sfx](/zh/development/comfy-router/models) | `pika/pika-sfx` | 0.060346 / s | +| [Pika Music](/zh/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | 4.52595 / 分钟 | +| [Pika Sfx](/zh/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | 0.060346 / s | | [Seed Audio 1.0](/zh/development/comfy-router/models/byteplus/seed-audio-1-0/code) | `byteplus/seed-audio-1.0` | 0.7543 / s | | [Seed Audio 1.0 Multilingual](/zh/development/comfy-router/models/byteplus/seed-audio-1-0-multilingual/code) | `byteplus/seed-audio-1.0-multilingual` | 0.7543 / s | | [Starfish](/zh/development/comfy-router/models/heygen/starfish/code) | `heygen/starfish` | 0.2013 / s | @@ -820,26 +820,26 @@ Comfy 的按用量计费费率按 GPU 秒计算。实际费用取决于 GPU 运 | [Qwen Image 3.0 Pro](/zh/development/comfy-router/models/qwen/qwen-image-3-0-pro/code) | `qwen/qwen-image-3.0-pro` | 输入图像 · 1K / 2K | $0.00429 / 输入图像 | | [Seedream 5.0 Pro](/zh/development/comfy-router/models/byteplus/seedream-5-0-pro-260628/code) | `byteplus/seedream-5-0-pro-260628` | 首张之后的输入图像 | $0.003 / 输入图像 | -#### 每 Recraft credit费率 +#### 每 Recraft 积分费率 | 名称 | 模型 ID | USD | | --- | --- | ---: | -| [Recraft V2](/zh/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | $0.00143 / Recraft credit | -| [Recraft V3](/zh/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | $0.00143 / Recraft credit | -| [Recraft V4](/zh/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | $0.00143 / Recraft credit | -| [Recraft V4 Pro](/zh/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | $0.00143 / Recraft credit | -| [Recraft V4 Styles](/zh/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Pro](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4 Styles Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1](/zh/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | $0.00143 / Recraft credit | -| [Recraft V4.1 Pro](/zh/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | $0.00143 / Recraft credit | -| [Recraft V4.1 Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility](/zh/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Pro](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Utility Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | $0.00143 / Recraft credit | -| [Recraft V4.1 Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | $0.00143 / Recraft credit | +| [Recraft V2](/zh/development/comfy-router/models/recraft/recraftv2/code) | `recraft/recraftv2` | $0.00143 / Recraft 积分 | +| [Recraft V3](/zh/development/comfy-router/models/recraft/recraftv3/code) | `recraft/recraftv3` | $0.00143 / Recraft 积分 | +| [Recraft V4](/zh/development/comfy-router/models/recraft/recraftv4/code) | `recraft/recraftv4` | $0.00143 / Recraft 积分 | +| [Recraft V4 Pro](/zh/development/comfy-router/models/recraft/recraftv4-pro/code) | `recraft/recraftv4_pro` | $0.00143 / Recraft 积分 | +| [Recraft V4 Styles](/zh/development/comfy-router/models/recraft/recraftv4-styles/code) | `recraft/recraftv4_styles` | $0.00143 / Recraft 积分 | +| [Recraft V4 Styles Pro](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro/code) | `recraft/recraftv4_styles_pro` | $0.00143 / Recraft 积分 | +| [Recraft V4 Styles Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-pro-vector/code) | `recraft/recraftv4_styles_pro_vector` | $0.00143 / Recraft 积分 | +| [Recraft V4 Styles Vector](/zh/development/comfy-router/models/recraft/recraftv4-styles-vector/code) | `recraft/recraftv4_styles_vector` | $0.00143 / Recraft 积分 | +| [Recraft V4.1](/zh/development/comfy-router/models/recraft/recraftv4-1/code) | `recraft/recraftv4_1` | $0.00143 / Recraft 积分 | +| [Recraft V4.1 Pro](/zh/development/comfy-router/models/recraft/recraftv4-1-pro/code) | `recraft/recraftv4_1_pro` | $0.00143 / Recraft 积分 | +| [Recraft V4.1 Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-pro-vector/code) | `recraft/recraftv4_1_pro_vector` | $0.00143 / Recraft 积分 | +| [Recraft V4.1 Utility](/zh/development/comfy-router/models/recraft/recraftv4-1-utility/code) | `recraft/recraftv4_1_utility` | $0.00143 / Recraft 积分 | +| [Recraft V4.1 Utility Pro](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-pro/code) | `recraft/recraftv4_1_utility_pro` | $0.00143 / Recraft 积分 | +| [Recraft V4.1 Utility Pro Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-pro-vector/code) | `recraft/recraftv4_1_utility_pro_vector` | $0.00143 / Recraft 积分 | +| [Recraft V4.1 Utility Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-utility-vector/code) | `recraft/recraftv4_1_utility_vector` | $0.00143 / Recraft 积分 | +| [Recraft V4.1 Vector](/zh/development/comfy-router/models/recraft/recraftv4-1-vector/code) | `recraft/recraftv4_1_vector` | $0.00143 / Recraft 积分 | #### 每参考图像费率 @@ -1081,7 +1081,7 @@ Ray 3.2 的 EXR 导出暂不可用。HDR 请求请勿启用 `exr_export`。HDR | --- | --- | --- | ---: | | [Aleph 2](/zh/development/comfy-router/models/runway/aleph2/code) | `runway/aleph2` | - | $0.4004 / s | | [Gen 4 Turbo](/zh/development/comfy-router/models/runway/gen4-turbo/code) | `runway/gen4_turbo` | - | $0.0715 / s | -| [Pika Soundtrack](/zh/development/comfy-router/models) | `pika/pika-soundtrack` | Input video | $0.00715 / s | +| [Pika Soundtrack](/zh/development/comfy-router/models/pika/pika-soundtrack/code) | `pika/pika-soundtrack` | Input video | $0.00715 / s | | [Sync 3](/zh/development/comfy-router/models/synclabs/sync-3/code) | `synclabs/sync-3` | - | $0.19019 / s | | [Erase](/zh/development/comfy-router/models/bria/video-edit-erase/code) | `bria/video-edit-erase` | - | $0.06435 / s | | [Green Screen](/zh/development/comfy-router/models/bria/video-edit-green-screen/code) | `bria/video-edit-green-screen` | - | $0.05 / s | @@ -1285,8 +1285,8 @@ Comfy 的按用量计费费率按 GPU 秒计算。实际费用取决于 GPU 运 | [Google Gemini](/zh/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-2.5-pro` | - | 音频 / 图像 / 文本 / 视频: $1.25 | 文本: $10.00 | | [Google Gemini](/zh/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.1-pro-preview` | - | 音频 / 图像 / 文本 / 视频: $2.00 | 文本 / 推理: $12.00
图像: $120.00 | | [Google Gemini](/zh/development/comfy-router/models/google/gemini/code) | `vertexai/gemini-3.5-flash` | - | 音频 / 图像 / 文本 / 视频: $1.50 | 文本 / 推理: $9.00 | -| [GPT 6.1 Sol](/zh/development/comfy-router/models) | `openai/gpt-6.1-sol` | 读取: $0.143
写入: $3.575 | 文本: $2.86 | 文本: $14.30 | -| [GPT 6.1 Terra](/zh/development/comfy-router/models) | `openai/gpt-6.1-terra` | 读取: $0.0715
写入: $1.7875 | 文本: $1.43 | 文本: $7.15 | +| [GPT 6.1 Sol](/zh/development/comfy-router/models/openai/gpt-6-1-sol/code) | `openai/gpt-6.1-sol` | 读取: $0.143
写入: $3.575 | 文本: $2.86 | 文本: $14.30 | +| [GPT 6.1 Terra](/zh/development/comfy-router/models/openai/gpt-6-1-terra/code) | `openai/gpt-6.1-terra` | 读取: $0.0715
写入: $1.7875 | 文本: $1.43 | 文本: $7.15 | | [GPT 6 Astra](/zh/development/comfy-router/models/openai/gpt-6-astra/code) | `openai/gpt-6-astra` | 读取: $1.43
写入: $17.875 | 文本: $14.30 | 文本: $71.50 | | [GPT 6 Luna](/zh/development/comfy-router/models/openai/gpt-6-luna/code) | `openai/gpt-6-luna` | 读取: $0.0143
写入: $0.17875 | 文本: $0.143 | 文本: $0.715 | | [GPT 6 Sol](/zh/development/comfy-router/models/openai/gpt-6-sol/code) | `openai/gpt-6-sol` | 读取: $0.286
写入: $3.575 | 文本: $2.86 | 文本: $14.30 | @@ -1331,22 +1331,22 @@ Comfy 的按用量计费费率按 GPU 秒计算。实际费用取决于 GPU 运 | --- | --- | ---: | | [Clean Audio](/zh/development/comfy-router/models/veed/clean-audio/code) | `veed/clean-audio` | 未发布 | -#### 每1K characters费率 +#### 每1K 字符费率 | 名称 | 模型 ID | 选项 | USD | | --- | --- | --- | ---: | -| [Eleven Multilingual V2](/zh/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 语音合成 | $0.24 / 1K characters | -| [Eleven V3](/zh/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 对话 / 语音合成 | $0.10 / 1K characters | -| [Eleven V4](/zh/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 对话 | $0.1144 / 1K characters | -| [Eleven V4 Turbo](/zh/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 对话 | $0.0572 / 1K characters | +| [Eleven Multilingual V2](/zh/development/comfy-router/models/elevenlabs/eleven-multilingual-v2/code) | `elevenlabs/eleven_multilingual_v2` | 语音合成 | $0.24 / 1K 字符 | +| [Eleven V3](/zh/development/comfy-router/models/elevenlabs/eleven-v3/code) | `elevenlabs/eleven_v3` | 对话 / 语音合成 | $0.10 / 1K 字符 | +| [Eleven V4](/zh/development/comfy-router/models/elevenlabs/eleven-v4/code) | `elevenlabs/eleven_v4` | 对话 | $0.1144 / 1K 字符 | +| [Eleven V4 Turbo](/zh/development/comfy-router/models/elevenlabs/eleven-v4-turbo/code) | `elevenlabs/eleven_v4_turbo` | 对话 | $0.0572 / 1K 字符 | #### 按时长计费 | 名称 | 模型 ID | USD | | --- | --- | ---: | | [Eleven Sfx V2](/zh/development/comfy-router/models/elevenlabs/eleven-sfx-v2/code) | `elevenlabs/eleven_sfx_v2` | $0.14 / 分钟 | -| [Pika Music](/zh/development/comfy-router/models) | `pika/pika-music` | $0.02145 / 分钟 | -| [Pika Sfx](/zh/development/comfy-router/models) | `pika/pika-sfx` | $0.000286 / s | +| [Pika Music](/zh/development/comfy-router/models/pika/pika-music/code) | `pika/pika-music` | $0.02145 / 分钟 | +| [Pika Sfx](/zh/development/comfy-router/models/pika/pika-sfx/code) | `pika/pika-sfx` | $0.000286 / s | | [Seed Audio 1.0](/zh/development/comfy-router/models/byteplus/seed-audio-1-0/code) | `byteplus/seed-audio-1.0` | $0.003575 / s | | [Seed Audio 1.0 Multilingual](/zh/development/comfy-router/models/byteplus/seed-audio-1-0-multilingual/code) | `byteplus/seed-audio-1.0-multilingual` | $0.003575 / s | | [Starfish](/zh/development/comfy-router/models/heygen/starfish/code) | `heygen/starfish` | $0.000954 / s |