Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / inference-providers /pr_2713 /en /tasks /text-generation.html

HuggingFaceDocBuilder

12 days ago

download

raw

41 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Text Generation","local":"text-generation","sections":[{"title":"Recommended models","local":"recommended-models","sections":[],"depth":3},{"title":"Using the API","local":"using-the-api","sections":[],"depth":3},{"title":"API specification","local":"api-specification","sections":[{"title":"Request","local":"request","sections":[],"depth":4},{"title":"Response","local":"response","sections":[],"depth":4}],"depth":3}],"depth":2}"/>
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/entry/start.Yrr5IqWF.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/chunks/8egz5TIQ.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/chunks/D1YZhoAV.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/entry/app.DLm95-7q.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/chunks/Bee_Vm2K.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/chunks/gYW7_7FM.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/chunks/CGX_pgXJ.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/chunks/DsnmJJEf.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/nodes/0._NE7fJvp.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/chunks/B5z72ZVn.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/nodes/62.Cicb7ObZ.js" rel="modulepreload">
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/chunks/9o5l2gGg.js" rel="modulepreload">
	<!--123xr5m--><meta name="hf:doc:metadata" content="{"title":"Text Generation","local":"text-generation","sections":[{"title":"Recommended models","local":"recommended-models","sections":[],"depth":3},{"title":"Using the API","local":"using-the-api","sections":[],"depth":3},{"title":"API specification","local":"api-specification","sections":[{"title":"Request","local":"request","sections":[],"depth":4},{"title":"Response","local":"response","sections":[],"depth":4}],"depth":3}],"depth":2}"/><!---->
	<link href="/docs/inference-providers/pr_2713/en/_app/immutable/assets/0.tn0RQdqM.css" rel="modulepreload"> <!--[--><!--[0--><!--[--><!--[0--><!--[--><p></p> <!--[1--><h2 class="relative group"><a id="text-generation" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#text-generation"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Text Generation</span></h2><!--]--><!----> <p>Generate text based on a prompt.</p> <p>If you are interested in a Chat Completion task, which generates a response based on a list of messages, check out the <a href="./chat-completion"><code>chat-completion</code></a> task.</p> <blockquote class="tip"><p>For more details about the <code>text-generation</code> task, check out its <a href="https://huggingface.co/tasks/text-generation" rel="nofollow">dedicated page</a>! You will find examples and related materials.</p></blockquote> <!--[2--><h3 class="relative group"><a id="recommended-models" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#recommended-models"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Recommended models</span></h3><!--]--><!----> <ul><li><a href="https://huggingface.co/google/gemma-2-2b-it" rel="nofollow">google/gemma-2-2b-it</a>: A text-generation model trained to follow instructions.</li> <li><a href="https://huggingface.co/Qwen/Qwen3-Coder-480B-A35B-Instruct" rel="nofollow">Qwen/Qwen3-Coder-480B-A35B-Instruct</a>: Powerful text generation model for coding.</li> <li><a href="https://huggingface.co/openai/gpt-oss-120b" rel="nofollow">openai/gpt-oss-120b</a>: Great text generation model with top-notch tool calling capabilities.</li> <li><a href="https://huggingface.co/Qwen/Qwen3-4B-Thinking-2507" rel="nofollow">Qwen/Qwen3-4B-Thinking-2507</a>: A powerful small model with reasoning capabilities.</li> <li><a href="https://huggingface.co/Qwen/Qwen2.5-7B-Instruct-1M" rel="nofollow">Qwen/Qwen2.5-7B-Instruct-1M</a>: Strong conversational model that supports very long instructions.</li> <li><a href="https://huggingface.co/Qwen/Qwen2.5-Coder-32B-Instruct" rel="nofollow">Qwen/Qwen2.5-Coder-32B-Instruct</a>: Text generation model used to write code.</li> <li><a href="https://huggingface.co/deepseek-ai/DeepSeek-R1" rel="nofollow">deepseek-ai/DeepSeek-R1</a>: Powerful reasoning based open large language model.</li></ul> <p>Explore all available models and find the one that suits you best <a href="https://huggingface.co/models?inference=warm&pipeline_tag=text-generation&sort=trending" rel="nofollow">here</a>, or from the terminal with the <a href="https://huggingface.co/docs/huggingface_hub/package_reference/cli#hf-models-list" rel="nofollow"><code>hf</code> CLI</a>:</p> <div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class="language-bash "><!---->hf models <span class="hljs-built_in">ls</span> --warm --pipeline-tag text-generation --<span class="hljs-built_in">sort</span> trending_score<!----></pre></div><!----> <!--[2--><h3 class="relative group"><a id="using-the-api" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#using-the-api"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Using the API</span></h3><!--]--><!----> <div class="md:items-top not-prose flex w-full flex-col justify-between gap-x-2 text-sm md:flex-row"><!--[0--><div><p class="hidden font-mono text-xs opacity-50 md:block">Language</p> <div class="my-1.5 flex flex-wrap items-center gap-x-1 gap-y-0.5"><!--[--><button class="text-md flex select-none items-center rounded-lg border px-1.5 py-1 leading-none border-gray-800 bg-black text-white dark:bg-gray-700" type="button"><!--[0--><!--[--><svg class="mr-1.5 text-current" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M15.84.5a16.4,16.4,0,0,0-3.57.32C9.1,1.39,8.53,2.53,8.53,4.64V7.48H16v1H5.77a4.73,4.73,0,0,0-4.7,3.74,14.82,14.82,0,0,0,0,7.54c.57,2.28,1.86,3.82,4,3.82h2.6V20.14a4.73,4.73,0,0,1,4.63-4.63h7.38a3.72,3.72,0,0,0,3.73-3.73V4.64A4.16,4.16,0,0,0,19.65.82,20.49,20.49,0,0,0,15.84.5ZM11.78,2.77a1.39,1.39,0,0,1,1.38,1.46,1.37,1.37,0,0,1-1.38,1.38A1.42,1.42,0,0,1,10.4,4.23,1.44,1.44,0,0,1,11.78,2.77Z" fill="#5a9fd4"></path><path d="M16.16,31.5a16.4,16.4,0,0,0,3.57-.32c3.17-.57,3.74-1.71,3.74-3.82V24.52H16v-1H26.23a4.73,4.73,0,0,0,4.7-3.74,14.82,14.82,0,0,0,0-7.54c-.57-2.28-1.86-3.82-4-3.82h-2.6v3.41a4.73,4.73,0,0,1-4.63,4.63H12.35a3.72,3.72,0,0,0-3.73,3.73v7.14a4.16,4.16,0,0,0,3.73,3.82A20.49,20.49,0,0,0,16.16,31.5Zm4.06-2.27a1.39,1.39,0,0,1-1.38-1.46,1.37,1.37,0,0,1,1.38-1.38,1.42,1.42,0,0,1,1.38,1.38A1.44,1.44,0,0,1,20.22,29.23Z" fill="#ffd43b"></path></svg><!--]--><!--]--> Python</button><button class="text-md flex select-none items-center rounded-lg border px-1.5 py-1 leading-none hover:shadow-xs cursor-pointer text-gray-500 opacity-90 hover:text-gray-700 dark:hover:text-gray-200" type="button"><!--[0--><!--[--><svg class="mr-1.5 text-current" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><rect width="32" height="32" fill="#f7df1e"></rect><path d="M21.5,25a3.27,3.27,0,0,0,3,1.83c1.25,0,2-.63,2-1.49,0-1-.81-1.39-2.19-2L23.56,23C21.39,22.1,20,20.94,20,18.49c0-2.25,1.72-4,4.41-4a4.44,4.44,0,0,1,4.27,2.41l-2.34,1.5a2,2,0,0,0-1.93-1.29,1.31,1.31,0,0,0-1.44,1.29c0,.9.56,1.27,1.85,1.83l.75.32c2.55,1.1,4,2.21,4,4.72,0,2.71-2.12,4.19-5,4.19a5.78,5.78,0,0,1-5.48-3.07Zm-10.63.26c.48.84.91,1.55,1.94,1.55s1.61-.39,1.61-1.89V14.69h3V25c0,3.11-1.83,4.53-4.49,4.53a4.66,4.66,0,0,1-4.51-2.75Z"></path></svg><!--]--><!--]--> JavaScript</button><button class="text-md flex select-none items-center rounded-lg border px-1.5 py-1 leading-none hover:shadow-xs cursor-pointer text-gray-500 opacity-90 hover:text-gray-700 dark:hover:text-gray-200" type="button"><!--[0--><!--[--><svg class="mr-1.5 text-current" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><rect width="32" height="32" rx="4" fill="#1683a5"></rect><path d="M6.71,14A5,5,0,0,1,8.82,9.29l2.64-2.2c1.67-1.37,2.52-1.41,4.6-1.41H21.7c1.19,0,2.45.27,2.45,1.79s-1.4,1.78-2.45,1.78H15.44a3.31,3.31,0,0,0-2,.89L11.24,12c-.55.44-1,.81-1,1.52v4.41c0,.7.41,1.07,1,1.52l2.16,1.82a3.34,3.34,0,0,0,2,.89H21.7c1.05,0,2.45.23,2.45,1.78s-1.26,1.78-2.45,1.78H16.06c-2.08,0-2.94,0-4.6-1.4L8.82,22.09A5.05,5.05,0,0,1,6.71,17.4Z" fill="#fff"></path></svg><!--]--><!--]--> cURL</button><!--]--></div></div><!--]--> <!--[0--><div><p class="hidden font-mono text-xs opacity-50 md:block">Client</p> <div class="my-1.5 flex flex-wrap items-center gap-x-1 gap-y-0.5"><!--[--><button class="text-md flex select-none items-center rounded-lg border px-1.5 py-1 leading-none border-gray-800 bg-black text-white dark:bg-gray-700" type="button">openai</button><button class="text-md flex select-none items-center rounded-lg border px-1.5 py-1 leading-none hover:shadow-xs cursor-pointer text-gray-500 opacity-90 hover:text-gray-700 dark:hover:text-gray-200" type="button">huggingface_hub</button><button class="text-md flex select-none items-center rounded-lg border px-1.5 py-1 leading-none hover:shadow-xs cursor-pointer text-gray-500 opacity-90 hover:text-gray-700 dark:hover:text-gray-200" type="button">requests</button><!--]--></div></div><!--]--> <!--[0--><div><p class="hidden font-mono text-xs opacity-50 md:block">Provider</p> <div class="my-1.5 flex flex-wrap items-center gap-x-1 gap-y-0.5"><!--[--><button class="text-md flex select-none items-center rounded-lg border px-1.5 py-1 leading-none border-gray-800 bg-black text-white dark:bg-gray-700" type="button"><!--[0--><!--[--><svg class="mr-1.5 text-current" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 26 26"><svg width="26" height="26" viewBox="0 0 26 26" fill="none" xmlns="http://www.w3.org/2000/svg"><rect x="2.43628" y="2.43652" width="21.1274" height="21.1274" rx="3.54011" fill="#0C0A09"></rect><path d="M21.0962 6.7616C20.2483 6.2632 19.1029 6 17.7812 6C15.7596 6 13.5312 6.6139 11.5294 7.6821L11.5152 7.6772L11.5124 7.6919C10.9068 8.0167 10.3196 8.3786 9.7685 8.7825C6.52079 11.1632 5.61129 13.9884 6.37912 15.499C5.53833 16.8794 5.02125 18.3081 5 20C6.615 17.0369 7.584 14.6359 12.8455 10.5934C11.3424 10.9035 8.74425 12.3749 6.99608 14.6079C6.83104 13.3017 7.90275 11.1926 10.2898 9.4426C10.593 9.2214 10.9068 9.0142 11.2277 8.8175C10.9769 9.5672 11.0577 9.381 10.537 10.4324C11.3063 9.7317 11.812 9.2984 12.5721 8.0979C13.5368 7.63815 14.5536 7.29388 15.6009 7.0724C15.4323 7.6093 15.1122 8.5193 14.6787 9.2389C14.6787 9.2389 15.7787 9.0121 16.6882 9.0639C16.1917 9.591 15.744 10.1622 15.2907 10.746C14.6702 11.5454 14.0284 12.3714 13.206 13.1407C13.1069 13.2338 13.0127 13.3178 12.917 13.4046C11.6534 13.2877 10.8197 13.7427 10.0377 14.5456C10.6539 14.2691 11.4827 14.0416 12.0012 14.1788C11.0449 14.9299 9.53829 15.9197 8.30083 15.8378C8.06567 16.1822 8.05079 16.1927 7.79296 16.6078C9.80108 17.0894 12.3227 15.1252 13.8067 13.7357C14.6772 12.9209 15.3402 12.0676 15.9813 11.2437C17.3002 9.5448 18.4399 8.0776 20.968 7.5197L22 7.2922L21.0962 6.7616Z" fill="#FFE184"></path></svg></svg><!--]--><!--]--> Featherless</button><!--]--> <!--[-1--><!--]--></div></div><!--]--> <div><p class="invisible hidden font-mono text-xs md:block">Settings</p> <div class="not-prose my-1.5 flex"><div class="relative hidden md:block "><button class=" " type="button"><!--[0--><!--[-1--><button class="text-md hover:shadow-xs flex cursor-pointer select-none items-center rounded-lg border px-1.5 py-1 leading-none text-gray-500 opacity-90 hover:text-gray-700 dark:hover:text-gray-200" type="button" title="Settings dropdown"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 9 7"><path fill="currentColor" d="M8.537 1.153H7.361A1.445 1.445 0 0 0 5.954 0c-.689 0-1.263.49-1.407 1.153H.5v.576h4.047a1.445 1.445 0 0 0 1.407 1.153c.689 0 1.263-.49 1.407-1.153h1.176v-.576M5.954 2.305a.847.847 0 0 1-.861-.864c0-.49.373-.865.861-.865s.861.375.861.865-.373.864-.861.864M.5 5.764h1.177a1.445 1.445 0 0 0 1.406 1.152c.69 0 1.263-.49 1.407-1.152h4.047v-.577H4.49a1.445 1.445 0 0 0-1.407-1.152c-.688 0-1.263.49-1.406 1.152H.5v.577M3.083 4.61c.488 0 .862.375.862.864 0 .49-.374.865-.862.865a.847.847 0 0 1-.86-.865c0-.49.372-.864.86-.864"></path></svg><!----> Settings</button><!--]--><!----><!--]--></button> <!--[-1--><!--]--></div><!----> <div class="relative md:hidden "><button class=" " type="button"><!--[0--><!--[-1--><button class="text-md hover:shadow-xs flex cursor-pointer select-none items-center rounded-lg border px-1.5 py-1 leading-none text-gray-500 opacity-90 hover:text-gray-700 dark:hover:text-gray-200" type="button" title="Settings dropdown"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 9 7"><path fill="currentColor" d="M8.537 1.153H7.361A1.445 1.445 0 0 0 5.954 0c-.689 0-1.263.49-1.407 1.153H.5v.576h4.047a1.445 1.445 0 0 0 1.407 1.153c.689 0 1.263-.49 1.407-1.153h1.176v-.576M5.954 2.305a.847.847 0 0 1-.861-.864c0-.49.373-.865.861-.865s.861.375.861.865-.373.864-.861.864M.5 5.764h1.177a1.445 1.445 0 0 0 1.406 1.152c.69 0 1.263-.49 1.407-1.152h4.047v-.577H4.49a1.445 1.445 0 0 0-1.407-1.152c-.688 0-1.263.49-1.406 1.152H.5v.577M3.083 4.61c.488 0 .862.375.862.864 0 .49-.374.865-.862.865a.847.847 0 0 1-.86-.865c0-.49.372-.864.86-.864"></path></svg><!----> Settings</button><!--]--><!----><!--]--></button> <!--[-1--><!--]--></div><!----> <div class="flex-grow md:hidden"></div></div></div></div> <!--[0--><div class="code-block relative "><div class="absolute top-2.5 right-4"><button class="inline-flex items-center relative text-sm focus:text-green-500 cursor-pointer focus:outline-none transition duration-200 ease-in-out opacity-0 mx-0.5 text-gray-600 " title="code excerpt" type="button"><svg xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M28,10V28H10V10H28m0-2H10a2,2,0,0,0-2,2V28a2,2,0,0,0,2,2H28a2,2,0,0,0,2-2V10a2,2,0,0,0-2-2Z" transform="translate(0)"></path><path d="M4,18H2V4A2,2,0,0,1,4,2H18V4H4Z" transform="translate(0)"></path><rect fill="none" width="32" height="32"></rect></svg><!----> <div class=" absolute pointer-events-none transition-opacity bg-black text-white py-1 px-2 leading-tight rounded font-normal shadow left-1/2 top-full transform -translate-x-1/2 translate-y-2 opacity-0 "><div class="absolute bottom-full left-1/2 transform -translate-x-1/2 w-0 h-0 border-black border-4 border-t-0" style="border-left-color: transparent; border-right-color: transparent;"></div> Copied</div><!----></button><!----></div> <pre class=" "><!----><span class="hljs-keyword">import</span> os
	<span class="hljs-keyword">from</span> openai <span class="hljs-keyword">import</span> OpenAI

	client = OpenAI(
	base_url=<span class="hljs-string">"https://router.huggingface.co/featherless-ai/v1/completions"</span>,
	api_key=os.environ[<span class="hljs-string">"HF_TOKEN"</span>],
	)

	completion = client.chat.completions.create(
	model=<span class="hljs-string">"poolside/Laguna-S-2.1"</span>,
	messages=<span class="hljs-string">"\"Can you please let us know more details about your \""</span>,
	)

	<span class="hljs-built_in">print</span>(completion.choices[<span class="hljs-number">0</span>].message)<!----></pre></div><!--]--><!----> <!--[2--><h3 class="relative group"><a id="api-specification" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#api-specification"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>API specification</span></h3><!--]--><!----> <!--[3--><h4 class="relative group"><a id="request" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#request"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Request</span></h4><!--]--><!----> <table><thead><tr><th align="left">Headers</th><th align="left"></th><th align="left"></th></tr></thead><tbody><tr><td align="left"><strong>authorization</strong></td><td align="left"><em>string</em></td><td align="left">Authentication header in the form <code>'Bearer: hf_**'</code> when <code>hf_*</code> is a personal user access token with “Inference Providers” permission. You can generate one from <a href="https://huggingface.co/settings/tokens/new?ownUserPermissions=inference.serverless.write&tokenType=fineGrained" rel="nofollow">your settings page</a>.</td></tr></tbody></table> <table><thead><tr><th align="left">Payload</th><th align="left"></th><th align="left"></th></tr></thead><tbody><tr><td align="left"><strong>inputs</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong>parameters</strong></td><td align="left"><em>object</em></td><td align="left"></td></tr><tr><td align="left"><strong> adapter_id</strong></td><td align="left"><em>string</em></td><td align="left">Lora adapter id</td></tr><tr><td align="left"><strong> best_of</strong></td><td align="left"><em>integer</em></td><td align="left">Generate best_of sequences and return the one if the highest token logprobs.</td></tr><tr><td align="left"><strong> decoder_input_details</strong></td><td align="left"><em>boolean</em></td><td align="left">Whether to return decoder input token logprobs and ids.</td></tr><tr><td align="left"><strong> details</strong></td><td align="left"><em>boolean</em></td><td align="left">Whether to return generation details.</td></tr><tr><td align="left"><strong> do_sample</strong></td><td align="left"><em>boolean</em></td><td align="left">Activate logits sampling.</td></tr><tr><td align="left"><strong> frequency_penalty</strong></td><td align="left"><em>number</em></td><td align="left">The parameter for frequency penalty. 1.0 means no penalty Penalize new tokens based on their existing frequency in the text so far, decreasing the model’s likelihood to repeat the same line verbatim.</td></tr><tr><td align="left"><strong> grammar</strong></td><td align="left"><em>unknown</em></td><td align="left">One of the following:</td></tr><tr><td align="left"><strong> (#1)</strong></td><td align="left"><em>object</em></td><td align="left"></td></tr><tr><td align="left"><strong> type</strong></td><td align="left"><em>enum</em></td><td align="left">Possible values: json.</td></tr><tr><td align="left"><strong> value</strong></td><td align="left"><em>unknown</em></td><td align="left">A string that represents a <a href="https://json-schema.org/" rel="nofollow">JSON Schema</a>. JSON Schema is a declarative language that allows to annotate JSON documents with types and descriptions.</td></tr><tr><td align="left"><strong> (#2)</strong></td><td align="left"><em>object</em></td><td align="left"></td></tr><tr><td align="left"><strong> type</strong></td><td align="left"><em>enum</em></td><td align="left">Possible values: regex.</td></tr><tr><td align="left"><strong> value</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong> (#3)</strong></td><td align="left"><em>object</em></td><td align="left"></td></tr><tr><td align="left"><strong> type</strong></td><td align="left"><em>enum</em></td><td align="left">Possible values: json_schema.</td></tr><tr><td align="left"><strong> value</strong></td><td align="left"><em>object</em></td><td align="left"></td></tr><tr><td align="left"><strong> name</strong></td><td align="left"><em>string</em></td><td align="left">Optional name identifier for the schema</td></tr><tr><td align="left"><strong> schema*</strong></td><td align="left"><em>unknown</em></td><td align="left">The actual JSON schema definition</td></tr><tr><td align="left"><strong> max_new_tokens</strong></td><td align="left"><em>integer</em></td><td align="left">Maximum number of tokens to generate.</td></tr><tr><td align="left"><strong> repetition_penalty</strong></td><td align="left"><em>number</em></td><td align="left">The parameter for repetition penalty. 1.0 means no penalty. See <a href="https://arxiv.org/pdf/1909.05858.pdf" rel="nofollow">this paper</a> for more details.</td></tr><tr><td align="left"><strong> return_full_text</strong></td><td align="left"><em>boolean</em></td><td align="left">Whether to prepend the prompt to the generated text</td></tr><tr><td align="left"><strong> seed</strong></td><td align="left"><em>integer</em></td><td align="left">Random sampling seed.</td></tr><tr><td align="left"><strong> stop</strong></td><td align="left"><em>string[]</em></td><td align="left">Stop generating tokens if a member of <code>stop</code> is generated.</td></tr><tr><td align="left"><strong> temperature</strong></td><td align="left"><em>number</em></td><td align="left">The value used to module the logits distribution.</td></tr><tr><td align="left"><strong> top_k</strong></td><td align="left"><em>integer</em></td><td align="left">The number of highest probability vocabulary tokens to keep for top-k-filtering.</td></tr><tr><td align="left"><strong> top_n_tokens</strong></td><td align="left"><em>integer</em></td><td align="left">The number of highest probability vocabulary tokens to keep for top-n-filtering.</td></tr><tr><td align="left"><strong> top_p</strong></td><td align="left"><em>number</em></td><td align="left">Top-p value for nucleus sampling.</td></tr><tr><td align="left"><strong> truncate</strong></td><td align="left"><em>integer</em></td><td align="left">Truncate inputs tokens to the given size.</td></tr><tr><td align="left"><strong> typical_p</strong></td><td align="left"><em>number</em></td><td align="left">Typical Decoding mass See <a href="https://arxiv.org/abs/2202.00666" rel="nofollow">Typical Decoding for Natural Language Generation</a> for more information.</td></tr><tr><td align="left"><strong> watermark</strong></td><td align="left"><em>boolean</em></td><td align="left">Watermarking with <a href="https://arxiv.org/abs/2301.10226" rel="nofollow">A Watermark for Large Language Models</a>.</td></tr><tr><td align="left"><strong>stream</strong></td><td align="left"><em>boolean</em></td><td align="left"></td></tr></tbody></table> <!--[3--><h4 class="relative group"><a id="response" class="header-link block pr-1.5 text-lg no-hover:hidden with-hover:absolute with-hover:p-1.5 with-hover:opacity-0 with-hover:group-hover:opacity-100 with-hover:right-full" href="#response"><span><svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" aria-hidden="true" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 256 256"><path d="M167.594 88.393a8.001 8.001 0 0 1 0 11.314l-67.882 67.882a8 8 0 1 1-11.314-11.315l67.882-67.881a8.003 8.003 0 0 1 11.314 0zm-28.287 84.86l-28.284 28.284a40 40 0 0 1-56.567-56.567l28.284-28.284a8 8 0 0 0-11.315-11.315l-28.284 28.284a56 56 0 0 0 79.196 79.197l28.285-28.285a8 8 0 1 0-11.315-11.314zM212.852 43.14a56.002 56.002 0 0 0-79.196 0l-28.284 28.284a8 8 0 1 0 11.314 11.314l28.284-28.284a40 40 0 0 1 56.568 56.567l-28.285 28.285a8 8 0 0 0 11.315 11.314l28.284-28.284a56.065 56.065 0 0 0 0-79.196z" fill="currentColor"></path></svg><!----></span></a> <span>Response</span></h4><!--]--><!----> <p>Output type depends on the <code>stream</code> input parameter.
	If <code>stream</code> is <code>false</code> (default), the response will be a JSON object with the following fields:</p> <table><thead><tr><th align="left">Body</th><th align="left"></th><th align="left"></th></tr></thead><tbody><tr><td align="left"><strong>details</strong></td><td align="left"><em>object</em></td><td align="left"></td></tr><tr><td align="left"><strong> best_of_sequences</strong></td><td align="left"><em>object[]</em></td><td align="left"></td></tr><tr><td align="left"><strong> finish_reason</strong></td><td align="left"><em>enum</em></td><td align="left">Possible values: length, eos_token, stop_sequence.</td></tr><tr><td align="left"><strong> generated_text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong> generated_tokens</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> prefill</strong></td><td align="left"><em>object[]</em></td><td align="left"></td></tr><tr><td align="left"><strong> id</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> logprob</strong></td><td align="left"><em>number</em></td><td align="left"></td></tr><tr><td align="left"><strong> text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong> seed</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> tokens</strong></td><td align="left"><em>object[]</em></td><td align="left"></td></tr><tr><td align="left"><strong> id</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> logprob</strong></td><td align="left"><em>number</em></td><td align="left"></td></tr><tr><td align="left"><strong> special</strong></td><td align="left"><em>boolean</em></td><td align="left"></td></tr><tr><td align="left"><strong> text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong> top_tokens</strong></td><td align="left"><em>array[]</em></td><td align="left"></td></tr><tr><td align="left"><strong> id</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> logprob</strong></td><td align="left"><em>number</em></td><td align="left"></td></tr><tr><td align="left"><strong> special</strong></td><td align="left"><em>boolean</em></td><td align="left"></td></tr><tr><td align="left"><strong> text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong> finish_reason</strong></td><td align="left"><em>enum</em></td><td align="left">Possible values: length, eos_token, stop_sequence.</td></tr><tr><td align="left"><strong> generated_tokens</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> prefill</strong></td><td align="left"><em>object[]</em></td><td align="left"></td></tr><tr><td align="left"><strong> id</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> logprob</strong></td><td align="left"><em>number</em></td><td align="left"></td></tr><tr><td align="left"><strong> text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong> seed</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> tokens</strong></td><td align="left"><em>object[]</em></td><td align="left"></td></tr><tr><td align="left"><strong> id</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> logprob</strong></td><td align="left"><em>number</em></td><td align="left"></td></tr><tr><td align="left"><strong> special</strong></td><td align="left"><em>boolean</em></td><td align="left"></td></tr><tr><td align="left"><strong> text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong> top_tokens</strong></td><td align="left"><em>array[]</em></td><td align="left"></td></tr><tr><td align="left"><strong> id</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> logprob</strong></td><td align="left"><em>number</em></td><td align="left"></td></tr><tr><td align="left"><strong> special</strong></td><td align="left"><em>boolean</em></td><td align="left"></td></tr><tr><td align="left"><strong> text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong>generated_text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr></tbody></table> <p>If <code>stream</code> is <code>true</code>, generated tokens are returned as a stream, using Server-Sent Events (SSE).
	For more information about streaming, check out <a href="https://huggingface.co/docs/text-generation-inference/conceptual/streaming" rel="nofollow">this guide</a>.</p> <table><thead><tr><th align="left">Body</th><th align="left"></th><th align="left"></th></tr></thead><tbody><tr><td align="left"><strong>details</strong></td><td align="left"><em>object</em></td><td align="left"></td></tr><tr><td align="left"><strong> finish_reason</strong></td><td align="left"><em>enum</em></td><td align="left">Possible values: length, eos_token, stop_sequence.</td></tr><tr><td align="left"><strong> generated_tokens</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> input_length</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> seed</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong>generated_text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong>index</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong>token</strong></td><td align="left"><em>object</em></td><td align="left"></td></tr><tr><td align="left"><strong> id</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> logprob</strong></td><td align="left"><em>number</em></td><td align="left"></td></tr><tr><td align="left"><strong> special</strong></td><td align="left"><em>boolean</em></td><td align="left"></td></tr><tr><td align="left"><strong> text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr><tr><td align="left"><strong>top_tokens</strong></td><td align="left"><em>object[]</em></td><td align="left"></td></tr><tr><td align="left"><strong> id</strong></td><td align="left"><em>integer</em></td><td align="left"></td></tr><tr><td align="left"><strong> logprob</strong></td><td align="left"><em>number</em></td><td align="left"></td></tr><tr><td align="left"><strong> special</strong></td><td align="left"><em>boolean</em></td><td align="left"></td></tr><tr><td align="left"><strong> text</strong></td><td align="left"><em>string</em></td><td align="left"></td></tr></tbody></table> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/hub-docs/blob/main/docs/inference-providers/tasks/text-generation.md" target="_blank"><svg class="mr-1" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" fill="currentColor" focusable="false" role="img" width="1em" height="1em" preserveAspectRatio="xMidYMid meet" viewBox="0 0 32 32"><path d="M31,16l-7,7l-1.41-1.41L28.17,16l-5.58-5.59L24,9l7,7z"></path><path d="M1,16l7-7l1.41,1.41L3.83,16l5.58,5.59L8,23l-7-7z"></path><path d="M12.419,25.484L17.639,6.552l1.932,0.518L14.351,26.002z"></path></svg><!----> <span><span class="underline">Update</span> on GitHub</span></a><!----> <p></p><!--]--><!----><!--]--><!--]--><!--]--> <!--[-1--><!--]--><!--]-->

	<script>
	{
	__sveltekit_1hi8cnu = {
	base: "/docs/inference-providers/pr_2713/en",
	assets: "/docs/inference-providers/pr_2713/en"
	};

	const element = document.currentScript.parentElement;

	Promise.all([
	import("/docs/inference-providers/pr_2713/en/_app/immutable/entry/start.Yrr5IqWF.js"),
	import("/docs/inference-providers/pr_2713/en/_app/immutable/entry/app.DLm95-7q.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 62],
	data: [null,null],
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 41 kB
Xet hash:: 3f0085de529da4004dba47bd6942ebd8f2c53f2926dcccb8a0896db42458b3a6

Xet efficiently stores files, intelligently splitting them into unique chunks and accelerating uploads and downloads. More info.