-
Notifications
You must be signed in to change notification settings - Fork 3.4k
Feat/add gh aw #1318
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: staged
Are you sure you want to change the base?
Feat/add gh aw #1318
Changes from all commits
0c3c5bb
4d6855e
0b28003
c330a7d
7c6c0be
aa6d771
d14dc51
caba4f0
78525f9
ba2ade0
3c3932f
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -149,6 +149,7 @@ See [CONTRIBUTING.md](../CONTRIBUTING.md#adding-skills) for guidelines on how to | |||||
| | [gh-cli](../skills/gh-cli/SKILL.md) | GitHub CLI (gh) comprehensive reference for repositories, issues, pull requests, Actions, projects, releases, gists, codespaces, organizations, extensions, and all GitHub operations from the command line. | None | | ||||||
| | [git-commit](../skills/git-commit/SKILL.md) | Execute git commit with conventional commit message analysis, intelligent staging, and message generation. Use when user asks to commit changes, create a git commit, or mentions "/commit". Supports: (1) Auto-detecting type and scope from changes, (2) Generating conventional commit messages from diff, (3) Interactive commit with optional type/scope/description overrides, (4) Intelligent file staging for logical grouping | None | | ||||||
| | [git-flow-branch-creator](../skills/git-flow-branch-creator/SKILL.md) | Intelligent Git Flow branch creator that analyzes git status/diff and creates appropriate branches following the nvie Git Flow branching model. | None | | ||||||
| | [github-agentic-workflows](../skills/github-agentic-workflows/SKILL.md) | Create, update, debug, upgrade, and manage GitHub Agentic Workflows (gh-aw). Covers workflow creation with YAML frontmatter and markdown prompts, trigger configuration, safe-outputs, MCP server integration, shared components, security best practices, and compilation. WHEN: create agentic workflow, gh-aw, update workflow, debug workflow, upgrade workflow, compile workflow, safe outputs, workflow triggers, MCP server workflow, shared workflow component, label command, slash command, agentic automation, GitHub Actions AI agent. | None | | ||||||
|
||||||
| | [github-agentic-workflows](../skills/github-agentic-workflows/SKILL.md) | Create, update, debug, upgrade, and manage GitHub Agentic Workflows (gh-aw). Covers workflow creation with YAML frontmatter and markdown prompts, trigger configuration, safe-outputs, MCP server integration, shared components, security best practices, and compilation. WHEN: create agentic workflow, gh-aw, update workflow, debug workflow, upgrade workflow, compile workflow, safe outputs, workflow triggers, MCP server workflow, shared workflow component, label command, slash command, agentic automation, GitHub Actions AI agent. | None | | |
| | github-agentic-workflows | Create, update, debug, upgrade, and manage GitHub Agentic Workflows (gh-aw). Covers workflow creation with YAML frontmatter and markdown prompts, trigger configuration, safe-outputs, MCP server integration, shared components, security best practices, and compilation. WHEN: create agentic workflow, gh-aw, update workflow, debug workflow, upgrade workflow, compile workflow, safe outputs, workflow triggers, MCP server workflow, shared workflow component, label command, slash command, agentic automation, GitHub Actions AI agent. | None | |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,268 @@ | ||
| --- | ||
| name: arize-ai-provider-integration | ||
| description: "INVOKE THIS SKILL when creating, reading, updating, or deleting Arize AI integrations. Covers listing integrations, creating integrations for any supported LLM provider (OpenAI, Anthropic, Azure OpenAI, AWS Bedrock, Vertex AI, Gemini, NVIDIA NIM, custom), updating credentials or metadata, and deleting integrations using the ax CLI." | ||
| --- | ||
|
|
||
| # Arize AI Integration Skill | ||
|
|
||
| ## Concepts | ||
|
|
||
| - **AI Integration** = stored LLM provider credentials registered in Arize; used by evaluators to call a judge model and by other Arize features that need to invoke an LLM on your behalf | ||
| - **Provider** = the LLM service backing the integration (e.g., `openAI`, `anthropic`, `awsBedrock`) | ||
| - **Integration ID** = a base64-encoded global identifier for an integration (e.g., `TGxtSW50ZWdyYXRpb246MTI6YUJjRA==`); required for evaluator creation and other downstream operations | ||
| - **Scoping** = visibility rules controlling which spaces or users can use an integration | ||
| - **Auth type** = how Arize authenticates with the provider: `default` (provider API key), `proxy_with_headers` (proxy via custom headers), or `bearer_token` (bearer token auth) | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| Proceed directly with the task — run the `ax` command you need. Do NOT check versions, env vars, or profiles upfront. | ||
|
|
||
| If an `ax` command fails, troubleshoot based on the error: | ||
| - `command not found` or version error → see references/ax-setup.md | ||
| - `401 Unauthorized` / missing API key → run `ax profiles show` to inspect the current profile. If the profile is missing or the API key is wrong: check `.env` for `ARIZE_API_KEY` and use it to create/update the profile via references/ax-profiles.md. If `.env` has no key either, ask the user for their Arize API key (https://app.arize.com/admin > API Keys) | ||
| - Space ID unknown → check `.env` for `ARIZE_SPACE_ID`, or run `ax spaces list -o json`, or ask the user | ||
| - LLM provider call fails (missing OPENAI_API_KEY / ANTHROPIC_API_KEY) → check `.env`, load if present, otherwise ask the user | ||
|
|
||
| --- | ||
|
|
||
| ## List AI Integrations | ||
|
|
||
| List all integrations accessible in a space: | ||
|
|
||
| ```bash | ||
| ax ai-integrations list --space-id SPACE_ID | ||
| ``` | ||
|
|
||
| Filter by name (case-insensitive substring match): | ||
|
|
||
| ```bash | ||
| ax ai-integrations list --space-id SPACE_ID --name "openai" | ||
| ``` | ||
|
|
||
| Paginate large result sets: | ||
|
|
||
| ```bash | ||
| # Get first page | ||
| ax ai-integrations list --space-id SPACE_ID --limit 20 -o json | ||
|
|
||
| # Get next page using cursor from previous response | ||
| ax ai-integrations list --space-id SPACE_ID --limit 20 --cursor CURSOR_TOKEN -o json | ||
| ``` | ||
|
|
||
| **Key flags:** | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--space-id` | Space to list integrations in | | ||
| | `--name` | Case-insensitive substring filter on integration name | | ||
| | `--limit` | Max results (1–100, default 50) | | ||
| | `--cursor` | Pagination token from a previous response | | ||
| | `-o, --output` | Output format: `table` (default) or `json` | | ||
|
|
||
| **Response fields:** | ||
|
|
||
| | Field | Description | | ||
| |-------|-------------| | ||
| | `id` | Base64 integration ID — copy this for downstream commands | | ||
| | `name` | Human-readable name | | ||
| | `provider` | LLM provider enum (see Supported Providers below) | | ||
| | `has_api_key` | `true` if credentials are stored | | ||
| | `model_names` | Allowed model list, or `null` if all models are enabled | | ||
| | `enable_default_models` | Whether default models for this provider are allowed | | ||
| | `function_calling_enabled` | Whether tool/function calling is enabled | | ||
| | `auth_type` | Authentication method: `default`, `proxy_with_headers`, or `bearer_token` | | ||
|
|
||
| --- | ||
|
|
||
| ## Get a Specific Integration | ||
|
|
||
| ```bash | ||
| ax ai-integrations get INT_ID | ||
| ax ai-integrations get INT_ID -o json | ||
| ``` | ||
|
|
||
| Use this to inspect an integration's full configuration or to confirm its ID after creation. | ||
|
|
||
| --- | ||
|
|
||
| ## Create an AI Integration | ||
|
|
||
| Before creating, always list integrations first — the user may already have a suitable one: | ||
|
|
||
| ```bash | ||
| ax ai-integrations list --space-id SPACE_ID | ||
| ``` | ||
|
|
||
| If no suitable integration exists, create one. The required flags depend on the provider. | ||
|
|
||
| ### OpenAI | ||
|
|
||
| ```bash | ||
| ax ai-integrations create \ | ||
| --name "My OpenAI Integration" \ | ||
| --provider openAI \ | ||
| --api-key $OPENAI_API_KEY | ||
| ``` | ||
|
|
||
| ### Anthropic | ||
|
|
||
| ```bash | ||
| ax ai-integrations create \ | ||
| --name "My Anthropic Integration" \ | ||
| --provider anthropic \ | ||
| --api-key $ANTHROPIC_API_KEY | ||
| ``` | ||
|
|
||
| ### Azure OpenAI | ||
|
|
||
| ```bash | ||
| ax ai-integrations create \ | ||
| --name "My Azure OpenAI Integration" \ | ||
| --provider azureOpenAI \ | ||
| --api-key $AZURE_OPENAI_API_KEY \ | ||
| --base-url "https://my-resource.openai.azure.com/" | ||
| ``` | ||
|
|
||
| ### AWS Bedrock | ||
|
|
||
| AWS Bedrock uses IAM role-based auth instead of an API key. Provide the ARN of the role Arize should assume: | ||
|
|
||
| ```bash | ||
| ax ai-integrations create \ | ||
| --name "My Bedrock Integration" \ | ||
| --provider awsBedrock \ | ||
| --role-arn "arn:aws:iam::123456789012:role/ArizeBedrockRole" | ||
| ``` | ||
|
|
||
| ### Vertex AI | ||
|
|
||
| Vertex AI uses GCP service account credentials. Provide the GCP project and region: | ||
|
|
||
| ```bash | ||
| ax ai-integrations create \ | ||
| --name "My Vertex AI Integration" \ | ||
| --provider vertexAI \ | ||
| --project-id "my-gcp-project" \ | ||
| --location "us-central1" | ||
| ``` | ||
|
|
||
| ### Gemini | ||
|
|
||
| ```bash | ||
| ax ai-integrations create \ | ||
| --name "My Gemini Integration" \ | ||
| --provider gemini \ | ||
| --api-key $GEMINI_API_KEY | ||
| ``` | ||
|
|
||
| ### NVIDIA NIM | ||
|
|
||
| ```bash | ||
| ax ai-integrations create \ | ||
| --name "My NVIDIA NIM Integration" \ | ||
| --provider nvidiaNim \ | ||
| --api-key $NVIDIA_API_KEY \ | ||
| --base-url "https://integrate.api.nvidia.com/v1" | ||
| ``` | ||
|
|
||
| ### Custom (OpenAI-compatible endpoint) | ||
|
|
||
| ```bash | ||
| ax ai-integrations create \ | ||
| --name "My Custom Integration" \ | ||
| --provider custom \ | ||
| --base-url "https://my-llm-proxy.example.com/v1" \ | ||
| --api-key $CUSTOM_LLM_API_KEY | ||
| ``` | ||
|
|
||
| ### Supported Providers | ||
|
|
||
| | Provider | Required extra flags | | ||
| |----------|---------------------| | ||
| | `openAI` | `--api-key <key>` | | ||
| | `anthropic` | `--api-key <key>` | | ||
| | `azureOpenAI` | `--api-key <key>`, `--base-url <azure-endpoint>` | | ||
| | `awsBedrock` | `--role-arn <arn>` | | ||
| | `vertexAI` | `--project-id <gcp-project>`, `--location <region>` | | ||
| | `gemini` | `--api-key <key>` | | ||
| | `nvidiaNim` | `--api-key <key>`, `--base-url <nim-endpoint>` | | ||
| | `custom` | `--base-url <endpoint>` | | ||
|
|
||
| ### Optional flags for any provider | ||
|
|
||
| | Flag | Description | | ||
| |------|-------------| | ||
| | `--model-names` | Comma-separated list of allowed model names; omit to allow all models | | ||
| | `--enable-default-models` / `--no-default-models` | Enable or disable the provider's default model list | | ||
| | `--function-calling` / `--no-function-calling` | Enable or disable tool/function calling support | | ||
|
|
||
| ### After creation | ||
|
|
||
| Capture the returned integration ID (e.g., `TGxtSW50ZWdyYXRpb246MTI6YUJjRA==`) — it is needed for evaluator creation and other downstream commands. If you missed it, retrieve it: | ||
|
|
||
| ```bash | ||
| ax ai-integrations list --space-id SPACE_ID -o json | ||
| # or, if you know the ID: | ||
| ax ai-integrations get INT_ID | ||
| ``` | ||
|
|
||
| --- | ||
|
|
||
| ## Update an AI Integration | ||
|
|
||
| `update` is a partial update — only the flags you provide are changed. Omitted fields stay as-is. | ||
|
|
||
| ```bash | ||
| # Rename | ||
| ax ai-integrations update INT_ID --name "New Name" | ||
|
|
||
| # Rotate the API key | ||
| ax ai-integrations update INT_ID --api-key $OPENAI_API_KEY | ||
|
|
||
| # Change the model list | ||
| ax ai-integrations update INT_ID --model-names "gpt-4o,gpt-4o-mini" | ||
|
|
||
| # Update base URL (for Azure, custom, or NIM) | ||
| ax ai-integrations update INT_ID --base-url "https://new-endpoint.example.com/v1" | ||
| ``` | ||
|
|
||
| Any flag accepted by `create` can be passed to `update`. | ||
|
|
||
| --- | ||
|
|
||
| ## Delete an AI Integration | ||
|
|
||
| **Warning:** Deletion is permanent. Evaluators that reference this integration will no longer be able to run. | ||
|
|
||
| ```bash | ||
| ax ai-integrations delete INT_ID --force | ||
| ``` | ||
|
|
||
| Omit `--force` to get a confirmation prompt instead of deleting immediately. | ||
|
|
||
| --- | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| | Problem | Solution | | ||
| |---------|----------| | ||
| | `ax: command not found` | See references/ax-setup.md | | ||
| | `401 Unauthorized` | API key may not have access to this space. Verify key and space ID at https://app.arize.com/admin > API Keys | | ||
| | `No profile found` | Run `ax profiles show --expand`; set `ARIZE_API_KEY` env var or write `~/.arize/config.toml` | | ||
| | `Integration not found` | Verify with `ax ai-integrations list --space-id SPACE_ID` | | ||
| | `has_api_key: false` after create | Credentials were not saved — re-run `update` with the correct `--api-key` or `--role-arn` | | ||
| | Evaluator runs fail with LLM errors | Check integration credentials with `ax ai-integrations get INT_ID`; rotate the API key if needed | | ||
| | `provider` mismatch | Cannot change provider after creation — delete and recreate with the correct provider | | ||
|
|
||
| --- | ||
|
|
||
| ## Related Skills | ||
|
|
||
| - **arize-evaluator**: Create LLM-as-judge evaluators that use an AI integration → use `arize-evaluator` | ||
| - **arize-experiment**: Run experiments that use evaluators backed by an AI integration → use `arize-experiment` | ||
|
|
||
| --- | ||
|
|
||
| ## Save Credentials for Future Use | ||
|
|
||
| See references/ax-profiles.md § Save Credentials for Future Use. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The PR description says the main change is adding documentation for a new
github-agentic-workflowsskill, but this PR also introduces many new plugin skills/agents/assets and changes numerousplugin.jsonmanifests. Please either (a) update the PR description to reflect the full scope, or (b) split these changes into separate PRs to keep review/rollback manageable.