diff --git a/spring-ai-core/src/main/java/org/springframework/ai/prompt/FormatProvider.java b/spring-ai-core/src/main/java/org/springframework/ai/prompt/FormatProvider.java index efefae42e..9bbb4a952 100644 --- a/spring-ai-core/src/main/java/org/springframework/ai/prompt/FormatProvider.java +++ b/spring-ai-core/src/main/java/org/springframework/ai/prompt/FormatProvider.java @@ -1,7 +1,35 @@ +/* + * Copyright 2023 the original author or authors. + * + * Licensed under the Apache License, Version 2.0 (the "License"); + * you may not use this file except in compliance with the License. + * You may obtain a copy of the License at + * + * https://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + package org.springframework.ai.prompt; +//TODO: Shouldn't the FormatProvider be inside the parser package? + +/** + * Implementations of this interface provides instructions for how the output of a + * language model should be formatted. + * + * @author Mark Pollack + */ public interface FormatProvider { + /** + * @return Returns a string containing instructions for how the output of a language + * model should be formatted. + */ String getFormat(); }