Skip to content

Commit 93c73f5

Browse files
committed
Add javadoc
1 parent 35d1ec7 commit 93c73f5

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/main/java/com/meilisearch/sdk/Index.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1242,6 +1242,15 @@ public TaskInfo resetSearchCutoffMsSettings() throws MeilisearchException {
12421242
return this.settingsHandler.resetSearchCutoffMsSettings(this.uid);
12431243
}
12441244

1245+
/**
1246+
* Retrieves documents that are semantically similar to a given document
1247+
*
1248+
* @param query SimilarDocumentRequest containing parameters for the similar documents search
1249+
* @return SimilarDocumentsResults containing the search results
1250+
* @throws MeilisearchException if an error occurs
1251+
* @see <a href="https://www.meilisearch.com/docs/reference/api/similar">API
1252+
* specification</a>
1253+
*/
12451254
public SimilarDocumentsResults searchSimilarDocuments(SimilarDocumentRequest query)
12461255
throws MeilisearchException {
12471256
return this.config.httpClient.post(

0 commit comments

Comments
 (0)