LlmKeywords (Katalon Studio API Specification)

com.kms.katalon.core.llm.keyword.LlmKeywords

```
@CompileStatic
class LlmKeywords
extends Object
```
Built-in keywords for calling the AI service configured for this execution from a test case.

Constructor Summary

Constructors
Constructor and description
`LlmKeywords ()`

Methods Summary

Methods
Type Params	Return Type	Name and description
	`static String`	`ask(String prompt)` Send a text prompt to the AI service and return its response text.
	`static String`	`ask(String prompt, List<String> attachmentPaths)` Send a text prompt with optional file/image attachments to the AI service and return its response text.
	`static String`	`ask(String prompt, String[] attachmentPaths)` Send a text prompt with optional file/image attachments to the AI service and return its response text.
	`static String`	`ask(FailureHandling flowControl, String prompt, String[] attachmentPaths)` Send a text prompt with optional file/image attachments to the AI service and return its response text.
	`static String`	`ask(FailureHandling flowControl, String prompt, List<String> attachmentPaths)` Send a text prompt with optional file/image attachments to the AI service and return its response text.
	`static String`	`ask(UserInput[] inputs)` Send a prompt built from UserInput parts to the AI service and return its response text.
	`static String`	`ask(FailureHandling flowControl, UserInput[] inputs)` Send a prompt built from UserInput parts to the AI service and return its response text.
	`static void`	`assertFile(String filePath, String expectation)` Ask the AI service whether a file's content (image or text-like) meets an expectation, and fail the step if it does not.
	`static void`	`assertFile(String[] filePaths, String expectation)` Ask the AI service whether the content of one or more files (images or text-like files, detected by extension) meets an expectation, and fail the step if it does not.
	`static void`	`assertFile(String[] filePaths, String expectation, FailureHandling flowControl)` Ask the AI service whether the content of one or more files (images or text-like files, detected by extension) meets an expectation, and fail the step if it does not.
	`static void`	`assertFile(String filePath, String expectation, FailureHandling flowControl)` Ask the AI service whether a file's content (image or text-like) meets an expectation, and fail the step if it does not.
	`static void`	`assertFile(List<String> filePaths, String expectation)` Ask the AI service whether the content of one or more files meets an expectation, and fail the step if it does not.
	`static void`	`assertFile(List<String> filePaths, String expectation, FailureHandling flowControl)` Ask the AI service whether the content of one or more files meets an expectation, and fail the step if it does not.
	`static void`	`assertText(String value, String expectation)` Ask the AI service whether a text value meets an expectation, and fail the step if it does not.
	`static void`	`assertText(String value, String expectation, FailureHandling flowControl)` Ask the AI service whether a text value meets an expectation, and fail the step if it does not.

Inherited Methods Summary

Inherited Methods
Methods inherited from class	Name
`class Object`	`equals, toString, hashCode, getClass, notify, notifyAll, wait, wait, wait`

- Constructor Detail
  - LlmKeywords()
- Method Detail
  - @CompileStatic static String ask(String prompt)
    
    Send a text prompt to the AI service and return its response text. To attach files or images, use ask(String, String...) — each attachment is detected by extension: image extensions (png, jpg, jpeg, webp, gif, heic, heif) are sent as images, other supported extensions (txt, csv, json, log, pdf) as files.
    throws:
    StepErrorException when no AI service is configured/available, or the AI returns an empty response
    
    Parameters:
    prompt - the question or instruction to send
    Returns:
    the AI response text
  - @CompileStatic static String ask(String prompt, List<String> attachmentPaths)
    
    Send a text prompt with optional file/image attachments to the AI service and return its response text. See ask(String, String...).
    throws:
    StepErrorException when no AI service is configured/available, an attachment is missing or of an unsupported type, or the AI returns an empty response
    
    Parameters:
    prompt - the question or instruction to send
    attachmentPaths - paths of files to attach — absolute, or relative to the project folder
    Returns:
    the AI response text
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static String ask(String prompt, String[] attachmentPaths)
    
    Send a text prompt with optional file/image attachments to the AI service and return its response text. See ask(String, List).
    throws:
    StepErrorException when no AI service is configured/available, an attachment is missing or of an unsupported type, or the AI returns an empty response
    
    Parameters:
    prompt - the question or instruction to send
    attachmentPaths - paths of files to attach — absolute, or relative to the project folder
    Returns:
    the AI response text
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static String ask(FailureHandling flowControl, String prompt, String[] attachmentPaths)
    
    Send a text prompt with optional file/image attachments to the AI service and return its response text. See ask(String, List).
    throws:
    StepErrorException when no AI service is configured/available, an attachment is missing or of an unsupported type, or the AI returns an empty response
    
    Parameters:
    flowControl - the failure-handling behavior applied when the keyword fails
    prompt - the question or instruction to send
    attachmentPaths - paths of files to attach — absolute, or relative to the project folder
    Returns:
    the AI response text
  - @CompileStatic static String ask(FailureHandling flowControl, String prompt, List<String> attachmentPaths)
    
    Send a text prompt with optional file/image attachments to the AI service and return its response text. See ask(String, String...).
    throws:
    StepErrorException when no AI service is configured/available, an attachment is missing or of an unsupported type, or the AI returns an empty response
    
    Parameters:
    flowControl - the failure-handling behavior applied when the keyword fails
    prompt - the question or instruction to send
    attachmentPaths - paths of files to attach — absolute, or relative to the project folder
    Returns:
    the AI response text
  - @CompileStatic static String ask(UserInput[] inputs)
    
    Send a prompt built from UserInput parts to the AI service and return its response text. Script alternative to ask(String, String...) when the order of text and attachment parts matters.
    throws:
    StepErrorException when no AI service is configured/available, an attachment is missing or of an unsupported type, or the AI returns an empty response
    
    Parameters:
    inputs - the prompt parts to send, in order
    Returns:
    the AI response text
  - @CompileStatic static String ask(FailureHandling flowControl, UserInput[] inputs)
    
    Send a prompt built from UserInput parts to the AI service and return its response text. See ask(UserInput...).
    throws:
    StepErrorException when no AI service is configured/available, an attachment is missing or of an unsupported type, or the AI returns an empty response
    
    Parameters:
    flowControl - the failure-handling behavior applied when the keyword fails
    inputs - the prompt parts to send, in order
    Returns:
    the AI response text
  - @CompileStatic static void assertFile(String filePath, String expectation)
    
    Ask the AI service whether a file's content (image or text-like) meets an expectation, and fail the step if it does not.
    throws:
    StepFailedException when the AI judges the file does not meet the expectation
    throws:
    StepErrorException when no AI service is configured/available, the file is missing or of an unsupported type, or the AI response cannot be judged
    
    Parameters:
    filePath - path of the file to judge — absolute, or relative to the project folder
    expectation - what the file is expected to satisfy, in plain language
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void assertFile(String[] filePaths, String expectation)
    
    Ask the AI service whether the content of one or more files (images or text-like files, detected by extension) meets an expectation, and fail the step if it does not.
    throws:
    StepFailedException when the AI judges the files do not meet the expectation
    throws:
    StepErrorException when no AI service is configured/available, a file is missing or of an unsupported type, or the AI response cannot be judged
    
    Parameters:
    filePaths - paths of the files to judge — absolute, or relative to the project folder
    expectation - what the files are expected to satisfy, in plain language
  - @CompileStatic static void assertFile(String[] filePaths, String expectation, FailureHandling flowControl)
    
    Ask the AI service whether the content of one or more files (images or text-like files, detected by extension) meets an expectation, and fail the step if it does not.
    throws:
    StepFailedException when the AI judges the files do not meet the expectation
    throws:
    StepErrorException when no AI service is configured/available, a file is missing or of an unsupported type, or the AI response cannot be judged
    
    Parameters:
    filePaths - paths of the files to judge — absolute, or relative to the project folder
    expectation - what the files are expected to satisfy, in plain language
    flowControl - the failure-handling behavior applied when the keyword fails
  - @CompileStatic static void assertFile(String filePath, String expectation, FailureHandling flowControl)
    
    Ask the AI service whether a file's content (image or text-like) meets an expectation, and fail the step if it does not.
    throws:
    StepFailedException when the AI judges the file does not meet the expectation
    throws:
    StepErrorException when no AI service is configured/available, the file is missing or of an unsupported type, or the AI response cannot be judged
    
    Parameters:
    filePath - path of the file to judge — absolute, or relative to the project folder
    expectation - what the file is expected to satisfy, in plain language
    flowControl - the failure-handling behavior applied when the keyword fails
  - @CompileStatic static void assertFile(List<String> filePaths, String expectation)
    
    Ask the AI service whether the content of one or more files meets an expectation, and fail the step if it does not. See assertFile(String[], String).
    throws:
    StepFailedException when the AI judges the files do not meet the expectation
    throws:
    StepErrorException when no AI service is configured/available, a file is missing or of an unsupported type, or the AI response cannot be judged
    
    Parameters:
    filePaths - paths of the files to judge — absolute, or relative to the project folder
    expectation - what the files are expected to satisfy, in plain language
  - @CompileStatic static void assertFile(List<String> filePaths, String expectation, FailureHandling flowControl)
    
    Ask the AI service whether the content of one or more files meets an expectation, and fail the step if it does not. See assertFile(String[], String).
    throws:
    StepFailedException when the AI judges the files do not meet the expectation
    throws:
    StepErrorException when no AI service is configured/available, a file is missing or of an unsupported type, or the AI response cannot be judged
    
    Parameters:
    filePaths - paths of the files to judge — absolute, or relative to the project folder
    expectation - what the files are expected to satisfy, in plain language
    flowControl - the failure-handling behavior applied when the keyword fails
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void assertText(String value, String expectation)
    
    Ask the AI service whether a text value meets an expectation, and fail the step if it does not.
    throws:
    StepFailedException when the AI judges the value does not meet the expectation
    throws:
    StepErrorException when no AI service is configured/available, or the AI response cannot be judged
    
    Parameters:
    value - the text value to judge
    expectation - what the value is expected to satisfy, in plain language
  - @CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void assertText(String value, String expectation, FailureHandling flowControl)
    
    Ask the AI service whether a text value meets an expectation, and fail the step if it does not.
    throws:
    StepFailedException when the AI judges the value does not meet the expectation
    throws:
    StepErrorException when no AI service is configured/available, or the AI response cannot be judged
    
    Parameters:
    value - the text value to judge
    expectation - what the value is expected to satisfy, in plain language
    flowControl - the failure-handling behavior applied when the keyword fails

Summary:
Constructor
Method

| Detail:
Constructor
Method

[Groovy] Class LlmKeywords

Constructor Summary

Methods Summary

Inherited Methods Summary

Constructor Detail

LlmKeywords()

Method Detail

@CompileStatic static String ask(String prompt)

@CompileStatic static String ask(String prompt, List<String> attachmentPaths)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static String ask(String prompt, String[] attachmentPaths)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static String ask(FailureHandling flowControl, String prompt, String[] attachmentPaths)

@CompileStatic static String ask(FailureHandling flowControl, String prompt, List<String> attachmentPaths)

@CompileStatic static String ask(UserInput[] inputs)

@CompileStatic static String ask(FailureHandling flowControl, UserInput[] inputs)

@CompileStatic static void assertFile(String filePath, String expectation)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void assertFile(String[] filePaths, String expectation)

@CompileStatic static void assertFile(String[] filePaths, String expectation, FailureHandling flowControl)

@CompileStatic static void assertFile(String filePath, String expectation, FailureHandling flowControl)

@CompileStatic static void assertFile(List<String> filePaths, String expectation)

@CompileStatic static void assertFile(List<String> filePaths, String expectation, FailureHandling flowControl)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void assertText(String value, String expectation)

@CompileStatic @Keyword(keywordObject: StringConstants.KW_CATEGORIZE_UTILITIES) static void assertText(String value, String expectation, FailureHandling flowControl)