-
Notifications
You must be signed in to change notification settings - Fork 2
Expand file tree
/
Copy pathcreateVertexAiModelProvider.html
More file actions
29 lines (29 loc) · 40.5 KB
/
Copy pathcreateVertexAiModelProvider.html
File metadata and controls
29 lines (29 loc) · 40.5 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
<!DOCTYPE html><html class="default" lang="en"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>createVertexAiModelProvider | generative-ts - v0.1.0-alpha.7</title><meta name="description" content="Documentation for generative-ts"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script defer src="../assets/main.js"></script><script async src="../assets/icons.js" id="tsd-icons-script"></script><script async src="../assets/search.js" id="tsd-search-script"></script><script async src="../assets/navigation.js" id="tsd-nav-script"></script><link rel="stylesheet" href="../assets/style/category-nav.css"/></head><body><script>document.documentElement.dataset.theme = localStorage.getItem("tsd-theme") || "os";document.body.style.display="none";setTimeout(() => app?app.showPage():document.body.style.removeProperty("display"),500)</script><header class="tsd-page-toolbar tsd-navigation__header__toolbar"><div class="tsd-toolbar-contents container"><a href="../index.html" class="title">generative-ts</a><div class="tsd-navigation__header__toolbar__right"><div id="tsd-toolbar-links"></div><div id="tsd-navigation-theme" class="tsd-navigation__header__toolbar__theme"><div class="theme-normal svg-22"><svg class="icon" viewBox="0 0 1024 1024" xmlns="http://www.w3.org/2000/svg" p-id="4180" width="200" height="200"><path d="M512 938.666667c235.648 0 426.666667-191.018667 426.666667-426.666667S747.648 85.333333 512 85.333333 85.333333 276.352 85.333333 512s191.018667 426.666667 426.666667 426.666667z m0-64v-725.333334a362.666667 362.666667 0 0 1 0 725.333334z" fill="currentColor" p-id="4181"></path></svg></div><div class="theme-os svg-20"><svg class="icon" viewBox="0 0 1024 1024" xmlns="http://www.w3.org/2000/svg" p-id="5207" width="200" height="200"><path d="M338.488889 617.244444h-28.444445l-19.911111-54.044444H210.488889l-19.911111 54.044444h-28.444445l73.955556-193.422222h25.6l76.8 193.422222zM284.444444 540.444444l-28.444444-79.644444-2.844444-14.222222-2.844445 14.222222-28.444444 79.644444H284.444444zM509.155556 537.6c0 54.044444-25.6 82.488889-73.955556 82.488889-48.355556 0-71.111111-25.6-71.111111-79.644445v-119.466666h25.6v116.622222c0 39.822222 17.066667 59.733333 48.355555 59.733333s48.355556-19.911111 48.355556-56.888889v-119.466666h25.6l-2.844444 116.622222zM674.133333 443.733333h-56.888889v173.511111h-25.6v-173.511111h-54.044444v-22.755555h136.533333zM676.977778 520.533333c0-31.288889 8.533333-56.888889 25.6-73.955555 17.066667-19.911111 39.822222-28.444444 68.266666-28.444445 25.6 0 48.355556 8.533333 65.422223 28.444445s25.6 42.666667 25.6 71.111111c0 31.288889-8.533333 56.888889-25.6 73.955555-17.066667 19.911111-39.822222 28.444444-68.266667 28.444445s-48.355556-8.533333-65.422222-28.444445c-17.066667-17.066667-25.6-39.822222-25.6-71.111111z m28.444444 0c0 22.755556 5.688889 42.666667 17.066667 56.888889 11.377778 14.222222 28.444444 22.755556 48.355555 22.755556s36.977778-5.688889 48.355556-19.911111c11.377778-14.222222 17.066667-31.288889 17.066667-56.888889 0-25.6-5.688889-45.511111-17.066667-56.888889-11.377778-14.222222-28.444444-19.911111-48.355556-19.911111s-36.977778 8.533333-48.355555 22.755555c-11.377778 8.533333-17.066667 28.444444-17.066667 51.2z" fill="currentColor" p-id="5208"></path><path d="M992.711111 520.533333c0 133.688889-54.044444 253.155556-142.222222 341.333334-88.177778 88.177778-207.644444 142.222222-338.488889 142.222222s-253.155556-54.044444-338.488889-142.222222-142.222222-207.644444-142.222222-341.333334 54.044444-253.155556 142.222222-341.333333c88.177778-88.177778 207.644444-142.222222 338.488889-142.222222s253.155556 54.044444 338.488889 142.222222 142.222222 207.644444 142.222222 341.333333z m-173.511111 307.2c79.644444-79.644444 128-187.733333 128-307.2s-48.355556-227.555556-128-307.2S634.311111 85.333333 512 85.333333c-119.466667 0-227.555556 48.355556-307.2 128-76.8 76.8-125.155556 184.888889-125.155556 304.355556s48.355556 227.555556 128 307.2c79.644444 79.644444 187.733333 128 307.2 128s227.555556-48.355556 304.355556-125.155556z" fill="currentColor" p-id="5209"></path></svg></div></div></div></div></header><div class="container container-main"><div class="col-content"><div class="tsd-page-title"><ul class="tsd-breadcrumb"><li><a href="../modules.html">generative-ts</a></li><li><a href="createVertexAiModelProvider.html">createVertexAiModelProvider</a></li></ul><h1>Function createVertexAiModelProvider</h1></div><section class="tsd-panel"><ul class="tsd-signatures"><li class="tsd-signature tsd-anchor-link"><a id="createVertexAiModelProvider" class="tsd-anchor"></a><span class="tsd-kind-call-signature">create<wbr/>Vertex<wbr/>Ai<wbr/>Model<wbr/>Provider</span><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createVertexAiModelProvider.html#createVertexAiModelProvider.THttpClientOptions">THttpClientOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">params</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span><a href="#createVertexAiModelProvider" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24"><use href="assets/icons.svg#icon-anchor"></use></svg></a></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a Google Cloud VertexAI <a href="../interfaces/ModelProvider.html" class="tsd-kind-interface">ModelProvider</a> with the <a href="../interfaces/GoogleGeminiApi.html" class="tsd-kind-interface">GoogleGeminiApi</a>.</p>
<pre><code class="language-ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">createVertexAiModelProvider</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@packages/gcloud-vertex-ai"</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">gemini</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">createVertexAiModelProvider</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">modelId:</span><span class="hl-1"> </span><span class="hl-2">"gemini-1.0-pro"</span><span class="hl-1">, </span><span class="hl-5">// VertexAI defined model ID</span><br/><span class="hl-1"> </span><span class="hl-5">// you can explicitly pass auth here, otherwise by default it is read from process.env</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">response</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">gemini</span><span class="hl-1">.</span><span class="hl-0">sendRequest</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">$prompt:</span><span class="hl-1"> </span><span class="hl-2">"Brief History of NY Mets:"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">// all other Gemini options available here</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-4">response</span><span class="hl-1">.</span><span class="hl-4">data</span><span class="hl-1">.</span><span class="hl-4">candidates</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">]);</span>
</code><button>Copy</button></pre>
<a id="md:provider-setup-and-notes" class="tsd-anchor"></a><h3><a href="#md:provider-setup-and-notes">Provider Setup and Notes</a></h3><p>Enable <a href="https://console.cloud.google.com/vertex-ai">VertexAI</a> in your Google Cloud Console. Note: VertexAI is currently only available in certain regions.</p>
<p>By default, this provider uses Google Cloud Application Default Credentials, meaning auth credentials will be found automatically based on the application environment. This is the preferred method of authentication if your app is running in Google Cloud.</p>
<p>Please follow instructions in <a href="https://cloud.google.com/docs/authentication/provide-credentials-adc#how-to">"Set up Application Default Credentials"</a> to set up ADC credentials.</p>
<p>If you pass in a custom client, Application Default Credentials will <strong>NOT</strong> be used, and auth logic will be left to the custom client. See <a href="https://www.npmjs.com/package/google-auth-library">google-auth-library</a> for possible strategies about different ways to authenticate.</p>
<p>If you do not pass a <a href="../interfaces/VertexAiAuthConfig.html" class="tsd-kind-interface">VertexAiAuthConfig</a> to <code>auth</code>, the values will be read from the environment as <code>GCLOUD_LOCATION</code> and <code>GCLOUD_PROJECT_ID</code>.</p>
<a id="md:model-parameters" class="tsd-anchor"></a><h3><a href="#md:model-parameters">Model Parameters</a></h3><ul>
<li><a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference">Gemini Inference API</a></li>
<li><a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/function-calling">Gemini Function Calling API</a></li>
</ul>
<a id="md:model-ids" class="tsd-anchor"></a><h3><a href="#md:model-ids">Model IDs</a></h3><ul>
<li><a href="https://cloud.google.com/vertex-ai/generative-ai/docs/learn/model-versioning#gemini-model-versions">Gemini Models</a></li>
</ul>
</div><section class="tsd-panel"><h4>Type Parameters</h4><ul class="tsd-type-parameter-list"><li><span><a id="createVertexAiModelProvider.THttpClientOptions" class="tsd-anchor"></a><span class="tsd-kind-type-parameter">THttpClientOptions</span> = <span class="tsd-signature-type">HttpClientOptions</span></span></li></ul></section><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">params</span>: <span class="tsd-signature-symbol">{ </span><br/><span> </span><span class="tsd-kind-property">auth</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/VertexAiAuthConfig.html" class="tsd-signature-type tsd-kind-interface">VertexAiAuthConfig</a><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/HttpClient.html" class="tsd-signature-type tsd-kind-interface">HttpClient</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createVertexAiModelProvider.html#createVertexAiModelProvider.THttpClientOptions">THttpClientOptions</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">; </span><br/><span> </span><span class="tsd-kind-property">modelId</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">; </span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">auth</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/VertexAiAuthConfig.html" class="tsd-signature-type tsd-kind-interface">VertexAiAuthConfig</a></h5><div class="tsd-comment tsd-typography"><p>Authorization configuration for VertexAI. If not supplied, it will be loaded from the environment.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><code class="tsd-tag ts-flagOptional">Optional</code> <span class="tsd-kind-property">client</span><span class="tsd-signature-symbol">?: </span><a href="../interfaces/HttpClient.html" class="tsd-signature-type tsd-kind-interface">HttpClient</a><span class="tsd-signature-symbol"><</span><a class="tsd-signature-type tsd-kind-type-parameter" href="createVertexAiModelProvider.html#createVertexAiModelProvider.THttpClientOptions">THttpClientOptions</a><span class="tsd-signature-symbol">></span></h5><div class="tsd-comment tsd-typography"><p>HTTP client to use for requests. If not supplied, a client implementing Google Cloud Application Default Credentials will be used.</p>
</div><div class="tsd-comment tsd-typography"></div></li><li class="tsd-parameter"><h5><span class="tsd-kind-property">model<wbr/>Id</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>The model ID as defined by Google Cloud VertexAI.</p>
</div><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h4><p>The VertexAI Model Provider</p>
<div class="tsd-comment tsd-typography"><h4>See</h4><ul>
<li><a href="https://cloud.google.com/docs/authentication/provide-credentials-adc#how-to">"Set up Application Default Credentials"</a></li>
<li><a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/inference">Gemini Inference API</a></li>
<li><a href="https://cloud.google.com/vertex-ai/generative-ai/docs/model-reference/function-calling">Gemini Function Calling API</a></li>
<li><a href="https://cloud.google.com/vertex-ai/generative-ai/docs/learn/model-versioning#gemini-model-versions">Gemini Models</a></li>
</ul>
<h4>Throws</h4><p>If no auth is passed and GCLOUD_LOCATION or GCLOUD_PROJECT_ID are not found in process.env</p>
<h4>Example: Usage</h4><pre><code class="language-ts"><span class="hl-3">import</span><span class="hl-1"> { </span><span class="hl-4">createVertexAiModelProvider</span><span class="hl-1"> } </span><span class="hl-3">from</span><span class="hl-1"> </span><span class="hl-2">"@packages/gcloud-vertex-ai"</span><span class="hl-1">;</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">gemini</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-0">createVertexAiModelProvider</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">modelId:</span><span class="hl-1"> </span><span class="hl-2">"gemini-1.0-pro"</span><span class="hl-1">, </span><span class="hl-5">// VertexAI defined model ID</span><br/><span class="hl-1"> </span><span class="hl-5">// you can explicitly pass auth here, otherwise by default it is read from process.env</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-6">const</span><span class="hl-1"> </span><span class="hl-7">response</span><span class="hl-1"> = </span><span class="hl-3">await</span><span class="hl-1"> </span><span class="hl-4">gemini</span><span class="hl-1">.</span><span class="hl-0">sendRequest</span><span class="hl-1">({</span><br/><span class="hl-1"> </span><span class="hl-4">$prompt:</span><span class="hl-1"> </span><span class="hl-2">"Brief History of NY Mets:"</span><span class="hl-1">,</span><br/><span class="hl-1"> </span><span class="hl-5">// all other Gemini options available here</span><br/><span class="hl-1">});</span><br/><br/><span class="hl-4">console</span><span class="hl-1">.</span><span class="hl-0">log</span><span class="hl-1">(</span><span class="hl-4">response</span><span class="hl-1">.</span><span class="hl-4">data</span><span class="hl-1">.</span><span class="hl-4">candidates</span><span class="hl-1">[</span><span class="hl-8">0</span><span class="hl-1">]);</span>
</code><button>Copy</button></pre>
</div><aside class="tsd-sources"><ul><li>Defined in packages/gcloud-vertex-ai/dist/createVertexAiModelProvider.d.ts:78</li></ul></aside></li></ul></section></div><div class="col-sidebar"><div class="page-menu"><details open class="tsd-index-accordion tsd-page-navigation"><summary class="tsd-accordion-summary"><h3><svg width="20" height="20" viewBox="0 0 24 24" fill="none"><use href="assets/icons.svg#icon-chevronDown"></use></svg>On This Page</h3></summary><div class="tsd-accordion-details"><a href="#md:provider-setup-and-notes"><span>Provider <wbr/>Setup and <wbr/>Notes</span></a><a href="#md:model-parameters"><span>Model <wbr/>Parameters</span></a><a href="#md:model-ids"><span>Model IDs</span></a></div></details></div><div class="site-menu"><nav class="tsd-navigation"><div class="tsd-navigation__toolbar-box"><header class="tsd-page-toolbar"><div class="tsd-toolbar-contents container"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget tsd-toolbar-icon search no-caption"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-search"></use></svg></label><input type="text" id="tsd-search-field" aria-label="Search"/></div><div class="field"><div id="tsd-toolbar-links"></div></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">generative-ts - v0.1.0-alpha.7</a></div><div class="table-cell" id="tsd-widgets"><a href="#" class="tsd-widget tsd-toolbar-icon menu no-caption" data-toggle="menu" aria-label="Menu"><svg width="16" height="16" viewBox="0 0 16 16" fill="none"><use href="assets/icons.svg#icon-menu"></use></svg></a></div></div></header></div><div class="tsd-navigation__main"><h2 class="tsd-navigation__title"><a href="../modules.html">CONTENTS</a></h2><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Providers</span></h2><ul class="tsd-navigation__category__links"><li><a href="createAwsBedrockModelProvider.html" class="tsd-navigation__category__link">createAwsBedrockModelProvider</a></li><li><a href="createCohereModelProvider.html" class="tsd-navigation__category__link">createCohereModelProvider</a></li><li><a href="createGroqModelProvider.html" class="tsd-navigation__category__link">createGroqModelProvider</a></li><li><a href="createHuggingfaceInferenceModelProvider.html" class="tsd-navigation__category__link">createHuggingfaceInferenceModelProvider</a></li><li><a href="createLmStudioModelProvider.html" class="tsd-navigation__category__link">createLmStudioModelProvider</a></li><li><a href="createMistralModelProvider.html" class="tsd-navigation__category__link">createMistralModelProvider</a></li><li><a href="createOpenAiChatModelProvider.html" class="tsd-navigation__category__link">createOpenAiChatModelProvider</a></li><li><a href="createVertexAiModelProvider.html" class="current tsd-navigation__category__link">createVertexAiModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>APIs</span></h2><ul class="tsd-navigation__category__links"><li><a href="../variables/Ai21Jurassic2Api-1.html" class="tsd-navigation__category__link">Ai21Jurassic2Api</a></li><li><a href="../variables/AmazonTitanTextApi-1.html" class="tsd-navigation__category__link">AmazonTitanTextApi</a></li><li><a href="../variables/CohereChatApi-1.html" class="tsd-navigation__category__link">CohereChatApi</a></li><li><a href="../variables/CohereGenerateApi-1.html" class="tsd-navigation__category__link">CohereGenerateApi</a></li><li><a href="../variables/GoogleGeminiApi-1.html" class="tsd-navigation__category__link">GoogleGeminiApi</a></li><li><a href="../variables/HfConversationalTaskApi-1.html" class="tsd-navigation__category__link">HfConversationalTaskApi</a></li><li><a href="../variables/HfTextGenerationTaskApi-1.html" class="tsd-navigation__category__link">HfTextGenerationTaskApi</a></li><li><a href="../variables/Llama2ChatApi-1.html" class="tsd-navigation__category__link">Llama2ChatApi</a></li><li><a href="../variables/Llama3ChatApi-1.html" class="tsd-navigation__category__link">Llama3ChatApi</a></li><li><a href="../variables/MistralAiApi.html" class="tsd-navigation__category__link">MistralAiApi</a></li><li><a href="../variables/MistralBedrockApi-1.html" class="tsd-navigation__category__link">MistralBedrockApi</a></li><li><a href="../variables/OpenAiChatApi.html" class="tsd-navigation__category__link">OpenAiChatApi</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Requests</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/Ai21Jurassic2Options.html" class="tsd-navigation__category__link">Ai21Jurassic2Options</a></li><li><a href="../interfaces/AmazonTitanTextOptions.html" class="tsd-navigation__category__link">AmazonTitanTextOptions</a></li><li><a href="../interfaces/CohereChatOptions.html" class="tsd-navigation__category__link">CohereChatOptions</a></li><li><a href="../interfaces/CohereGenerateOptions.html" class="tsd-navigation__category__link">CohereGenerateOptions</a></li><li><a href="../interfaces/GoogleGeminiOptions.html" class="tsd-navigation__category__link">GoogleGeminiOptions</a></li><li><a href="../interfaces/HfConversationalTaskOptions.html" class="tsd-navigation__category__link">HfConversationalTaskOptions</a></li><li><a href="../interfaces/HfInferenceApiOptions.html" class="tsd-navigation__category__link">HfInferenceApiOptions</a></li><li><a href="../interfaces/HfTextGenerationTaskOptions.html" class="tsd-navigation__category__link">HfTextGenerationTaskOptions</a></li><li><a href="../interfaces/Llama2ChatOptions.html" class="tsd-navigation__category__link">Llama2ChatOptions</a></li><li><a href="../interfaces/Llama3ChatOptions.html" class="tsd-navigation__category__link">Llama3ChatOptions</a></li><li><a href="../interfaces/MistralAiOptions.html" class="tsd-navigation__category__link">MistralAiOptions</a></li><li><a href="../interfaces/MistralBedrockOptions.html" class="tsd-navigation__category__link">MistralBedrockOptions</a></li><li><a href="../interfaces/OpenAiChatOptions.html" class="tsd-navigation__category__link">OpenAiChatOptions</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Responses</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/Ai21Jurassic2Response.html" class="tsd-navigation__category__link">Ai21Jurassic2Response</a></li><li><a href="../interfaces/AmazonTitanTextResponse.html" class="tsd-navigation__category__link">AmazonTitanTextResponse</a></li><li><a href="../interfaces/CohereChatResponse.html" class="tsd-navigation__category__link">CohereChatResponse</a></li><li><a href="../interfaces/CohereGenerateResponse.html" class="tsd-navigation__category__link">CohereGenerateResponse</a></li><li><a href="../interfaces/GoogleGeminiResponse.html" class="tsd-navigation__category__link">GoogleGeminiResponse</a></li><li><a href="../interfaces/HfConversationalTaskResponse.html" class="tsd-navigation__category__link">HfConversationalTaskResponse</a></li><li><a href="../interfaces/HfTextGenerationTaskResponse.html" class="tsd-navigation__category__link">HfTextGenerationTaskResponse</a></li><li><a href="../interfaces/LlamaResponse.html" class="tsd-navigation__category__link">LlamaResponse</a></li><li><a href="../interfaces/MistralAiResponse.html" class="tsd-navigation__category__link">MistralAiResponse</a></li><li><a href="../interfaces/MistralBedrockResponse.html" class="tsd-navigation__category__link">MistralBedrockResponse</a></li><li><a href="../interfaces/OpenAiChatResponse.html" class="tsd-navigation__category__link">OpenAiChatResponse</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Templates</span></h2><ul class="tsd-navigation__category__links"><li><a href="../variables/Ai21Jurassic2Template.html" class="tsd-navigation__category__link">Ai21Jurassic2Template</a></li><li><a href="../variables/AmazonTitanTextTemplate.html" class="tsd-navigation__category__link">AmazonTitanTextTemplate</a></li><li><a href="../variables/CohereChatTemplate.html" class="tsd-navigation__category__link">CohereChatTemplate</a></li><li><a href="../variables/CohereGenerateTemplate.html" class="tsd-navigation__category__link">CohereGenerateTemplate</a></li><li><a href="../variables/GoogleGeminiTemplate.html" class="tsd-navigation__category__link">GoogleGeminiTemplate</a></li><li><a href="../variables/HfConversationalTaskTemplate.html" class="tsd-navigation__category__link">HfConversationalTaskTemplate</a></li><li><a href="../variables/HfTextGenerationTaskTemplate.html" class="tsd-navigation__category__link">HfTextGenerationTaskTemplate</a></li><li><a href="../variables/Llama2ChatTemplate.html" class="tsd-navigation__category__link">Llama2ChatTemplate</a></li><li><a href="../variables/Llama3ChatTemplate.html" class="tsd-navigation__category__link">Llama3ChatTemplate</a></li><li><a href="../variables/MistralAiTemplate.html" class="tsd-navigation__category__link">MistralAiTemplate</a></li><li><a href="../variables/MistralBedrockTemplate.html" class="tsd-navigation__category__link">MistralBedrockTemplate</a></li><li><a href="../variables/OpenAiChatTemplate.html" class="tsd-navigation__category__link">OpenAiChatTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Core Implementations</span></h2><ul class="tsd-navigation__category__links"><li><a href="../classes/BaseModelProvider.html" class="tsd-navigation__category__link">BaseModelProvider</a></li><li><a href="../classes/FnTemplate.html" class="tsd-navigation__category__link">FnTemplate</a></li><li><a href="../classes/HttpModelProvider.html" class="tsd-navigation__category__link">HttpModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Core Interfaces</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/HttpClient.html" class="tsd-navigation__category__link">HttpClient</a></li><li><a href="../interfaces/ModelApi.html" class="tsd-navigation__category__link">ModelApi</a></li><li><a href="../interfaces/ModelProvider.html" class="tsd-navigation__category__link">ModelProvider</a></li><li><a href="../interfaces/ModelRequestOptions.html" class="tsd-navigation__category__link">ModelRequestOptions</a></li><li><a href="../interfaces/Template.html" class="tsd-navigation__category__link">Template</a></li><li><a href="../types/ModelId.html" class="tsd-navigation__category__link">ModelId</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Provider: AWS Bedrock</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/AwsBedrockAuthConfig.html" class="tsd-navigation__category__link">AwsBedrockAuthConfig</a></li><li><a href="../variables/Ai21Jurassic2Api-1.html" class="tsd-navigation__category__link">Ai21Jurassic2Api</a></li><li><a href="../variables/AmazonTitanTextApi-1.html" class="tsd-navigation__category__link">AmazonTitanTextApi</a></li><li><a href="../variables/CohereGenerateApi-1.html" class="tsd-navigation__category__link">CohereGenerateApi</a></li><li><a href="../variables/Llama2ChatApi-1.html" class="tsd-navigation__category__link">Llama2ChatApi</a></li><li><a href="../variables/Llama3ChatApi-1.html" class="tsd-navigation__category__link">Llama3ChatApi</a></li><li><a href="../variables/MistralBedrockApi-1.html" class="tsd-navigation__category__link">MistralBedrockApi</a></li><li><a href="createAwsBedrockModelProvider.html" class="tsd-navigation__category__link">createAwsBedrockModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Provider: Cohere</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/CohereAuthConfig.html" class="tsd-navigation__category__link">CohereAuthConfig</a></li><li><a href="../variables/CohereChatApi-1.html" class="tsd-navigation__category__link">CohereChatApi</a></li><li><a href="../variables/CohereGenerateApi-1.html" class="tsd-navigation__category__link">CohereGenerateApi</a></li><li><a href="createCohereModelProvider.html" class="tsd-navigation__category__link">createCohereModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Provider: Groq</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/GroqAuthConfig.html" class="tsd-navigation__category__link">GroqAuthConfig</a></li><li><a href="../variables/OpenAiChatApi.html" class="tsd-navigation__category__link">OpenAiChatApi</a></li><li><a href="createGroqModelProvider.html" class="tsd-navigation__category__link">createGroqModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Provider: GCloud VertexAI</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/VertexAiAuthConfig.html" class="tsd-navigation__category__link">VertexAiAuthConfig</a></li><li><a href="../variables/GoogleGeminiApi-1.html" class="tsd-navigation__category__link">GoogleGeminiApi</a></li><li><a href="createVertexAiModelProvider.html" class="current tsd-navigation__category__link">createVertexAiModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Provider: Huggingface</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/HuggingfaceAuthConfig.html" class="tsd-navigation__category__link">HuggingfaceAuthConfig</a></li><li><a href="../variables/HfConversationalTaskApi-1.html" class="tsd-navigation__category__link">HfConversationalTaskApi</a></li><li><a href="../variables/HfTextGenerationTaskApi-1.html" class="tsd-navigation__category__link">HfTextGenerationTaskApi</a></li><li><a href="createHuggingfaceInferenceModelProvider.html" class="tsd-navigation__category__link">createHuggingfaceInferenceModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Provider: LMStudio</span></h2><ul class="tsd-navigation__category__links"><li><a href="../variables/OpenAiChatApi.html" class="tsd-navigation__category__link">OpenAiChatApi</a></li><li><a href="createLmStudioModelProvider.html" class="tsd-navigation__category__link">createLmStudioModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Provider: Mistral</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/MistralAuthConfig.html" class="tsd-navigation__category__link">MistralAuthConfig</a></li><li><a href="../variables/MistralAiApi.html" class="tsd-navigation__category__link">MistralAiApi</a></li><li><a href="createMistralModelProvider.html" class="tsd-navigation__category__link">createMistralModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Provider: OpenAI</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/OpenAiAuthConfig.html" class="tsd-navigation__category__link">OpenAiAuthConfig</a></li><li><a href="../variables/OpenAiChatApi.html" class="tsd-navigation__category__link">OpenAiChatApi</a></li><li><a href="createOpenAiChatModelProvider.html" class="tsd-navigation__category__link">createOpenAiChatModelProvider</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Ai21 Jurassic 2</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/Ai21Jurassic2Options.html" class="tsd-navigation__category__link">Ai21Jurassic2Options</a></li><li><a href="../interfaces/Ai21Jurassic2Response.html" class="tsd-navigation__category__link">Ai21Jurassic2Response</a></li><li><a href="../variables/Ai21Jurassic2Api-1.html" class="tsd-navigation__category__link">Ai21Jurassic2Api</a></li><li><a href="../variables/Ai21Jurassic2Template.html" class="tsd-navigation__category__link">Ai21Jurassic2Template</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Amazon Titan Text</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/AmazonTitanTextOptions.html" class="tsd-navigation__category__link">AmazonTitanTextOptions</a></li><li><a href="../interfaces/AmazonTitanTextResponse.html" class="tsd-navigation__category__link">AmazonTitanTextResponse</a></li><li><a href="../variables/AmazonTitanTextApi-1.html" class="tsd-navigation__category__link">AmazonTitanTextApi</a></li><li><a href="../variables/AmazonTitanTextTemplate.html" class="tsd-navigation__category__link">AmazonTitanTextTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Cohere Chat</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/CohereChatOptions.html" class="tsd-navigation__category__link">CohereChatOptions</a></li><li><a href="../interfaces/CohereChatResponse.html" class="tsd-navigation__category__link">CohereChatResponse</a></li><li><a href="../variables/CohereChatApi-1.html" class="tsd-navigation__category__link">CohereChatApi</a></li><li><a href="../variables/CohereChatTemplate.html" class="tsd-navigation__category__link">CohereChatTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Cohere Generate</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/CohereGenerateOptions.html" class="tsd-navigation__category__link">CohereGenerateOptions</a></li><li><a href="../interfaces/CohereGenerateResponse.html" class="tsd-navigation__category__link">CohereGenerateResponse</a></li><li><a href="../variables/CohereGenerateApi-1.html" class="tsd-navigation__category__link">CohereGenerateApi</a></li><li><a href="../variables/CohereGenerateTemplate.html" class="tsd-navigation__category__link">CohereGenerateTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Google Gemini</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/GoogleGeminiOptions.html" class="tsd-navigation__category__link">GoogleGeminiOptions</a></li><li><a href="../interfaces/GoogleGeminiResponse.html" class="tsd-navigation__category__link">GoogleGeminiResponse</a></li><li><a href="../variables/GoogleGeminiApi-1.html" class="tsd-navigation__category__link">GoogleGeminiApi</a></li><li><a href="../variables/GoogleGeminiTemplate.html" class="tsd-navigation__category__link">GoogleGeminiTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Huggingface Conversational Task</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/HfConversationalTaskOptions.html" class="tsd-navigation__category__link">HfConversationalTaskOptions</a></li><li><a href="../interfaces/HfConversationalTaskResponse.html" class="tsd-navigation__category__link">HfConversationalTaskResponse</a></li><li><a href="../variables/HfConversationalTaskApi-1.html" class="tsd-navigation__category__link">HfConversationalTaskApi</a></li><li><a href="../variables/HfConversationalTaskTemplate.html" class="tsd-navigation__category__link">HfConversationalTaskTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Huggingface Text Generation Task</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/HfTextGenerationTaskOptions.html" class="tsd-navigation__category__link">HfTextGenerationTaskOptions</a></li><li><a href="../interfaces/HfTextGenerationTaskResponse.html" class="tsd-navigation__category__link">HfTextGenerationTaskResponse</a></li><li><a href="../variables/HfTextGenerationTaskApi-1.html" class="tsd-navigation__category__link">HfTextGenerationTaskApi</a></li><li><a href="../variables/HfTextGenerationTaskTemplate.html" class="tsd-navigation__category__link">HfTextGenerationTaskTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Llama2</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/Llama2ChatOptions.html" class="tsd-navigation__category__link">Llama2ChatOptions</a></li><li><a href="../interfaces/LlamaResponse.html" class="tsd-navigation__category__link">LlamaResponse</a></li><li><a href="../variables/Llama2ChatApi-1.html" class="tsd-navigation__category__link">Llama2ChatApi</a></li><li><a href="../variables/Llama2ChatTemplate.html" class="tsd-navigation__category__link">Llama2ChatTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Llama3</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/Llama3ChatOptions.html" class="tsd-navigation__category__link">Llama3ChatOptions</a></li><li><a href="../interfaces/LlamaResponse.html" class="tsd-navigation__category__link">LlamaResponse</a></li><li><a href="../variables/Llama3ChatApi-1.html" class="tsd-navigation__category__link">Llama3ChatApi</a></li><li><a href="../variables/Llama3ChatTemplate.html" class="tsd-navigation__category__link">Llama3ChatTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Mistral Bedrock</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/MistralBedrockOptions.html" class="tsd-navigation__category__link">MistralBedrockOptions</a></li><li><a href="../interfaces/MistralBedrockResponse.html" class="tsd-navigation__category__link">MistralBedrockResponse</a></li><li><a href="../variables/MistralBedrockApi-1.html" class="tsd-navigation__category__link">MistralBedrockApi</a></li><li><a href="../variables/MistralBedrockTemplate.html" class="tsd-navigation__category__link">MistralBedrockTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Mistral ChatCompletion</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/MistralAiOptions.html" class="tsd-navigation__category__link">MistralAiOptions</a></li><li><a href="../interfaces/MistralAiResponse.html" class="tsd-navigation__category__link">MistralAiResponse</a></li><li><a href="../variables/MistralAiApi.html" class="tsd-navigation__category__link">MistralAiApi</a></li><li><a href="../variables/MistralAiTemplate.html" class="tsd-navigation__category__link">MistralAiTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>OpenAI ChatCompletion</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/OpenAiChatOptions.html" class="tsd-navigation__category__link">OpenAiChatOptions</a></li><li><a href="../interfaces/OpenAiChatResponse.html" class="tsd-navigation__category__link">OpenAiChatResponse</a></li><li><a href="../variables/OpenAiChatApi.html" class="tsd-navigation__category__link">OpenAiChatApi</a></li><li><a href="../variables/OpenAiChatTemplate.html" class="tsd-navigation__category__link">OpenAiChatTemplate</a></li></ul></div><div class="tsd-navigation__category"><h2 class="tsd-navigation__category__title"><span>Other</span></h2><ul class="tsd-navigation__category__links"><li><a href="../interfaces/Ai21Jurassic2Api.html" class="tsd-navigation__category__link">Ai21Jurassic2Api</a></li><li><a href="../interfaces/AmazonTitanTextApi.html" class="tsd-navigation__category__link">AmazonTitanTextApi</a></li><li><a href="../interfaces/CohereChatApi.html" class="tsd-navigation__category__link">CohereChatApi</a></li><li><a href="../interfaces/CohereGenerateApi.html" class="tsd-navigation__category__link">CohereGenerateApi</a></li><li><a href="../interfaces/GoogleGeminiApi.html" class="tsd-navigation__category__link">GoogleGeminiApi</a></li><li><a href="../interfaces/HfConversationalTaskApi.html" class="tsd-navigation__category__link">HfConversationalTaskApi</a></li><li><a href="../interfaces/HfTextGenerationTaskApi.html" class="tsd-navigation__category__link">HfTextGenerationTaskApi</a></li><li><a href="../interfaces/HttpClientRequest.html" class="tsd-navigation__category__link">HttpClientRequest</a></li><li><a href="../interfaces/Llama2ChatApi.html" class="tsd-navigation__category__link">Llama2ChatApi</a></li><li><a href="../interfaces/Llama3ChatApi.html" class="tsd-navigation__category__link">Llama3ChatApi</a></li><li><a href="../interfaces/MistralBedrockApi.html" class="tsd-navigation__category__link">MistralBedrockApi</a></li><li><a href="../types/InferHttpClientOptions.html" class="tsd-navigation__category__link">InferHttpClientOptions</a></li></ul></div></div></nav></div></div></div><div class="overlay"></div><script src="../assets/lib/category-nav.js"></script></body></html>