Skip to content

Commit f04eaa5

Browse files
committed
update example and parameters
Signed-off-by: Rishav Dhar <19497993+rdhar@users.noreply.github.com>
1 parent 7d45ebb commit f04eaa5

File tree

1 file changed

+23
-14
lines changed

1 file changed

+23
-14
lines changed

README.md

Lines changed: 23 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,18 @@ jobs:
3333
payload: |
3434
model: openai/gpt-4.1-mini
3535
messages:
36+
- role: system
37+
content: You are a helpful assistant running within GitHub CI.
3638
- role: user
3739
content: Concisely summarize this GitHub issue titled ${{ github.event.issue.title }}: ${{ github.event.issue.body }}
40+
max_tokens: 100
3841
temperature: 0.9
3942
top_p: 0.9
4043
4144
- name: Comment summary
4245
run: gh issue comment $NUMBER --body "$SUMMARY"
4346
env:
44-
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
47+
GH_TOKEN: ${{ github.token }}
4548
NUMBER: ${{ github.event.issue.number }}
4649
SUMMARY: ${{ steps.prompt.outputs.response }}
4750
```
@@ -50,23 +53,29 @@ jobs:
5053
5154
## Inputs
5255
53-
Only `messages` and `model` are required inputs. [Compare available AI models](https://docs.github.com/en/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task "Comparison of AI models for GitHub.") to choose the best one for your use-case.
56+
Either `payload` or `payload-file` is required. [Compare available AI models](https://docs.github.com/en/copilot/using-github-copilot/ai-models/choosing-the-right-ai-model-for-your-task "Comparison of AI models for GitHub.") to choose the best one for your use-case.
5457

55-
| Name | Description |
56-
| -------------------- | ---------------------------------------------------------------------------------------------------- |
57-
| `github-api-version` | GitHub API version.</br>Default: `2022-11-28` |
58-
| `github-token` | GitHub token.</br>Default: `github.token` |
59-
| `max-tokens` | Maximum number of tokens to generate in the completion.</br>Example: `1000` |
60-
| `messages` | Messages to send to the model in JSON format.</br>Example: `[{"role": "user", "content": "Hello!"}]` |
61-
| `model` | Model to use for inference.</br>Example: `openai/o4-mini` |
62-
| `org` | Organization to which the request should be attributed.</br>Example: `github.repository_owner` |
58+
| Type | Name | Description |
59+
| ------ | -------------------- | ------------------------------------------------------------------------------------------------------------ |
60+
| Data | `payload` | Body parameters of the inference request in YAML format.</br>Example: `model:…` |
61+
| Data | `payload-file` | Path to a file containing the body parameters of the inference request.</br>Example: `./payload.[json\|yml]` |
62+
| Config | `show-payload` | Whether to show the payload in the logs.</br>Default: `true` |
63+
| Config | `show-response` | Whether to show the response content in the logs.</br>Default: `true` |
64+
| Admin | `github-api-version` | GitHub API version.</br>Default: `2022-11-28` |
65+
| Admin | `github-token` | GitHub token.</br>Default: `github.token` |
66+
| Admin | `org` | Organization for request attribution.</br>Example: `github.repository_owner` |
67+
68+
</br>
6369

6470
## Outputs
6571

66-
| Name | Description |
67-
| -------------- | -------------------------------------------- |
68-
| `response` | Response content from the inference request. |
69-
| `response-raw` | Raw, complete response in JSON format. |
72+
| Name | Description |
73+
| -------------- | --------------------------------------------------------------- |
74+
| `response` | Response content from the inference request. |
75+
| `response-raw` | File path containing the complete, raw response in JSON format. |
76+
| `payload` | Body parameters of the inference request in JSON format. |
77+
78+
</br>
7079

7180
## Security
7281

0 commit comments

Comments
 (0)