Skip to content

Commit

Permalink
fix issues in comments
Browse files Browse the repository at this point in the history
Signed-off-by: zane-neo <[email protected]>
  • Loading branch information
zane-neo committed Dec 9, 2024
1 parent 3adeaf6 commit 72c1ec5
Showing 1 changed file with 4 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@

/**
* This is the default embedding post process function, the expected result from the model in two cases:
* 1. A list of list of float for APIs embedding type is not enabled.
* 2. A map of string to list of list of number for APIs that embedding type is enabled.
* 1. A {@link List} of {@link List} of {@link Float} {@link Float} for APIs embedding type is not enabled.
* 2. A map of string to {@link List} of {@link List} of {@link Number} for APIs that embedding type is enabled.
* An example of enabled embedding type is cohere v2, the embedding API requires embedding_types as a mandatory field in the request body:
* <a href="https://docs.cohere.com/reference/embed#request.body.embedding_types">...</a>
* Currently, OpenAI Cohere and default sagemaker embedding models are using this function.
Expand Down Expand Up @@ -134,8 +134,8 @@ private void validateEmbeddingList(List<?> outerList) {
* },
* ......
* }
* 1. When response filter is set to: $.embeddings.float, then the result is a list of list<Number>.
* 2. When response filter is set to: $.embeddings, then the result is a map of embedding type to list of list<Number>.
* 1. When response filter is set to: $.embeddings.float, then the result is a {@link List} of {@link List} of {@link Number}.
* 2. When response filter is set to: $.embeddings, then the result is a map of embedding type to {@link List} of {@link List} of {@link Number}.
* 3. When response filter is not set which is the default case, and the result is same with case2.
* @param modelOutput the embedding result of embedding type supported models.
* @return List of ModelTensor that represent the embedding result including all different embedding types.
Expand Down

0 comments on commit 72c1ec5

Please sign in to comment.