Skip to content

Commit cbdb578

Browse files
committed
Fix javadoc for HTML elements
1 parent c93c6fd commit cbdb578

File tree

3 files changed

+8
-8
lines changed

3 files changed

+8
-8
lines changed

spring-ai-core/src/main/java/org/springframework/ai/evaluation/FactCheckingEvaluator.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -23,19 +23,19 @@
2323
/**
2424
* Implementation of {@link Evaluator} used to evaluate the factual accuracy of Large
2525
* Language Model (LLM) responses against provided context.
26-
* <p/>
26+
* <p>
2727
* This evaluator addresses a specific type of potential error in LLM outputs known as
2828
* "hallucination" in the context of grounded factuality. It verifies whether a given
2929
* statement (the "claim") is logically supported by a provided context (the "document").
30-
* <p/>
30+
* <p>
3131
* Key concepts: - Document: The context or grounding information against which the claim
3232
* is checked. - Claim: The statement to be verified against the document.
33-
* <p/>
33+
* <p>
3434
* The evaluator uses a prompt-based approach with a separate, typically smaller and more
3535
* efficient LLM to perform the fact-checking. This design choice allows for
3636
* cost-effective and rapid verification, which is crucial when evaluating longer LLM
3737
* outputs that may require multiple verification steps.
38-
* <p/>
38+
* <p>
3939
* Implementation note: For efficient and accurate fact-checking, consider using
4040
* specialized models like Bespoke-Minicheck, a grounded factuality checking model
4141
* developed by Bespoke Labs and available in Ollama. Such models are specifically
@@ -45,12 +45,12 @@
4545
* Hallucinations with Bespoke-Minicheck</a> and the research paper:
4646
* <a href="https://arxiv.org/pdf/2404.10774v1">MiniCheck: An Efficient Method for LLM
4747
* Hallucination Detection</a>
48-
* <p/>
48+
* <p>
4949
* Note: This evaluator is specifically designed to fact-check statements against given
5050
* information. It's not meant for other types of accuracy tests, like quizzing an AI on
5151
* obscure facts without giving it any reference material to work with (so-called 'closed
5252
* book' scenarios).
53-
* <p/>
53+
* <p>
5454
* The evaluation process aims to determine if the claim is supported by the document,
5555
* returning a boolean result indicating whether the fact-check passed or failed.
5656
*

spring-ai-core/src/main/java/org/springframework/ai/model/function/FunctionCallingOptions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ static FunctionCallingOptionsBuilder builder() {
5353
void setFunctionCallbacks(List<FunctionCallback> functionCallbacks);
5454

5555
/**
56-
* @return <@link Set> of function names from the ChatModel registry to be used in the
56+
* @return {@link Set} of function names from the ChatModel registry to be used in the
5757
* next chat completion requests.
5858
*/
5959
Set<String> getFunctions();

spring-ai-core/src/main/java/org/springframework/ai/observation/conventions/AiObservationMetricNames.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818

1919
/**
2020
* Enumeration of metric names used in AI observations.
21-
* <p/>
21+
* <p>
2222
* Based on OpenTelemetry's Semantic Conventions for AI systems.
2323
*
2424
* @author Thomas Vitale

0 commit comments

Comments
 (0)