📝 fix some docstrings

src/v2/client.ts

@@ -69,10 +69,10 @@ export class Client {
   }
 
   /**
-   * Searches for resources matching the given criteria.
-   * @param search
+   * Search for resources matching the given criteria.
+   * @param search Search definition class to use.
    * @param searchParameters Search parameters.
-   * @returns a `Promise` containing the search response.
+   * @returns a `Promise` containing the search response with the matching resources.
    */
   async search<S extends typeof BaseSearch>(
     search: S,

src/v2/http/mindeeApiV2.ts

@@ -139,8 +139,8 @@ export class MindeeApiV2 {
   }
 
   /**
-   * Searches for resources matching the given criteria.
-   * @param search
+   * Retrieves a list of resources with the given criteria.
+   * @param search Search definition class to use.
    * @param parameters Search parameters.
    * @returns a `Promise` containing the search response.
    */

src/v2/parsing/inference/field/ragMetadata.ts

@@ -1,6 +1,6 @@
 import { StringDict } from "@/parsing/stringDict.js";
 
-/** Metadata produced by RAG-enabled extraction. */
+/** Metadata about the RAG operation. */
 export class RagMetadata {
   /**
    * The UUID of the matched document used during the RAG operation.

src/v2/parsing/search/baseSearchResponse.ts

@@ -17,7 +17,8 @@ export abstract class BaseSearchResponse extends BaseResponse {
   }
 
   /**
-   * List of strings representing the search response.
+   * Lines composing the response-specific body (header + items).
+   * @returns An array of body lines.
    */
   protected abstract bodyLines(): string[];
 

src/v2/parsing/search/modelWebhook.ts

@@ -1,7 +1,7 @@
 import { StringDict } from "@/parsing/index.js";
 
 /**
- * Model webhook info.
+ * Information about a model's webhook.
  */
 export class ModelWebhook {
   /**

src/v2/parsing/search/paginationMetadata.ts

@@ -1,7 +1,7 @@
 import { StringDict } from "@/parsing/index.js";
 
 /**
- * PaginationMetadata data associated with model search.
+ * Pagination metadata associated with searches.
  */
 export class PaginationMetadata {
   /**

src/v2/parsing/search/searchModel.ts

@@ -2,7 +2,7 @@ import { StringDict } from "@/parsing/index.js";
 import { ModelWebhook } from "./modelWebhook.js";
 
 /**
- * Models search response.
+ * Individual model information.
  */
 export class SearchModel {
   /**
@@ -21,7 +21,7 @@ export class SearchModel {
   public modelType: string;
 
   /**
-   * Webhooks associated with the model.
+   * List of webhooks associated with the model.
    */
   public webhooks: ModelWebhook[];
 

src/v2/parsing/search/searchModels.ts

@@ -1,6 +1,9 @@
 import { SearchModel } from "@/v2/parsing/search/searchModel.js";
 import { StringDict } from "@/parsing/index.js";
 
+/**
+ * List of search models.
+ */
 export class SearchModels extends Array<SearchModel> {
 
   constructor(serverResponse: StringDict[] = []) {

src/v2/search/models/modelSearchResponse.ts

@@ -8,7 +8,7 @@ import { SearchModels } from "@/v2/parsing/search/searchModels.js";
 export class ModelSearchResponse extends BaseSearchResponse {
 
   /**
-   * List of models returned by the search.
+   * Paginated list of matching models.
    */
   public models: SearchModels;
 

src/v2/search/ragDocuments/ragDocumentSearchResponse.ts

@@ -3,7 +3,7 @@ import { BaseSearchResponse } from "@/v2/parsing/search/index.js";
 import { SearchRagDocuments } from "@/v2/parsing/search/searchRagDocuments.js";
 
 /**
- * RAG documents search response.
+ * RAG Documents search response.
  */
 export class RagDocumentSearchResponse extends BaseSearchResponse {