update jsdoc

cityssm · May 10, 2024 · efa20f7 · efa20f7
1 parent 5b60578
commit efa20f7
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 3 deletions.
diff --git a/index.d.ts b/index.d.ts
@@ -58,7 +58,10 @@ export declare class SectorFlow {
      * Sends a message to a project, returning the responses.
      * @param {string} projectId - The project id.
      * @param {string} message - The message.
-     * @param {string} threadId - The optional thread id, to continue a chain of messages.
+     * @param {object} options - Optional.
+     * @param {string} options.threadId - The optional thread id, to continue a chain of messages.
+     * @param {string} options.collectionName - The optional SectorFlow collection name that contains the file. Used with the fileName option.
+     * @param {string} options.fileName - The optional SectorFlow file name. Used with the collectionName option.
      * @returns {Promise<ChatMessageResponse>} - The responses to the message.
      */
     sendChatMessage(projectId: string, message: string, options?: {

diff --git a/index.js b/index.js
@@ -177,7 +177,10 @@ export class SectorFlow {
      * Sends a message to a project, returning the responses.
      * @param {string} projectId - The project id.
      * @param {string} message - The message.
-     * @param {string} threadId - The optional thread id, to continue a chain of messages.
+     * @param {object} options - Optional.
+     * @param {string} options.threadId - The optional thread id, to continue a chain of messages.
+     * @param {string} options.collectionName - The optional SectorFlow collection name that contains the file. Used with the fileName option.
+     * @param {string} options.fileName - The optional SectorFlow file name. Used with the collectionName option.
      * @returns {Promise<ChatMessageResponse>} - The responses to the message.
      */
     async sendChatMessage(projectId, message, options) {

diff --git a/index.ts b/index.ts
@@ -252,7 +252,10 @@ export class SectorFlow {
    * Sends a message to a project, returning the responses.
    * @param {string} projectId - The project id.
    * @param {string} message - The message.
-   * @param {string} threadId - The optional thread id, to continue a chain of messages.
+   * @param {object} options - Optional.
+   * @param {string} options.threadId - The optional thread id, to continue a chain of messages.
+   * @param {string} options.collectionName - The optional SectorFlow collection name that contains the file. Used with the fileName option.
+   * @param {string} options.fileName - The optional SectorFlow file name. Used with the collectionName option.
    * @returns {Promise<ChatMessageResponse>} - The responses to the message.
    */
   async sendChatMessage(