Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* initial default use case addition Signed-off-by: Amit Galitzky <[email protected]> * adding IT and UT Signed-off-by: Amit Galitzky <[email protected]> * addresing comments and adding more tests Signed-off-by: Amit Galitzky <[email protected]> * addressing more comments and adding more UT Signed-off-by: Amit Galitzky <[email protected]> * addressed more comments and more UT Signed-off-by: Amit Galitzky <[email protected]> --------- Signed-off-by: Amit Galitzky <[email protected]> (cherry picked from commit b148eb5) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
- Loading branch information
1 parent
cedaac8
commit e12d866
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,110 @@ | ||
| /* | ||
| * Copyright OpenSearch Contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * | ||
| * The OpenSearch Contributors require contributions made to | ||
| * this file be licensed under the Apache-2.0 license or a | ||
| * compatible open source license. | ||
| */ | ||
| package org.opensearch.flowframework.common; | ||
|
|
||
| import org.apache.logging.log4j.LogManager; | ||
| import org.apache.logging.log4j.Logger; | ||
| import org.opensearch.core.rest.RestStatus; | ||
| import org.opensearch.flowframework.exception.FlowFrameworkException; | ||
|
|
||
| /** | ||
| * Enum encapsulating the different default use cases and templates we have stored | ||
| */ | ||
| public enum DefaultUseCases { | ||
|
|
||
| /** defaults file and substitution ready template for OpenAI embedding model */ | ||
| OPEN_AI_EMBEDDING_MODEL_DEPLOY( | ||
| "open_ai_embedding_model_deploy", | ||
| "defaults/open-ai-embedding-defaults.json", | ||
| "substitutionTemplates/deploy-remote-model-template.json" | ||
| ), | ||
| /** defaults file and substitution ready template for cohere embedding model */ | ||
| COHERE_EMBEDDING_MODEL_DEPLOY( | ||
| "cohere-embedding_model_deploy", | ||
| "defaults/cohere-embedding-defaults.json", | ||
| "substitutionTemplates/deploy-remote-model-template-extra-params.json" | ||
| ), | ||
| /** defaults file and substitution ready template for local neural sparse model and ingest pipeline*/ | ||
| LOCAL_NEURAL_SPARSE_SEARCH( | ||
| "local_neural_sparse_search", | ||
| "defaults/local-sparse-search-defaults.json", | ||
| "substitutionTemplates/neural-sparse-local-template.json" | ||
| ); | ||
|
|
||
| private final String useCaseName; | ||
| private final String defaultsFile; | ||
| private final String substitutionReadyFile; | ||
| private static final Logger logger = LogManager.getLogger(DefaultUseCases.class); | ||
|
|
||
| DefaultUseCases(String useCaseName, String defaultsFile, String substitutionReadyFile) { | ||
| this.useCaseName = useCaseName; | ||
| this.defaultsFile = defaultsFile; | ||
| this.substitutionReadyFile = substitutionReadyFile; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the useCaseName for the given enum Constant | ||
| * @return the useCaseName of this use case. | ||
| */ | ||
| public String getUseCaseName() { | ||
| return useCaseName; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the defaultsFile for the given enum Constant | ||
| * @return the defaultsFile of this for the given useCase. | ||
| */ | ||
| public String getDefaultsFile() { | ||
| return defaultsFile; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the substitutionReadyFile for the given enum Constant | ||
| * @return the substitutionReadyFile of the given useCase | ||
| */ | ||
| public String getSubstitutionReadyFile() { | ||
| return substitutionReadyFile; | ||
| } | ||
|
|
||
| /** | ||
| * Gets the defaultsFile based on the given use case. | ||
| * @param useCaseName name of the given use case | ||
| * @return the defaultsFile for that usecase | ||
| * @throws FlowFrameworkException if the use case doesn't exist in enum | ||
| */ | ||
| public static String getDefaultsFileByUseCaseName(String useCaseName) throws FlowFrameworkException { | ||
| if (useCaseName != null && !useCaseName.isEmpty()) { | ||
| for (DefaultUseCases usecase : values()) { | ||
| if (useCaseName.equals(usecase.getUseCaseName())) { | ||
| return usecase.getDefaultsFile(); | ||
| } | ||
| } | ||
| } | ||
| logger.error("Unable to find defaults file for use case: {}", useCaseName); | ||
| throw new FlowFrameworkException("Unable to find defaults file for use case: " + useCaseName, RestStatus.BAD_REQUEST); | ||
| } | ||
|
|
||
| /** | ||
| * Gets the substitutionReadyFile based on the given use case | ||
| * @param useCaseName name of the given use case | ||
| * @return the substitutionReadyFile which has the template | ||
| * @throws FlowFrameworkException if the use case doesn't exist in enum | ||
| */ | ||
| public static String getSubstitutionReadyFileByUseCaseName(String useCaseName) throws FlowFrameworkException { | ||
| if (useCaseName != null && !useCaseName.isEmpty()) { | ||
| for (DefaultUseCases useCase : values()) { | ||
| if (useCase.getUseCaseName().equals(useCaseName)) { | ||
| return useCase.getSubstitutionReadyFile(); | ||
| } | ||
| } | ||
| } | ||
| logger.error("Unable to find substitution ready file for use case: {}", useCaseName); | ||
| throw new FlowFrameworkException("Unable to find substitution ready file for use case: " + useCaseName, RestStatus.BAD_REQUEST); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.