Buckets:

hf-doc-build
/

doc-dev

Files

xet

hf-doc-build/doc-dev / huggingface.js /pr_2407 /en /inference /modules /snippets.html

HuggingFaceDocBuilder

7 days ago

download

raw

19.4 kB

	<meta charset="utf-8" /><meta name="hf:doc:metadata" content="{"title":"Namespace: snippets","local":"namespace-snippets","sections":[{"title":"Type Aliases","local":"type-aliases","sections":[{"title":"InferenceSnippetOptions","local":"inferencesnippetoptions","sections":[{"title":"Defined in","local":"inferencesnippetoptions.defined-in","sections":[],"depth":4}],"depth":3}],"depth":2},{"title":"Functions","local":"functions","sections":[{"title":"getInferenceSnippets","local":"getinferencesnippets","sections":[{"title":"Parameters","local":"getinferencesnippets.parameters","sections":[],"depth":4},{"title":"Returns","local":"getinferencesnippets.returns","sections":[],"depth":4},{"title":"Defined in","local":"getinferencesnippets.defined-in","sections":[],"depth":4}],"depth":3}],"depth":2}],"depth":1}"/>
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/entry/start.eM26CY71.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/chunks/CCYYiBQd.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/chunks/DFy5I85X.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/entry/app.CY6JZ4dv.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/chunks/CremqiJX.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/chunks/CPAbvujP.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/chunks/DsnmJJEf.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/chunks/DhgwNPpP.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/nodes/0.BcdPWMX4.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/chunks/CQUS8w2G.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/nodes/82.C_aI-g8t.js" rel="modulepreload">
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/chunks/CqGR3rDF.js" rel="modulepreload">
	<!--e4a2td--><meta name="hf:doc:metadata" content="{"title":"Namespace: snippets","local":"namespace-snippets","sections":[{"title":"Type Aliases","local":"type-aliases","sections":[{"title":"InferenceSnippetOptions","local":"inferencesnippetoptions","sections":[{"title":"Defined in","local":"inferencesnippetoptions.defined-in","sections":[],"depth":4}],"depth":3}],"depth":2},{"title":"Functions","local":"functions","sections":[{"title":"getInferenceSnippets","local":"getinferencesnippets","sections":[{"title":"Parameters","local":"getinferencesnippets.parameters","sections":[],"depth":4},{"title":"Returns","local":"getinferencesnippets.returns","sections":[],"depth":4},{"title":"Defined in","local":"getinferencesnippets.defined-in","sections":[],"depth":4}],"depth":3}],"depth":2}],"depth":1}"/><!---->
	<link href="/docs/huggingface.js/pr_2407/en/_app/immutable/assets/0.tn0RQdqM.css" rel="modulepreload"> <!--[--><!--[0--><!--[--><!--[0--><!--[--><p></p> <div class="items-center shrink-0 min-w-[100px] max-sm:min-w-[50px] justify-end ml-auto flex" style="float: right; margin-left: 10px; display: inline-flex; position: relative; z-index: 10;"><div class="inline-flex rounded-md max-sm:rounded-sm"><button class="inline-flex items-center gap-1 h-7 max-sm:h-7 px-2 max-sm:px-1.5 text-sm font-medium text-gray-800 border border-r-0 rounded-l-md max-sm:rounded-l-sm border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-live="polite"><span class="inline-flex items-center justify-center rounded-md p-0.5 max-sm:p-0 hover:text-gray-800 dark:hover:text-gray-200"><svg class="sm:size-3.5 size-3" 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><!----></span> <span>Copy page</span></button> <button class="inline-flex items-center justify-center w-6 max-sm:w-5 h-7 max-sm:h-7 disabled:pointer-events-none text-sm text-gray-500 hover:text-gray-700 dark:hover:text-white rounded-r-md max-sm:rounded-r-sm border border-l transition border-gray-200 bg-white hover:shadow-inner dark:border-gray-850 dark:bg-gray-950 dark:text-gray-200 dark:hover:bg-gray-800" aria-haspopup="menu" aria-expanded="false" aria-label="Open copy menu"><svg class="transition-transform text-gray-400 overflow-visible sm:size-3.5 size-3 rotate-0" width="1em" height="1em" viewBox="0 0 12 7" fill="none" xmlns="http://www.w3.org/2000/svg"><path d="M1 1L6 6L11 1" stroke="currentColor"></path></svg><!----></button></div> <!--[-1--><!--]--></div><!----> <!--[0--><h1 class="relative group"><a id="namespace-snippets" 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="#namespace-snippets"><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>Namespace: snippets</span></h1><!--]--><!----> <!--[1--><h2 class="relative group"><a id="type-aliases" 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="#type-aliases"><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>Type Aliases</span></h2><!--]--><!----> <!--[2--><h3 class="relative group"><a id="inferencesnippetoptions" 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="#inferencesnippetoptions"><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>InferenceSnippetOptions</span></h3><!--]--><!----> <p>Ƭ <strong>InferenceSnippetOptions</strong>: { <code>accessToken?</code>: <code>string</code> ; <code>billTo?</code>: <code>string</code> ; <code>directRequest?</code>: <code>boolean</code> ; <code>endpointUrl?</code>: <code>string</code> ; <code>inputs?</code>: <code>Record</code><<code>string</code>, <code>unknown</code>> ; <code>streaming?</code>: <code>boolean</code> } & <code>Record</code><<code>string</code>, <code>unknown</code>></p> <!--[3--><h4 class="relative group"><a id="inferencesnippetoptions.defined-in" 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="#inferencesnippetoptions.defined-in"><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>Defined in</span></h4><!--]--><!----> <p><a href="https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/snippets/getInferenceSnippets.ts#L18" rel="nofollow">inference/src/snippets/getInferenceSnippets.ts:18</a></p> <!--[1--><h2 class="relative group"><a id="functions" 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="#functions"><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>Functions</span></h2><!--]--><!----> <!--[2--><h3 class="relative group"><a id="getinferencesnippets" 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="#getinferencesnippets"><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>getInferenceSnippets</span></h3><!--]--><!----> <p>▸ <strong>getInferenceSnippets</strong>(<code>model</code>, <code>provider</code>, <code>inferenceProviderMapping?</code>, <code>opts?</code>): <code>InferenceSnippet</code>[]</p> <!--[3--><h4 class="relative group"><a id="getinferencesnippets.parameters" 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="#getinferencesnippets.parameters"><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>Parameters</span></h4><!--]--><!----> <table><thead><tr><th align="left">Name</th><th align="left">Type</th></tr></thead><tbody><tr><td align="left"><code>model</code></td><td align="left"><code>ModelDataMinimal</code></td></tr><tr><td align="left"><code>provider</code></td><td align="left"><code>"baseten"</code> \| <code>"cerebras"</code> \| <code>"cohere"</code> \| <code>"deepinfra"</code> \| <code>"fal-ai"</code> \| <code>"featherless-ai"</code> \| <code>"fireworks-ai"</code> \| <code>"groq"</code> \| <code>"hf-inference"</code> \| <code>"novita"</code> \| <code>"nscale"</code> \| <code>"openai"</code> \| <code>"ovhcloud"</code> \| <code>"publicai"</code> \| <code>"replicate"</code> \| <code>"scaleway"</code> \| <code>"together"</code> \| <code>"wavespeed"</code> \| <code>"zai-org"</code> \| <code>"auto"</code></td></tr><tr><td align="left"><code>inferenceProviderMapping?</code></td><td align="left"><a href="../interfaces/InferenceProviderMappingEntry"><code>InferenceProviderMappingEntry</code></a></td></tr><tr><td align="left"><code>opts?</code></td><td align="left"><code>Record</code><<code>string</code>, <code>unknown</code>></td></tr></tbody></table> <!--[3--><h4 class="relative group"><a id="getinferencesnippets.returns" 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="#getinferencesnippets.returns"><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>Returns</span></h4><!--]--><!----> <p><code>InferenceSnippet</code>[]</p> <!--[3--><h4 class="relative group"><a id="getinferencesnippets.defined-in" 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="#getinferencesnippets.defined-in"><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>Defined in</span></h4><!--]--><!----> <p><a href="https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/snippets/getInferenceSnippets.ts#L421" rel="nofollow">inference/src/snippets/getInferenceSnippets.ts:421</a></p> <a class="!text-gray-400 !no-underline text-sm flex items-center not-prose mt-4" href="https://github.com/huggingface/huggingface.js/blob/main/docs/inference/modules/snippets.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_tmxqcc = {
	base: "/docs/huggingface.js/pr_2407/en",
	assets: "/docs/huggingface.js/pr_2407/en"
	};

	const element = document.currentScript.parentElement;

	Promise.all([
	import("/docs/huggingface.js/pr_2407/en/_app/immutable/entry/start.eM26CY71.js"),
	import("/docs/huggingface.js/pr_2407/en/_app/immutable/entry/app.CY6JZ4dv.js")
	]).then(([kit, app]) => {
	kit.start(app, element, {
	node_ids: [0, 82],
	data: [null,null],
	form: null,
	error: null
	});
	});
	}
	</script>

Xet Storage Details

Size:: 19.4 kB
Xet hash:: c3e9b9eafba6f07a5ac255182d95a8c38f6f5f5e9d98f9f389c9cee6814fd0a8

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