union type for createAwsBedrockModelProvider api param

Econify · Jun 5, 2024 · 7a65c15 · 7a65c15
1 parent cf7beb6
commit 7a65c15
Show file tree

Hide file tree

Showing 91 changed files with 234 additions and 185 deletions.
diff --git a/docs/assets/navigation.js b/docs/assets/navigation.js
diff --git a/docs/assets/search.js b/docs/assets/search.js
diff --git a/docs/classes/BaseModelProvider.html b/docs/classes/BaseModelProvider.html
diff --git a/docs/classes/EjsTemplate.html b/docs/classes/EjsTemplate.html
diff --git a/docs/classes/HttpModelProvider.html b/docs/classes/HttpModelProvider.html
diff --git a/docs/functions/createAwsBedrockModelProvider.html b/docs/functions/createAwsBedrockModelProvider.html
diff --git a/docs/functions/createCohereModelProvider.html b/docs/functions/createCohereModelProvider.html
diff --git a/docs/functions/createGroqModelProvider.html b/docs/functions/createGroqModelProvider.html
diff --git a/docs/functions/createHuggingfaceInferenceModelProvider.html b/docs/functions/createHuggingfaceInferenceModelProvider.html
diff --git a/docs/functions/createLmStudioModelProvider.html b/docs/functions/createLmStudioModelProvider.html
diff --git a/docs/functions/createMistralModelProvider.html b/docs/functions/createMistralModelProvider.html
diff --git a/docs/functions/createOpenAiChatModelProvider.html b/docs/functions/createOpenAiChatModelProvider.html
diff --git a/docs/hierarchy.html b/docs/hierarchy.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/interfaces/Ai21Jurassic2Api.html b/docs/interfaces/Ai21Jurassic2Api.html
diff --git a/docs/interfaces/Ai21Jurassic2Options.html b/docs/interfaces/Ai21Jurassic2Options.html
diff --git a/docs/interfaces/Ai21Jurassic2Response.html b/docs/interfaces/Ai21Jurassic2Response.html
diff --git a/docs/interfaces/AmazonTitanTextApi.html b/docs/interfaces/AmazonTitanTextApi.html
diff --git a/docs/interfaces/AmazonTitanTextOptions.html b/docs/interfaces/AmazonTitanTextOptions.html
diff --git a/docs/interfaces/AmazonTitanTextResponse.html b/docs/interfaces/AmazonTitanTextResponse.html
diff --git a/docs/interfaces/AwsAuthConfig.html b/docs/interfaces/AwsAuthConfig.html
diff --git a/docs/interfaces/CohereAuthConfig.html b/docs/interfaces/CohereAuthConfig.html
diff --git a/docs/interfaces/CohereChatApi.html b/docs/interfaces/CohereChatApi.html
diff --git a/docs/interfaces/CohereChatOptions.html b/docs/interfaces/CohereChatOptions.html
diff --git a/docs/interfaces/CohereChatResponse.html b/docs/interfaces/CohereChatResponse.html
diff --git a/docs/interfaces/CohereGenerateApi.html b/docs/interfaces/CohereGenerateApi.html
diff --git a/docs/interfaces/CohereGenerateOptions.html b/docs/interfaces/CohereGenerateOptions.html
diff --git a/docs/interfaces/CohereGenerateResponse.html b/docs/interfaces/CohereGenerateResponse.html
diff --git a/docs/interfaces/GroqAuthConfig.html b/docs/interfaces/GroqAuthConfig.html
diff --git a/docs/interfaces/HfConversationalTaskOptions.html b/docs/interfaces/HfConversationalTaskOptions.html
diff --git a/docs/interfaces/HfConversationalTaskResponse.html b/docs/interfaces/HfConversationalTaskResponse.html
diff --git a/docs/interfaces/HfInferenceApiOptions.html b/docs/interfaces/HfInferenceApiOptions.html
diff --git a/docs/interfaces/HfTextGenerationTaskOptions.html b/docs/interfaces/HfTextGenerationTaskOptions.html
diff --git a/docs/interfaces/HfTextGenerationTaskResponse.html b/docs/interfaces/HfTextGenerationTaskResponse.html
diff --git a/docs/interfaces/HttpClient.html b/docs/interfaces/HttpClient.html
diff --git a/docs/interfaces/HuggingfaceAuthConfig.html b/docs/interfaces/HuggingfaceAuthConfig.html
diff --git a/docs/interfaces/Llama2ChatApi.html b/docs/interfaces/Llama2ChatApi.html
diff --git a/docs/interfaces/Llama2ChatOptions.html b/docs/interfaces/Llama2ChatOptions.html
diff --git a/docs/interfaces/Llama3ChatApi.html b/docs/interfaces/Llama3ChatApi.html
diff --git a/docs/interfaces/Llama3ChatOptions.html b/docs/interfaces/Llama3ChatOptions.html
diff --git a/docs/interfaces/LlamaResponse.html b/docs/interfaces/LlamaResponse.html
diff --git a/docs/interfaces/MistralAiOptions.html b/docs/interfaces/MistralAiOptions.html
diff --git a/docs/interfaces/MistralAiResponse.html b/docs/interfaces/MistralAiResponse.html
diff --git a/docs/interfaces/MistralAuthConfig.html b/docs/interfaces/MistralAuthConfig.html
diff --git a/docs/interfaces/MistralBedrockApi.html b/docs/interfaces/MistralBedrockApi.html
diff --git a/docs/interfaces/MistralBedrockOptions.html b/docs/interfaces/MistralBedrockOptions.html
diff --git a/docs/interfaces/MistralBedrockResponse.html b/docs/interfaces/MistralBedrockResponse.html
diff --git a/docs/interfaces/ModelApi.html b/docs/interfaces/ModelApi.html
diff --git a/docs/interfaces/ModelProvider.html b/docs/interfaces/ModelProvider.html
diff --git a/docs/interfaces/ModelRequestOptions.html b/docs/interfaces/ModelRequestOptions.html
diff --git a/docs/interfaces/OpenAiAuthConfig.html b/docs/interfaces/OpenAiAuthConfig.html
diff --git a/docs/interfaces/OpenAiChatOptions.html b/docs/interfaces/OpenAiChatOptions.html
diff --git a/docs/interfaces/OpenAiChatResponse.html b/docs/interfaces/OpenAiChatResponse.html
diff --git a/docs/interfaces/Template.html b/docs/interfaces/Template.html
diff --git a/docs/modules.html b/docs/modules.html
diff --git a/docs/types/ModelId.html b/docs/types/ModelId.html
diff --git a/docs/variables/Ai21Jurassic2Api-1.html b/docs/variables/Ai21Jurassic2Api-1.html
diff --git a/docs/variables/Ai21Jurassic2Api.html b/docs/variables/Ai21Jurassic2Api.html
diff --git a/docs/variables/Ai21Jurassic2Template.html b/docs/variables/Ai21Jurassic2Template.html
diff --git a/docs/variables/AmazonTitanTextApi-1.html b/docs/variables/AmazonTitanTextApi-1.html
diff --git a/docs/variables/AmazonTitanTextApi.html b/docs/variables/AmazonTitanTextApi.html
diff --git a/docs/variables/AmazonTitanTextTemplate.html b/docs/variables/AmazonTitanTextTemplate.html
diff --git a/docs/variables/CohereChatApi-1.html b/docs/variables/CohereChatApi-1.html
diff --git a/docs/variables/CohereChatTemplate.html b/docs/variables/CohereChatTemplate.html
diff --git a/docs/variables/CohereGenerateApi-1.html b/docs/variables/CohereGenerateApi-1.html
diff --git a/docs/variables/CohereGenerateTemplate.html b/docs/variables/CohereGenerateTemplate.html
diff --git a/docs/variables/HfConversationalTaskApi.html b/docs/variables/HfConversationalTaskApi.html
diff --git a/docs/variables/HfConversationalTaskTemplate.html b/docs/variables/HfConversationalTaskTemplate.html
diff --git a/docs/variables/HfTextGenerationTaskApi.html b/docs/variables/HfTextGenerationTaskApi.html
diff --git a/docs/variables/HfTextGenerationTaskTemplate.html b/docs/variables/HfTextGenerationTaskTemplate.html
diff --git a/docs/variables/Llama2ChatApi-1.html b/docs/variables/Llama2ChatApi-1.html
diff --git a/docs/variables/Llama2ChatApi.html b/docs/variables/Llama2ChatApi.html
diff --git a/docs/variables/Llama2ChatTemplate.html b/docs/variables/Llama2ChatTemplate.html
diff --git a/docs/variables/Llama3ChatApi-1.html b/docs/variables/Llama3ChatApi-1.html
diff --git a/docs/variables/Llama3ChatApi.html b/docs/variables/Llama3ChatApi.html
diff --git a/docs/variables/Llama3ChatTemplate.html b/docs/variables/Llama3ChatTemplate.html
diff --git a/docs/variables/MistralAiApi.html b/docs/variables/MistralAiApi.html
diff --git a/docs/variables/MistralAiTemplate.html b/docs/variables/MistralAiTemplate.html
diff --git a/docs/variables/MistralBedrockApi-1.html b/docs/variables/MistralBedrockApi-1.html
diff --git a/docs/variables/MistralBedrockApi.html b/docs/variables/MistralBedrockApi.html
diff --git a/docs/variables/MistralBedrockTemplate.html b/docs/variables/MistralBedrockTemplate.html
diff --git a/docs/variables/OpenAiChatApi.html b/docs/variables/OpenAiChatApi.html
diff --git a/docs/variables/OpenAiChatTemplate.html b/docs/variables/OpenAiChatTemplate.html
diff --git a/packages/core/src/apis/ai21/jurassic2.ts b/packages/core/src/apis/ai21/jurassic2.ts
@@ -198,6 +198,9 @@ export function isAi21Jurassic2Response(
   return !isLeft(Ai21Jurassic2ResponseCodec.decode(response));
 }
 
+export interface Ai21Jurassic2Api
+  extends ModelApi<Ai21Jurassic2Options, Ai21Jurassic2Response> {}
+
 /**
  *
  * ## Reference
@@ -211,10 +214,7 @@ export function isAi21Jurassic2Response(
  * @category Provider: AWS Bedrock
  *
  */
-export const Ai21Jurassic2Api: ModelApi<
-  Ai21Jurassic2Options,
-  Ai21Jurassic2Response
-> = {
+export const Ai21Jurassic2Api: Ai21Jurassic2Api = {
   requestTemplate: Ai21Jurassic2Template,
   responseGuard: isAi21Jurassic2Response,
 };
diff --git a/packages/core/src/apis/amazon/titanText.ts b/packages/core/src/apis/amazon/titanText.ts
@@ -73,6 +73,9 @@ export function isAmazonTitanTextResponse(
   return !isLeft(AmazonTitanTextResponseCodec.decode(response));
 }
 
+export interface AmazonTitanTextApi
+  extends ModelApi<AmazonTitanTextOptions, AmazonTitanTextResponse> {}
+
 /**
  *
  * ## Reference
@@ -86,10 +89,7 @@ export function isAmazonTitanTextResponse(
  * @category Provider: AWS Bedrock
  *
  */
-export const AmazonTitanTextApi: ModelApi<
-  AmazonTitanTextOptions,
-  AmazonTitanTextResponse
-> = {
+export const AmazonTitanTextApi: AmazonTitanTextApi = {
   requestTemplate: AmazonTitanTextTemplate,
   responseGuard: isAmazonTitanTextResponse,
 };
diff --git a/packages/core/src/apis/meta/llama2ChatApi.ts b/packages/core/src/apis/meta/llama2ChatApi.ts
@@ -36,6 +36,9 @@ export const Llama2ChatTemplate = new EjsTemplate<Llama2ChatOptions>(
   templateSource,
 );
 
+export interface Llama2ChatApi
+  extends ModelApi<Llama2ChatOptions, LlamaResponse> {}
+
 /**
  *
  * ## Reference
@@ -49,7 +52,7 @@ export const Llama2ChatTemplate = new EjsTemplate<Llama2ChatOptions>(
  * @category Provider: AWS Bedrock
  *
  */
-export const Llama2ChatApi: ModelApi<Llama2ChatOptions, LlamaResponse> = {
+export const Llama2ChatApi: Llama2ChatApi = {
   requestTemplate: Llama2ChatTemplate,
   responseGuard: isLlamaResponse,
 };
diff --git a/packages/core/src/apis/meta/llama3ChatApi.ts b/packages/core/src/apis/meta/llama3ChatApi.ts
@@ -35,6 +35,9 @@ export const Llama3ChatTemplate = new EjsTemplate<Llama3ChatOptions>(
   templateSource,
 );
 
+export interface Llama3ChatApi
+  extends ModelApi<Llama3ChatOptions, LlamaResponse> {}
+
 /**
  *
  * ## Reference
@@ -48,7 +51,7 @@ export const Llama3ChatTemplate = new EjsTemplate<Llama3ChatOptions>(
  * @category Provider: AWS Bedrock
  *
  */
-export const Llama3ChatApi: ModelApi<Llama3ChatOptions, LlamaResponse> = {
+export const Llama3ChatApi: Llama3ChatApi = {
   requestTemplate: Llama3ChatTemplate,
   responseGuard: isLlamaResponse,
 };
diff --git a/packages/core/src/apis/mistral/mistralBedrockApi.ts b/packages/core/src/apis/mistral/mistralBedrockApi.ts
@@ -63,6 +63,9 @@ export function isMistralBedrockResponse(
   return !isLeft(MistralBedrockResponseCodec.decode(response));
 }
 
+export interface MistralBedrockApi
+  extends ModelApi<MistralBedrockOptions, MistralBedrockResponse> {}
+
 /**
  *
  * ## Reference
@@ -76,10 +79,7 @@ export function isMistralBedrockResponse(
  * @category Provider: AWS Bedrock
  *
  */
-export const MistralBedrockApi: ModelApi<
-  MistralBedrockOptions,
-  MistralBedrockResponse
-> = {
+export const MistralBedrockApi: MistralBedrockApi = {
   requestTemplate: MistralBedrockTemplate,
   responseGuard: isMistralBedrockResponse,
 };
diff --git a/packages/core/src/providers/aws_bedrock/createAwsBedrockModelProvider.spec.ts b/packages/core/src/providers/aws_bedrock/createAwsBedrockModelProvider.spec.ts
@@ -1,7 +1,5 @@
 import aws4 from "aws4";
 
-import type { ModelApi } from "@typeDefs";
-
 import { AwsBedrockModelProvider } from "./AwsBedrockModelProvider";
 import { createAwsBedrockModelProvider } from "./createAwsBedrockModelProvider";
 
@@ -14,7 +12,7 @@ describe("AwsBedrockModelProvider", () => {
       render: jest.fn().mockReturnValue("dummy-request-template-output"),
     },
     responseGuard: jest.fn().mockReturnValue(true),
-  } as unknown as ModelApi;
+  } as unknown as any;
 
   const mockAuthConfig = {
     AWS_ACCESS_KEY_ID: "dummy-access-key-id",

diff --git a/packages/core/src/providers/aws_bedrock/createAwsBedrockModelProvider.ts b/packages/core/src/providers/aws_bedrock/createAwsBedrockModelProvider.ts
@@ -1,16 +1,34 @@
 import type {
   HttpClient,
+  InferRequestOptions,
+  InferResponse,
   ModelApi,
   ModelId,
-  ModelRequestOptions,
 } from "@typeDefs";
 
+import {
+  Ai21Jurassic2Api,
+  AmazonTitanTextApi,
+  CohereGenerateApi,
+  Llama2ChatApi,
+  Llama3ChatApi,
+  MistralBedrockApi,
+} from "../../apis";
+
 import { AwsBedrockModelProvider } from "./AwsBedrockModelProvider";
 
 import { AwsAuthConfig } from "./authConfig";
 
 const DEFAULT_REGION = "us-east-1";
 
+type AwsBedrockApi =
+  | Ai21Jurassic2Api
+  | AmazonTitanTextApi
+  | CohereGenerateApi
+  | Llama2ChatApi
+  | Llama3ChatApi
+  | MistralBedrockApi;
+
 /**
  *
  * Creates an AWS Bedrock {@link ModelProvider} with the provided {@link ModelApi}.
@@ -31,7 +49,7 @@ const DEFAULT_REGION = "us-east-1";
  * console.log(response.results[0]?.outputText);
  * ```
  *
- * ### Known Compatible APIs:
+ * ### Compatible APIs
  * - {@link AmazonTitanTextApi}
  * - {@link CohereGenerateApi}
  * - {@link Llama2ChatApi}
@@ -45,12 +63,12 @@ const DEFAULT_REGION = "us-east-1";
  * @category Provider: AWS Bedrock
  *
  * @param {Object} params
- * @param {ModelApi} params.api - The API instance to use for making requests.
+ * @param {AwsBedrockApi} params.api - The API instance to use for making requests.
  * @param {string} params.modelId - The model ID as defined by AWS Bedrock.
  * @param {HttpClient} [params.client] - HTTP client to use for requests. If not supplied, the built-in fetch-based implementation will be used.
  * @param {AwsAuthConfig} [params.auth] - Authentication configuration for AWS. If not supplied, credentials will be loaded from the environment.
  * @param {string} [params.region=us-east-1] - AWS region where the Bedrock model is deployed. Defaults to "us-east-1".
- * @returns {AwsBedrockModelProvider<TRequestOptions, TResponse>} The AWS Bedrock Model Provider with the specified {@link ModelApi}.
+ * @returns {AwsBedrockModelProvider} The AWS Bedrock Model Provider with the specified {@link ModelApi}.
  *
  * @example Multiple APIs
  * ```ts
@@ -100,23 +118,25 @@ const DEFAULT_REGION = "us-east-1";
  * ```
  */
 export function createAwsBedrockModelProvider<
-  TRequestOptions extends ModelRequestOptions,
-  TResponse = unknown,
+  TAwsBedrockApi extends AwsBedrockApi,
 >({
   api,
   modelId,
   client,
   auth,
   region = DEFAULT_REGION,
 }: {
-  api: ModelApi<TRequestOptions, TResponse>;
+  api: TAwsBedrockApi;
   modelId: ModelId;
   client?: HttpClient;
   auth?: AwsAuthConfig;
   region?: string;
 }) {
   return new AwsBedrockModelProvider({
-    api,
+    api: api as ModelApi<
+      InferRequestOptions<TAwsBedrockApi>,
+      InferResponse<TAwsBedrockApi>
+    >,
     modelId,
     client,
     auth,

diff --git a/packages/core/src/providers/cohere/createCohereModelProvider.ts b/packages/core/src/providers/cohere/createCohereModelProvider.ts
@@ -5,7 +5,7 @@ import type {
   ModelApi,
 } from "@typeDefs";
 
-import { CohereChatApi, CohereGenerateApi } from "../../apis/cohere";
+import { CohereChatApi, CohereGenerateApi } from "../../apis";
 
 import { BearerTokenAuthStrategy, HttpModelProvider } from "../http";
 
@@ -40,7 +40,7 @@ type CohereApi = CohereGenerateApi | CohereChatApi;
  * @category Provider: Cohere
  *
  * @param {Object} params
- * @param {CohereGenerateApi | CohereChatApi} [params.api] - The API to use for the provider. Defaults to {@link CohereChatApi}.
+ * @param {CohereApi} [params.api] - The API to use for the provider. Defaults to {@link CohereChatApi}.
  * @param {string} params.modelId - The model ID as defined by Cohere.
  * @param {HttpClient} [params.client] - HTTP client to use for requests. If not supplied, the built-in fetch-based implementation will be used.
  * @param {CohereAuthConfig} [params.auth] - Authentication configuration for Cohere. If not supplied, it will be loaded from the environment.