Merge pull request #27 from mattleibow/dev/system-prompt-file

feat: Add system-prompt-file input for file-based system prompts

Author: sgoedecke

.github/workflows/ci.yml

@@ -80,11 +80,16 @@ jobs:
       - name: Create Prompt File
         run: echo "hello" > prompt.txt
 
+      - name: Create System Prompt File
+        run:
+          echo "You are a helpful AI assistant for testing." > system-prompt.txt
+
       - name: Test Local Action with Prompt File
         id: test-action-prompt-file
         uses: ./
         with:
           prompt-file: prompt.txt
+          system-prompt-file: system-prompt.txt
         env:
           GITHUB_TOKEN: ${{ github.token }}
 

README.md

@@ -47,6 +47,21 @@ steps:
       prompt-file: './path/to/prompt.txt'
 ```
 
+### Using a system prompt file
+
+In addition to the regular prompt, you can provide a system prompt file instead
+of an inline system prompt:
+
+```yaml
+steps:
+  - name: Run AI Inference with System Prompt File
+    id: inference
+    uses: actions/ai-inference@v1
+    with:
+      prompt: 'Hello!'
+      system-prompt-file: './path/to/system-prompt.txt'
+```
+
 ### Read output from file instead of output
 
 This can be useful when model response exceeds actions output limit
@@ -70,15 +85,16 @@ steps:
 Various inputs are defined in [`action.yml`](action.yml) to let you configure
 the action:
 
-| Name            | Description                                                                                                                           | Default                              |
-| --------------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
-| `token`         | Token to use for inference. Typically the GITHUB_TOKEN secret                                                                         | `github.token`                       |
-| `prompt`        | The prompt to send to the model                                                                                                       | N/A                                  |
-| `prompt-file`   | Path to a file containing the prompt. If both `prompt` and `prompt-file` are provided, `prompt-file` takes precedence                 | `""`                                 |
-| `system-prompt` | The system prompt to send to the model                                                                                                | `""`                                 |
-| `model`         | The model to use for inference. Must be available in the [GitHub Models](https://github.com/marketplace?type=models) catalog          | `gpt-4o`                             |
-| `endpoint`      | The endpoint to use for inference. If you're running this as part of an org, you should probably use the org-specific Models endpoint | `https://models.github.ai/inference` |
-| `max-tokens`    | The max number of tokens to generate                                                                                                  | 200                                  |
+| Name                 | Description                                                                                                                                       | Default                              |
+| -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------ |
+| `token`              | Token to use for inference. Typically the GITHUB_TOKEN secret                                                                                     | `github.token`                       |
+| `prompt`             | The prompt to send to the model                                                                                                                   | N/A                                  |
+| `prompt-file`        | Path to a file containing the prompt. If both `prompt` and `prompt-file` are provided, `prompt-file` takes precedence                             | `""`                                 |
+| `system-prompt`      | The system prompt to send to the model                                                                                                            | `"You are a helpful assistant"`      |
+| `system-prompt-file` | Path to a file containing the system prompt. If both `system-prompt` and `system-prompt-file` are provided, `system-prompt-file` takes precedence | `""`                                 |
+| `model`              | The model to use for inference. Must be available in the [GitHub Models](https://github.com/marketplace?type=models) catalog                      | `gpt-4o`                             |
+| `endpoint`           | The endpoint to use for inference. If you're running this as part of an org, you should probably use the org-specific Models endpoint             | `https://models.github.ai/inference` |
+| `max-tokens`         | The max number of tokens to generate                                                                                                              | 200                                  |
 
 ## Outputs