From c4e7efb499745a76ce6a9581a73e83f9728f9986 Mon Sep 17 00:00:00 2001 From: jitokim Date: Sun, 3 Nov 2024 22:57:55 +0900 Subject: [PATCH] Fix typos in classes under the embedding package Signed-off-by: jitokim --- .../springframework/ai/embedding/EmbeddingModel.java | 3 ++- .../ai/embedding/EmbeddingResultMetadata.java | 5 +++-- .../ai/embedding/TokenCountBatchingStrategy.java | 11 ++++++----- 3 files changed, 11 insertions(+), 8 deletions(-) diff --git a/spring-ai-core/src/main/java/org/springframework/ai/embedding/EmbeddingModel.java b/spring-ai-core/src/main/java/org/springframework/ai/embedding/EmbeddingModel.java index e4785b867..9875ec2b0 100644 --- a/spring-ai-core/src/main/java/org/springframework/ai/embedding/EmbeddingModel.java +++ b/spring-ai-core/src/main/java/org/springframework/ai/embedding/EmbeddingModel.java @@ -30,6 +30,7 @@ import org.springframework.util.Assert; * @author Christian Tzolov * @author Josh Long * @author Soby Chacko + * @author Jihoon Kim * @since 1.0.0 * */ @@ -59,7 +60,7 @@ public interface EmbeddingModel extends Model embed(List texts) { Assert.notNull(texts, "Texts must not be null"); diff --git a/spring-ai-core/src/main/java/org/springframework/ai/embedding/EmbeddingResultMetadata.java b/spring-ai-core/src/main/java/org/springframework/ai/embedding/EmbeddingResultMetadata.java index eb0dfead4..3b57f5cd7 100644 --- a/spring-ai-core/src/main/java/org/springframework/ai/embedding/EmbeddingResultMetadata.java +++ b/spring-ai-core/src/main/java/org/springframework/ai/embedding/EmbeddingResultMetadata.java @@ -23,13 +23,14 @@ import org.springframework.util.MimeTypeUtils; /** * @author Christian Tzolov + * @author Jihoon Kim */ public class EmbeddingResultMetadata implements ResultMetadata { public static EmbeddingResultMetadata EMPTY = new EmbeddingResultMetadata(); /** - * The {@link MimeType} of the source data used to generate the embedding. + * The {@link ModalityType} of the source data used to generate the embedding. */ private final ModalityType modalityType; @@ -80,7 +81,7 @@ public class EmbeddingResultMetadata implements ResultMetadata { private static MimeType TEXT_MIME_TYPE = MimeTypeUtils.parseMimeType("text/*"); - private static MimeType IMAGE_MIME_TYPE = MimeTypeUtils.parseMimeType("text/*"); + private static MimeType IMAGE_MIME_TYPE = MimeTypeUtils.parseMimeType("image/*"); private static MimeType VIDEO_MIME_TYPE = MimeTypeUtils.parseMimeType("video/*"); diff --git a/spring-ai-core/src/main/java/org/springframework/ai/embedding/TokenCountBatchingStrategy.java b/spring-ai-core/src/main/java/org/springframework/ai/embedding/TokenCountBatchingStrategy.java index 8a2a1195c..713eefb96 100644 --- a/spring-ai-core/src/main/java/org/springframework/ai/embedding/TokenCountBatchingStrategy.java +++ b/spring-ai-core/src/main/java/org/springframework/ai/embedding/TokenCountBatchingStrategy.java @@ -49,6 +49,7 @@ import org.springframework.util.Assert; * @author Soby Chacko * @author Mark Pollack * @author Laura Trotta + * @author Jihoon Kim * @since 1.0.0 */ public class TokenCountBatchingStrategy implements BatchingStrategy { @@ -68,7 +69,7 @@ public class TokenCountBatchingStrategy implements BatchingStrategy { private final int maxInputTokenCount; - private final ContentFormatter contentFormater; + private final ContentFormatter contentFormatter; private final MetadataMode metadataMode; @@ -78,9 +79,9 @@ public class TokenCountBatchingStrategy implements BatchingStrategy { /** * @param encodingType {@link EncodingType} + * @param maxInputTokenCount upper limit for input tokens * @param reservePercentage the percentage of tokens to reserve from the max input * token count to create a buffer. - * @param maxInputTokenCount upper limit for input tokens */ public TokenCountBatchingStrategy(EncodingType encodingType, int maxInputTokenCount, double reservePercentage) { this(encodingType, maxInputTokenCount, reservePercentage, Document.DEFAULT_CONTENT_FORMATTER, @@ -106,7 +107,7 @@ public class TokenCountBatchingStrategy implements BatchingStrategy { Assert.notNull(metadataMode, "MetadataMode must not be null"); this.tokenCountEstimator = new JTokkitTokenCountEstimator(encodingType); this.maxInputTokenCount = (int) Math.round(maxInputTokenCount * (1 - reservePercentage)); - this.contentFormater = contentFormatter; + this.contentFormatter = contentFormatter; this.metadataMode = metadataMode; } @@ -129,7 +130,7 @@ public class TokenCountBatchingStrategy implements BatchingStrategy { Assert.notNull(metadataMode, "MetadataMode must not be null"); this.tokenCountEstimator = tokenCountEstimator; this.maxInputTokenCount = (int) Math.round(maxInputTokenCount * (1 - reservePercentage)); - this.contentFormater = contentFormatter; + this.contentFormatter = contentFormatter; this.metadataMode = metadataMode; } @@ -142,7 +143,7 @@ public class TokenCountBatchingStrategy implements BatchingStrategy { for (Document document : documents) { int tokenCount = this.tokenCountEstimator - .estimate(document.getFormattedContent(this.contentFormater, this.metadataMode)); + .estimate(document.getFormattedContent(this.contentFormatter, this.metadataMode)); if (tokenCount > this.maxInputTokenCount) { throw new IllegalArgumentException( "Tokens in a single document exceeds the maximum number of allowed input tokens");