From abd9e327aa65ac3746864c790a275778c29ff6a7 Mon Sep 17 00:00:00 2001 From: Christian Tzolov Date: Thu, 11 Apr 2024 14:42:22 +0200 Subject: [PATCH] Add s.ai.openai.embedding.options.dimensions documentation --- .../springframework/ai/openai/OpenAiEmbeddingOptions.java | 8 ++++---- .../ROOT/pages/api/embeddings/openai-embeddings.adoc | 1 + 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiEmbeddingOptions.java b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiEmbeddingOptions.java index 3f91e12f5..b82594987 100644 --- a/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiEmbeddingOptions.java +++ b/models/spring-ai-openai/src/main/java/org/springframework/ai/openai/OpenAiEmbeddingOptions.java @@ -86,7 +86,7 @@ public class OpenAiEmbeddingOptions implements EmbeddingOptions { } public String getModel() { - return model; + return this.model; } public void setModel(String model) { @@ -94,7 +94,7 @@ public class OpenAiEmbeddingOptions implements EmbeddingOptions { } public String getEncodingFormat() { - return encodingFormat; + return this.encodingFormat; } public void setEncodingFormat(String encodingFormat) { @@ -102,7 +102,7 @@ public class OpenAiEmbeddingOptions implements EmbeddingOptions { } public Integer getDimensions() { - return dimensions; + return this.dimensions; } public void setDimensions(Integer dimensions) { @@ -110,7 +110,7 @@ public class OpenAiEmbeddingOptions implements EmbeddingOptions { } public String getUser() { - return user; + return this.user; } public void setUser(String user) { diff --git a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc index 1933669b3..f1d9eb04a 100644 --- a/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc +++ b/spring-ai-docs/src/main/antora/modules/ROOT/pages/api/embeddings/openai-embeddings.adoc @@ -94,6 +94,7 @@ The prefix `spring.ai.openai.embedding` is property prefix that configures the ` | spring.ai.openai.embedding.options.model | The model to use | text-embedding-ada-002 (other options: text-embedding-3-large, text-embedding-3-small) | spring.ai.openai.embedding.options.encodingFormat | The format to return the embeddings in. Can be either float or base64. | - | spring.ai.openai.embedding.options.user | A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. | - +| spring.ai.openai.embedding.options.dimensions | The number of dimensions the resulting output embeddings should have. Only supported in `text-embedding-3` and later models. | - |==== NOTE: You can override the common `spring.ai.openai.base-url` and `spring.ai.openai.api-key` for the `ChatClient` and `EmbeddingClient` implementations.