feat(jsdoc): add JSDoc comments for Search

Author: niloysikdar

src/search/@types/index.ts

@@ -1,4 +1,7 @@
 export type MethodParamsOptions = {
+  /**
+   * The context ID to be used for the request, you can get all context IDs by calling `hyper.contexts.list()` and then using the `id` field from the response.
+   */
   contextId: string;
 };
 
@@ -37,7 +40,16 @@ type MetaDataType =
     };
 
 export type SearchResultData = {
+  /**
+   * The content of the document
+   */
   page_content: string;
+  /**
+   * The type of the document
+   */
   type: 'Document';
+  /**
+   * Metadata about the document
+   */
   metadata: MetaDataType;
 };

src/search/search.ts

@@ -4,6 +4,18 @@ import type { MethodParamsOptions, SearchResultData } from './@types';
 export class Search {
   constructor(private readonly hyper: Hyper) {}
 
+  /**
+   * Execute embeddings Search API to perform nuanced searches across integrated third-party data sources and internal documents. More information: https://docs.gethyper.ai/search#post-v1-search
+   * @param {string} query - The query to be processed
+   * @param {MethodParamsOptions} options - Optional parameters to be passed to the request, such as `contextId`
+   * @returns The result of embeddings Search API to perform nuanced searches across integrated third-party data sources and internal documents
+   * @example
+   * const { data, error } = await hyper.search.execute(
+        'quarterly sales report',
+        { contextId: '123e4567-e89b-12d3-a456-426614174000' },
+     );
+   * console.log(data);
+   */
   async execute(query: string, options?: MethodParamsOptions) {
     const payload = options?.contextId
       ? { query, context_id: options.contextId }