update some javadoc warnings

Author: markpollack

models/spring-ai-moonshot/src/main/java/org/springframework/ai/moonshot/api/MoonshotApi.java

@@ -253,9 +253,12 @@ public static Object function(String functionName) {
 	/**
 	 * Message comprising the conversation.
 	 *
-	 * @param content The contents of the message.
-	 * @param role The role of the messages author. Could be one of the {@link Role}
+	 * @param rawContent The raw contents of the message.
+	 * @param role The role of the message's author. Could be one of the {@link Role}
 	 * types.
+	 * @param name The name of the message's author.
+	 * @param toolCallId The ID of the tool call associated with the message.
+	 * @param toolCalls The list of tool calls associated with the message.
 	 */
 	@JsonInclude(Include.NON_NULL)
 	public record ChatCompletionMessage(

spring-ai-core/src/main/java/org/springframework/ai/chat/client/AdvisedRequest.java

@@ -30,8 +30,19 @@
  * ChatClient's call method
  *
  * @author Christian Tzolov
- * @since 1.0.0 M1
- *
+ * @since 1.0.0
+ * @param chatModel the chat model used
+ * @param userText the text provided by the user
+ * @param systemText the text provided by the system
+ * @param chatOptions the options for the chat
+ * @param media the list of media items
+ * @param functionNames the list of function names
+ * @param functionCallbacks the list of function callbacks
+ * @param messages the list of messages
+ * @param userParams the map of user parameters
+ * @param systemParams the map of system parameters
+ * @param advisors the list of request response advisors
+ * @param advisorParams the map of advisor parameters
  */
 public record AdvisedRequest(ChatModel chatModel, String userText, String systemText, ChatOptions chatOptions,
 		List<Media> media, List<String> functionNames, List<FunctionCallback> functionCallbacks, List<Message> messages,

spring-ai-core/src/main/java/org/springframework/ai/chat/client/DefaultChatClientBuilder.java

@@ -32,12 +32,15 @@
 import org.springframework.util.Assert;
 
 /**
+ * DefaultChatClientBuilder is a builder class for creating a ChatClient.
+ *
+ * It provides methods to set default values for various properties of the ChatClient.
+ *
  * @author Mark Pollack
  * @author Christian Tzolov
  * @author Josh Long
  * @author Arjen Poutsma
  * @since 1.0.0
- *
  */
 public class DefaultChatClientBuilder implements Builder {
 

spring-ai-core/src/main/java/org/springframework/ai/chat/client/ResponseEntity.java

@@ -22,6 +22,8 @@
  *
  * @param <R> the entire response type.
  * @param <E> the converted entity type.
+ * @param response the entire response object.
+ * @param entity the converted entity object.
  * @author Christian Tzolov
  * @since 1.0.0
  */

spring-ai-core/src/main/java/org/springframework/ai/chat/client/advisor/AbstractChatMemoryAdvisor.java

@@ -24,6 +24,7 @@
 /**
  * Abstract class that serves as a base for chat memory advisors.
  *
+ * @param <T> the type of the chat memory.
  * @author Christian Tzolov
  * @since 1.0.0 M1
  */

spring-ai-core/src/main/java/org/springframework/ai/chat/prompt/Prompt.java

@@ -28,14 +28,17 @@
 import org.springframework.ai.model.ModelRequest;
 
 /**
+ * The Prompt class represents a prompt used in AI model requests. A prompt consists of
+ * one or more messages and additional chat options.
+ *
  * @author Mark Pollack
  * @author luocongqiu
  */
 public class Prompt implements ModelRequest<List<Message>> {
 
 	private final List<Message> messages;
 
-	private ChatOptions modelOptions;
+	private ChatOptions chatOptions;
 
 	public Prompt(String contents) {
 		this(new UserMessage(contents));
@@ -49,17 +52,17 @@ public Prompt(List<Message> messages) {
 		this.messages = messages;
 	}
 
-	public Prompt(String contents, ChatOptions modelOptions) {
-		this(new UserMessage(contents), modelOptions);
+	public Prompt(String contents, ChatOptions chatOptions) {
+		this(new UserMessage(contents), chatOptions);
 	}
 
-	public Prompt(Message message, ChatOptions modelOptions) {
-		this(Collections.singletonList(message), modelOptions);
+	public Prompt(Message message, ChatOptions chatOptions) {
+		this(Collections.singletonList(message), chatOptions);
 	}
 
-	public Prompt(List<Message> messages, ChatOptions modelOptions) {
+	public Prompt(List<Message> messages, ChatOptions chatOptions) {
 		this.messages = messages;
-		this.modelOptions = modelOptions;
+		this.chatOptions = chatOptions;
 	}
 
 	public String getContents() {
@@ -72,7 +75,7 @@ public String getContents() {
 
 	@Override
 	public ChatOptions getOptions() {
-		return this.modelOptions;
+		return this.chatOptions;
 	}
 
 	@Override
@@ -82,7 +85,7 @@ public List<Message> getInstructions() {
 
 	@Override
 	public String toString() {
-		return "Prompt{" + "messages=" + this.messages + ", modelOptions=" + this.modelOptions + '}';
+		return "Prompt{" + "messages=" + this.messages + ", modelOptions=" + this.chatOptions + '}';
 	}
 
 	@Override
@@ -91,16 +94,16 @@ public boolean equals(Object o) {
 			return true;
 		if (!(o instanceof Prompt prompt))
 			return false;
-		return Objects.equals(this.messages, prompt.messages) && Objects.equals(this.modelOptions, prompt.modelOptions);
+		return Objects.equals(this.messages, prompt.messages) && Objects.equals(this.chatOptions, prompt.chatOptions);
 	}
 
 	@Override
 	public int hashCode() {
-		return Objects.hash(this.messages, this.modelOptions);
+		return Objects.hash(this.messages, this.chatOptions);
 	}
 
 	public Prompt copy() {
-		return new Prompt(instructionsCopy(), this.modelOptions);
+		return new Prompt(instructionsCopy(), this.chatOptions);
 	}
 
 	private List<Message> instructionsCopy() {

spring-ai-core/src/main/java/org/springframework/ai/vectorstore/filter/Filter.java

@@ -75,13 +75,17 @@ public interface Operand {
 	/**
 	 * String identifier representing an expression key. (e.g. the country in the country
 	 * == "NL" expression).
+	 *
+	 * @param key expression key
 	 */
 	public record Key(String key) implements Operand {
 	}
 
 	/**
 	 * Represents expression value constant or constant array. Support Numeric, Boolean
 	 * and String data types.
+	 *
+	 * @param value value constant or constant array
 	 */
 	public record Value(Object value) implements Operand {
 	}

spring-ai-core/src/main/java/org/springframework/ai/vectorstore/filter/converter/AbstractFilterExpressionConverter.java

@@ -26,6 +26,12 @@
 import org.springframework.ai.vectorstore.filter.Filter.Operand;
 
 /**
+ * AbstractFilterExpressionConverter is an abstract class that implements the
+ * FilterExpressionConverter interface. It provides default implementations for converting
+ * a Filter.Expression into a string representation. All specific filter expression
+ * converters should extend this abstract class and implement the remaining abstract
+ * methods. Note: The class cannot be directly instantiated as it is abstract.
+ *
  * @author Christian Tzolov
  */
 public abstract class AbstractFilterExpressionConverter implements FilterExpressionConverter {

vector-stores/spring-ai-elasticsearch-store/src/main/java/org/springframework/ai/vectorstore/ElasticsearchAiSearchFilterExpressionConverter.java

@@ -28,6 +28,10 @@
 import java.util.regex.Pattern;
 
 /**
+ * ElasticsearchAiSearchFilterExpressionConverter is a class that converts
+ * Filter.Expression objects into Elasticsearch query string representation. It extends
+ * the AbstractFilter ExpressionConverter class.
+ *
  * @author Jemin Huh
  * @since 1.0.0
  */

vector-stores/spring-ai-elasticsearch-store/src/main/java/org/springframework/ai/vectorstore/ElasticsearchVectorStore.java

@@ -46,6 +46,14 @@
 import static org.springframework.ai.vectorstore.SimilarityFunction.l2_norm;
 
 /**
+ * The ElasticsearchVectorStore class implements the VectorStore interface and provides
+ * functionality for managing and querying documents in Elasticsearch. It uses an
+ * embedding model to generate vector representations of the documents and performs
+ * similarity searches based on these vectors.
+ *
+ * The ElasticsearchVectorStore class requires a RestClient and an EmbeddingModel to be
+ * instantiated. It also supports optional initialization of the Elasticsearch schema.
+ *
  * @author Jemin Huh
  * @author Wei Jiang
  * @author Laura Trotta