-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'main' of https://github.com/askorama/oramacloud-client …
…into feat/complete-interaction-event
- Loading branch information
Showing
56 changed files
with
3,979 additions
and
4,307 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -203,4 +203,6 @@ $RECYCLE.BIN/ | |
|
|
||
|
|
||
| example/out.js | ||
| .vscode | ||
| .vscode | ||
|
|
||
| .turbo | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,257 +1,16 @@ | ||
| # Orama Cloud Client | ||
| # Orama Cloud Client Monorepo | ||
|
|
||
| [](https://github.com/askorama/javascript-sdk/actions/workflows/node.js.yml) | ||
| See README in individual packages | ||
|
|
||
| ## Install | ||
| ## Development | ||
|
|
||
| ```sh | ||
| npm i @oramacloud/client | ||
| ``` | ||
| * `pnpm i` | ||
| * `pnpm build` | ||
|
|
||
| ## Integrating with Orama Cloud | ||
| To bump version: | ||
| * `pnpm run bump-version [version]` | ||
| * `git push origin tag v[version]` | ||
|
|
||
| ```js | ||
| import { OramaClient } from "@oramacloud/client"; | ||
|
|
||
| const client = new OramaClient({ | ||
| endpoint: "<Your Orama Cloud Endpoint>", | ||
| api_key: "<Your Orama Cloud API Key>", | ||
| }); | ||
|
|
||
| const results = await client.search({ | ||
| term: "red leather shoes", | ||
| }); | ||
| ``` | ||
|
|
||
| ## Advanced search | ||
|
|
||
| ```js | ||
| const results = await client.search({ | ||
| term: "red leather shoes", | ||
| where: { | ||
| price: { | ||
| lte: 9.99, | ||
| }, | ||
| gender: "unisex", | ||
| }, | ||
| limit: 5, | ||
| offset: 1, | ||
| }); | ||
| ``` | ||
|
|
||
| ## Generating embeddings via the Secure Proxy | ||
|
|
||
| ```js | ||
| import { OramaProxy } from "@oramacloud/client"; | ||
|
|
||
| const proxy = new OramaClient({ | ||
| api_key: "<Your Orama Secure Proxy API Key>", | ||
| }); | ||
|
|
||
| const embeddings = await proxy.generateEmbeddings( | ||
| "red leather shoes", | ||
| "openai/text-embedding-ada-002" | ||
| ); | ||
|
|
||
| console.log(embeddings); | ||
| // [-0.019633075, -0.00820422, -0.013555876, -0.011825735, 0.006641511, -0.012948156, ...] | ||
| ``` | ||
|
|
||
| Available models: | ||
|
|
||
| - `orama/gte-small`. 384 dimensions, operated by Orama Cloud (preferred) | ||
| - `orama/gte-medium`. 768 dimensions, operated by Orama Cloud | ||
| - `orama/gte-large`. 1024 dimensions, operated by Orama Cloud | ||
| - `openai/text-embedding-ada-002`. 1536 dimensions, proxied to OpenAI | ||
| - `openai/text-embedding-3-small`. 1536 dimensions, proxied to OpenAI | ||
| - `openai/text-embedding-3-large`. 3072 dimensions, proxied to OpenAI | ||
|
|
||
| ## Generating chat completions via the Secure Proxy | ||
|
|
||
| You can generate chat completions via the Secure Proxy in two different ways: | ||
|
|
||
| ### Returning a single string | ||
|
|
||
| ```js | ||
| import { OramaProxy } from "@oramacloud/client"; | ||
|
|
||
| const proxy = new OramaClient({ | ||
| api_key: "<Your Orama Secure Proxy API Key>", | ||
| }); | ||
|
|
||
| const chatParams = { | ||
| model: "openai/gpt-4", | ||
| messages: [{ role: "user", content: "Who is Michael Scott?" }], | ||
| }; | ||
|
|
||
| const response = await proxy.chat(chatParams); | ||
| console.log(response); | ||
|
|
||
| // "Michael Scott is a fictional character from the television show "The Office" (US version) ..." | ||
| ``` | ||
|
|
||
| Available models: | ||
|
|
||
| - `openai/gpt-4o` | ||
| - `openai/gpt-4o-mini` | ||
| - `openai/gpt-4-turbo` | ||
| - `openai/gpt-4` | ||
| - `openai/gpt-3.5-turbo` | ||
|
|
||
| ### Returning a stream (via async iterators) | ||
|
|
||
| ```js | ||
| import { OramaProxy } from "@oramacloud/client"; | ||
|
|
||
| const proxy = new OramaClient({ | ||
| api_key: "<Your Orama Secure Proxy API Key>", | ||
| }); | ||
|
|
||
| const chatParams = { | ||
| model: "openai/gpt-4", | ||
| messages: [{ role: "user", content: "Who is Michael Scott?" }], | ||
| }; | ||
|
|
||
| for await (const message of proxy.chatStream(chatParams)) { | ||
| console.log(message); | ||
| } | ||
|
|
||
| // Michael | ||
| // Scott is | ||
| // a fictional | ||
| // character from the | ||
| // television show | ||
| // "The | ||
| // Office" (US | ||
| // version) | ||
| // ... | ||
| ``` | ||
|
|
||
| Available models: | ||
|
|
||
| - `openai/gpt-4o` | ||
| - `openai/gpt-4o-mini` | ||
| - `openai/gpt-4-turbo` | ||
| - `openai/gpt-4` | ||
| - `openai/gpt-3.5-turbo` | ||
|
|
||
| ## With React | ||
|
|
||
| ```jsx | ||
| import { OramaCloud, useSearch } from "@oramacloud/client/react"; | ||
|
|
||
| export function App() { | ||
| return ( | ||
| <OramaCloud | ||
| endpoint="<Your Orama Cloud Endpoint>" | ||
| apiKey="<Your Orama Cloud API Key>" | ||
| > | ||
| <Search /> | ||
| </OramaCloud> | ||
| ); | ||
| } | ||
|
|
||
| function Search() { | ||
| const { results, error } = useSearch({ | ||
| term: "red leather shoes", | ||
| limit: 10, | ||
| offset: 5, | ||
| }); | ||
|
|
||
| return ( | ||
| <> | ||
| {results.hits.map((hit) => { | ||
| <div key={hit.id}> | ||
| <p> {hit.document.myCustomProperty} </p> | ||
| </div>; | ||
| })} | ||
| </> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| ## With Vue | ||
|
|
||
| Import the composable into your component and it's ready to use. | ||
|
|
||
| ```jsx | ||
| <template> | ||
| <li v-for="hit in results?.hits" :key="hit.id"> | ||
| {{ hit.id }} | ||
| </li> | ||
| </template> | ||
|
|
||
| <script setup> | ||
| import { useSearch } from "@oramacloud/client/vue"; | ||
| import { orama } from './orama' | ||
|
|
||
| const { results } = useSearch({ | ||
| cloudConfig: { | ||
| apiKey: "<Your Orama Cloud API Key>", | ||
| endpoint: "<Your Orama Cloud Endpoint>", | ||
| }, | ||
| term: "guitar", | ||
| limit: 5 | ||
| }); | ||
| </script> | ||
| ``` | ||
|
|
||
| ## Identifying users | ||
|
|
||
| ### Usage with browsers | ||
|
|
||
| 1. Call the `.identify()` method with the user's unique identifier. | ||
| 2. Call `.reset()` when users log out. | ||
|
|
||
| Note: we suggest developers to always call `.identify()` when users sign-up, log-in or when the user re-opens the application in a logged-in state. | ||
|
|
||
| Example or already logged in state: | ||
|
|
||
| ```js | ||
|
|
||
| import { OramaClient } from "@oramacloud/client"; | ||
|
|
||
| const client = new OramaClient({ | ||
| endpoint: "<Your Orama Cloud Endpoint>", | ||
| api_key: "<Your Orama Cloud API Key>", | ||
| }); | ||
|
|
||
| client.identify("<Your unique User ID>"); | ||
|
|
||
| client.search({ | ||
| term: "red leather shoes", | ||
| }); | ||
| ``` | ||
|
|
||
| Upon logging out: | ||
|
|
||
| ```js | ||
| client.reset(); | ||
| ``` | ||
|
|
||
| ### Usage with server-side applications | ||
|
|
||
| 1. Call the `.identify()` method with the user's unique identifier. | ||
| 2. Call `.reset()` when users log out. | ||
|
|
||
| OramaClient will always generate a new userId upon **initialization**, so we suggest developers to call the `.reset()` function even when users are not necessarily identified. This will ensure that the client is not associated with the previous user, thus preventing improper data association between sessions. | ||
|
|
||
| ### Usage of Alias | ||
|
|
||
| Aliases are employed to link multiple identifiers to a single user, enabling the tracking of anonymous users across different sessions. This is particularly beneficial for monitoring users who are not logged in or who access the platform from various devices. | ||
|
|
||
| ```js | ||
| import { OramaClient } from "@oramacloud/client"; | ||
|
|
||
| const client = new OramaClient({ | ||
| endpoint: "<Your Orama Cloud Endpoint>", | ||
| api_key: "<Your Orama Cloud API Key>", | ||
| }); | ||
|
|
||
| // Sets the alias for the current user | ||
| client.alias("<Unique Alias ID>"); | ||
|
|
||
| client.search({ | ||
| term: "red leather shoes", | ||
| }); | ||
| ``` | ||
| To mass publish: | ||
| * need to be on main without any uncomitted changes | ||
| * `pnpm run publish-all` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,30 +1,34 @@ | ||
| { | ||
| "$schema": "https://biomejs.dev/schemas/1.4.1/schema.json", | ||
| "organizeImports": { | ||
| "enabled": true | ||
| }, | ||
| "formatter": { | ||
| "enabled": true, | ||
| "lineWidth": 160, | ||
| "$schema": "https://biomejs.dev/schemas/1.9.2/schema.json", | ||
| "organizeImports": { | ||
| "enabled": true | ||
| }, | ||
| "formatter": { | ||
| "enabled": true, | ||
| "lineWidth": 160, | ||
| "indentStyle": "space" | ||
| }, | ||
| "linter": { | ||
| "enabled": true, | ||
| "rules": { | ||
| "recommended": true, | ||
| "style": { | ||
| "noNonNullAssertion": "off" | ||
| }, | ||
| "suspicious": { | ||
| "noExplicitAny": "off" | ||
| } | ||
| } | ||
| }, | ||
| "javascript": { | ||
| }, | ||
| "linter": { | ||
| "enabled": true, | ||
| "rules": { | ||
| "recommended": true, | ||
| "style": { | ||
| "noNonNullAssertion": "off" | ||
| }, | ||
| "suspicious": { | ||
| "noExplicitAny": "off" | ||
| } | ||
| } | ||
| }, | ||
| "javascript": { | ||
| "formatter": { | ||
| "trailingCommas": "none", | ||
| "semicolons": "asNeeded", | ||
| "trailingComma": "none", | ||
| "quoteStyle": "single" | ||
| } | ||
| }, | ||
| "files": { | ||
| "include": ["apps/**", "packages/**"], | ||
| "ignore": ["**/dist/**", "**/node_modules/**"] | ||
| } | ||
| } | ||
| } |
Oops, something went wrong.