Skip to content

Commit 018257a

Browse files
committed
fix: Resolve javadoc and maven confiuration issues
1 parent 0ca91b2 commit 018257a

File tree

28 files changed

+110
-53
lines changed

28 files changed

+110
-53
lines changed

document-readers/markdown-reader/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@
4141
<dependency>
4242
<groupId>org.springframework.ai</groupId>
4343
<artifactId>spring-ai-core</artifactId>
44-
<version>${parent.version}</version>
44+
<version>${project.parent.version}</version>
4545
</dependency>
4646

4747
<dependency>

document-readers/markdown-reader/src/main/java/org/springframework/ai/reader/markdown/MarkdownDocumentReader.java

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,14 +65,27 @@ public class MarkdownDocumentReader implements DocumentReader {
6565
*/
6666
private final Parser parser;
6767

68+
/**
69+
* Create a new {@link MarkdownDocumentReader} instance.
70+
* @param markdownResource the resource to read
71+
*/
6872
public MarkdownDocumentReader(String markdownResource) {
6973
this(new DefaultResourceLoader().getResource(markdownResource), MarkdownDocumentReaderConfig.defaultConfig());
7074
}
7175

76+
/**
77+
* Create a new {@link MarkdownDocumentReader} instance.
78+
* @param markdownResource the resource to read
79+
* @param config the configuration to use
80+
*/
7281
public MarkdownDocumentReader(String markdownResource, MarkdownDocumentReaderConfig config) {
7382
this(new DefaultResourceLoader().getResource(markdownResource), config);
7483
}
7584

85+
/**
86+
* Create a new {@link MarkdownDocumentReader} instance.
87+
* @param markdownResource the resource to read
88+
*/
7689
public MarkdownDocumentReader(Resource markdownResource, MarkdownDocumentReaderConfig config) {
7790
this.markdownResource = markdownResource;
7891
this.config = config;
@@ -115,6 +128,9 @@ static class DocumentVisitor extends AbstractVisitor {
115128
this.config = config;
116129
}
117130

131+
/**
132+
* Visits the document node and initializes the current document builder.
133+
*/
118134
@Override
119135
public void visit(org.commonmark.node.Document document) {
120136
this.currentDocumentBuilder = Document.builder();

document-readers/pdf-reader/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
<dependency>
4444
<groupId>org.springframework.ai</groupId>
4545
<artifactId>spring-ai-core</artifactId>
46-
<version>${parent.version}</version>
46+
<version>${project.parent.version}</version>
4747
</dependency>
4848

4949
<dependency>

document-readers/tika-reader/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@
4444
<dependency>
4545
<groupId>org.springframework.ai</groupId>
4646
<artifactId>spring-ai-core</artifactId>
47-
<version>${parent.version}</version>
47+
<version>${project.parent.version}</version>
4848
</dependency>
4949

5050
<dependency>

models/spring-ai-postgresml/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@
4343
<dependency>
4444
<groupId>org.springframework.ai</groupId>
4545
<artifactId>spring-ai-core</artifactId>
46-
<version>${parent.version}</version>
46+
<version>${project.parent.version}</version>
4747
</dependency>
4848

4949
<dependency>

models/spring-ai-transformers/pom.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
<dependency>
5656
<groupId>org.springframework.ai</groupId>
5757
<artifactId>spring-ai-core</artifactId>
58-
<version>${parent.version}</version>
58+
<version>${project.parent.version}</version>
5959
</dependency>
6060

6161
<dependency>

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,9 @@ interface PromptUserSpec {
115115

116116
}
117117

118+
/**
119+
* Specification for a prompt system.
120+
*/
118121
interface PromptSystemSpec {
119122

120123
PromptSystemSpec text(String text);

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

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,10 +26,22 @@
2626

2727
public class AbstractResponseMetadata {
2828

29+
/**
30+
* AI metadata string format.
31+
*/
2932
protected static final String AI_METADATA_STRING = "{ id: %1$s, usage: %2$s, rateLimit: %3$s }";
3033

34+
/**
35+
* Metadata map.
36+
*/
3137
protected final Map<String, Object> map = new ConcurrentHashMap<>();
3238

39+
/**
40+
* Create a new {@link AbstractResponseMetadata} instance.
41+
*/
42+
public AbstractResponseMetadata() {
43+
}
44+
3345
/**
3446
* Gets an entry from the context. Returns {@code null} when entry is not present.
3547
* @param key key

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ default void accept(List<Document> documents) {
5151
/**
5252
* Deletes documents from the vector store.
5353
* @param idList list of document ids for which documents will be removed.
54-
* @return
54+
* @return Returns true if the documents were successfully deleted.
5555
*/
5656
Optional<Boolean> delete(List<String> idList);
5757

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

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,12 @@
3737
*/
3838
public abstract class AbstractFilterExpressionConverter implements FilterExpressionConverter {
3939

40+
/**
41+
* Create a new AbstractFilterExpressionConverter.
42+
*/
43+
public AbstractFilterExpressionConverter() {
44+
}
45+
4046
@Override
4147
public String convertExpression(Expression expression) {
4248
return this.convertOperand(expression);

0 commit comments

Comments
 (0)