Skip to content

Commit 018257a

Browse files
tzolovtzolov
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);

‎spring-ai-core/src/main/java/org/springframework/ai/vectorstore/observation/AbstractObservationVectorStore.java

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ public abstract class AbstractObservationVectorStore implements VectorStore {
4545
/**
4646
* Create a new {@link AbstractObservationVectorStore} instance.
4747
* @param observationRegistry the observation registry to use
48+
* @param customObservationConvention the custom observation convention to use
4849
*/
4950
public AbstractObservationVectorStore(ObservationRegistry observationRegistry,
5051
VectorStoreObservationConvention customObservationConvention) {
@@ -100,12 +101,31 @@ public List<Document> similaritySearch(SearchRequest request) {
100101
});
101102
}
102103

104+
/**
105+
* Perform the actual add operation.
106+
* @param documents the documents to add
107+
*/
103108
public abstract void doAdd(List<Document> documents);
104109

110+
/**
111+
* Perform the actual delete operation.
112+
* @param idList the list of document IDs to delete
113+
* @return true if the documents were successfully deleted
114+
*/
105115
public abstract Optional<Boolean> doDelete(List<String> idList);
106116

117+
/**
118+
* Perform the actual similarity search operation.
119+
* @param request the search request
120+
* @return the list of documents that match the query request conditions
121+
*/
107122
public abstract List<Document> doSimilaritySearch(SearchRequest request);
108123

124+
/**
125+
* Create a new {@link VectorStoreObservationContext.Builder} instance.
126+
* @param operationName the operation name
127+
* @return the observation context builder
128+
*/
109129
public abstract VectorStoreObservationContext.Builder createObservationContextBuilder(String operationName);
110130

111131
}

‎vector-stores/spring-ai-azure-store/pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<dependency>
4646
<groupId>org.springframework.ai</groupId>
4747
<artifactId>spring-ai-core</artifactId>
48-
<version>${parent.version}</version>
48+
<version>${project.parent.version}</version>
4949
</dependency>
5050
<dependency>
5151
<groupId>com.azure</groupId>
@@ -69,15 +69,15 @@
6969
<dependency>
7070
<groupId>org.springframework.ai</groupId>
7171
<artifactId>spring-ai-transformers</artifactId>
72-
<version>${parent.version}</version>
72+
<version>${project.parent.version}</version>
7373
<scope>test</scope>
7474
</dependency>
7575

7676
<!-- Contains sample test data -->
7777
<dependency>
7878
<groupId>org.springframework.ai</groupId>
7979
<artifactId>spring-ai-test</artifactId>
80-
<version>${parent.version}</version>
80+
<version>${project.parent.version}</version>
8181
<scope>test</scope>
8282
</dependency>
8383

‎vector-stores/spring-ai-chroma-store/pom.xml

Lines changed: 3 additions & 3 deletions
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>
@@ -53,7 +53,7 @@
5353
<dependency>
5454
<groupId>org.springframework.ai</groupId>
5555
<artifactId>spring-ai-openai</artifactId>
56-
<version>${parent.version}</version>
56+
<version>${project.parent.version}</version>
5757
<scope>test</scope>
5858
</dependency>
5959

@@ -91,7 +91,7 @@
9191
<dependency>
9292
<groupId>org.springframework.ai</groupId>
9393
<artifactId>spring-ai-transformers</artifactId>
94-
<version>${parent.version}</version>
94+
<version>${project.parent.version}</version>
9595
<scope>test</scope>
9696
</dependency>
9797
</dependencies>

‎vector-stores/spring-ai-coherence-store/pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@
2929
<dependency>
3030
<groupId>org.springframework.ai</groupId>
3131
<artifactId>spring-ai-core</artifactId>
32-
<version>${parent.version}</version>
32+
<version>${project.parent.version}</version>
3333
</dependency>
3434

3535
<dependency>
@@ -54,15 +54,15 @@
5454
<dependency>
5555
<groupId>org.springframework.ai</groupId>
5656
<artifactId>spring-ai-transformers</artifactId>
57-
<version>${parent.version}</version>
57+
<version>${project.parent.version}</version>
5858
<scope>test</scope>
5959
</dependency>
6060

6161

6262
<dependency>
6363
<groupId>org.springframework.ai</groupId>
6464
<artifactId>spring-ai-test</artifactId>
65-
<version>${parent.version}</version>
65+
<version>${project.parent.version}</version>
6666
<scope>test</scope>
6767
</dependency>
6868

‎vector-stores/spring-ai-elasticsearch-store/pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@
4747
<dependency>
4848
<groupId>org.springframework.ai</groupId>
4949
<artifactId>spring-ai-core</artifactId>
50-
<version>${parent.version}</version>
50+
<version>${project.parent.version}</version>
5151
</dependency>
5252

5353
<dependency>
@@ -60,14 +60,14 @@
6060
<dependency>
6161
<groupId>org.springframework.ai</groupId>
6262
<artifactId>spring-ai-openai</artifactId>
63-
<version>${parent.version}</version>
63+
<version>${project.parent.version}</version>
6464
<scope>test</scope>
6565
</dependency>
6666

6767
<dependency>
6868
<groupId>org.springframework.ai</groupId>
6969
<artifactId>spring-ai-test</artifactId>
70-
<version>${parent.version}</version>
70+
<version>${project.parent.version}</version>
7171
<scope>test</scope>
7272
</dependency>
7373

‎vector-stores/spring-ai-gemfire-store/pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -64,21 +64,21 @@
6464
<dependency>
6565
<groupId>org.springframework.ai</groupId>
6666
<artifactId>spring-ai-openai</artifactId>
67-
<version>${parent.version}</version>
67+
<version>${project.parent.version}</version>
6868
<scope>test</scope>
6969
</dependency>
7070

7171
<dependency>
7272
<groupId>org.springframework.ai</groupId>
7373
<artifactId>spring-ai-test</artifactId>
74-
<version>${parent.version}</version>
74+
<version>${project.parent.version}</version>
7575
<scope>test</scope>
7676
</dependency>
7777

7878
<dependency>
7979
<groupId>org.springframework.ai</groupId>
8080
<artifactId>spring-ai-transformers</artifactId>
81-
<version>${parent.version}</version>
81+
<version>${project.parent.version}</version>
8282
<scope>test</scope>
8383
</dependency>
8484

‎vector-stores/spring-ai-hanadb-store/pom.xml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@
4646
<dependency>
4747
<groupId>org.springframework.ai</groupId>
4848
<artifactId>spring-ai-core</artifactId>
49-
<version>${parent.version}</version>
49+
<version>${project.parent.version}</version>
5050
</dependency>
5151

5252
<dependency>
@@ -70,7 +70,7 @@
7070
<dependency>
7171
<groupId>org.springframework.ai</groupId>
7272
<artifactId>spring-ai-openai</artifactId>
73-
<version>${parent.version}</version>
73+
<version>${project.parent.version}</version>
7474
<scope>test</scope>
7575
</dependency>
7676

@@ -83,14 +83,14 @@
8383
<dependency>
8484
<groupId>org.springframework.ai</groupId>
8585
<artifactId>spring-ai-test</artifactId>
86-
<version>${parent.version}</version>
86+
<version>${project.parent.version}</version>
8787
<scope>test</scope>
8888
</dependency>
8989

9090
<dependency>
9191
<groupId>org.springframework.ai</groupId>
9292
<artifactId>spring-ai-pdf-document-reader</artifactId>
93-
<version>${parent.version}</version>
93+
<version>${project.parent.version}</version>
9494
<scope>test</scope>
9595
</dependency>
9696
<dependency>

‎vector-stores/spring-ai-milvus-store/pom.xml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@
4545
<dependency>
4646
<groupId>org.springframework.ai</groupId>
4747
<artifactId>spring-ai-core</artifactId>
48-
<version>${parent.version}</version>
48+
<version>${project.parent.version}</version>
4949
</dependency>
5050

5151
<dependency>
@@ -59,14 +59,14 @@
5959
<dependency>
6060
<groupId>org.springframework.ai</groupId>
6161
<artifactId>spring-ai-openai</artifactId>
62-
<version>${parent.version}</version>
62+
<version>${project.parent.version}</version>
6363
<scope>test</scope>
6464
</dependency>
6565

6666
<dependency>
6767
<groupId>org.springframework.ai</groupId>
6868
<artifactId>spring-ai-test</artifactId>
69-
<version>${parent.version}</version>
69+
<version>${project.parent.version}</version>
7070
<scope>test</scope>
7171
</dependency>
7272

‎vector-stores/spring-ai-mongodb-atlas-store/pom.xml

Lines changed: 3 additions & 3 deletions
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
<!-- MongoDB -->
5050
<dependency>
@@ -60,7 +60,7 @@
6060
<dependency>
6161
<groupId>org.springframework.ai</groupId>
6262
<artifactId>spring-ai-openai</artifactId>
63-
<version>${parent.version}</version>
63+
<version>${project.parent.version}</version>
6464
<scope>test</scope>
6565
</dependency>
6666

@@ -83,7 +83,7 @@
8383
<dependency>
8484
<groupId>org.springframework.ai</groupId>
8585
<artifactId>spring-ai-test</artifactId>
86-
<version>${parent.version}</version>
86+
<version>${project.parent.version}</version>
8787
<scope>test</scope>
8888
</dependency>
8989

0 commit comments

Comments
 (0)