Merge pull request #170 from forcedotcom/mz/jsonschema-callLLM

feat: add json_schema as parameter to call LLM

Author: mingxuanzhangsfdx

src/types/llmService/LLMService.ts

@@ -14,11 +14,24 @@ export interface LLMServiceInterface {
    * @param engineeredPrompt - The prompt that has been engineered for the LLM.
    * @param promptId - The ID of the prompt (optional).
    * @param outputTokenLimit - The limit on the number of output tokens (optional).
+   * @param options - The object of other options in the request (optional)
    * @returns A promise that resolves to the LLM's response as a string.
    */
   callLLM(
     engineeredPrompt: string,
     promptId?: string,
-    outputTokenLimit?: number
+    outputTokenLimit?: number,
+    options?: CallLLMOptions
   ): Promise<string>;
 }
+
+export type CallLLMOptions = {
+  // Values to be added to the parameters property on the request.
+  parameters?: {
+    guided_json?: string; // TODO: define the type in detail
+  };
+  // Properties to be added to the body of the request.
+  properties?: {
+    stop_sequence?: string[]; // TODO: define the type in detail
+  };
+};