Add ShoppingAssistant, and AlloyDB support to ProductCatalog (GoogleCloudPlatform#2466)

* feat: new shopping-assistant-service based on recommendation service,… (GoogleCloudPlatform#2407)

* feat: new shopping-assistant-service based on recommendation service, langchain and genai packages

* feat: Significantly paired down shop assist

* refactor: last remnants of GRPC

* Add AI Assistant service (GoogleCloudPlatform#2408)

* Add bot UI

* Fix

* Fix

* Fix: requirements.txt

* Unquote query

* Default ns

* Change port

* Change port

* feat: Phase 1 complete

* fix: cleanup

* fix: env and rename

---------

Co-authored-by: aaronmwanjala <[email protected]>

* Add scripts to deploy, init, and ingest into AlloyDB (GoogleCloudPlatform#2423)

* Add AlloyDB set-up

* Add AlloyDB set-up

* Add AlloyDB set-up

* Add AlloyDB set-up

* Add AlloyDB set-up

* Add AlloyDB table population scripts

* Generate embeddings when you import data

* Fix scripts comments

---------

Co-authored-by: Aja Hammerly <[email protected]>

* Multi modal chat (GoogleCloudPlatform#2417)

* refactor: prompt call changed to POST, to accommodate multi-modal requests.

* feat: Added file upload to chat, plumbed the new post through to the end.

* feat: text and image multi modal calls are supported.

* Bones of retrieval are in place, still need to debug

* feat: RAG very nearly implemented end to end

* Revert "feat: RAG very nearly implemented end to end"

This reverts commit a72e96c.

* feat: last few fixes for RAG flow

- Disable `readOnlyRootFilesystem` on the shoppingassistantservice
 - Enable a public IP for the alloydb instance
 - Define the id_column (wasn't documented)
 - Set the model name to models/embedding-001 in order to use textembedding-gecko@003, which I couldn't find anywhere but on MoMA
 - Use .invoke instead of .run here because .run has been deprecated since Jan 5th.
 - Configuring a few columns in the vector store (embedding_column, content_column, etc)

* merge: apikey

* fix: merge conflict

* fix: merge conflict in requirements

* Revert "Revert "feat: RAG very nearly implemented end to end""

This reverts commit 196e428

* feat: two step retrieval query

* fix: key

* chore: requirements

* Update scripts/1_deploy_alloydb_infra.sh

* Update kustomize/components/alloydb/kustomization.yaml

* Update kustomize/components/alloydb/kustomization.yaml

* Update kustomize/components/alloydb/kustomization.yaml

* Update kustomize/components/alloydb/kustomization.yaml

* Update kustomize/components/alloydb/kustomization.yaml

* Update kustomize/components/alloydb/kustomization.yaml

---------

Co-authored-by: Olivier Bourgeois <[email protected]>

* Revamp bot assistant UI (GoogleCloudPlatform#2437)

* Revamp frontend bot into own page

* Revert temp changes

* Tuning the responses to the rag implementation (GoogleCloudPlatform#2441)

* Revamp frontend bot into own page

* FEAT: Making it clearer what's happening

* FEAT: Tweaking the prompts

* REFACTOR: moving towards manual vector search

* feat: Interior design flow working for demo

---------

Co-authored-by: Olivier Bourgeois <[email protected]>

* refactor: cleaning up logging

* Add image and product rendering to frontend (GoogleCloudPlatform#2442)

* Revamp frontend bot into own page

* Revert temp changes

* Fix file permissions

* Remove placeholder variables

* Fix scripts

* Display user image in the chat log

* Extract the product IDs from prompt response

* Add product images to prompt response

* Fix handler hostname

* De-hardcode the assistant service host from the frontend

* Turn on cymbal branding

* Add Dockerfile.pip to gitignore

* Add product cards to response

* Add shimmer to bot text loading

* Fix broken script

* Add missing API to script

* Add demo instructions

* Add disclaimer to README notes

* Polish the assistant UI

* Fix file selector alignment

* refactor: better comments!

* fix: logs and comments for the demo

* Refactor envs out of demo (GoogleCloudPlatform#2457)

* First pass at extracting envs

* Update requirements

* Fix scripts envs

* Fix wrong region env

* WIP secret manager

* WIP secret manager

* WIP secret manager

* WIP secret manager

* WIP secret manager

* Add disable-shopping-assistant component

* Add disable-shopping-assistant component

* Add disable-shopping-assistant component

* Remove hero image temporarily

* WIP secret manager

* WIP secret manager

* WIP secret manager

* WIP secret manager

* AlloyDB support for the products catalog (GoogleCloudPlatform#2425)

* Add SA bindings for products catalog

* Add initial trial of postgre connection

* Fix connection envs

* Fix posgres connection

* Add more columns

* Add missing roles

* Add missing columns

* Add missing columns

* Remove embedding columns

* Remove embedding columns

* Extract envs out

* Extract envs out

* Refactor catalog loading

* Refactor catalog loading

* Refactor catalog loading

* Refactor catalog loading

* Refactor catalog loading

* Refactor catalog loading

* Add Secret Manager query

* Update README

* Update README

* Clean up copyright headers, comments, manifests

* Consolidate .gitignore files into one

* Tweak README script

* Move shopping assistant scripts to kustomize component

---------

Co-authored-by: Aaron Wanjala <[email protected]>
Co-authored-by: Aja Hammerly <[email protected]>

Author: 3 people

.github/workflows/install-dependencies.sh

@@ -1,20 +1,28 @@
-bin/
-pkg/
 .DS_Store
-*.pyc
-*.swp
-*.tfstate
-*.tfstate*
-*~
-.vscode/
-.vs/
-.idea
-.skaffold-*.yaml
+.eclipse.buildship.core.prefs
+.gradle/
+.idea/
 .kubernetes-manifests-*/
 .project
-.eclipse.buildship.core.prefs
-.terraform
-.terraform/*
+.skaffold-*.yaml
 .terraform.lock.hcl
+.terraform/*
+.venv/
+.vs/
+.vscode/
+*.iml
+*.ipr
+*.iws
+*.pyc
+*.swp
+*.tfstate*
 *.tfvars
+*~
+bin/
+build/
+Dockerfile.pip
+node_modules/
+obj/
+pkg/
 release/wi-kubernetes-manifests.yaml
+vendor/

.gitignore

@@ -80,6 +80,8 @@ spec:
             value: "checkoutservice:5050"
           - name: AD_SERVICE_ADDR
             value: "adservice:9555"
+          - name: SHOPPING_ASSISTANT_SERVICE_ADDR
+            value: "shoppingassistantservice:80"
           # # ENV_PLATFORM: One of: local, gcp, aws, azure, onprem, alibaba
           # # When not set, defaults to "local" unless running in GKE, otherwies auto-sets to gcp
           # - name: ENV_PLATFORM
@@ -88,6 +90,8 @@ spec:
             value: "0"
           # - name: CYMBAL_BRANDING
           #   value: "true"
+          - name: ENABLE_ASSISTANT
+            value: "true"
           # - name: FRONTEND_MESSAGE
           #   value: "Replace this with a message you want to display on all pages."
           # As part of an optional Google Cloud demo, you can run an optional microservice called the "packaging service".

docs/releasing/README.md

@@ -25,15 +25,18 @@ resources:
  - paymentservice.yaml
  - productcatalogservice.yaml
  - recommendationservice.yaml
+ - shoppingassistantservice.yaml
  - redis.yaml
  - shippingservice.yaml
-# components:
+components:
 # - ../kustomize/components/cymbal-branding
 # - ../kustomize/components/google-cloud-operations
 # - ../kustomize/components/memorystore
 # - ../kustomize/components/network-policies
 # - ../kustomize/components/service-accounts
+# - ../kustomize/components/alloydb
 # - ../kustomize/components/spanner
 # - ../kustomize/components/container-images-tag
 # - ../kustomize/components/container-images-tag-suffix
 # - ../kustomize/components/container-images-registry
+ - ../kustomize/components/disable-shopping-assistant

kubernetes-manifests/frontend.yaml

@@ -0,0 +1,88 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: apps/v1
+kind: Deployment
+metadata:
+  name: shoppingassistantservice
+  labels:
+    app: shoppingassistantservice
+spec:
+  selector:
+    matchLabels:
+      app: shoppingassistantservice
+  template:
+    metadata:
+      labels:
+        app: shoppingassistantservice
+    spec:
+      serviceAccountName: default
+      terminationGracePeriodSeconds: 5
+      securityContext:
+        fsGroup: 1000
+        runAsGroup: 1000
+        runAsNonRoot: true
+        runAsUser: 1000
+      containers:
+      - name: server
+        securityContext:
+          allowPrivilegeEscalation: false
+          capabilities:
+            drop:
+              - ALL
+          privileged: false
+          readOnlyRootFilesystem: false
+        image: shoppingassistantservice
+        ports:
+        - name: http
+          containerPort: 8080
+        env:
+        - name: GOOGLE_API_KEY
+          value: GOOGLE_API_KEY_VAL
+        - name: ALLOYDB_CLUSTER_NAME
+          value: ALLOYDB_CLUSTER_NAME_VAL
+        - name: ALLOYDB_INSTANCE_NAME
+          value: ALLOYDB_INSTANCE_NAME_VAL
+        - name: ALLOYDB_DATABASE_NAME
+          value: ALLOYDB_DATABASE_NAME_VAL
+        - name: ALLOYDB_TABLE_NAME
+          value: ALLOYDB_TABLE_NAME_VAL
+        - name: ALLOYDB_SECRET_NAME
+          value: ALLOYDB_SECRET_NAME_VAL
+        - name: PROJECT_ID
+          value: PROJECT_ID_VAL
+        - name: REGION
+          value: REGION_VAL
+        resources:
+          requests:
+            cpu: 100m
+            memory: 64Mi
+          limits:
+            cpu: 200m
+            memory: 128Mi
+---
+apiVersion: v1
+kind: Service
+metadata:
+  name: shoppingassistantservice
+  labels:
+    app: shoppingassistantservice
+spec:
+  type: ClusterIP
+  selector:
+    app: shoppingassistantservice
+  ports:
+  - name: http
+    port: 80
+    targetPort: 8080

kubernetes-manifests/kustomization.yaml

@@ -78,6 +78,8 @@ spec:
             value: "checkoutservice:5050"
           - name: AD_SERVICE_ADDR
             value: "adservice:9555"
+          - name: SHOPPING_ASSISTANT_SERVICE_ADDR
+            value: "shoppingassistantservice:80"
           # # ENV_PLATFORM: One of: local, gcp, aws, azure, onprem, alibaba
           # # When not set, defaults to "local" unless running in GKE, otherwies auto-sets to gcp
           # - name: ENV_PLATFORM
@@ -86,6 +88,8 @@ spec:
             value: "0"
           # - name: CYMBAL_BRANDING
           #   value: "true"
+          - name: ENABLE_ASSISTANT
+            value: "true"
           # - name: FRONTEND_MESSAGE
           #   value: "Replace this with a message you want to display on all pages."
           # As part of an optional Google Cloud demo, you can run an optional microservice called the "packaging service".

kubernetes-manifests/shoppingassistantservice.yaml

@@ -34,9 +34,9 @@ patches:
               - name: ALLOYDB_PRIMARY_IP
                 value: ALLOYDB_PRIMARY_IP_VAL
               - name: ALLOYDB_DATABASE_NAME
-                value: ALLOYDB_DATABASE_NAME_VAL
+                value: ALLOYDB_CARTS_DATABASE_NAME
               - name: ALLOYDB_TABLE_NAME
-                value: ALLOYDB_TABLE_NAME_VAL
+                value: ALLOYDB_CARTS_TABLE_NAME_VAL
               - name: ALLOYDB_SECRET_NAME
                 value: ALLOYDB_SECRET_NAME_VAL
               - name: PROJECT_ID
@@ -49,6 +49,48 @@ patches:
       name: cartservice
       annotations:
         iam.gke.io/gcp-service-account: ALLOYDB_USER_GSA_ID
+# productcatalogservice - replace ALLOYDB environments
+- patch: |-
+    apiVersion: apps/v1
+    kind: Deployment
+    metadata:
+      name: productcatalogservice
+    spec:
+      template:
+        spec:
+          containers:
+            - name: server
+              env:
+              - name: ALLOYDB_CLUSTER_NAME
+                value: ALLOYDB_CLUSTER_NAME_VAL
+              - name: ALLOYDB_INSTANCE_NAME
+                value: ALLOYDB_INSTANCE_NAME_VAL
+              - name: ALLOYDB_DATABASE_NAME
+                value: ALLOYDB_PRODUCTS_DATABASE_NAME_VAL
+              - name: ALLOYDB_TABLE_NAME
+                value: ALLOYDB_PRODUCTS_TABLE_NAME_VAL
+              - name: ALLOYDB_SECRET_NAME
+                value: ALLOYDB_SECRET_NAME_VAL
+              - name: PROJECT_ID
+                value: PROJECT_ID_VAL
+              - name: REGION
+                value: REGION_VAL
+# productcatalogservice - add the GSA annotation for the productcatalogservice KSA
+- patch: |-
+    apiVersion: v1
+    kind: ServiceAccount
+    metadata:
+      name: productcatalogservice
+      annotations:
+        iam.gke.io/gcp-service-account: ALLOYDB_USER_GSA_ID
+# shoppingassistantservice - add the GSA annotation for the shoppingassistantservice KSA
+- patch: |-
+    apiVersion: v1
+    kind: ServiceAccount
+    metadata:
+      name: shoppingassistantservice
+      annotations:
+        iam.gke.io/gcp-service-account: ALLOYDB_USER_GSA_ID
 # redis - remove the redis-cart Deployment
 - patch: |-
     apiVersion: apps/v1

kustomize/base/frontend.yaml

@@ -0,0 +1,45 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: kustomize.config.k8s.io/v1alpha1
+kind: Component
+patches:
+# shoppingassistantservice - remove Deployment
+- patch: |-
+    apiVersion: apps/v1
+    kind: Deployment
+    metadata:
+      name: shoppingassistantservice
+    $patch: delete
+# shoppingassistantservice - remove Service
+- patch: |-
+    apiVersion: v1
+    kind: Service
+    metadata:
+      name: shoppingassistantservice
+    $patch: delete
+# frontend - set ENABLE_ASSISTANT to false
+- patch: |-
+    apiVersion: apps/v1
+    kind: Deployment
+    metadata:
+      name: frontend
+    spec:
+      template:
+        spec:
+          containers:
+          - name: server
+            env:
+            - name: ENABLE_ASSISTANT
+              value: "false"

kustomize/components/alloydb/kustomization.yaml

@@ -26,6 +26,7 @@ resources:
 - service-account-productcatalogservice.yaml
 - service-account-recommendationservice.yaml
 - service-account-shippingservice.yaml
+- service-account-shoppingassistantservice.yaml
 patches:
 - target:
     kind: Deployment
@@ -41,6 +42,13 @@ patches:
     - op: replace
       path: /spec/template/spec/serviceAccountName
       value: cartservice
+- target:
+    kind: Deployment
+    name: shoppingassistantservice
+  patch: |-
+    - op: replace
+      path: /spec/template/spec/serviceAccountName
+      value: shoppingassistantservice
 - target:
     kind: Deployment
     name: checkoutservice

kustomize/components/disable-shopping-assistant/kustomization.yaml

@@ -0,0 +1,18 @@
+# Copyright 2024 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#      https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+apiVersion: v1
+kind: ServiceAccount
+metadata:
+  name: shoppingassistantservice