feat: update photo's caption

.gitignore

@@ -25,10 +25,14 @@ save_it-*.tar
 # Temporary files, for example, from tests.
 /tmp/
 .DS_Store
-data
-dev.sh
-start.sh
-run.sh
-nohup.out
 
+# data
 _local
+data
+
+# scripts
+_local*
+_dev*
+_stag*
+_prod*
+nohup.out

README.md

@@ -2,6 +2,8 @@
 
 A telegram bot can Save photos and Search photos
 
+## Features
+
 - [x] Save photos via a link
 - [x] Search photos using semantic search
 - [x] Find similar photos by photo
@@ -27,13 +29,8 @@ messages:
 
 ```
 /search cat
-
 /search dog
-
 /search girl
-
-/similar photo
-
 /similar photo
 ```
 
@@ -58,10 +55,45 @@ mix deps.get
 ```
 
 ```sh
-# run
+# start typesense
+docker compose up
+```
+
+```sh
+# modify env
 export TELEGRAM_BOT_TOKEN=
 export TYPESENSE_URL=
 export TYPESENSE_API_KEY=
 
 iex -S mix run --no-halt
 ```
+
+Pro Tips: create shell script for fast run app
+
+1. touch start.sh
+
+```sh
+#!/bin/sh
+
+export TELEGRAM_BOT_TOKEN=<YOUR_TELEGRAM_BOT_TOKEN>
+
+export TYPESENSE_URL=<YOUR_TYPESENSE_URL>
+export TYPESENSE_API_KEY=<YOUR_TYPESENSE_API_KEY>
+
+export GOOGLE_OAUTH_CLIENT_ID=<YOUR_GOOGLE_OAUTH_CLIENT_ID>
+export GOOGLE_OAUTH_CLIENT_SECRET=<YOUR_GOOGLE_OAUTH_CLIENT_SECRET>
+
+iex -S mix run --no-halt
+```
+
+2. execute permission
+
+```sh
+chmod +x start.sh
+```
+
+3. run
+
+```sh
+./start.sh
+```

config/runtime.exs

@@ -9,5 +9,3 @@ config :save_it, :typesense_api_key, System.get_env("TYPESENSE_API_KEY", "xyz")
 # optional
 config :save_it, :google_oauth_client_id, System.get_env("GOOGLE_OAUTH_CLIENT_ID")
 config :save_it, :google_oauth_client_secret, System.get_env("GOOGLE_OAUTH_CLIENT_SECRET")
-
-config :save_it, :web_url, System.get_env("WEB_URL", "http://localhost:4000")

docs/dev-logs/2024-10-25.md

@@ -0,0 +1,9 @@
+# 2024-10-25
+
+## Req call typesense API alway :timeout, but typesense was updated.
+
+```elixir
+** (MatchError) no match of right hand side value: {:error, %Req.TransportError{reason: :timeout}}
+    (save_it 0.2.0-rc.1) lib/migration/typesense.ex:11: Migration.Typesense.create_collection!/1
+    priv/typesense/reset.exs:3: (file)
+```

docs/dev/typesense.md

@@ -0,0 +1,14 @@
+# Typesense
+
+## Typesense API Errors
+
+```
+# 400	Bad Request - The request could not be understood due to malformed syntax.
+# 401	Unauthorized - Your API key is wrong.
+# 404	Not Found - The requested resource is not found.
+# 409	Conflict - When a resource already exists.
+# 422	Unprocessable Entity - Request is well-formed, but cannot be processed.
+# 503	Service Unavailable - We’re temporarily offline. Please try again later.
+```
+
+docs: https://typesense.org/docs/27.1/api/api-errors.html#api-errors

lib/migration/typesense.ex

@@ -0,0 +1,42 @@
+defmodule Migration.Typesense do
+  def create_collection!(schema) do
+    req = build_request("/collections")
+    {:ok, res} = Req.post(req, json: schema)
+
+    res.body
+  end
+
+  def delete_collection!(collection_name) do
+    req = build_request("/collections/#{collection_name}")
+    {:ok, res} = Req.delete(req)
+
+    res.body
+  end
+
+  def list_collections() do
+    req = build_request("/collections")
+    {:ok, res} = Req.get(req)
+
+    res.body
+  end
+
+  defp get_env() do
+    url = Application.fetch_env!(:save_it, :typesense_url)
+    api_key = Application.fetch_env!(:save_it, :typesense_api_key)
+
+    {url, api_key}
+  end
+
+  defp build_request(path) do
+    {url, api_key} = get_env()
+
+    Req.new(
+      base_url: url,
+      url: path,
+      headers: [
+        {"Content-Type", "application/json"},
+        {"X-TYPESENSE-API-KEY", api_key}
+      ]
+    )
+  end
+end

lib/migration/typesense/photo.ex

@@ -0,0 +1,35 @@
+defmodule Migration.Typesense.Photo do
+  alias Migration.Typesense
+
+  @photos_schema %{
+    "name" => "photos",
+    "fields" => [
+      # image: base64 encoded string
+      %{"name" => "image", "type" => "image", "store" => false},
+      %{
+        "name" => "image_embedding",
+        "type" => "float[]",
+        "embed" => %{
+          "from" => ["image"],
+          "model_config" => %{
+            "model_name" => "ts/clip-vit-b-p32"
+          }
+        }
+      },
+      %{"name" => "caption", "type" => "string", "optional" => true},
+      %{"name" => "file_id", "type" => "string"},
+      %{"name" => "belongs_to_id", "type" => "string"},
+      %{"name" => "inserted_at", "type" => "int64"}
+    ],
+    "default_sorting_field" => "inserted_at"
+  }
+
+  def create_collection!() do
+    Typesense.create_collection!(@photos_schema)
+  end
+
+  def reset!() do
+    Typesense.delete_collection!(@photos_schema["name"])
+    Typesense.create_collection!(@photos_schema)
+  end
+end