Skip to content

docs: embeddings example #263

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Mar 5, 2025
Merged

docs: embeddings example #263

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
84dba94
fix: change model to TEXT_EMBEDDING_3_SMALL due to unsupported dimens…
ykoh42 Mar 1, 2025
05d09ea
docs: add `EmbeddingsExample`
ykoh42 Mar 1, 2025
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
2 changes: 1 addition & 1 deletion openai-java-core/src/test/kotlin/com/openai/services/blocking/EmbeddingServiceTest.kt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ class EmbeddingServiceTest {
embeddingService.create(
EmbeddingCreateParams.builder()
.input("The quick brown fox jumped over the lazy dog")
.model(EmbeddingModel.TEXT_EMBEDDING_ADA_002)
.model(EmbeddingModel.TEXT_EMBEDDING_3_SMALL)
.dimensions(1L)
.encodingFormat(EmbeddingCreateParams.EncodingFormat.FLOAT)
.user("user-1234")
Expand Down
24 changes: 24 additions & 0 deletions openai-java-example/src/main/java/com/openai/example/EmbeddingsAsyncExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package com.openai.example;

import com.openai.client.OpenAIClientAsync;
import com.openai.client.okhttp.OpenAIOkHttpClientAsync;
import com.openai.models.EmbeddingCreateParams;
import com.openai.models.EmbeddingModel;

public final class EmbeddingsAsyncExample {
private EmbeddingsAsyncExample() {}

public static void main(String[] args) {
// Configures using one of:
// - The `OPENAI_API_KEY` environment variable
// - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables
OpenAIClientAsync client = OpenAIOkHttpClientAsync.fromEnv();

EmbeddingCreateParams createParams = EmbeddingCreateParams.builder()
.input("The quick brown fox jumped over the lazy dog")
.model(EmbeddingModel.TEXT_EMBEDDING_3_SMALL)
.build();

client.embeddings().create(createParams).thenAccept(System.out::println).join();
}
}
24 changes: 24 additions & 0 deletions openai-java-example/src/main/java/com/openai/example/EmbeddingsExample.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.EmbeddingCreateParams;
import com.openai.models.EmbeddingModel;

public final class EmbeddingsExample {
private EmbeddingsExample() {}

public static void main(String[] args) {
// Configures using one of:
// - The `OPENAI_API_KEY` environment variable
// - The `AZURE_OPENAI_ENDPOINT` and `AZURE_OPENAI_KEY` environment variables
OpenAIClient client = OpenAIOkHttpClient.fromEnv();

EmbeddingCreateParams createParams = EmbeddingCreateParams.builder()
.input("The quick brown fox jumped over the lazy dog")
.model(EmbeddingModel.TEXT_EMBEDDING_3_SMALL)
.build();

System.out.println(client.embeddings().create(createParams));
}
}