Azure / Azure/azure-sdk-for-python
[aw] Documentation Consistency Check failed
- Dominant language
- Python
- Stars
- 5.6k
- Forks
- 3.4k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 193
Description
### Workflow Failure
**Workflow:** [Documentation Consistency Check](https://github.com/Azure/azure-sdk-for-python/blob/main/.github/workflows/doc-consistency-check.md)
**Branch:** main
**Run:** https://github.com/Azure/azure-sdk-for-python/actions/runs/34807417848
**Pull Request:** [#47974](https://github.com/Azure/azure-sdk-for-python/pull/47974)
> [!WARNING]
> **Invalid or Unsupported Model**: The agent failed because the configured model name is invalid, unknown, or unavailable for this engine/account.
This is a **configuration issue**, not a transient error — retrying will not help.
How to fix this
Specify a valid model for the selected engine in the workflow frontmatter:
```yaml
---
engine: copilot
model: gpt-5-mini
---
```
To find valid models, check your engine/provider documentation (for Copilot see [supported models](https://docs.github.com/en/copilot/using-github-copilot/using-github-copilot-in-the-command-line#supported-models)).
> [!WARNING]
> **Engine Failure**: The `copilot` engine terminated unexpectedly.
**Last agent output:**
```
● Request failed (transient_bad_request). Retrying...
● Request failed (transient_bad_request). Retrying...
400 The requested model is not available for integrator "agentic-workflows". Available models: [gpt-4.1 claude-fable-5.1 claude-fable-5 claude-opus-4.6 claude-opus-4.7 claude-opus-4.8-fast claude-opus-4.8 claude-opus-5 claude-sonnet-5 copilot-search-a copilot-search-b copilot-search-c exec-agent-a exec-agent-b exec-agent-c gpt-5.3-codex gpt-5.4-mini gpt-5.4 gpt-5.5 gpt-5.6-luna gpt-5.6-sol-fast gpt-5.6-sol gpt-5.6-terra gpt-5.6-luna-utility gpt-6-astra grok-4.5 grok-4.6 kimi-k2.7-code kimi-k3 mai-code-1.1-flash trajectory-compaction gpt-5-mini gpt-3.5-turbo gpt-3.5-turbo-0613 gpt-4o-mini gpt-4o-mini-2024-07-18 copilot-preview-4o-mini-a1cfd608 gpt-4 gpt-4-0613 copilot-preview-gpt4-centralus gpt-4o gpt-4o-2024-11-20 gpt-4o-2024-05-13 gpt-4-o-preview gpt-4o-japanwest copilot-preview-gpt4o-centralus gpt-4o-2024-08-06 claude-haiku-4.5 gpt-4.1-2025-04-14 goldeneye-secondary gpt-5.2]. Verify the correct Copilot-Integration-Id header is being sent.
Changes +0 -0
Duration 25s
● Request failed (transient_bad_request). Retrying...
● Request failed (transient_bad_request). Retrying...
400 The requested model is not available for integrator "agentic-workflows". Available models: [gpt-4.1 claude-fable-5.1 claude-fable-5 claude-opus-4.6 claude-opus-4.7 claude-opus-4.8-fast claude-opus-4.8 claude-opus-5 claude-sonnet-5 copilot-search-a copilot-search-b copilot-search-c exec-agent-a exec-agent-b exec-agent-c gpt-5.3-codex gpt-5.4-mini gpt-5.4 gpt-5.5 gpt-5.6-luna gpt-5.6-sol-fast gpt-5.6-sol gpt-5.6-terra gpt-5.6-luna-utility gpt-6-astra grok-4.5 grok-4.6 kimi-k2.7-code kimi-k3 mai-code-1.1-flash trajectory-compaction gpt-5-mini gpt-3.5-turbo gpt-3.5-turbo-0613 gpt-4o-mini gpt-4o-mini-2024-07-18 copilot-preview-4o-mini-a1cfd608 gpt-4 gpt-4-0613 copilot-preview-gpt4-centralus gpt-4o gpt-4o-2024-11-20 gpt-4o-2024-05-13 gpt-4-o-preview gpt-4o-japanwest copilot-preview-gpt4o-centralus gpt-4o-2024-08-06 claude-haiku-4.5 gpt-4.1-2025-04-14 goldeneye-secondary gpt-5.2]. Verify the correct Copilot-Integration-Id header is being sent.
Changes +0 -0
Duration 49s
```
### Action Required
**Assign this issue to an agent** to debug and fix the issue.
Debug with any coding agent
Use this prompt with any coding agent (GitHub Copilot, Claude, Gemini, etc.):
````
Debug the agentic workflow failure using https://raw.githubusercontent.com/github/gh-aw/main/debug.md
The failed workflow run is at https://github.com/Azure/azure-sdk-for-python/actions/runs/34807417848
````
Manually invoke the agent
Debug this workflow failure using your favorite Agent CLI and the `agentic-workflows` prompt.
- Start your agent
- Load the `agentic-workflows` skill from `.github/skills/agentic-workflows/SKILL.md` or
- Type `debug the agentic workflow doc-consistency-check failure in https://github.com/Azure/azure-sdk-for-python/actions/runs/34807417848`
> [!TIP]
>
> Stop reporting this workflow as a failure
>
> To stop a workflow from creating failure issues, set `report-failure-as-issue: false` in its frontmatter:
> ```yaml
> safe-outputs:
> report-failure-as-issue: false
> ```
>
>
> Generated from [Documentation Consistency Check](https://github.com/Azure/azure-sdk-for-python/actions/runs/34807417848) · [◷](https://github.com/search?q=repo%3AAzure%2Fazure-sdk-for-python+is%3Aissue+%22gh-aw-workflow-id%3A+doc-consistency-check%22&type=issues)
> - [x] expires on Sep 21, 2026, 4:52 AM UTC
Contributor guide
Research direction
Start with .github/workflows/doc-consistency-check.md and inspect its workflow frontmatter, especially the configured engine and model. Compare the model setting with the supported models reported in the failed run, then rerun the Documentation Consistency Check workflow. Done means the workflow completes without the model-not-supported or engine failure.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- github-actions, yaml
- Domain
- ci-cd
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Active
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100