Merge pull request #828 from meppsilon/add-hyperbolic

feat: add hyperbolic api to eliza
elizaOS · Dec 10, 2024 · 736ebda · 736ebda
2 parents 9b9b530 + 840bcb9
commit 736ebda
Show file tree

Hide file tree

Showing 7 changed files with 58 additions and 19 deletions.
diff --git a/.env.example b/.env.example
@@ -19,6 +19,8 @@ GOOGLE_GENERATIVE_AI_API_KEY= # Gemini API key
 ALI_BAILIAN_API_KEY= # Ali Bailian API Key
 VOLENGINE_API_KEY=  # VolEngine API Key
 
+HYPERBOLIC_API_KEY= # Hyperbolic API Key
+
 # Speech Synthesis
 ELEVENLABS_XI_API_KEY= # API key from elevenlabs
 

diff --git a/agent/src/index.ts b/agent/src/index.ts
@@ -270,6 +270,11 @@ export function getTokenForProvider(
                 character.settings?.secrets?.VOLENGINE_API_KEY ||
                 settings.VOLENGINE_API_KEY
             );
+        case ModelProviderName.HYPERBOLIC:
+            return (
+                character.settings?.secrets?.HYPERBOLIC_API_KEY ||
+                settings.HYPERBOLIC_API_KEY
+            );
     }
 }
 

diff --git a/docs/api/enumerations/ModelProviderName.md b/docs/api/enumerations/ModelProviderName.md
@@ -12,7 +12,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:214](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L214)
+[packages/core/src/types.ts:215](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L215)
 
 ***
 
@@ -22,7 +22,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:215](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L215)
+[packages/core/src/types.ts:216](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L216)
 
 ***
 
@@ -32,7 +32,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:216](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L216)
+[packages/core/src/types.ts:217](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L217)
 
 ***
 
@@ -42,7 +42,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:217](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L217)
+[packages/core/src/types.ts:218](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L218)
 
 ***
 
@@ -52,7 +52,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:218](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L218)
+[packages/core/src/types.ts:219](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L219)
 
 ***
 
@@ -62,7 +62,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:219](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L219)
+[packages/core/src/types.ts:220](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L220)
 
 ***
 
@@ -72,7 +72,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:220](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L220)
+[packages/core/src/types.ts:221](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L221)
 
 ***
 
@@ -82,7 +82,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:221](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L221)
+[packages/core/src/types.ts:222](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L222)
 
 ***
 
@@ -92,7 +92,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:222](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L222)
+[packages/core/src/types.ts:223](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L223)
 
 ***
 
@@ -102,7 +102,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:223](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L223)
+[packages/core/src/types.ts:224](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L224)
 
 ***
 
@@ -112,7 +112,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:224](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L224)
+[packages/core/src/types.ts:225](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L225)
 
 ***
 
@@ -122,7 +122,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:225](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L225)
+[packages/core/src/types.ts:226](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L226)
 
 ***
 
@@ -132,7 +132,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:226](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L226)
+[packages/core/src/types.ts:227](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L227)
 
 ***
 
@@ -142,7 +142,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:227](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L227)
+[packages/core/src/types.ts:228](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L228)
 
 ***
 
@@ -152,7 +152,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:228](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L228)
+[packages/core/src/types.ts:229](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L229)
 
 ***
 
@@ -162,7 +162,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:229](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L229)
+[packages/core/src/types.ts:230](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L230)
 
 ***
 
@@ -172,7 +172,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:230](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L230)
+[packages/core/src/types.ts:231](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L231)
 
 ***
 
@@ -182,7 +182,7 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:231](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L231)
+[packages/core/src/types.ts:232](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L232)
 
 ***
 
@@ -192,4 +192,14 @@ Available model providers
 
 #### Defined in
 
-[packages/core/src/types.ts:232](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L232)
+[packages/core/src/types.ts:233](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L233)
+
+***
+
+### HYPERBOLIC
+
+> **HYPERBOLIC**: `"hyperbolic"`
+
+#### Defined in
+
+[packages/core/src/types.ts:234](/~https://github.com/ai16z/eliza/blob/main/packages/core/src/types.ts#L234)
diff --git a/docs/api/type-aliases/Models.md b/docs/api/type-aliases/Models.md
@@ -84,6 +84,10 @@ Model configurations by provider
 
 > **volengine**: [`Model`](Model.md)
 
+### hyperbolic
+
+> **hyperbolic**: [`Model`](Model.md)
+
 ## Defined in
 
 [packages/core/src/types.ts:188](/~https://github.com/monilpat/eliza/blob/main/packages/core/src/types.ts#L188)
diff --git a/packages/core/src/generation.ts b/packages/core/src/generation.ts
@@ -129,6 +129,7 @@ export async function generateText({
             case ModelProviderName.ALI_BAILIAN:
             case ModelProviderName.VOLENGINE:
             case ModelProviderName.LLAMACLOUD:
+            case ModelProviderName.HYPERBOLIC:
             case ModelProviderName.TOGETHER: {
                 elizaLogger.debug("Initializing OpenAI model.");
                 const openai = createOpenAI({ apiKey, baseURL: endpoint });

diff --git a/packages/core/src/models.ts b/packages/core/src/models.ts
@@ -381,6 +381,21 @@ export const models: Models = {
             [ModelClass.EMBEDDING]: "doubao-embedding",
         },
     },
+    [ModelProviderName.HYPERBOLIC]: {
+        endpoint: "https://api.hyperbolic.xyz/v1",
+        settings: {
+            stop: [],
+            maxInputTokens: 128000,
+            maxOutputTokens: 8192,
+            temperature: 0.6,
+        },
+        model: {
+            [ModelClass.SMALL]: "meta-llama/Llama-3.2-3B-Instruct",
+            [ModelClass.MEDIUM]: "meta-llama/Meta-Llama-3.1-70B-Instruct",
+            [ModelClass.LARGE]: "meta-llama/Meta-Llama-3.1-405-Instruct",
+            [ModelClass.IMAGE]: "FLUX.1-dev",
+        },
+    },
 };
 
 export function getModel(provider: ModelProviderName, type: ModelClass) {

diff --git a/packages/core/src/types.ts b/packages/core/src/types.ts
@@ -205,6 +205,7 @@ export type Models = {
     [ModelProviderName.GAIANET]: Model;
     [ModelProviderName.ALI_BAILIAN]: Model;
     [ModelProviderName.VOLENGINE]: Model;
+    [ModelProviderName.HYPERBOLIC]: Model;
 };
 
 /**
@@ -230,6 +231,7 @@ export enum ModelProviderName {
     GAIANET = "gaianet",
     ALI_BAILIAN = "ali_bailian",
     VOLENGINE = "volengine",
+    HYPERBOLIC = "hyperbolic",
 }
 
 /**