Merge pull request #254 from weaviate/add-generative-friendliai-module

Add support for generative-friendliai module

Author: jfrancoa

.cicd/test.sh

@@ -165,6 +165,8 @@ function check_creates_template() {
   check_modules "--set offload.s3.enabled=true" "value: offload-s3"
   check_modules "--set modules.generative-anthropic.enabled=true" "value: generative-anthropic"
   check_modules "--set modules.generative-anthropic.enabled=true --set modules.generative-anthropic.apiKey=apiKey" "value: generative-anthropic"
+  check_modules "--set modules.generative-friendliai.enabled=true" "value: generative-friendliai"
+  check_modules "--set modules.generative-friendliai.enabled=true --set modules.generative-friendliai.token=token" "value: generative-friendliai"
 
   check_modules "--set modules.text2vec-openai.enabled=true --set modules.text2vec-openai.azureApiKey=azureApiKey" "value: text2vec-openai"
   check_modules "--set modules.qna-openai.enabled=true --set modules.qna-openai.azureApiKey=azureApiKey" "value: qna-openai"
@@ -208,6 +210,7 @@ function check_creates_template() {
   check_string_existence "--set modules.text2vec-openai.enabled=true --set modules.text2vec-jinaai.enabled=true --set modules.text2vec-jinaai.apiKey=JinaAIApiKey" "name: JINAAI_APIKEY"
   check_string_existence "--set modules.text2vec-openai.enabled=true --set modules.reranker-jinaai.enabled=true --set modules.reranker-jinaai.apiKey=JinaAIApiKey" "name: JINAAI_APIKEY"
   check_string_existence "--set modules.text2vec-openai.enabled=true --set modules.reranker-jinaai.enabled=true --set modules.reranker-jinaai.apiKey=JinaAIApiKey --set modules.text2vec-jinaai.enabled=true --set modules.text2vec-jinaai.apiKey=JinaAIApiKey" "name: JINAAI_APIKEY"
+  check_string_existence "--set modules.text2vec-openai.enabled=true --set modules.generative-friendliai.enabled=true --set modules.generative-friendliai.token=FriendliToken" "name: FRIENDLI_TOKEN"
 
   check_setting_has_value "--set replicas=3 --set env.RAFT_BOOTSTRAP_EXPECT=3" "name: RAFT_JOIN" "value: \"weaviate-0,weaviate-1,weaviate-2\""
   check_setting_has_value "--set replicas=3 --set env.RAFT_BOOTSTRAP_EXPECT=3" "name: RAFT_BOOTSTRAP_EXPECT" "value: \"3\""

weaviate/templates/_helpers.tpl

@@ -47,6 +47,9 @@
   {{- if (index .Values "modules" "generative-anthropic" "enabled") -}}
     {{ $modules = append $modules "generative-anthropic" }}
   {{- end -}}
+  {{- if (index .Values "modules" "generative-friendliai" "enabled") -}}
+    {{ $modules = append $modules "generative-friendliai" }}
+  {{- end -}}
   {{- if or (index .Values "modules" "img2vec-neural" "enabled") (index .Values "modules" "img2vec-neural" "inferenceUrl") -}}
     {{ $modules = append $modules "img2vec-neural" }}
   {{- end -}}

weaviate/templates/tokenFriendliAISecret.yaml

@@ -0,0 +1,12 @@
+{{ if and (index .Values "modules" "generative-friendliai" "enabled") (index .Values "modules" "generative-friendliai" "token") }}
+apiVersion: v1
+kind: Secret
+metadata:
+  name: weaviate-friendliai
+  labels:
+    app.kubernetes.io/name: weaviate
+    app.kubernetes.io/managed-by: helm
+type: Opaque
+data:
+  token: {{ index .Values "modules" "generative-friendliai" "token" | b64enc }}
+{{ end }}

weaviate/templates/weaviateStatefulset.yaml

@@ -274,6 +274,13 @@ spec:
                 name: weaviate-octoai
                 key: apiKey
           {{- end  }}
+          {{- if and (index .Values "modules" "generative-friendliai" "enabled") (index .Values "modules" "generative-friendliai" "token") }}
+          - name: FRIENDLI_TOKEN
+            valueFrom:
+              secretKeyRef:
+                name: weaviate-friendliai
+                key: token
+          {{- end  }}
           {{- if and (index .Values "offload" "s3" "enabled") (index .Values "offload" "s3" "envconfig") }}
             {{- range $key, $value := index .Values "offload" "s3" "envconfig" }}
           - name: {{ $key }}

weaviate/values.yaml

@@ -1374,6 +1374,18 @@ modules:
     # an environment variable
     apiKey: ''
 
+  # The generative-friendliai module uses FriendliAI API.
+  # More information about FriendliAI API can be found here:
+  # https://docs.friendli.ai/openapi/create-chat-completions
+  generative-friendliai:
+
+    # enable if you want to use FriendliAI module
+    enabled: false
+
+    # Set your FriendliAI Token to be passed to Weaviate pod as
+    # an environment variable
+    token: ''
+
   # The img2vec-neural module uses neural networks, to generate
   # a vector representation of the image
   img2vec-neural: