Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Allow using Azure for embedding with the JS client + fix docker-compose for running tests #2227

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 51 additions & 1 deletion clients/js/src/embeddings/OpenAIEmbeddingFunction.ts
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,33 @@ class OpenAIAPIv3 implements OpenAIAPI {
}
}

class OpenAIAPIAzure implements OpenAIAPI {
private openai: any;

constructor(configuration: { apiKey: string; apiVersion?: string; apiBase?: string; deployment?: string }) {
this.openai = new OpenAIApi.AzureOpenAI({
apiKey: configuration.apiKey,
apiBase: configuration.apiBase,
apiVersion: configuration.apiVersion,
deployment: configuration.deployment,
});
}

public async createEmbedding(params: {
model: string;
input: string[];
user?: string;
}): Promise<number[][]> {
const embeddings: number[][] = [];
const response = await this.openai.embeddings.create(params);
const data = response["data"];
for (let i = 0; i < data.length; i += 1) {
embeddings.push(data[i]["embedding"]);
}
return embeddings;
}
}

class OpenAIAPIv4 implements OpenAIAPI {
private readonly apiKey: any;
private openai: any;
Expand Down Expand Up @@ -76,23 +103,39 @@ class OpenAIAPIv4 implements OpenAIAPI {
export class OpenAIEmbeddingFunction implements IEmbeddingFunction {
private api_key: string;
private org_id: string;
private api_type?: string;
private api_version?: string;
private api_base?: string;
private deployment?: string;
private model: string;
private openaiApi?: OpenAIAPI;

constructor({
openai_api_key,
openai_model,
openai_organization_id,
api_type,
api_base,
api_version,
deployment,
}: {
openai_api_key: string;
openai_model?: string;
openai_organization_id?: string;
api_type?: string;
api_base?: string;
api_version?: string;
deployment?: string;
}) {
// we used to construct the client here, but we need to async import the types
// for the openai npm package, and the constructor can not be async
this.api_key = openai_api_key;
this.org_id = openai_organization_id || "";
this.model = openai_model || "text-embedding-ada-002";
this.api_type = api_type;
this.api_base = api_base;
this.api_version = api_version;
this.deployment = deployment;
}

private async loadClient() {
Expand All @@ -115,7 +158,14 @@ export class OpenAIEmbeddingFunction implements IEmbeddingFunction {
throw _a; // Re-throw other errors
}

if (openAiMajorVersion > 3) {
if (this.api_type === "azure") {
this.openaiApi = new OpenAIAPIAzure({
apiKey: this.api_key,
apiBase: this.api_base,
apiVersion: this.api_version,
deployment: this.deployment
});
} else if (openAiMajorVersion > 3) {
this.openaiApi = new OpenAIAPIv4(this.api_key);
} else {
this.openaiApi = new OpenAIAPIv3({
Expand Down
2 changes: 1 addition & 1 deletion docker-compose.test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ services:
- ALLOW_RESET=True
- IS_PERSISTENT=True
ports:
- 8000:8000
- "${CHROMA_PORT:-8000}:8000"
networks:
- test_net

Expand Down
14 changes: 14 additions & 0 deletions docs/docs.trychroma.com/pages/integrations/openai.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,5 +74,19 @@ const collection = await client.getCollection({
})
```

To use the OpenAI embedding models on other platforms such as Azure, you can use the `api_base` and `api_type` parameters:
```javascript
const {OpenAIEmbeddingFunction} = require('chromadb');
const embeddingFunction = new OpenAIEmbeddingFunction({
openai_api_key: "apiKey",
api_type: "azure",
api_version: "apiVersion",
api_base: "apiBase",
deployment: "deployment",
model: "text-embedding-3-small"
})
```


{% /tab %}
{% /tabs %}
Loading